play.mvc

Class Controller

java.lang.Object

play.mvc.Results

play.mvc.Controller

All Implemented Interfaces:

Http.HeaderNames, Http.Status

public abstract class Controller
extends Results
implements Http.Status, Http.HeaderNames

Superclass for a Java-based controller.

Field Summary

Fields inherited from interface play.mvc.Http.Status

ACCEPTED, BAD_GATEWAY, BAD_REQUEST, CONFLICT, CONTINUE, CREATED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_A_TEAPOT, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, LENGTH_REQUIRED, LOCKED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MULTI_STATUS, MULTIPLE_CHOICES, NETWORK_AUTHENTICATION_REQUIRED, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, OK, PARTIAL_CONTENT, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROXY_AUTHENTICATION_REQUIRED, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, REQUESTED_RANGE_NOT_SATISFIABLE, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_MANY_REQUESTS, UNAUTHORIZED, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, USE_PROXY

Fields inherited from interface play.mvc.Http.HeaderNames

ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_RANGES, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, AGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_SECURITY_POLICY, CONTENT_SECURITY_POLICY_REPORT_ONLY, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, FORWARDED, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LINK, LOCATION, MAX_FORWARDS, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, REFERRER_POLICY, RETRY_AFTER, SERVER, SET_COOKIE, SET_COOKIE2, STRICT_TRANSPORT_SECURITY, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, WARNING, WWW_AUTHENTICATE, X_CONTENT_SECURITY_POLICY_NONCE_HEADER, X_CONTENT_TYPE_OPTIONS, X_FORWARDED_FOR, X_FORWARDED_HOST, X_FORWARDED_PORT, X_FORWARDED_PROTO, X_FRAME_OPTIONS, X_PERMITTED_CROSS_DOMAIN_POLICIES, X_REQUESTED_WITH, X_XSS_PROTECTION

Constructor Summary

Constructors

Constructor and Description
Controller()

Method Summary

Modifier and Type	Method and Description
static boolean	changeLang(Lang lang) Deprecated. Deprecated as of 2.7.0. Use MessagesApi.setLang(Result, Lang) or Result.withLang(Lang, MessagesApi).
static boolean	changeLang(java.lang.String code) Deprecated. Deprecated as of 2.7.0. Use MessagesApi.setLang(Result, Lang) or Result.withLang(Lang, MessagesApi).
static void	clearLang() Deprecated. Deprecated as of 2.7.0. Use MessagesApi.clearLang(Result) or Result.withoutLang(MessagesApi).
static Http.Context	ctx() Deprecated. Deprecated as of 2.7.0. See migration guide..
static Http.Flash	flash() Deprecated. Deprecated as of 2.7.0. Use Http.RequestHeader.flash() and Result instead.
static java.lang.String	flash(java.lang.String key) Deprecated. Deprecated as of 2.7.0. Use Result instead.
static void	flash(java.lang.String key, java.lang.String value) Deprecated. Deprecated as of 2.7.0. Use Result instead.
static Lang	lang() Deprecated. Deprecated as of 2.7.0. See migration guide..
static Http.Request	request() Deprecated. Deprecated as of 2.7.0. See migration guide..
static Http.Response	response() Deprecated. Deprecated as of 2.7.0. Use Result instead.
static Http.Session	session() Deprecated. Deprecated as of 2.7.0. Use Http.RequestHeader.session() and Result instead.
static java.lang.String	session(java.lang.String key) Deprecated. Deprecated as of 2.7.0. Use Result instead.
static void	session(java.lang.String key, java.lang.String value) Deprecated. Deprecated as of 2.7.0. Use Result instead.
static Result	TODO() Deprecated. Deprecated as of 2.7.0. Use #TODO(Request) instead.
static Result	TODO(Http.Request request) Generates a 501 NOT_IMPLEMENTED simple result.

Methods inherited from class play.mvc.Results

badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, contentDispositionHeader, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, found, found, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, movedPermanently, movedPermanently, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, noContent, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, permanentRedirect, permanentRedirect, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, redirect, redirect, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, seeOther, seeOther, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, temporaryRedirect, temporaryRedirect, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType

Methods inherited from class java.lang.Object

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

Constructor Detail

Controller

public Controller()

Method Detail

TODO

@Deprecated
public static Result TODO()

Deprecated. Deprecated as of 2.7.0. Use #TODO(Request) instead.

Generates a 501 NOT_IMPLEMENTED simple result.

TODO

public static Result TODO(Http.Request request)

Generates a 501 NOT_IMPLEMENTED simple result.

ctx

@Deprecated
public static Http.Context ctx()

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

Returns the current HTTP context.

Returns:

the context

request

@Deprecated
public static Http.Request request()

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

Returns the current HTTP request.

Returns:

the request

lang

@Deprecated
public static Lang lang()

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

Returns the current lang.

Returns:

the language

changeLang

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

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

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 static boolean changeLang(Lang lang)

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

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 static void clearLang()

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

Clear the lang for the current user.

response

@Deprecated
public static Http.Response response()

Deprecated. Deprecated as of 2.7.0. Use Result instead.

Returns the current HTTP response.

Returns:

the response

session

@Deprecated
public static Http.Session session()

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

Returns the current HTTP session.

Returns:

the session

session

@Deprecated
public static void session(java.lang.String key,
                                       java.lang.String value)

Deprecated. Deprecated as of 2.7.0. Use Result instead.

Puts a new value into the current session.

Parameters:

key - the key to set into the session

value - the value to set for key

session

@Deprecated
public static java.lang.String session(java.lang.String key)

Deprecated. Deprecated as of 2.7.0. Use Result instead.

Returns a value from the session.

Parameters:

key - the session key

Returns:

the value for the provided key, or null if there was no value

flash

@Deprecated
public static Http.Flash flash()

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

Returns the current HTTP flash scope.

Returns:

the flash scope

flash

@Deprecated
public static void flash(java.lang.String key,
                                     java.lang.String value)

Deprecated. Deprecated as of 2.7.0. Use Result instead.

Puts a new value into the flash scope.

Parameters:

key - the key to put into the flash scope

value - the value corresponding to key

flash

@Deprecated
public static java.lang.String flash(java.lang.String key)

Deprecated. Deprecated as of 2.7.0. Use Result instead.

Returns a value from the flash scope.

Parameters:

key - the key to look up in the flash scope

Returns:

the value corresponding to key from the flash scope, or null if there was none