HTTPRequest

Abstract Value Members

abstract def authType: Box[String]

returns
- HTTP authentication scheme: BASIC, DIGEST etc. Empty if there is auth header.
abstract def contentType: Box[String]

returns
- the MIME type of the body of the request. Empty if this is unknonwn.
abstract def context: HTTPContext

returns
- 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.
abstract def contextPath: String

returns
- the context path. Similar with HttpServletRequest.getContextPath. Return "" empty string if your implementation does not support the contept of context path
abstract def cookies: List[HTTPCookie]

returns
- cookies from this request. Nil if there are no cookies.
abstract def destroyServletSession(): Unit

Destroy the underlying servlet session
abstract def extractFiles: List[ParamHolder]

returns
- the files uploaded
abstract def headers: List[HTTPParam]

returns
- all header parameters present in this request. Nil if no headers are used.
abstract def headers(name: String): List[String]

Return the header values by the given name.
Return the header values by the given name.
name
- the header name
returns
- List[String] or Nil if there is no such header
abstract def inputStream: InputStream

returns
- the input stream for the request body
abstract def locale: Box[Locale]

returns
- the locale forthis request. Empty if there is not language information.
abstract def method: String

returns
- the HTTP method: GET, POST etc.
abstract def multipartContent_?: Boolean

returns
true - if the request content is multipart
abstract def param(name: String): List[String]

name
- the parameter name
returns
- the list of values associated with this name
abstract def paramNames: List[String]

returns
- request parameter names
abstract def params: List[HTTPParam]

returns
- all request parameters
abstract def provider: HTTPProvider

The provider associated with this request
abstract def queryString: Box[String]

returns
- the entire query string. Empty if the requst contains no query string
abstract def remoteAddress: String

returns
- the remote address of the client or the last seen proxy.
abstract def remoteHost: String

returns
- the fully qualified name of the client host or last seen proxy
abstract def remotePort: Int

returns
- the source port of the client or last seen proxy.
abstract def resume(what: (Req, LiftResponse)): Boolean

Resume this request
Resume this request
returns
false if this continuation cannot be resumed as it is not in pending state.
abstract def resumeInfo: Option[(Req, LiftResponse)]

returns
- Some[Any] if this is a resumed request, return the state associated with it.
abstract def scheme: String

returns
- the name of the scheme of this request: http, https etc.
abstract def serverName: String

returns
- the host name of the server
abstract def serverPort: Int

returns
- the server port
abstract def session: HTTPSession

returns
- the HTTP session associated with this request
abstract def sessionId: Box[String]

returns
the sessionID (if there is one) for this request. This will *NOT* create a new session if one does not already exist
abstract def setCharacterEncoding(encoding: String): Unit

Sets the character encoding that will be used for request body read
Sets the character encoding that will be used for request body read
encoding
- the encoding that will be used (e.g. UTF-8)
abstract def snapshot: HTTPRequest

Creates a new HTTPRequest instance as a copy of this one.
Creates a new HTTPRequest instance as a copy of this one. 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.
abstract def suspend(timeout: Long): RetryState.Value

Suspend the curent request and resume it after a given timeout
abstract def suspendResumeSupport_?: Boolean

returns
true if the underlying container supports suspend/resume idiom.
abstract def uri: String

returns
- the request URI
abstract def url: String

returns
- the request URL
abstract def userAgent: Box[String]

The User-Agent of the request

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def header(name: String): Box[String]

Return the header value by the given name
Return the header value by the given name
name
- the header name
returns
- the header value. Empty if there is no such header
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package provider

trait HTTPRequest extends AnyRef

Abstract Value Members

abstract def authType: Box[String]

abstract def contentType: Box[String]

abstract def context: HTTPContext

abstract def contextPath: String

abstract def cookies: List[HTTPCookie]

abstract def destroyServletSession(): Unit

abstract def extractFiles: List[ParamHolder]

abstract def headers: List[HTTPParam]

abstract def headers(name: String): List[String]

abstract def inputStream: InputStream

abstract def locale: Box[Locale]

abstract def method: String

abstract def multipartContent_?: Boolean

abstract def param(name: String): List[String]

abstract def paramNames: List[String]

abstract def params: List[HTTPParam]

abstract def provider: HTTPProvider

abstract def queryString: Box[String]

abstract def remoteAddress: String

abstract def remoteHost: String

abstract def remotePort: Int

abstract def resume(what: (Req, LiftResponse)): Boolean

abstract def resumeInfo: Option[(Req, LiftResponse)]

abstract def scheme: String

abstract def serverName: String

abstract def serverPort: Int

abstract def session: HTTPSession

abstract def sessionId: Box[String]

abstract def setCharacterEncoding(encoding: String): Unit

abstract def snapshot: HTTPRequest

abstract def suspend(timeout: Long): RetryState.Value

abstract def suspendResumeSupport_?: Boolean

abstract def uri: String

abstract def url: String

abstract def userAgent: Box[String]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def header(name: String): Box[String]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped