The HTTP request header. Note that it doesn't contain the request body yet.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
- Self type
Members list
Value members
Abstract methods
A map of typed attributes associated with the request.
A map of typed attributes associated with the request.
Attributes
The remote connection that made the request.
The remote connection that made the request.
Attributes
The target of the HTTP request, i.e. the URI or path that was given on the first line of the request.
The target of the HTTP request, i.e. the URI or path that was given on the first line of the request.
Attributes
Concrete methods
Check if this request accepts a given media type.
Check if this request accepts a given media type.
Attributes
- Returns
-
true if
mimeTypematches the Accept header, otherwise false
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.
Type parameters
- A
-
The type of value.
Value parameters
- key
-
The new attribute key.
- value
-
The attribute value.
Attributes
- Returns
-
The new version of this object with the new attribute.
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.
Value parameters
- e1
-
The new attribute.
Attributes
- Returns
-
The new version of this object with the new attribute.
Create a new versions of this object with the given attributes attached to it.
Create a new versions of this object with the given attributes attached to it.
Value parameters
- e1
-
The first new attribute.
- e2
-
The second new attribute.
Attributes
- Returns
-
The new version of this object with the new attributes.
Create a new versions of this object with the given attributes attached to it.
Create a new versions of this object with the given attributes attached to it.
Value parameters
- e1
-
The first new attribute.
- e2
-
The second new attribute.
- e3
-
The third new attribute.
Attributes
- Returns
-
The new version of this object with the new attributes.
Create a new versions of this object with the given attributes attached to it.
Create a new versions of this object with the given attributes attached to it.
Value parameters
- entries
-
The new attributes.
Attributes
- Returns
-
The new version of this object with the new attributes.
The X509 certificate chain presented by a client during SSL requests. This method is equivalent to connection.clientCertificateChain.
The X509 certificate chain presented by a client during SSL requests. This method is equivalent to connection.clientCertificateChain.
Attributes
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.
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.
Attributes
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 flash, to allow it to be evaluated on-demand.
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 flash, to allow it to be evaluated on-demand.
Attributes
Helper method to access a queryString parameter. This method delegates to connection.getQueryParameter(key).
Helper method to access a queryString parameter. This method delegates to connection.getQueryParameter(key).
Attributes
- 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
Noneis returned.
True if this request has a body, so we know if we should trigger body parsing. The base implementation simply checks for the Content-Length or Transfer-Encoding headers, but subclasses (such as fake requests) may return true in other cases so the headers need not be updated to reflect the body.
True if this request has a body, so we know if we should trigger body parsing. The base implementation simply checks for the Content-Length or Transfer-Encoding headers, but subclasses (such as fake requests) may return true in other cases so the headers need not be updated to reflect the body.
Attributes
The request id. The request id is stored as an attribute indexed by play.api.mvc.request.RequestAttrKey.Id.
The request id. The request id is stored as an attribute indexed by play.api.mvc.request.RequestAttrKey.Id.
Attributes
The URI path. This method delegates to target.path.
The URI path. This method delegates to target.path.
Attributes
The parsed query string. This method delegates to target.queryMap.
The parsed query string. This method delegates to target.queryMap.
Attributes
Returns the raw query string. This method delegates to connection.rawQueryString.
Returns the raw query string. This method delegates to connection.rawQueryString.
Attributes
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.
Attributes
Create a new versions of this object with the given attribute removed.
Create a new versions of this object with the given attribute removed.
Value parameters
- key
-
The key of the attribute to remove.
Attributes
- Returns
-
The new version of this object with the attribute removed.
Is the client using SSL? This method delegates to connection.secure.
Is the client using SSL? This method delegates to connection.secure.
Attributes
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 play.api.mvc.request.Cell to store the session cookie, to allow it to be evaluated on-demand.
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 play.api.mvc.request.Cell to store the session cookie, to allow it to be evaluated on-demand.
Attributes
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns
-
a string representation of the object.
- Definition Classes
-
Any
The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred (It will take precedence over any other language).
The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred (It will take precedence over any other language).
Attributes
- Returns
-
The current transient language of this request.
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.
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.
Attributes
Create a new version of this object with the given attributes attached to it. This replaces any existing attributes.
Create a new version of this object with the given attributes attached to it. This replaces any existing attributes.
Value parameters
- newAttrs
-
The new attributes to add.
Attributes
- Returns
-
The new version of this object with the attributes attached.
Attach a body to this header.
Attach a body to this header.
Type parameters
- A
-
The type of the body.
Value parameters
- body
-
The body to attach.
Attributes
- Returns
-
A new request with the body attached to the header.
The remote connection that made the request.
The remote connection that made the request.
Attributes
Return a new copy of the request with its method changed.
Return a new copy of the request with its method changed.
Attributes
Return a new copy of the request with its target changed.
Return a new copy of the request with its target changed.
Attributes
Create a new versions of this object with the given transient language set. The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred (It will take precedence over any other language).
Create a new versions of this object with the given transient language set. The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred (It will take precedence over any other language).
Value parameters
- lang
-
The language to use.
Attributes
- Returns
-
The new version of this object with the given transient language set.
Create a new versions of this object with the given transient language set. The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred (It will take precedence over any other language).
Create a new versions of this object with the given transient language set. The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred (It will take precedence over any other language).
Value parameters
- code
-
The language to use.
Attributes
- Returns
-
The new version of this object with the given transient language set.
Create a new versions of this object with the given transient language set. The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred (It will take precedence over any other language).
Create a new versions of this object with the given transient language set. The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred (It will take precedence over any other language).
Value parameters
- locale
-
The language to use.
Attributes
- Returns
-
The new version of this object with the given transient language set.
Return a new copy of the request with its HTTP version changed.
Return a new copy of the request with its HTTP version changed.
Attributes
Create a new versions of this object with the given transient language removed.
Create a new versions of this object with the given transient language removed.
Attributes
- Returns
-
The new version of this object with the transient language removed.
Concrete fields
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).
Attributes
Attributes
- Returns
-
The media types list of the request’s Accept header, sorted by preference (preferred first).
Returns the charset of the request for text-based body
Returns the charset of the request for text-based body
Attributes
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))
Attributes
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.
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.