Packages

  • package root
    Definition Classes
    root
  • package play

    Play framework.

    Play framework.

    Play

    http://www.playframework.com

    Definition Classes
    root
  • package api

    Contains the public API for Scala developers.

    Contains the public API for Scala developers.

    Read configuration 
    val poolSize = configuration.getInt("engine.pool.size")
    Use the logger 
    Logger.info("Hello!")
    Define a Plugin 
    class MyPlugin(app: Application) extends Plugin
    Create adhoc applications (for testing) 
    val application = Application(new File("."), this.getClass.getClassloader, None, Play.Mode.DEV)
    Definition Classes
    play
  • package mvc

    Contains the Controller/Action/Result API to handle HTTP requests.

    Contains the Controller/Action/Result API to handle HTTP requests.

    For example, a typical controller:

    class HomeController @Inject() (val controllerComponents: ControllerComponents) extends BaseController {

  def index = Action {
    Ok("It works!")
  }

}
    Definition Classes
    api
  • object Security

    Helpers to create secure actions.

    Helpers to create secure actions.

    Definition Classes
    mvc
  • AuthenticatedBuilder
  • AuthenticatedRequest
c

play.api.mvc.Security

AuthenticatedRequest

class AuthenticatedRequest[+A, U] extends WrappedRequest[A]

An authenticated request

Source
Security.scala
Linear Supertypes
WrappedRequest[A], Request[A], RequestHeader, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AuthenticatedRequest
  2. WrappedRequest
  3. Request
  4. RequestHeader
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AuthenticatedRequest(user: U, request: Request[A])

    user

    The user that made the request

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val acceptLanguages: Seq[Lang]

    The Request Langs extracted from the Accept-Language header and sorted by preference (preferred first).

    The Request Langs extracted from the Accept-Language header and sorted by preference (preferred first).

    Definition Classes
    RequestHeader
  5. lazy val acceptedTypes: Seq[MediaRange]

    returns

    The media types list of the request’s Accept header, sorted by preference (preferred first).

    Definition Classes
    RequestHeader
  6. def accepts(mimeType: String): Boolean

    Check if this request accepts a given media type.

    Check if this request accepts a given media type.

    returns

    true if mimeType matches the Accept header, otherwise false

    Definition Classes
    RequestHeader
  7. def addAttr[B](key: TypedKey[B], value: B): Request[A]

    Create a new versions of this object with the given attribute attached to it.

    Create a new versions of this object with the given attribute attached to it.

    key

    The new attribute key.

    value

    The attribute value.

    returns

    The new version of this object with the new attribute.

    Definition Classes
    Request → RequestHeader
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asJava: mvc.Http.Request
    Definition Classes
    Request → RequestHeader
  10. def attrs: TypedMap

    A map of typed attributes associated with the request.

    A map of typed attributes associated with the request.

    Definition Classes
    WrappedRequest → RequestHeader
  11. def body: A

    The body content.

    The body content.

    Definition Classes
    WrappedRequest → Request
  12. lazy val charset: Option[String]

    Returns the charset of the request for text-based body

    Returns the charset of the request for text-based body

    Definition Classes
    RequestHeader
  13. final def clientCertificateChain: Option[Seq[X509Certificate]]

    The X509 certificate chain presented by a client during SSL requests.

    The X509 certificate chain presented by a client during SSL requests. This method is equivalent to connection.clientCertificateChain.

    Definition Classes
    RequestHeader
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  15. def connection: RemoteConnection

    The remote connection that made the request.

    The remote connection that made the request.

    Definition Classes
    WrappedRequest → RequestHeader
  16. lazy val contentType: Option[String]

    Returns the value of the Content-Type header (without the parameters (eg charset))

    Returns the value of the Content-Type header (without the parameters (eg charset))

    Definition Classes
    RequestHeader
  17. def cookies: Cookies

    The HTTP cookies.

    The HTTP cookies. The request's cookies are stored in an attribute indexed by play.api.mvc.request.RequestAttrKey.Cookies. The attribute uses a Cell to store the cookies, to allow them to be evaluated on-demand.

    Definition Classes
    RequestHeader
  18. lazy val domain: String

    The HTTP domain.

    The HTTP domain. The domain part of the request's host.

    Definition Classes
    RequestHeader
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  22. def flash: Flash

    Parses the Flash cookie and returns the Flash data.

    Parses the Flash cookie and returns the Flash data. The request's flash cookie is stored in an attribute indexed by play.api.mvc.request.RequestAttrKey.Flash. The attribute uses a play.api.mvc.request.Cell to store the flash, to allow it to be evaluated on-demand.

    Definition Classes
    RequestHeader
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def getQueryString(key: String): Option[String]

    Helper method to access a queryString parameter.

    Helper method to access a queryString parameter. This method delegates to connection.getQueryParameter(key).

    returns

    The query parameter's value if the parameter is present and there is only one value. If the parameter is absent or there is more than one value for that parameter then None is returned.

    Definition Classes
    RequestHeader
  25. def hasBody: Boolean

    True if this request has a body.

    True if this request has a body. This is either done by inspecting the request headers or the body itself to see if it is an entity representing an "empty" body.

    Definition Classes
    Request → RequestHeader
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def headers: Headers

    The HTTP headers.

    The HTTP headers.

    Definition Classes
    WrappedRequest → RequestHeader
  28. lazy val host: String

    The HTTP host (domain, optionally port).

    The HTTP host (domain, optionally port). This value is derived from the request target, if a hostname is present. If the target doesn't have a host then the Host header is used, if present. If that's not present then an empty string is returned.

    Definition Classes
    RequestHeader
  29. final def id: Long

    The request id.

    The request id. The request id is stored as an attribute indexed by play.api.mvc.request.RequestAttrKey.Id.

    Definition Classes
    RequestHeader
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def map[B](f: (A) => B): Request[B]

    Transform the request body.

    Transform the request body.

    Definition Classes
    Request
  32. lazy val mediaType: Option[MediaType]

    The media type of this request.

    The media type of this request. Same as contentType, except returns a fully parsed media type with parameters.

    Definition Classes
    RequestHeader
  33. def method: String

    The HTTP method.

    The HTTP method.

    Definition Classes
    WrappedRequest → RequestHeader
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def newWrapper[B](newRequest: Request[B]): AuthenticatedRequest[B, U]

    Create a copy of this wrapper, but wrapping a new request.

    Create a copy of this wrapper, but wrapping a new request. Subclasses can override this method.

    Attributes
    protected
    Definition Classes
    AuthenticatedRequest → WrappedRequest
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def path: String

    The URI path.

    The URI path. This method delegates to target.path.

    Definition Classes
    RequestHeader
  39. final def queryString: Map[String, Seq[String]]

    The parsed query string.

    The parsed query string. This method delegates to target.queryMap.

    Definition Classes
    RequestHeader
  40. def rawQueryString: String

    Returns the raw query string.

    Returns the raw query string. This method delegates to connection.rawQueryString.

    Definition Classes
    RequestHeader
  41. final def remoteAddress: String

    The client IP address.

    The client IP address.

    retrieves the last untrusted proxy from the Forwarded-Headers or the X-Forwarded-*-Headers.

    This method delegates to connection.remoteAddressString.

    Definition Classes
    RequestHeader
  42. def removeAttr(key: TypedKey[_]): Request[A]

    Create a new versions of this object with the given attribute removed.

    Create a new versions of this object with the given attribute removed.

    key

    The key of the attribute to remove.

    returns

    The new version of this object with the attribute removed.

    Definition Classes
    Request → RequestHeader
  43. final def secure: Boolean

    Is the client using SSL? This method delegates to connection.secure.

    Is the client using SSL? This method delegates to connection.secure.

    Definition Classes
    RequestHeader
  44. def session: Session

    Parses the Session cookie and returns the Session data.

    Parses the Session cookie and returns the Session data. The request's session cookie is stored in an attribute indexed by play.api.mvc.request.RequestAttrKey.Session. The attribute uses a play.api.mvc.request.Cell to store the session cookie, to allow it to be evaluated on-demand.

    Definition Classes
    RequestHeader
  45. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  46. def target: RequestTarget

    The target of the HTTP request, i.e.

    The target of the HTTP request, i.e. the URI or path that was given on the first line of the request.

    Definition Classes
    WrappedRequest → RequestHeader
  47. def toString(): String
    Definition Classes
    RequestHeader → AnyRef → Any
  48. def transientLang(): Option[Lang]

    The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred() (It will take precedence over any other language).

    The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred() (It will take precedence over any other language).

    returns

    The current transient language of this request.

    Definition Classes
    RequestHeader
  49. final def uri: String

    The complete request URI, containing both path and query string.

    The complete request URI, containing both path and query string. The URI is what was on the status line after the request method. E.g. in "GET /foo/bar?q=s HTTP/1.1" the URI should be /foo/bar?q=s. It could be absolute, some clients send absolute URLs, especially proxies, e.g. http://www.example.org/foo/bar?q=s.

    This method delegates to target.uriString.

    Definition Classes
    RequestHeader
  50. val user: U
  51. def version: String

    The HTTP version.

    The HTTP version.

    Definition Classes
    WrappedRequest → RequestHeader
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  55. def withAttrs(newAttrs: TypedMap): WrappedRequest[A]

    Create a new version of this object with the given attributes attached to it.

    Create a new version of this object with the given attributes attached to it. This replaces any existing attributes.

    newAttrs

    The new attributes to add.

    returns

    The new version of this object with the attributes attached.

    Definition Classes
    WrappedRequest → Request → RequestHeader
  56. def withBody[B](body: B): WrappedRequest[B]

    Attach a body to this header.

    Attach a body to this header.

    body

    The body to attach.

    returns

    A new request with the body attached to the header.

    Definition Classes
    WrappedRequest → RequestHeader
  57. def withConnection(newConnection: RemoteConnection): WrappedRequest[A]
    Definition Classes
    WrappedRequest → Request → RequestHeader
  58. def withHeaders(newHeaders: Headers): WrappedRequest[A]

    The remote connection that made the request.

    The remote connection that made the request.

    Definition Classes
    WrappedRequest → Request → RequestHeader
  59. def withMethod(newMethod: String): WrappedRequest[A]

    Return a new copy of the request with its method changed.

    Return a new copy of the request with its method changed.

    Definition Classes
    WrappedRequest → Request → RequestHeader
  60. def withTarget(newTarget: RequestTarget): WrappedRequest[A]

    Return a new copy of the request with its target changed.

    Return a new copy of the request with its target changed.

    Definition Classes
    WrappedRequest → Request → RequestHeader
  61. def withTransientLang(locale: Locale): Request[A]

    Create a new versions of this object with the given transient language set.

    Create a new versions of this object with the given transient language set. The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred() (It will take precedence over any other language).

    locale

    The language to use.

    returns

    The new version of this object with the given transient language set.

    Definition Classes
    Request → RequestHeader
  62. def withTransientLang(code: String): Request[A]

    Create a new versions of this object with the given transient language set.

    Create a new versions of this object with the given transient language set. The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred() (It will take precedence over any other language).

    code

    The language to use.

    returns

    The new version of this object with the given transient language set.

    Definition Classes
    Request → RequestHeader
  63. def withTransientLang(lang: Lang): Request[A]

    Create a new versions of this object with the given transient language set.

    Create a new versions of this object with the given transient language set. The transient language will be taken into account when using play.api.i18n.MessagesApi.preferred() (It will take precedence over any other language).

    lang

    The language to use.

    returns

    The new version of this object with the given transient language set.

    Definition Classes
    Request → RequestHeader
  64. def withVersion(newVersion: String): WrappedRequest[A]

    Return a new copy of the request with its HTTP version changed.

    Return a new copy of the request with its HTTP version changed.

    Definition Classes
    WrappedRequest → Request → RequestHeader
  65. def withoutTransientLang(): Request[A]

    Create a new versions of this object with the given transient language removed.

    Create a new versions of this object with the given transient language removed.

    returns

    The new version of this object with the transient language removed.

    Definition Classes
    Request → RequestHeader

Inherited from WrappedRequest[A]

Inherited from Request[A]

Inherited from RequestHeader

Inherited from AnyRef

Inherited from Any

Ungrouped