net.liftweb.http.provider

HTTPRequest

trait HTTPRequest extends AnyRef

The representation of a HTTP request state

linear super types: 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
Impl.
  1. Concrete
  2. Abstract

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  9. def authType : Box[String]

    returns

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

    attributes: abstract
  10. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  11. def contentType : Box[String]

    returns

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

    attributes: abstract
  12. 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
  13. 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
  14. def cookies : List[HTTPCookie]

    returns

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

    attributes: abstract
  15. def destroyServletSession () : Unit

    Destroy the underlying servlet session

    Destroy the underlying servlet session

    attributes: abstract
  16. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  17. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  18. def extractFiles : List[ParamHolder]

    returns

    - the files uploaded

    attributes: abstract
  19. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  20. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  21. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  22. 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

  23. def headers : List[HTTPParam]

    returns

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

    attributes: abstract
  24. 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
  25. def inputStream : InputStream

    returns

    - the input stream for the request body

    attributes: abstract
  26. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  27. def locale : Box[Locale]

    returns

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

    attributes: abstract
  28. def method : String

    returns

    - the HTTP method: GET, POST etc.

    attributes: abstract
  29. def multipartContent_? : Boolean

    returns

    true - if the request content is multipart

    attributes: abstract
  30. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  31. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  32. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  33. def param (name: String) : List[String]

    name

    - the parameter name

    returns

    - the list of values associated with this name

    attributes: abstract
  34. def paramNames : List[String]

    returns

    - request parameter names

    attributes: abstract
  35. def params : List[HTTPParam]

    returns

    - all request parameters

    attributes: abstract
  36. def provider : HTTPProvider

    The provider associated with this request

    The provider associated with this request

    attributes: abstract
  37. def queryString : Box[String]

    returns

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

    attributes: abstract
  38. def remoteAddress : String

    returns

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

    attributes: abstract
  39. def remoteHost : String

    returns

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

    attributes: abstract
  40. def remotePort : Int

    returns

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

    attributes: abstract
  41. 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
  42. def resumeInfo : Option[(Req, LiftResponse)]

    returns

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

    attributes: abstract
  43. def scheme : String

    returns

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

    attributes: abstract
  44. def serverName : String

    returns

    - the host name of the server

    attributes: abstract
  45. def serverPort : Int

    returns

    - the server port

    attributes: abstract
  46. def session : HTTPSession

    returns

    - the HTTP session associated with this request

    attributes: abstract
  47. 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
  48. 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
  49. 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
  50. 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
  51. def suspendResumeSupport_? : Boolean

    returns

    true if the underlying container supports suspend/resume idiom.

    attributes: abstract
  52. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  53. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  54. def uri : String

    returns

    - the request URI

    attributes: abstract
  55. def url : String

    returns

    - the request URL

    attributes: abstract
  56. def userAgent : Box[String]

    The User-Agent of the request

    The User-Agent of the request

    attributes: abstract
  57. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  58. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  59. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from AnyRef

Inherited from Any