play.api.mvc

Controller

trait Controller extends Results with BodyParsers with HttpProtocol with Status with HeaderNames with ContentTypes with RequestExtractors with Rendering

Defines utility methods to generate Action and Results types.

For example:

object Application extends Controller {

def hello(name:String) = Action { request =>
  Ok("Hello " + name)
}

}
Source
Controller.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Controller
  2. Rendering
  3. RequestExtractors
  4. AcceptExtractors
  5. ContentTypes
  6. HeaderNames
  7. Status
  8. HttpProtocol
  9. BodyParsers
  10. Results
  11. AnyRef
  12. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class Status extends Result

    Generates default Result from a content type, headers and content.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. object &

    Convenient extractor allowing to apply two extractors.

  5. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  6. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  7. val ACCEPT: String

    Definition Classes
    HeaderNames
  8. val ACCEPTED: Int

    Definition Classes
    Status
  9. val ACCEPT_CHARSET: String

    Definition Classes
    HeaderNames
  10. val ACCEPT_ENCODING: String

    Definition Classes
    HeaderNames
  11. val ACCEPT_LANGUAGE: String

    Definition Classes
    HeaderNames
  12. val ACCEPT_RANGES: String

    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String

    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_ALLOW_HEADERS: String

    Definition Classes
    HeaderNames
  15. val ACCESS_CONTROL_ALLOW_METHODS: String

    Definition Classes
    HeaderNames
  16. val ACCESS_CONTROL_ALLOW_ORIGIN: String

    Definition Classes
    HeaderNames
  17. val ACCESS_CONTROL_EXPOSE_HEADERS: String

    Definition Classes
    HeaderNames
  18. val ACCESS_CONTROL_MAX_AGE: String

    Definition Classes
    HeaderNames
  19. val ACCESS_CONTROL_REQUEST_HEADERS: String

    Definition Classes
    HeaderNames
  20. val ACCESS_CONTROL_REQUEST_METHOD: String

    Definition Classes
    HeaderNames
  21. val AGE: String

    Definition Classes
    HeaderNames
  22. val ALLOW: String

    Definition Classes
    HeaderNames
  23. val AUTHORIZATION: String

    Definition Classes
    HeaderNames
  24. val Accepted: Status

    Generates a ‘202 ACCEPTED’ result.

    Generates a ‘202 ACCEPTED’ result.

    Definition Classes
    Results
  25. object Accepts

    Common extractors to check if a request accepts JSON, Html, etc.

  26. val BAD_GATEWAY: Int

    Definition Classes
    Status
  27. val BAD_REQUEST: Int

    Definition Classes
    Status
  28. val BINARY: String

    Content-Type of binary data.

    Content-Type of binary data.

    Definition Classes
    ContentTypes
  29. val BadGateway: Status

    Generates a ‘502 BAD_GATEWAY’ result.

    Generates a ‘502 BAD_GATEWAY’ result.

    Definition Classes
    Results
  30. val BadRequest: Status

    Generates a ‘400 BAD_REQUEST’ result.

    Generates a ‘400 BAD_REQUEST’ result.

    Definition Classes
    Results
  31. val CACHE_CONTROL: String

    Definition Classes
    HeaderNames
  32. val CACHE_MANIFEST: String

    Content-Type of application cache.

    Content-Type of application cache.

    Definition Classes
    ContentTypes
  33. val CHUNKED: String

    Definition Classes
    HttpProtocol
  34. val CONFLICT: Int

    Definition Classes
    Status
  35. val CONNECTION: String

    Definition Classes
    HeaderNames
  36. val CONTENT_DISPOSITION: String

    Definition Classes
    HeaderNames
  37. val CONTENT_ENCODING: String

    Definition Classes
    HeaderNames
  38. val CONTENT_LANGUAGE: String

    Definition Classes
    HeaderNames
  39. val CONTENT_LENGTH: String

    Definition Classes
    HeaderNames
  40. val CONTENT_LOCATION: String

    Definition Classes
    HeaderNames
  41. val CONTENT_MD5: String

    Definition Classes
    HeaderNames
  42. val CONTENT_RANGE: String

    Definition Classes
    HeaderNames
  43. val CONTENT_TRANSFER_ENCODING: String

    Definition Classes
    HeaderNames
  44. val CONTENT_TYPE: String

    Definition Classes
    HeaderNames
  45. val CONTINUE: Int

    Definition Classes
    Status
  46. val COOKIE: String

    Definition Classes
    HeaderNames
  47. val CREATED: Int

    Definition Classes
    Status
  48. def CSS(implicit codec: Codec): String

    Content-Type of css.

    Content-Type of css.

    Definition Classes
    ContentTypes
  49. val Conflict: Status

    Generates a ‘409 CONFLICT’ result.

    Generates a ‘409 CONFLICT’ result.

    Definition Classes
    Results
  50. val Created: Status

    Generates a ‘201 CREATED’ result.

    Generates a ‘201 CREATED’ result.

    Definition Classes
    Results
  51. val DATE: String

    Definition Classes
    HeaderNames
  52. val ETAG: String

    Definition Classes
    HeaderNames
  53. def EVENT_STREAM(implicit codec: Codec): String

    Content-Type of server sent events.

    Content-Type of server sent events.

    Definition Classes
    ContentTypes
  54. val EXPECT: String

    Definition Classes
    HeaderNames
  55. val EXPECTATION_FAILED: Int

    Definition Classes
    Status
  56. val EXPIRES: String

    Definition Classes
    HeaderNames
  57. val EntityTooLarge: Status

    Generates a ‘413 REQUEST_ENTITY_TOO_LARGE’ result.

    Generates a ‘413 REQUEST_ENTITY_TOO_LARGE’ result.

    Definition Classes
    Results
  58. val ExpectationFailed: Status

    Generates a ‘417 EXPECTATION_FAILED’ result.

    Generates a ‘417 EXPECTATION_FAILED’ result.

    Definition Classes
    Results
  59. val FAILED_DEPENDENCY: Int

    Definition Classes
    Status
  60. val FORBIDDEN: Int

    Definition Classes
    Status
  61. def FORM(implicit codec: Codec): String

    Content-Type of form-urlencoded.

    Content-Type of form-urlencoded.

    Definition Classes
    ContentTypes
  62. val FOUND: Int

    Definition Classes
    Status
  63. val FROM: String

    Definition Classes
    HeaderNames
  64. val FailedDependency: Status

    Generates a ‘424 FAILED_DEPENDENCY’ result.

    Generates a ‘424 FAILED_DEPENDENCY’ result.

    Definition Classes
    Results
  65. val Forbidden: Status

    Generates a ‘403 FORBIDDEN’ result.

    Generates a ‘403 FORBIDDEN’ result.

    Definition Classes
    Results
  66. def Found(url: String): Result

    Generates a ‘302 FOUND’ simple result.

    Generates a ‘302 FOUND’ simple result.

    url

    the URL to redirect to

    Definition Classes
    Results
  67. val GATEWAY_TIMEOUT: Int

    Definition Classes
    Status
  68. val GONE: Int

    Definition Classes
    Status
  69. val GatewayTimeout: Status

    Generates a ‘504 GATEWAY_TIMEOUT’ result.

    Generates a ‘504 GATEWAY_TIMEOUT’ result.

    Definition Classes
    Results
  70. val Gone: Status

    Generates a ‘410 GONE’ result.

    Generates a ‘410 GONE’ result.

    Definition Classes
    Results
  71. val HOST: String

    Definition Classes
    HeaderNames
  72. def HTML(implicit codec: Codec): String

    Content-Type of html.

    Content-Type of html.

    Definition Classes
    ContentTypes
  73. val HTTP_1_0: String

    Definition Classes
    HttpProtocol
  74. val HTTP_1_1: String

    Definition Classes
    HttpProtocol
  75. val HTTP_VERSION_NOT_SUPPORTED: Int

    Definition Classes
    Status
  76. val HttpVersionNotSupported: Status

    Generates a ‘505 HTTP_VERSION_NOT_SUPPORTED’ result.

    Generates a ‘505 HTTP_VERSION_NOT_SUPPORTED’ result.

    Definition Classes
    Results
  77. val IF_MATCH: String

    Definition Classes
    HeaderNames
  78. val IF_MODIFIED_SINCE: String

    Definition Classes
    HeaderNames
  79. val IF_NONE_MATCH: String

    Definition Classes
    HeaderNames
  80. val IF_RANGE: String

    Definition Classes
    HeaderNames
  81. val IF_UNMODIFIED_SINCE: String

    Definition Classes
    HeaderNames
  82. val INSUFFICIENT_STORAGE: Int

    Definition Classes
    Status
  83. val INTERNAL_SERVER_ERROR: Int

    Definition Classes
    Status
  84. val InsufficientStorage: Status

    Generates a ‘507 INSUFFICIENT_STORAGE’ result.

    Generates a ‘507 INSUFFICIENT_STORAGE’ result.

    Definition Classes
    Results
  85. val InternalServerError: Status

    Generates a ‘500 INTERNAL_SERVER_ERROR’ result.

    Generates a ‘500 INTERNAL_SERVER_ERROR’ result.

    Definition Classes
    Results
  86. def JAVASCRIPT(implicit codec: Codec): String

    Content-Type of javascript.

    Content-Type of javascript.

    Definition Classes
    ContentTypes
  87. def JSON(implicit codec: Codec): String

    Content-Type of json.

    Content-Type of json.

    Definition Classes
    ContentTypes
  88. val LAST_MODIFIED: String

    Definition Classes
    HeaderNames
  89. val LENGTH_REQUIRED: Int

    Definition Classes
    Status
  90. val LOCATION: String

    Definition Classes
    HeaderNames
  91. val LOCKED: Int

    Definition Classes
    Status
  92. val Locked: Status

    Generates a ‘423 LOCKED’ result.

    Generates a ‘423 LOCKED’ result.

    Definition Classes
    Results
  93. val MAX_FORWARDS: String

    Definition Classes
    HeaderNames
  94. val METHOD_NOT_ALLOWED: Int

    Definition Classes
    Status
  95. val MOVED_PERMANENTLY: Int

    Definition Classes
    Status
  96. val MULTIPLE_CHOICES: Int

    Definition Classes
    Status
  97. val MULTI_STATUS: Int

    Definition Classes
    Status
  98. val MethodNotAllowed: Status

    Generates a ‘405 METHOD_NOT_ALLOWED’ result.

    Generates a ‘405 METHOD_NOT_ALLOWED’ result.

    Definition Classes
    Results
  99. def MovedPermanently(url: String): Result

    Generates a ‘301 MOVED_PERMANENTLY’ simple result.

    Generates a ‘301 MOVED_PERMANENTLY’ simple result.

    url

    the URL to redirect to

    Definition Classes
    Results
  100. val MultiStatus: Status

    Generates a ‘207 MULTI_STATUS’ result.

    Generates a ‘207 MULTI_STATUS’ result.

    Definition Classes
    Results
  101. val NON_AUTHORITATIVE_INFORMATION: Int

    Definition Classes
    Status
  102. val NOT_ACCEPTABLE: Int

    Definition Classes
    Status
  103. val NOT_FOUND: Int

    Definition Classes
    Status
  104. val NOT_IMPLEMENTED: Int

    Definition Classes
    Status
  105. val NOT_MODIFIED: Int

    Definition Classes
    Status
  106. val NO_CONTENT: Int

    Definition Classes
    Status
  107. val NoContent: Result

    Generates a ‘204 NO_CONTENT’ result.

    Generates a ‘204 NO_CONTENT’ result.

    Definition Classes
    Results
  108. val NonAuthoritativeInformation: Status

    Generates a ‘203 NON_AUTHORITATIVE_INFORMATION’ result.

    Generates a ‘203 NON_AUTHORITATIVE_INFORMATION’ result.

    Definition Classes
    Results
  109. val NotAcceptable: Status

    Generates a ‘406 NOT_ACCEPTABLE’ result.

    Generates a ‘406 NOT_ACCEPTABLE’ result.

    Definition Classes
    Results
  110. val NotFound: Status

    Generates a ‘404 NOT_FOUND’ result.

    Generates a ‘404 NOT_FOUND’ result.

    Definition Classes
    Results
  111. val NotImplemented: Status

    Generates a ‘501 NOT_IMPLEMENTED’ result.

    Generates a ‘501 NOT_IMPLEMENTED’ result.

    Definition Classes
    Results
  112. val NotModified: Result

    Generates a ‘304 NOT_MODIFIED’ result.

    Generates a ‘304 NOT_MODIFIED’ result.

    Definition Classes
    Results
  113. val OK: Int

    Definition Classes
    Status
  114. val ORIGIN: String

    Definition Classes
    HeaderNames
  115. val Ok: Status

    Generates a ‘200 OK’ result.

    Generates a ‘200 OK’ result.

    Definition Classes
    Results
  116. val PARTIAL_CONTENT: Int

    Definition Classes
    Status
  117. val PAYMENT_REQUIRED: Int

    Definition Classes
    Status
  118. val PRAGMA: String

    Definition Classes
    HeaderNames
  119. val PRECONDITION_FAILED: Int

    Definition Classes
    Status
  120. val PROXY_AUTHENTICATE: String

    Definition Classes
    HeaderNames
  121. val PROXY_AUTHENTICATION_REQUIRED: Int

    Definition Classes
    Status
  122. val PROXY_AUTHORIZATION: String

    Definition Classes
    HeaderNames
  123. val PartialContent: Status

    Generates a ‘206 PARTIAL_CONTENT’ result.

    Generates a ‘206 PARTIAL_CONTENT’ result.

    Definition Classes
    Results
  124. val PreconditionFailed: Status

    Generates a ‘412 PRECONDITION_FAILED’ result.

    Generates a ‘412 PRECONDITION_FAILED’ result.

    Definition Classes
    Results
  125. val RANGE: String

    Definition Classes
    HeaderNames
  126. val REFERER: String

    Definition Classes
    HeaderNames
  127. val REQUESTED_RANGE_NOT_SATISFIABLE: Int

    Definition Classes
    Status
  128. val REQUEST_ENTITY_TOO_LARGE: Int

    Definition Classes
    Status
  129. val REQUEST_TIMEOUT: Int

    Definition Classes
    Status
  130. val REQUEST_URI_TOO_LONG: Int

    Definition Classes
    Status
  131. val RESET_CONTENT: Int

    Definition Classes
    Status
  132. val RETRY_AFTER: String

    Definition Classes
    HeaderNames
  133. def Redirect(call: Call): Result

    Generates a redirect simple result.

    Generates a redirect simple result.

    call

    Call defining the URL to redirect to, which typically comes from the reverse router

    Definition Classes
    Results
  134. def Redirect(url: String, queryString: Map[String, Seq[String]] = Map.empty, status: Int = SEE_OTHER): Result

    Generates a redirect simple result.

    Generates a redirect simple result.

    url

    the URL to redirect to

    queryString

    queryString parameters to add to the queryString

    status

    HTTP status

    Definition Classes
    Results
  135. def Redirect(url: String, status: Int): Result

    Generates a redirect simple result.

    Generates a redirect simple result.

    url

    the URL to redirect to

    status

    HTTP status

    Definition Classes
    Results
  136. val RequestTimeout: Status

    Generates a ‘408 REQUEST_TIMEOUT’ result.

    Generates a ‘408 REQUEST_TIMEOUT’ result.

    Definition Classes
    Results
  137. val ResetContent: Result

    Generates a ‘205 RESET_CONTENT’ result.

    Generates a ‘205 RESET_CONTENT’ result.

    Definition Classes
    Results
  138. val SEE_OTHER: Int

    Definition Classes
    Status
  139. val SERVER: String

    Definition Classes
    HeaderNames
  140. val SERVICE_UNAVAILABLE: Int

    Definition Classes
    Status
  141. val SET_COOKIE: String

    Definition Classes
    HeaderNames
  142. val SET_COOKIE2: String

    Definition Classes
    HeaderNames
  143. val SWITCHING_PROTOCOLS: Int

    Definition Classes
    Status
  144. def SeeOther(url: String): Result

    Generates a ‘303 SEE_OTHER’ simple result.

    Generates a ‘303 SEE_OTHER’ simple result.

    url

    the URL to redirect to

    Definition Classes
    Results
  145. val ServiceUnavailable: Status

    Generates a ‘503 SERVICE_UNAVAILABLE’ result.

    Generates a ‘503 SERVICE_UNAVAILABLE’ result.

    Definition Classes
    Results
  146. def Status(code: Int): Status

    Generates a simple result.

    Generates a simple result.

    code

    the status code

    Definition Classes
    Results
  147. val TE: String

    Definition Classes
    HeaderNames
  148. val TEMPORARY_REDIRECT: Int

    Definition Classes
    Status
  149. def TEXT(implicit codec: Codec): String

    Content-Type of text.

    Content-Type of text.

    Definition Classes
    ContentTypes
  150. val TODO: Action[AnyContent]

    Provides an empty Action implementation: the result is a standard ‘Not implemented yet’ result page.

    Provides an empty Action implementation: the result is a standard ‘Not implemented yet’ result page.

    For example:

    def index(name:String) = TODO
  151. val TOO_MANY_REQUEST: Int

    Definition Classes
    Status
  152. val TRAILER: String

    Definition Classes
    HeaderNames
  153. val TRANSFER_ENCODING: String

    Definition Classes
    HeaderNames
  154. def TemporaryRedirect(url: String): Result

    Generates a ‘307 TEMPORARY_REDIRECT’ simple result.

    Generates a ‘307 TEMPORARY_REDIRECT’ simple result.

    url

    the URL to redirect to

    Definition Classes
    Results
  155. val TooManyRequest: Status

    Generates a ‘429 TOO_MANY_REQUEST’ result.

    Generates a ‘429 TOO_MANY_REQUEST’ result.

    Definition Classes
    Results
  156. val UNAUTHORIZED: Int

    Definition Classes
    Status
  157. val UNPROCESSABLE_ENTITY: Int

    Definition Classes
    Status
  158. val UNSUPPORTED_MEDIA_TYPE: Int

    Definition Classes
    Status
  159. val UPGRADE: String

    Definition Classes
    HeaderNames
  160. val USER_AGENT: String

    Definition Classes
    HeaderNames
  161. val USE_PROXY: Int

    Definition Classes
    Status
  162. val Unauthorized: Status

    Generates a ‘401 UNAUTHORIZED’ result.

    Generates a ‘401 UNAUTHORIZED’ result.

    Definition Classes
    Results
  163. val UnprocessableEntity: Status

    Generates a ‘422 UNPROCESSABLE_ENTITY’ result.

    Generates a ‘422 UNPROCESSABLE_ENTITY’ result.

    Definition Classes
    Results
  164. val UnsupportedMediaType: Status

    Generates a ‘415 UNSUPPORTED_MEDIA_TYPE’ result.

    Generates a ‘415 UNSUPPORTED_MEDIA_TYPE’ result.

    Definition Classes
    Results
  165. val UriTooLong: Status

    Generates a ‘414 REQUEST_URI_TOO_LONG’ result.

    Generates a ‘414 REQUEST_URI_TOO_LONG’ result.

    Definition Classes
    Results
  166. val VARY: String

    Definition Classes
    HeaderNames
  167. val VIA: String

    Definition Classes
    HeaderNames
  168. val WARNING: String

    Definition Classes
    HeaderNames
  169. val WWW_AUTHENTICATE: String

    Definition Classes
    HeaderNames
  170. def XML(implicit codec: Codec): String

    Content-Type of xml.

    Content-Type of xml.

    Definition Classes
    ContentTypes
  171. val X_FORWARDED_FOR: String

    Definition Classes
    HeaderNames
  172. val X_FORWARDED_HOST: String

    Definition Classes
    HeaderNames
  173. val X_FORWARDED_PORT: String

    Definition Classes
    HeaderNames
  174. val X_FORWARDED_PROTO: String

    Definition Classes
    HeaderNames
  175. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  176. def chunk(trailers: Option[Iteratee[Array[Byte], Seq[(String, String)]]] = None): Enumeratee[Array[Byte], Array[Byte]]

    Implements HTTP chunked transfer encoding.

    Implements HTTP chunked transfer encoding.

    trailers

    An optional trailers iteratee. If supplied, this will be zipped with the output iteratee, so that it can calculate some trailing headers, which will be included with the last chunk.

    Definition Classes
    Results
  177. def chunk: Enumeratee[Array[Byte], Array[Byte]]

    Implements HTTP chunked transfer encoding.

    Implements HTTP chunked transfer encoding.

    Definition Classes
    Results
  178. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  179. def dechunk: Enumeratee[Array[Byte], Array[Byte]]

    Dechunks a chunked transfer encoding stream.

    Dechunks a chunked transfer encoding stream.

    Chunks may span multiple elements in the stream.

    Definition Classes
    Results
  180. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  181. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  182. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  183. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  184. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  185. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  186. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  187. final def notify(): Unit

    Definition Classes
    AnyRef
  188. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  189. object parse

    Default body parsers.

  190. object render

    Definition Classes
    Rendering
  191. implicit def request2flash(implicit request: RequestHeader): Flash

    Retrieve the flash scope implicitly from the request.

    Retrieve the flash scope implicitly from the request.

    For example:

    def index(name:String) = Action { implicit request =>
    val message = flash("message")
    Ok("Got " + message)
    }
  192. implicit def request2lang(implicit request: RequestHeader): Lang

  193. implicit def request2session(implicit request: RequestHeader): Session

    Retrieves the session implicitly from the request.

    Retrieves the session implicitly from the request.

    For example:

    def index(name:String) = Action { implicit request =>
    val username = session("username")
    Ok("Hello " + username)
    }
  194. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  195. def toString(): String

    Definition Classes
    AnyRef → Any
  196. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  197. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  198. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  199. def withCharset(mimeType: String)(implicit codec: Codec): String

    returns

    the codec charset appended to mimeType

    Definition Classes
    ContentTypes

Inherited from Rendering

Inherited from RequestExtractors

Inherited from AcceptExtractors

Inherited from ContentTypes

Inherited from HeaderNames

Inherited from http.Status

Inherited from HttpProtocol

Inherited from BodyParsers

Inherited from Results

Inherited from AnyRef

Inherited from Any

Ungrouped