play.mvc

Class Http.RequestImpl

java.lang.Object

play.core.j.RequestHeaderImpl

play.mvc.Http.RequestImpl

All Implemented Interfaces:

Http.Request, Http.RequestHeader

Enclosing class:

Http

public static class Http.RequestImpl
extends play.core.j.RequestHeaderImpl
implements Http.Request

An HTTP request.

Constructor Summary

Constructors

Constructor and Description
RequestImpl(play.api.mvc.Request<Http.RequestBody> request) Constructor with a requestbody.
RequestImpl(play.api.mvc.RequestHeader header) Constructor only based on a header.

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) Sets the username.
java.lang.String	username() The user name for this request, if defined.
Http.Request	withUsername(java.lang.String username) This method returns a new request, based on the current underlying with a giving username.

Methods inherited from class play.core.j.RequestHeaderImpl

_underlyingHeader, acceptedTypes, acceptLanguages, accepts, cookie, cookies, getHeader, getQueryString, hasHeader, headers, host, method, path, queryString, remoteAddress, secure, toString, uri, version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface play.mvc.Http.RequestHeader

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

Constructor Detail

RequestImpl

public RequestImpl(play.api.mvc.RequestHeader header)

Constructor only based on a header.

Parameters:

header - the header from a request

RequestImpl

public RequestImpl(play.api.mvc.Request<Http.RequestBody> request)

Constructor with a requestbody.

Parameters:

request - the body of the request

Method Detail

body

public Http.RequestBody body()

Description copied from interface: Http.Request

The request body.

Specified by:

body in interface Http.Request

Returns:

the underlying body, if present otherwise null

username

public java.lang.String username()

Description copied from interface: Http.Request

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

Specified by:

username in interface Http.Request

Returns:

the username

setUsername

public void setUsername(java.lang.String username)

Sets the username.

Specified by:

setUsername in interface Http.Request

Parameters:

username - the username of the requester

withUsername

public Http.Request withUsername(java.lang.String username)

This method returns a new request, based on the current underlying with a giving username.

Specified by:

withUsername in interface Http.Request

Parameters:

username - the new user name

Returns:

a new request with a request body based on the current request

_underlyingRequest

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

Description copied from interface: Http.Request

For internal Play-use only

Specified by:

_underlyingRequest in interface Http.Request

Returns:

the underlying body of the request