net.liftweb.http.provider.HTTPRequest

trait HTTPRequest

trait HTTPRequest

 extends ScalaObject


The representation of a HTTP request state


Source: HTTPRequest.scala(33)

Direct Known Subclasses

HTTPRequestServlet,

 Fields

authType.. abstract def authType
[details]
return
- - HTTP authentication scheme: BASIC, DIGEST etc. Empty if there is auth header.
Box[String]
contentType.. abstract def contentType
[details]
return
- - the MIME type of the body of the request. Empty if this is unknonwn.
Box[String]
context.. abstract def context
[details]
return
- - the HTTPContext of this service. It does not guarantee that it returns the same HTTPContext reference upon each invocation but it must guarantee that HTTPContext reference contains the same information.
HTTPContext
contextPath.. abstract def contextPath
[details]
return
- - the context path. Similar with HttpServletRequest.getContextPath. Return "" empty string if your implementation does not support the contept of context path
String
cookies.. abstract def cookies
[details]
return
- - cookies from this request. Nil if there are no cookies.
List[HTTPCookie]
extractFiles.. abstract def extractFiles
[details]
return
- - the files uploaded
List[ParamHolder]
headers.. abstract def headers
[details]
return
- - all header parameters present in this request. Nil if no headers are used.
List[HTTPParam]
inputStream.. abstract def inputStream
[details]
return
- - the input stream for the request body
InputStream
locale.. abstract def locale
[details]
return
- - the locale forthis request. Empty if there is not language information.
Box[Locale]
method.. abstract def method
[details]
return
- - the HTTP method: GET, POST etc.
String
multipartContent_?.. abstract def multipartContent_?
[details]
return
- true - if the request content is multipart
Boolean
paramNames.. abstract def paramNames
[details]
return
- - request parameter names
List[String]
params.. abstract def params
[details]
return
- - all request parameters
List[HTTPParam]
queryString.. abstract def queryString
[details]
return
- - the entire query string. Empty if the requst contains no query string
Box[String]
remoteAddress.. abstract def remoteAddress
[details]
return
- - the remote address of the client or the last seen proxy.
String
remoteHost.. abstract def remoteHost
[details]
return
- - the fully qualified name of the client host or last seen proxy
String
remotePort.. abstract def remotePort
[details]
return
- - the source port of the client or last seen proxy.
Int
resumeInfo.. abstract def resumeInfo
[details]
return
- - Some[Any] if this is a resumed request, return the state associated with it.
Option[Any]
scheme.. abstract def scheme
[details]
return
- - the name of the scheme of this request: http, https etc.
String
serverName.. abstract def serverName
[details]
return
- - the host name of the server
String
serverPort.. abstract def serverPort
[details]
return
- - the server port
Int
session.. abstract def session
[details]
return
- - the HTTP session associated with this request
HTTPSession
sessionId.. abstract def sessionId
[details]
return
- the sessionID (if there is one) for this request. This will *NOT* create a new session if one does not already exist
Box[String]
snapshot.. abstract def snapshot
Creates a new HTTPRequest instance as a copy of this one [details]
It is used when snapshots of the current request context is created in order for this request object to be used on different threads (such as asynchronous template fragments processing). The new instance must not keep any reference to the container' instances.
HTTPRequest
suspendResumeSupport_?.. abstract def suspendResumeSupport_?
[details]
return
- true if the underlying container supports suspend/resume idiom.
Boolean
uri.. abstract def uri
[details]
return
- - the request URI
String
url.. abstract def url
[details]
return
- - the request URL
String
userAgent.. abstract def userAgent
The User-Agent of the request
Box[String]

 Methods

!=.. final def !=(arg0 : Any) Boolean Any
!=.. final def !=(arg0 : Object) Boolean AnyRef
==.. final def ==(arg0 : Object) Boolean AnyRef
==.. final def ==(arg0 : Any) Boolean Any
asInstanceOf.. final def asInstanceOf[T0] T0 Any
clone.. protected def clone Object AnyRef
eq.. final def eq(arg0 : Object) Boolean AnyRef
equals.. def equals(arg0 : Any) Boolean AnyRef
finalize.. protected def finalize Unit AnyRef
getClass.. final def getClass Class[Any] AnyRef
hashCode.. def hashCode Int AnyRef
header.. def header(name : String)
Return the header value by the given name [details]
param
name - - the header name
return
- - the header value. Empty if there is no such header
Box[String]
headers.. abstract def headers(name : String)
Return the header values by the given name [details]
param
name - - the header name
return
- - List[String] or Nil if there is no such header
List[String]
isInstanceOf.. final def isInstanceOf[T0] Boolean Any
ne.. final def ne(arg0 : Object) Boolean AnyRef
notify.. final def notify Unit AnyRef
notifyAll.. final def notifyAll Unit AnyRef
param.. abstract def param(name : String)
[details]
param
name - - the parameter name
return
- - the list of values associated with this name
List[String]
resume.. abstract def resume(what : Object)
Resume this request [details]
return
- false if this continuation cannot be resumed as it is not in pending state.
Boolean
setCharacterEncoding.. abstract def setCharacterEncoding(encoding : String)
Sets the character encoding that will be used for request body read [details]
param
encoding - - the encoding that will be used (e.g. UTF-8)
Unit
suspend.. abstract def suspend(timeout : Long)
Suspend the curent request and resume it after a given timeout
Value
synchronized.. final def synchronized[T0](arg0 : T0) T0 AnyRef
toString.. def toString String AnyRef
wait.. final def wait Unit AnyRef
wait.. final def wait(arg0 : Long) Unit AnyRef
wait.. final def wait(arg0 : Long, arg1 : Int) Unit AnyRef
Copyright (c) 2006-2010 WorldWide Conferencing, LLC. All Rights Reserved.