play.mvc

Class Http.Request

java.lang.Object

play.mvc.Http.Request

All Implemented Interfaces:

Serializable

Enclosing class:

Http

public static class Http.Request
extends Object
implements Serializable

An HTTP Request

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	action Full action (ex: Application.index)
String	actionMethod Action method name
Map<String,Object>	args Free space to store your request specific data
InputStream	body Body stream
String	contentType Request content-type
String	controller Controller to invoke
Class<? extends Controller>	controllerClass The invoked controller class
Controller	controllerInstance The instance of invoked controller in case it uses non-static action methods.
Map<String,Http.Cookie>	cookies HTTP Cookies
static ThreadLocal<Http.Request>	current Bind to thread
Date	date When the request has been received
String	domain Server domain
String	encoding This is the encoding used to decode this request.
String	format Format (html,xml,json,text)
Map<String,Http.Header>	headers HTTP Headers
String	host Server host
Method	invokedMethod The really invoker Java method
boolean	isLoopback Request comes from loopback interface
boolean	isNew New request or already submitted
String	method HTTP method
Scope.Params	params Params
String	password HTTP Basic Password
String	path Request path
Integer	port HTTP port
String	querystring QueryString
String	remoteAddress Client address
Map<String,String>	routeArgs Additional HTTP params extracted from route
Boolean	secure is HTTPS ?
String	url URL path (excluding scheme, host and port), starting with '/' Example: With this full URL http://localhost:9000/path0/path1 => url will be /path0/path1
String	user HTTP Basic User

Constructor Summary

Constructors

Constructor and Description
Request() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	_init() Deprecated.
List<String>	acceptLanguage() Return the languages requested by the browser, ordered by preference (preferred first).
protected void	authorizationInit()
static Http.Request	createRequest(String _remoteAddress, String _method, String _path, String _querystring, String _contentType, InputStream _body, String _url, String _host, boolean _isLoopback, int _port, String _domain, boolean _secure, Map<String,Http.Header> _headers, Map<String,Http.Cookie> _cookies) All creation / initiating of new requests should use this method.
static Http.Request	current() Retrieve the current request
Http.Request	get() Useful because we sometime use a lazy request loader
String	getBase() Get the request base (ex: http://localhost:9000
boolean	isAjax() This request was sent by an Ajax framework.
boolean	isModified(String etag, long last)
protected void	parseXForwarded()
void	resolveFormat() Automatically resolve request format from the Accept header (in this order : html > xml > json > text)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

host

public String host

Server host

path

public String path

Request path

querystring

public String querystring

QueryString

url

public String url

URL path (excluding scheme, host and port), starting with '/'
Example:
With this full URL http://localhost:9000/path0/path1
=> url will be /path0/path1

method

public String method

HTTP method

domain

public String domain

Server domain

remoteAddress

public String remoteAddress

Client address

contentType

public String contentType

Request content-type

encoding

public String encoding

This is the encoding used to decode this request. If encoding-info is not found in request, then Play.defaultWebEncoding is used

controller

public String controller

Controller to invoke

actionMethod

public String actionMethod

Action method name

port

public Integer port

HTTP port

secure

public Boolean secure

is HTTPS ?

headers

public Map<String,Http.Header> headers

HTTP Headers

cookies

public Map<String,Http.Cookie> cookies

HTTP Cookies

body

public transient InputStream body

Body stream

routeArgs

public Map<String,String> routeArgs

Additional HTTP params extracted from route

format

public String format

Format (html,xml,json,text)

action

public String action

Full action (ex: Application.index)

current

public static final ThreadLocal<Http.Request> current

Bind to thread

invokedMethod

public transient Method invokedMethod

The really invoker Java method

controllerClass

public transient Class<? extends Controller> controllerClass

The invoked controller class

controllerInstance

public transient Controller controllerInstance

The instance of invoked controller in case it uses non-static action methods.

args

public Map<String,Object> args

Free space to store your request specific data

date

public Date date

When the request has been received

isNew

public boolean isNew

New request or already submitted

user

public String user

HTTP Basic User

password

public String password

HTTP Basic Password

isLoopback

public boolean isLoopback

Request comes from loopback interface

params

public final Scope.Params params

Params

Constructor Detail

Request

@Deprecated
public Request()

Deprecated.

Deprecate the default constructor to encourage the use of createRequest() when creating new requests. Cannot hide it with protected because we have to be backward compatible with modules - ie PlayGrizzlyAdapter.java

Method Detail

createRequest

public static Http.Request createRequest(String _remoteAddress,
                                         String _method,
                                         String _path,
                                         String _querystring,
                                         String _contentType,
                                         InputStream _body,
                                         String _url,
                                         String _host,
                                         boolean _isLoopback,
                                         int _port,
                                         String _domain,
                                         boolean _secure,
                                         Map<String,Http.Header> _headers,
                                         Map<String,Http.Cookie> _cookies)

All creation / initiating of new requests should use this method. The purpose of this is to "show" what is needed when creating new Requests.

Returns:

the newly created Request object

parseXForwarded

protected void parseXForwarded()

_init

@Deprecated
public void _init()

Deprecated.

Deprecated to encourage users to use createRequest() instead.

authorizationInit

protected void authorizationInit()

resolveFormat

public void resolveFormat()

Automatically resolve request format from the Accept header (in this order : html > xml > json > text)

current

public static Http.Request current()

Retrieve the current request

Returns:

the current request

get

public Http.Request get()

Useful because we sometime use a lazy request loader

Returns:

itself

isAjax

public boolean isAjax()

This request was sent by an Ajax framework. (rely on the X-Requested-With header).

getBase

public String getBase()

Get the request base (ex: http://localhost:9000

Returns:

the request base of the url (protocol, host and port)

toString

public String toString()

Overrides:

toString in class Object

acceptLanguage

public List<String> acceptLanguage()

Return the languages requested by the browser, ordered by preference (preferred first). If no Accept-Language header is present, an empty list is returned.

Returns:

Language codes in order of preference, e.g. "en-us,en-gb,en,de".

isModified

public boolean isModified(String etag,
                          long last)