net.liftweb.http.provider

HTTPRequest

trait HTTPRequest extends AnyRef

The representation of a HTTP request state

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. HTTPRequest
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def authType: Box[String]

    returns

    - HTTP authentication scheme: BASIC, DIGEST etc. Empty if there is auth header.

  2. abstract def contentType: Box[String]

    returns

    - the MIME type of the body of the request. Empty if this is unknonwn.

  3. 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.

  4. 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

  5. abstract def cookies: List[HTTPCookie]

    returns

    - cookies from this request. Nil if there are no cookies.

  6. abstract def destroyServletSession(): Unit

    Destroy the underlying servlet session

  7. abstract def extractFiles: List[ParamHolder]

    returns

    - the files uploaded

  8. abstract def headers: List[HTTPParam]

    returns

    - all header parameters present in this request. Nil if no headers are used.

  9. 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

  10. abstract def inputStream: InputStream

    returns

    - the input stream for the request body

  11. abstract def locale: Box[Locale]

    returns

    - the locale forthis request. Empty if there is not language information.

  12. abstract def method: String

    returns

    - the HTTP method: GET, POST etc.

  13. abstract def multipartContent_?: Boolean

    returns

    true - if the request content is multipart

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

    name

    - the parameter name

    returns

    - the list of values associated with this name

  15. abstract def paramNames: List[String]

    returns

    - request parameter names

  16. abstract def params: List[HTTPParam]

    returns

    - all request parameters

  17. abstract def provider: HTTPProvider

    The provider associated with this request

  18. abstract def queryString: Box[String]

    returns

    - the entire query string. Empty if the requst contains no query string

  19. abstract def remoteAddress: String

    returns

    - the remote address of the client or the last seen proxy.

  20. abstract def remoteHost: String

    returns

    - the fully qualified name of the client host or last seen proxy

  21. abstract def remotePort: Int

    returns

    - the source port of the client or last seen proxy.

  22. 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.

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

    returns

    - Some[Any] if this is a resumed request, return the state associated with it.

  24. abstract def scheme: String

    returns

    - the name of the scheme of this request: http, https etc.

  25. abstract def serverName: String

    returns

    - the host name of the server

  26. abstract def serverPort: Int

    returns

    - the server port

  27. abstract def session: HTTPSession

    returns

    - the HTTP session associated with this request

  28. 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

  29. 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)

  30. 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.

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

    Suspend the curent request and resume it after a given timeout

  32. abstract def suspendResumeSupport_?: Boolean

    returns

    true if the underlying container supports suspend/resume idiom.

  33. abstract def uri: String

    returns

    - the request URI

  34. abstract def url: String

    returns

    - the request URL

  35. abstract def userAgent: Box[String]

    The User-Agent of the request

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  13. 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

  14. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  19. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any