play.mvc

Class Http.Context

java.lang.Object

play.mvc.Http.Context

Direct Known Subclasses:

Http.WrappedContext

Enclosing class:

Http

public static class Http.Context
extends java.lang.Object

The global HTTP context.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Http.Context.Implicit Import in templates to get implicit HTTP context.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.lang.Object>	args Free space to store your request specific data.
static java.lang.ThreadLocal<Http.Context>	current

Constructor Summary

Constructors

Constructor and Description
Context(Http.Request request) Creates a new HTTP context.
Context(Http.RequestBuilder requestBuilder) Creates a new HTTP context.
Context(java.lang.Long id, play.api.mvc.RequestHeader header, Http.Request request, Http.Response response, Http.Session session, Http.Flash flash, java.util.Map<java.lang.String,java.lang.Object> args) Creates a new HTTP context, using the references provided.
Context(java.lang.Long id, play.api.mvc.RequestHeader header, Http.Request request, java.util.Map<java.lang.String,java.lang.String> sessionData, java.util.Map<java.lang.String,java.lang.String> flashData, java.util.Map<java.lang.String,java.lang.Object> args) Creates a new HTTP context.

Method Summary

Modifier and Type	Method and Description
play.api.mvc.RequestHeader	_requestHeader() The original Play request Header used to create this context.
boolean	changeLang(Lang lang) Change durably the lang for the current user.
boolean	changeLang(java.lang.String code) Change durably the lang for the current user.
void	clearLang() Clear the lang for the current user.
void	clearTransientLang() Clear the language for the current request, but don't change the language cookie.
static Http.Context	current() Retrieves the current HTTP context, for the current thread.
Http.Flash	flash() Returns the current flash scope.
java.lang.Long	id() The context id (unique)
Lang	lang() The current lang
Messages	messages()
Http.Request	request() Returns the current request.
Http.Response	response() Returns the current response.
Http.Session	session() Returns the current session.
void	setTransientLang(Lang lang) Set the language for the current request, but don't change the language cookie.
void	setTransientLang(java.lang.String code) Set the language for the current request, but don't change the language cookie.
java.lang.String	toString()
Http.Context	withRequest(Http.Request request) Create a new context with the given request.

Methods inherited from class java.lang.Object

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

Field Detail

current

public static java.lang.ThreadLocal<Http.Context> current

args

public java.util.Map<java.lang.String,java.lang.Object> args

Free space to store your request specific data.

Constructor Detail

Context

public Context(Http.RequestBuilder requestBuilder)

Creates a new HTTP context.

Parameters:

requestBuilder - the HTTP request builder

Context

public Context(Http.Request request)

Creates a new HTTP context.

Parameters:

request - the HTTP request

Context

public Context(java.lang.Long id,
               play.api.mvc.RequestHeader header,
               Http.Request request,
               java.util.Map<java.lang.String,java.lang.String> sessionData,
               java.util.Map<java.lang.String,java.lang.String> flashData,
               java.util.Map<java.lang.String,java.lang.Object> args)

Creates a new HTTP context.

Parameters:

id - the unique context ID

header - the request header

request - the request with body

sessionData - the session data extracted from the session cookie

flashData - the flash data extracted from the flash cookie

args - any arbitrary data to associate with this request context.

Context

public Context(java.lang.Long id,
               play.api.mvc.RequestHeader header,
               Http.Request request,
               Http.Response response,
               Http.Session session,
               Http.Flash flash,
               java.util.Map<java.lang.String,java.lang.Object> args)

Creates a new HTTP context, using the references provided. Use this constructor (or withRequest) to copy a context within a Java Action to be passed to a delegate.

Parameters:

id - the unique context ID

header - the request header

request - the request with body

response - the response instance to use

session - the session instance to use

flash - the flash instance to use

args - any arbitrary data to associate with this request context.

Method Detail

current

public static Http.Context current()

Retrieves the current HTTP context, for the current thread.

Returns:

the context

id

public java.lang.Long id()

The context id (unique)

Returns:

the id

request

public Http.Request request()

Returns the current request.

Returns:

the request

response

public Http.Response response()

Returns the current response.

Returns:

the response

session

public Http.Session session()

Returns the current session.

Returns:

the session

flash

public Http.Flash flash()

Returns the current flash scope.

Returns:

the flash scope

_requestHeader

public play.api.mvc.RequestHeader _requestHeader()

The original Play request Header used to create this context. For internal usage only.

Returns:

the original request header.

lang

public Lang lang()

The current lang

Returns:

the current lang

messages

public Messages messages()

Returns:

the messages for the current lang

changeLang

public boolean changeLang(java.lang.String code)

Change durably the lang for the current user.

Parameters:

code - New lang code to use (e.g. "fr", "en-US", etc.)

Returns:

true if the requested lang was supported by the application, otherwise false

changeLang

public boolean changeLang(Lang lang)

Change durably the lang for the current user.

Parameters:

lang - New Lang object to use

Returns:

true if the requested lang was supported by the application, otherwise false

clearLang

public void clearLang()

Clear the lang for the current user.

setTransientLang

public void setTransientLang(java.lang.String code)

Set the language for the current request, but don't change the language cookie. This means the language will be set for this request, but will not change for future requests.

Parameters:

code - the language code to set (e.g. "en-US")

Throws:

java.lang.IllegalArgumentException - If the given language is not supported by the application.

setTransientLang

public void setTransientLang(Lang lang)

Set the language for the current request, but don't change the language cookie. This means the language will be set for this request, but will not change for future requests.

Parameters:

lang - the language to set

Throws:

java.lang.IllegalArgumentException - If the given language is not supported by the application.

clearTransientLang

public void clearTransientLang()

Clear the language for the current request, but don't change the language cookie. This means the language will be cleared for this request (so a default will be used), but will not change for future requests.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a String representation

withRequest

public Http.Context withRequest(Http.Request request)

Create a new context with the given request. The id, Scala RequestHeader, session, flash and args remain unchanged. This method is intended for use within a Java action, to create a new Context to pass to a delegate action.

Parameters:

request - The request to create the new header from.

Returns:

The new context.