play.mvc

Class Http.Context

java.lang.Object

play.mvc.Http.Context

Direct Known Subclasses:

Http.WrappedContext

Enclosing class:

Http

Deprecated.

Deprecated as of 2.7.0. See migration guide.

@Deprecated
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 Deprecated. Deprecated as of 2.7.0. Use Result instead.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.lang.Object>	args Deprecated. Deprecated as of 2.7.0. Use request attributes instead.
static java.lang.ThreadLocal<Http.Context>	current Deprecated. Deprecated as of 2.7.0. Use a request instead.

Constructor Summary

Constructors

Constructor and Description
Context(Http.RequestBuilder requestBuilder, play.core.j.JavaContextComponents components) Deprecated. Creates a new HTTP context.
Context(Http.Request request, play.core.j.JavaContextComponents components) Deprecated. 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, play.core.j.JavaContextComponents components) Deprecated. Use #Context(Long, play.api.mvc.RequestHeader, Request, Response, Session, Flash, Map, Lang, JavaContextComponents) instead. Since 2.7.0.
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, Lang lang, play.core.j.JavaContextComponents components) Deprecated. 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, play.core.j.JavaContextComponents components) Deprecated. Creates a new HTTP context.
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, Lang lang, play.core.j.JavaContextComponents components) Deprecated. Creates a new HTTP context.

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) Deprecated. Deprecated as of 2.7.0. Use MessagesApi.setLang(Result, Lang).
boolean	changeLang(java.lang.String code) Deprecated. Deprecated as of 2.7.0. Use MessagesApi.setLang(Result, Lang).
static void	clear() Deprecated. Deprecated as of 2.7.0. Use a request instead.
void	clearLang() Deprecated. Deprecated as of 2.7.0. Use MessagesApi.clearLang(Result).
void	clearTransientLang() Deprecated. Deprecated as of 2.7.0. See migration guide..
static Http.Context	current() Deprecated. Deprecated as of 2.7.0. Use a request instead.
FileMimeTypes	fileMimeTypes() Deprecated. Deprecated as of 2.7.0. Inject FileMimeTypes instead.
Http.Flash	flash() Deprecated. Deprecated as of 2.7.0. Use Http.RequestHeader.flash() and Result instead.
java.lang.Long	id() Deprecated. Deprecated as of 2.7.0 Use Http.RequestHeader.id() instead.
Lang	lang() Deprecated. Deprecated as of 2.7.0. See migration guide..
Messages	messages() Deprecated. Deprecated as of 2.7.0. See migration guide..
Http.Request	request() Deprecated. Deprecated as of 2.7.0. See migration guide..
Http.Response	response() Deprecated. Deprecated as of 2.7.0. Use Result instead.
static java.util.Optional<Http.Context>	safeCurrent() Deprecated. Deprecated as of 2.7.0. Use a request instead.
Http.Session	session() Deprecated. Deprecated as of 2.7.0. Use Http.RequestHeader.session() and Result instead.
static void	setCurrent(Http.Context ctx) Deprecated. Deprecated as of 2.7.0. Use a request instead.
void	setTransientLang(Lang lang) Deprecated. Deprecated as of 2.7.0. See migration guide..
void	setTransientLang(java.lang.String code) Deprecated. Deprecated as of 2.7.0. See migration guide..
java.lang.String	toString() Deprecated.
Http.Context	withRequest(Http.Request request) Deprecated. Deprecated as of 2.7.0. See migration guide..

Methods inherited from class java.lang.Object

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

Field Detail

current

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

Deprecated. Deprecated as of 2.7.0. Use a request instead.

args

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

Deprecated. Deprecated as of 2.7.0. Use request attributes instead.

Free space to store your request specific data.

Constructor Detail

Context

public Context(Http.RequestBuilder requestBuilder,
               play.core.j.JavaContextComponents components)

Deprecated.

Creates a new HTTP context.

Parameters:

requestBuilder - the HTTP request builder.

components - the context components.

Context

public Context(Http.Request request,
               play.core.j.JavaContextComponents components)

Deprecated.

Creates a new HTTP context.

Parameters:

request - the HTTP request

components - the context components.

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,
               play.core.j.JavaContextComponents components)

Deprecated.

Creates a new HTTP context.

Parameters:

id - the unique context ID

header - the request header (Not used anymore. You could simply pass null, it doesn't matter)

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.

components - the context components.

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,
               Lang lang,
               play.core.j.JavaContextComponents components)

Deprecated.

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.

lang - the transient lang to use.

components - the context components.

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,
               play.core.j.JavaContextComponents components)

Deprecated. Use #Context(Long, play.api.mvc.RequestHeader, Request, Response, Session, Flash, Map, Lang, JavaContextComponents) instead. Since 2.7.0.

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.

components - the context components.

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,
               Lang lang,
               play.core.j.JavaContextComponents components)

Deprecated.

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 (Not used anymore. You could simply pass null, it doesn't matter)

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.

lang - the transient lang to use.

components - the context components.

Method Detail

current

@Deprecated
public static Http.Context current()

Deprecated. Deprecated as of 2.7.0. Use a request instead.

Retrieves the current HTTP context, for the current thread.

Returns:

the context

safeCurrent

@Deprecated
public static java.util.Optional<Http.Context> safeCurrent()

Deprecated. Deprecated as of 2.7.0. Use a request instead.

Safely retrieves the current HTTP context, for the current thread.

Returns:

the context or empty if null

setCurrent

@Deprecated
public static void setCurrent(Http.Context ctx)

Deprecated. Deprecated as of 2.7.0. Use a request instead.

Safely sets the current HTTP context, for the current thread. Does nothing is the context thread local is disabled.

clear

@Deprecated
public static void clear()

Deprecated. Deprecated as of 2.7.0. Use a request instead.

Safely removes the current HTTP context, for the current thread. Does nothing is the context thread local is disabled.

id

@Deprecated
public java.lang.Long id()

Deprecated. Deprecated as of 2.7.0 Use Http.RequestHeader.id() instead.

The context id (unique)

Returns:

the id

request

@Deprecated
public Http.Request request()

Deprecated. Deprecated as of 2.7.0. See migration guide..

Returns the current request.

Returns:

the request

response

@Deprecated
public Http.Response response()

Deprecated. Deprecated as of 2.7.0. Use Result instead.

Returns the current response.

Returns:

the response

session

@Deprecated
public Http.Session session()

Deprecated. Deprecated as of 2.7.0. Use Http.RequestHeader.session() and Result instead.

Returns the current session.

Returns:

the session

flash

@Deprecated
public Http.Flash flash()

Deprecated. Deprecated as of 2.7.0. Use Http.RequestHeader.flash() and Result instead.

Returns the current flash scope.

Returns:

the flash scope

_requestHeader

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

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

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

Returns:

the original request header.

lang

@Deprecated
public Lang lang()

Deprecated. Deprecated as of 2.7.0. See migration guide..

The current lang

Returns:

the current lang

messages

@Deprecated
public Messages messages()

Deprecated. Deprecated as of 2.7.0. See migration guide..

Returns:

the messages for the current lang

changeLang

@Deprecated
public boolean changeLang(java.lang.String code)

Deprecated. Deprecated as of 2.7.0. Use MessagesApi.setLang(Result, Lang).

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

@Deprecated
public boolean changeLang(Lang lang)

Deprecated. Deprecated as of 2.7.0. Use MessagesApi.setLang(Result, 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

@Deprecated
public void clearLang()

Deprecated. Deprecated as of 2.7.0. Use MessagesApi.clearLang(Result).

Clear the lang for the current user.

setTransientLang

@Deprecated
public void setTransientLang(java.lang.String code)

Deprecated. Deprecated as of 2.7.0. See migration guide..

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

@Deprecated
public void setTransientLang(Lang lang)

Deprecated. Deprecated as of 2.7.0. See migration guide..

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

@Deprecated
public void clearTransientLang()

Deprecated. Deprecated as of 2.7.0. See migration guide..

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.

fileMimeTypes

@Deprecated
public FileMimeTypes fileMimeTypes()

Deprecated. Deprecated as of 2.7.0. Inject FileMimeTypes instead.

toString

public java.lang.String toString()

Deprecated.

Overrides:

toString in class java.lang.Object

Returns:

a String representation

withRequest

@Deprecated
public Http.Context withRequest(Http.Request request)

Deprecated. Deprecated as of 2.7.0. See migration guide..

Create a new context with the given request.

The id, 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.