root
API
Generated with
root/play/play.api/play.api.mvc/Request

Request

play.api.mvc.Request
See theRequest companion object
trait Request[+A] extends RequestHeader

The complete HTTP request.

Type parameters

A

the body content type.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class WrappedRequest[A]
class MessagesRequest[A]
class AuthenticatedRequest[A, U]
Self type
Request[A]

Members list

Value members

Abstract methods

def body: A

The body content.

The body content.

Attributes

Concrete methods

override def addAttr[B](key: TypedKey[B], value: B): Request[A]

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.

Definition Classes
override def addAttrs(e1: TypedEntry[_]): Request[A]

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.

Definition Classes
override def addAttrs(e1: TypedEntry[_], e2: TypedEntry[_]): Request[A]

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.

Definition Classes
override def addAttrs(e1: TypedEntry[_], e2: TypedEntry[_], e3: TypedEntry[_]): Request[A]

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.

Definition Classes
override def addAttrs(entries: TypedEntry[_]*): Request[A]

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.

Definition Classes
override def asJava: Request

Be aware that when converting a Scala request to a Java request that the body will not be converted automatically to a Java equivalent body. For example: If the Scala request contains a play.api.mvc.RawBuffer it will not be converted into it's Java equivalent play.mvc.Http.RawBuffer, or a Scala AnyContentAsEmpty will not be converted into a java.util.Optional.empty() (which is the Play Java equivalent of an empty body). Therefore helper methods like request.asJava.body().asRaw(), asJson(), etc. will very likely not work. You can however retrieve any stored body object by using request.asJava.body().as(classOf[Object]).

Be aware that when converting a Scala request to a Java request that the body will not be converted automatically to a Java equivalent body. For example: If the Scala request contains a play.api.mvc.RawBuffer it will not be converted into it's Java equivalent play.mvc.Http.RawBuffer, or a Scala AnyContentAsEmpty will not be converted into a java.util.Optional.empty() (which is the Play Java equivalent of an empty body). Therefore helper methods like request.asJava.body().asRaw(), asJson(), etc. will very likely not work. You can however retrieve any stored body object by using request.asJava.body().as(classOf[Object]).

Attributes

Definition Classes
override def hasBody: Boolean

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

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

Attributes

Definition Classes
def map[B](f: A => B): Request[B]

Transform the request body.

Transform the request body.

Attributes

override def removeAttr(key: TypedKey[_]): Request[A]

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.

Definition Classes
override def withAttrs(newAttrs: TypedMap): Request[A]

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.

Definition Classes
override def withConnection(newConnection: RemoteConnection): Request[A]

Attributes

Definition Classes
override def withHeaders(newHeaders: Headers): Request[A]

The remote connection that made the request.

The remote connection that made the request.

Attributes

Definition Classes
override def withMethod(newMethod: String): Request[A]

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

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

Attributes

Definition Classes
override def withTarget(newTarget: RequestTarget): Request[A]

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

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

Attributes

Definition Classes
override def withTransientLang(lang: Lang): Request[A]

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.

Definition Classes
override def withTransientLang(code: String): Request[A]

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.

Definition Classes
override def withTransientLang(locale: Locale): Request[A]

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.

Definition Classes
override def withVersion(newVersion: String): Request[A]

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

Definition Classes
override def withoutTransientLang(): Request[A]

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.

Definition Classes

Inherited methods

def accepts(mimeType: String): Boolean

Check if this request accepts a given media type.

Check if this request accepts a given media type.

Attributes

Returns

true if mimeType matches the Accept header, otherwise false

Inherited from:
RequestHeader
final def clientCertificateChain: Option[Seq[X509Certificate]]

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

Inherited from:
RequestHeader
def cookies: 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.

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

Inherited from:
RequestHeader
def flash: Flash

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

Inherited from:
RequestHeader
def getQueryString(key: String): Option[String]

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 None is returned.

Inherited from:
RequestHeader
final def id: Long

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

Inherited from:
RequestHeader
final def path: String

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

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

Attributes

Inherited from:
RequestHeader
final def queryString: Map[String, Seq[String]]

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

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

Attributes

Inherited from:
RequestHeader
def rawQueryString: String

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

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

Attributes

Inherited from:
RequestHeader
final def remoteAddress: String

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

Inherited from:
RequestHeader
final def secure: Boolean

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

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

Attributes

Inherited from:
RequestHeader
def session: Session

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

Inherited from:
RequestHeader
override def toString: String

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
RequestHeader -> Any
Inherited from:
RequestHeader
def transientLang(): Option[Lang]

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.

Inherited from:
RequestHeader
final def uri: 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.

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

Inherited from:
RequestHeader
def withBody[A](body: A): Request[A]

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.

Inherited from:
RequestHeader

Inherited and Abstract methods

def attrs: TypedMap

A map of typed attributes associated with the request.

A map of typed attributes associated with the request.

Attributes

Inherited from:
RequestHeader
def connection: RemoteConnection

The remote connection that made the request.

The remote connection that made the request.

Attributes

Inherited from:
RequestHeader
def headers: Headers

The HTTP headers.

The HTTP headers.

Attributes

Inherited from:
RequestHeader
def method: String

The HTTP method.

The HTTP method.

Attributes

Inherited from:
RequestHeader
def target: RequestTarget

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

Inherited from:
RequestHeader
def version: String

The HTTP version.

The HTTP version.

Attributes

Inherited from:
RequestHeader

Inherited fields

lazy val acceptLanguages: Seq[Lang]

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

Inherited from:
RequestHeader
lazy val acceptedTypes: Seq[MediaRange]

Attributes

Returns

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

Inherited from:
RequestHeader
lazy val charset: Option[String]

Returns the charset of the request for text-based body

Returns the charset of the request for text-based body

Attributes

Inherited from:
RequestHeader
lazy val contentType: Option[String]

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

Inherited from:
RequestHeader
lazy val domain: String

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

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

Attributes

Inherited from:
RequestHeader
lazy val host: String

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.

Attributes

Inherited from:
RequestHeader
lazy val mediaType: Option[MediaType]

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

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

Attributes

Inherited from:
RequestHeader
Generated with