Controller (playframework)

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.

Nested Class Summary
- Nested classes/interfaces inherited from class play.mvc.Results
  Results.AsyncResult, Results.ByteChunks, Results.Chunks<A>, Results.Redirect, Results.Status, Results.StringChunks, Results.Todo

Field Summary
- Fields inherited from class play.mvc.Results
  TODO
- Fields inherited from interface play.mvc.Http.Status
  ACCEPTED, BAD_GATEWAY, BAD_REQUEST, CONFLICT, CONTINUE, CREATED, EXPECTATION_FAILED, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, INTERNAL_SERVER_ERROR, LENGTH_REQUIRED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MULTIPLE_CHOICES, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, OK, PARTIAL_CONTENT, PAYMENT_REQUIRED, PRECONDITION_FAILED, PROXY_AUTHENTICATION_REQUIRED, REQUEST_ENTITY_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, REQUESTED_RANGE_NOT_SATISFIABLE, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, UNAUTHORIZED, UNSUPPORTED_MEDIA_TYPE, 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_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LOCATION, MAX_FORWARDS, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, RETRY_AFTER, SERVER, SET_COOKIE, SET_COOKIE2, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

Constructors
Constructor and Description

Controller()

Constructors
Constructor and Description
`Controller()`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`changeLang(java.lang.String code)` Change durably the lang for the current user
`static void`	`clearLang()` Clear the lang for the current user.
`static Http.Context`	`ctx()` Returns the current HTTP context.
`static Http.Flash`	`flash()` Returns the current HTTP flash scope.
`static java.lang.String`	`flash(java.lang.String key)` Returns a value from the flash scope.
`static void`	`flash(java.lang.String key, java.lang.String value)` Puts a new value into the flash scope.
`static Lang`	`lang()` Returns the current lang.
`static Http.Request`	`request()` Returns the current HTTP request.
`static Http.Response`	`response()` Returns the current HTTP response.
`static Http.Session`	`session()` Returns the current HTTP session.
`static java.lang.String`	`session(java.lang.String key)` Returns a value from the session.
`static void`	`session(java.lang.String key, java.lang.String value)` Puts a new value into the current session.

Methods inherited from class play.mvc.Results
async, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, 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, found, found, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, movedPermanently, movedPermanently, noContent, 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, redirect, redirect, seeOther, seeOther, status, status, status, status, status, status, status, status, status, status, status, status, status, temporaryRedirect, temporaryRedirect, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized

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
  - ctx
```
public static Http.Context ctx()
```
    Returns the current HTTP context.
  - request
```
public static Http.Request request()
```
    Returns the current HTTP request.
  - lang
```
public static Lang lang()
```
    Returns the current lang.
  - changeLang
```
public static 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.
  - clearLang
```
public static void clearLang()
```
    Clear the lang for the current user.
  - response
```
public static Http.Response response()
```
    Returns the current HTTP response.
  - session
```
public static Http.Session session()
```
    Returns the current HTTP session.
  - session
```
public static void session(java.lang.String key,
           java.lang.String value)
```
    Puts a new value into the current session.
  - session
```
public static java.lang.String session(java.lang.String key)
```
    Returns a value from the session.
  - flash
```
public static Http.Flash flash()
```
    Returns the current HTTP flash scope.
  - flash
```
public static void flash(java.lang.String key,
         java.lang.String value)
```
    Puts a new value into the flash scope.
  - flash
```
public static java.lang.String flash(java.lang.String key)
```
    Returns a value from the flash scope.

Class Controller

Nested Class Summary

Nested classes/interfaces inherited from class play.mvc.Results

Field Summary

Fields inherited from class play.mvc.Results

Fields inherited from interface play.mvc.Http.Status

Fields inherited from interface play.mvc.Http.HeaderNames

Constructor Summary

Method Summary

Methods inherited from class play.mvc.Results

Methods inherited from class java.lang.Object

Constructor Detail

Controller

Method Detail

ctx

request

lang

changeLang

clearLang

response

session

session

session

flash

flash

flash