net.liftweb.http.provider

HTTPRequest

trait HTTPRequest extends AnyRef

The representation of a HTTP request state

Linear Supertypes
AnyRef, Any
Known Subclasses
HTTPRequestServlet
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. def authType : Box[String]

    returns

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

    Attributes
    abstract

  2. def contentType : Box[String]

    returns

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

    Attributes
    abstract

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

    Attributes
    abstract

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

    Attributes
    abstract

  5. def cookies : List[HTTPCookie]

    returns

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

    Attributes
    abstract

  6. def destroyServletSession (): Unit

    Destroy the underlying servlet session

    Destroy the underlying servlet session

    Attributes
    abstract

  7. def extractFiles : List[ParamHolder]

    returns

    - the files uploaded

    Attributes
    abstract

  8. def headers : List[HTTPParam]

    returns

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

    Attributes
    abstract

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

    Attributes
    abstract

  10. def inputStream : InputStream

    returns

    - the input stream for the request body

    Attributes
    abstract

  11. def locale : Box[Locale]

    returns

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

    Attributes
    abstract

  12. def method : String

    returns

    - the HTTP method: GET, POST etc.

    Attributes
    abstract

  13. def multipartContent_? : Boolean

    returns

    true - if the request content is multipart

    Attributes
    abstract

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

    name

    - the parameter name

    returns

    - the list of values associated with this name

    Attributes
    abstract

  15. def paramNames : List[String]

    returns

    - request parameter names

    Attributes
    abstract

  16. def params : List[HTTPParam]

    returns

    - all request parameters

    Attributes
    abstract

  17. def provider : HTTPProvider

    The provider associated with this request

    The provider associated with this request

    Attributes
    abstract

  18. def queryString : Box[String]

    returns

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

    Attributes
    abstract

  19. def remoteAddress : String

    returns

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

    Attributes
    abstract

  20. def remoteHost : String

    returns

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

    Attributes
    abstract

  21. def remotePort : Int

    returns

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

    Attributes
    abstract

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

    Attributes
    abstract

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

    returns

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

    Attributes
    abstract

  24. def scheme : String

    returns

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

    Attributes
    abstract

  25. def serverName : String

    returns

    - the host name of the server

    Attributes
    abstract

  26. def serverPort : Int

    returns

    - the server port

    Attributes
    abstract

  27. def session : HTTPSession

    returns

    - the HTTP session associated with this request

    Attributes
    abstract

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

    Attributes
    abstract

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

    Attributes
    abstract

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

    Attributes
    abstract

  31. def suspend (timeout: Long): Value

    Suspend the curent request and resume it after a given timeout

    Suspend the curent request and resume it after a given timeout

    Attributes
    abstract

  32. def suspendResumeSupport_? : Boolean

    returns

    true if the underlying container supports suspend/resume idiom.

    Attributes
    abstract

  33. def uri : String

    returns

    - the request URI

    Attributes
    abstract

  34. def url : String

    returns

    - the request URL

    Attributes
    abstract

  35. def userAgent : Box[String]

    The User-Agent of the request

    The User-Agent of the request

    Attributes
    abstract

Concrete Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  8. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    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. def getClass (): java.lang.Class[_]

    Attributes
    final
    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. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  15. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  16. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  17. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  18. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  19. def toString (): String

    Definition Classes
    AnyRef → Any

  20. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  21. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  22. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any