play.mvc

Class Http.WrappedContext

java.lang.Object

play.mvc.Http.Context

play.mvc.Http.WrappedContext

Enclosing class:

Http

public abstract static class Http.WrappedContext
extends Http.Context

A wrapped context. Use this to modify the context in some way.

Nested Class Summary

Nested classes/interfaces inherited from class play.mvc.Http.Context

Http.Context.Implicit

Field Summary

Fields inherited from class play.mvc.Http.Context

args, current

Constructor Summary

Constructors

Constructor and Description
WrappedContext(Http.Context wrapped)

Method Summary

Modifier and Type	Method and Description
play.api.mvc.RequestHeader	_requestHeader() Deprecated. Use request().asScala() instead. Since 2.7.0.
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.
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() Deprecated. Deprecated as of 2.7.0. Use Result instead.
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.

Methods inherited from class play.mvc.Http.Context

current, fileMimeTypes, toString, withRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

WrappedContext

public WrappedContext(Http.Context wrapped)

Parameters:

wrapped - the context the created instance will wrap

Method Detail

id

public java.lang.Long id()

Description copied from class: Http.Context

The context id (unique)

Overrides:

id in class Http.Context

Returns:

the id

request

public Http.Request request()

Description copied from class: Http.Context

Returns the current request.

Overrides:

request in class Http.Context

Returns:

the request

response

@Deprecated
public Http.Response response()

Deprecated. Deprecated as of 2.7.0. Use Result instead.

Description copied from class: Http.Context

Returns the current response.

Overrides:

response in class Http.Context

Returns:

the response

session

public Http.Session session()

Description copied from class: Http.Context

Returns the current session.

Overrides:

session in class Http.Context

Returns:

the session

flash

public Http.Flash flash()

Description copied from class: Http.Context

Returns the current flash scope.

Overrides:

flash in class Http.Context

Returns:

the flash scope

_requestHeader

@Deprecated
public play.api.mvc.RequestHeader _requestHeader()

Deprecated. Use request().asScala() instead. Since 2.7.0.

Description copied from class: Http.Context

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

Overrides:

_requestHeader in class Http.Context

Returns:

the original request header.

lang

public Lang lang()

Description copied from class: Http.Context

The current lang

Overrides:

lang in class Http.Context

Returns:

the current lang

changeLang

public boolean changeLang(java.lang.String code)

Description copied from class: Http.Context

Change durably the lang for the current user.

Overrides:

changeLang in class Http.Context

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)

Description copied from class: Http.Context

Change durably the lang for the current user.

Overrides:

changeLang in class Http.Context

Parameters:

lang - New Lang object to use

Returns:

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

clearLang

public void clearLang()

Description copied from class: Http.Context

Clear the lang for the current user.

Overrides:

clearLang in class Http.Context

setTransientLang

public void setTransientLang(java.lang.String code)

Description copied from class: Http.Context

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.

Overrides:

setTransientLang in class Http.Context

Parameters:

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

setTransientLang

public void setTransientLang(Lang lang)

Description copied from class: Http.Context

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.

Overrides:

setTransientLang in class Http.Context

Parameters:

lang - the language to set

clearTransientLang

public void clearTransientLang()

Description copied from class: Http.Context

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.

Overrides:

clearTransientLang in class Http.Context

messages

public Messages messages()

Overrides:

messages in class Http.Context

Returns:

the messages for the current lang