Trait/Object

play.api.mvc

Request

Related Docs: object Request | package mvc

Permalink

trait Request[+A] extends RequestHeader

The complete HTTP request.

A

the body content type.

Self Type
Request[A]
Annotations
@implicitNotFound( "Cannot find any HTTP Request here" )
Source
Request.scala
Linear Supertypes
RequestHeader, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Request
  2. RequestHeader
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def attrs: TypedMap

    Permalink

    A map of typed attributes associated with the request.

    A map of typed attributes associated with the request.

    Definition Classes
    RequestHeader
  2. abstract def body: A

    Permalink

    The body content.

  3. abstract def connection: RemoteConnection

    Permalink

    The remote connection that made the request.

    The remote connection that made the request.

    Definition Classes
    RequestHeader
  4. abstract def headers: Headers

    Permalink

    The HTTP headers.

    The HTTP headers.

    Definition Classes
    RequestHeader
  5. abstract def method: String

    Permalink

    The HTTP method.

    The HTTP method.

    Definition Classes
    RequestHeader
  6. abstract def target: RequestTarget

    Permalink

    The target of the HTTP request, i.e.

    The target of the HTTP request, i.e. the URI or path that was given on the first line of the request.

    Definition Classes
    RequestHeader
  7. abstract def version: String

    Permalink

    The HTTP version.

    The HTTP version.

    Definition Classes
    RequestHeader

Concrete Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. lazy val acceptLanguages: Seq[Lang]

    Permalink

    The Request Langs extracted from the Accept-Language header and sorted by preference (preferred first).

    The Request Langs extracted from the Accept-Language header and sorted by preference (preferred first).

    Definition Classes
    RequestHeader
  5. lazy val acceptedTypes: Seq[MediaRange]

    Permalink

    returns

    The media types list of the request’s Accept header, sorted by preference (preferred first).

    Definition Classes
    RequestHeader
  6. def accepts(mimeType: String): Boolean

    Permalink

    Check if this request accepts a given media type.

    Check if this request accepts a given media type.

    returns

    true if mimeType matches the Accept header, otherwise false

    Definition Classes
    RequestHeader
  7. def addAttr[B](key: TypedKey[B], value: B): Request[A]

    Permalink

    Create a new versions of this object with the given attribute attached to it.

    Create a new versions of this object with the given attribute attached to it.

    key

    The new attribute key.

    value

    The attribute value.

    returns

    The new version of this object with the new attribute.

    Definition Classes
    RequestRequestHeader
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def asJava: mvc.Http.RequestHeader

    Permalink
    Definition Classes
    RequestHeader
  10. lazy val charset: Option[String]

    Permalink

    Returns the charset of the request for text-based body

    Returns the charset of the request for text-based body

    Definition Classes
    RequestHeader
  11. final def clientCertificateChain: Option[Seq[X509Certificate]]

    Permalink

    The X509 certificate chain presented by a client during SSL requests.

    The X509 certificate chain presented by a client during SSL requests. This method is equivalent to connection.clientCertificateChain.

    Definition Classes
    RequestHeader
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. lazy val contentType: Option[String]

    Permalink

    Returns the value of the Content-Type header (without the parameters (eg charset))

    Returns the value of the Content-Type header (without the parameters (eg charset))

    Definition Classes
    RequestHeader
  14. def cookies: Cookies

    Permalink

    The HTTP cookies.

    The HTTP cookies. The request's cookies are stored in an attribute indexed by play.api.mvc.request.RequestAttrKey.Cookies. The attribute uses a Cell to store the cookies, to allow them to be evaluated on-demand.

    Definition Classes
    RequestHeader
  15. lazy val domain: String

    Permalink

    The HTTP domain.

    The HTTP domain. The domain part of the request's host.

    Definition Classes
    RequestHeader
  16. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def flash: Flash

    Permalink

    Parses the Flash cookie and returns the Flash data.

    Parses the Flash cookie and returns the Flash data. The request's flash cookie is stored in an attribute indexed by play.api.mvc.request.RequestAttrKey.Flash. The attribute uses a play.api.mvc.request.Cell to store the session, to allow it to be evaluated on-demand.

    Definition Classes
    RequestHeader
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def getQueryString(key: String): Option[String]

    Permalink

    Helper method to access a queryString parameter.

    Helper method to access a queryString parameter. This method delegates to connection.getQueryParameter(key).

    returns

    The query parameter's value if the parameter is present and there is only one value. If the parameter is absent or there is more than one value for that parameter then None is returned.

    Definition Classes
    RequestHeader
  22. def hasBody: Boolean

    Permalink

    True if this request has a body.

    True if this request has a body. This is either done by inspecting the body itself to see if it is an entity representing an "empty" body.

    Definition Classes
    RequestRequestHeader
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. lazy val host: String

    Permalink

    The HTTP host (domain, optionally port).

    The HTTP host (domain, optionally port). This value is derived from the request target, if a hostname is present. If the target doesn't have a host then the Host header is used, if present. If that's not present then an empty string is returned.

    Definition Classes
    RequestHeader
  25. final def id: Long

    Permalink

    The request id.

    The request id. The request id is stored as an attribute indexed by play.api.mvc.request.RequestAttrKey.Id.

    Definition Classes
    RequestHeader
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. def map[B](f: (A) ⇒ B): Request[B]

    Permalink

    Transform the request body.

  28. lazy val mediaType: Option[MediaType]

    Permalink

    The media type of this request.

    The media type of this request. Same as contentType, except returns a fully parsed media type with parameters.

    Definition Classes
    RequestHeader
  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def path: String

    Permalink

    The URI path.

    The URI path. This method delegates to target.path.

    Definition Classes
    RequestHeader
  33. final def queryString: Map[String, Seq[String]]

    Permalink

    The parsed query string.

    The parsed query string. This method delegates to target.queryMap.

    Definition Classes
    RequestHeader
  34. def rawQueryString: String

    Permalink

    Returns the raw query string.

    Returns the raw query string. This method delegates to connection.rawQueryString.

    Definition Classes
    RequestHeader
  35. final def remoteAddress: String

    Permalink

    The client IP address.

    The client IP address.

    retrieves the last untrusted proxy from the Forwarded-Headers or the X-Forwarded-*-Headers.

    This method delegates to connection.remoteAddressString.

    Definition Classes
    RequestHeader
  36. final def secure: Boolean

    Permalink

    Is the client using SSL? This method delegates to connection.secure.

    Is the client using SSL? This method delegates to connection.secure.

    Definition Classes
    RequestHeader
  37. def session: Session

    Permalink

    Parses the Session cookie and returns the Session data.

    Parses the Session cookie and returns the Session data. The request's session cookie is stored in an attribute indexed by play.api.mvc.request.RequestAttrKey.Session. The attribute uses a Cell to store the session cookie, to allow it to be evaluated on-demand.

    Definition Classes
    RequestHeader
  38. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  39. def toString(): String

    Permalink
    Definition Classes
    RequestHeader → AnyRef → Any
  40. final def uri: String

    Permalink

    The complete request URI, containing both path and query string.

    The complete request URI, containing both path and query string. The URI is what was on the status line after the request method. E.g. in "GET /foo/bar?q=s HTTP/1.1" the URI should be /foo/bar?q=s. It could be absolute, some clients send absolute URLs, especially proxies, e.g. http://www.example.org/foo/bar?q=s.

    This method delegates to target.uriString.

    Definition Classes
    RequestHeader
  41. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def withAttrs(newAttrs: TypedMap): Request[A]

    Permalink

    Create a new version of this object with the given attributes attached to it.

    Create a new version of this object with the given attributes attached to it. This replaces any existing attributes.

    newAttrs

    The new attributes to add.

    returns

    The new version of this object with the attributes attached.

    Definition Classes
    RequestRequestHeader
  45. def withBody[A](body: A): Request[A]

    Permalink

    Attach a body to this header.

    Attach a body to this header.

    A

    The type of the body.

    body

    The body to attach.

    returns

    A new request with the body attached to the header.

    Definition Classes
    RequestHeader
  46. def withConnection(newConnection: RemoteConnection): Request[A]

    Permalink
    Definition Classes
    RequestRequestHeader
  47. def withHeaders(newHeaders: Headers): Request[A]

    Permalink

    The remote connection that made the request.

    The remote connection that made the request.

    Definition Classes
    RequestRequestHeader
  48. def withMethod(newMethod: String): Request[A]

    Permalink

    Return a new copy of the request with its method changed.

    Return a new copy of the request with its method changed.

    Definition Classes
    RequestRequestHeader
  49. def withTarget(newTarget: RequestTarget): Request[A]

    Permalink

    Return a new copy of the request with its target changed.

    Return a new copy of the request with its target changed.

    Definition Classes
    RequestRequestHeader
  50. def withVersion(newVersion: String): Request[A]

    Permalink

    Return a new copy of the request with its HTTP version changed.

    Return a new copy of the request with its HTTP version changed.

    Definition Classes
    RequestRequestHeader

Deprecated Value Members

  1. def copy(id: Long = null, uri: String = null, path: String = null, method: String = this.method, version: String = this.version, queryString: Map[String, Seq[String]] = null, headers: Headers = null, remoteAddress: String = null, secure: Boolean = null, clientCertificateChain: Option[Seq[X509Certificate]] = null): RequestHeader

    Permalink

    Copy the request.

    Copy the request.

    Definition Classes
    RequestHeader
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use the with* methods instead

Inherited from RequestHeader

Inherited from AnyRef

Inherited from Any

Ungrouped