play.mvc

Interface Http.Request

All Superinterfaces:

Http.RequestHeader

All Known Implementing Classes:

Http.RequestImpl, play.core.j.RequestImpl

Enclosing class:

Http

public static interface Http.Request
extends Http.RequestHeader

An HTTP request.

Method Summary

Modifier and Type	Method and Description
play.api.mvc.Request<Http.RequestBody>	_underlyingRequest() Deprecated. As of release 2.6.0. Use asScala()
<A> Http.Request	addAttr(TypedKey<A> key, A value) Create a new versions of this object with the given attribute attached to it.
play.api.mvc.Request<Http.RequestBody>	asScala() Return the Scala version of the request
Http.RequestBody	body() The request body.
java.lang.String	username() Deprecated. As of release 2.6, use attrs.get(Security.USERNAME) or attrs.getOptional(Security.USERNAME).
Http.Request	withAttrs(TypedMap newAttrs) Create a new version of this object with the given attributes attached to it.
Http.Request	withBody(Http.RequestBody body) Attach a body to this header.
Http.Request	withUsername(java.lang.String username) Deprecated. As of release 2.6, use req.withAttrs(req.attrs().put(Security.USERNAME, username)).

Methods inherited from interface play.mvc.Http.RequestHeader

_underlyingHeader, acceptedTypes, acceptLanguages, accepts, attrs, charset, clientCertificateChain, contentType, cookie, cookies, getHeader, getQueryString, hasBody, hasHeader, headers, host, method, path, queryString, remoteAddress, secure, tags, uri, version

Method Detail

body

Http.RequestBody body()

The request body.

Returns:

the body

withBody

Http.Request withBody(Http.RequestBody body)

Description copied from interface: Http.RequestHeader

Attach a body to this header.

Specified by:

withBody in interface Http.RequestHeader

Parameters:

body - The body to attach.

Returns:

A new request with the body attached to the header.

withAttrs

Http.Request withAttrs(TypedMap newAttrs)

Description copied from interface: Http.RequestHeader

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

Specified by:

withAttrs in interface Http.RequestHeader

Parameters:

newAttrs - The new attributes to add.

Returns:

The new version of this object with the attributes attached.

addAttr

<A> Http.Request addAttr(TypedKey<A> key,
                         A value)

Description copied from interface: Http.RequestHeader

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

Specified by:

addAttr in interface Http.RequestHeader

Parameters:

key - The new attribute key.

value - The attribute value.

Returns:

The new version of this object with the new attribute.

username

@Deprecated
java.lang.String username()

Deprecated. As of release 2.6, use attrs.get(Security.USERNAME) or attrs.getOptional(Security.USERNAME).

The user name for this request, if defined. This is usually set by annotating your Action with @Authenticated.

Returns:

the username

withUsername

@Deprecated
Http.Request withUsername(java.lang.String username)

Deprecated. As of release 2.6, use req.withAttrs(req.attrs().put(Security.USERNAME, username)).

Returns a request updated with specified user name

Parameters:

username - the new user name

Returns:

a copy of the request containing the specified user name

_underlyingRequest

@Deprecated
play.api.mvc.Request<Http.RequestBody> _underlyingRequest()

Deprecated. As of release 2.6.0. Use asScala()

For internal Play-use only

Returns:

the underlying request

asScala

play.api.mvc.Request<Http.RequestBody> asScala()

Return the Scala version of the request

Specified by:

asScala in interface Http.RequestHeader

Returns:

the underlying request.

See Also:

Request