play.mvc

Interface Http.Request

All Superinterfaces:

Http.RequestHeader

All Known Implementing Classes:

Http.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() For internal Play-use only
Http.RequestBody	body() The request body.
void	setUsername(java.lang.String username) Deprecated. As of release 2.4, use withUsername(java.lang.String)
java.lang.String	username() The user name for this request, if defined.
Http.Request	withUsername(java.lang.String username) Returns a request updated with specified user name

Methods inherited from interface play.mvc.Http.RequestHeader

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

Method Detail

body

Http.RequestBody body()

The request body.

Returns:

the body

username

java.lang.String username()

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

Returns:

the username

setUsername

@Deprecated
void setUsername(java.lang.String username)

Deprecated. As of release 2.4, use withUsername(java.lang.String)

Defines the user name for this request.

Parameters:

username - Deprecated

withUsername

Http.Request withUsername(java.lang.String 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

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

For internal Play-use only

Returns:

the underlying request