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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

    user

    The user that made the request

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. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  6. 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
  7. lazy val acceptedTypes: Seq[MediaRange]

    returns

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

    Definition Classes
    RequestHeader
  8. 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
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def body: A

    The body content.

    The body content.

    Definition Classes
    WrappedRequestRequest
  11. 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
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. 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
  14. lazy val cookies: Cookies

    The HTTP cookies.

    The HTTP cookies.

    Definition Classes
    RequestHeader
  15. def copy(id: Long = this.id, tags: Map[String, String] = this.tags, uri: String = this.uri, path: String = this.path, method: String = this.method, version: String = this.version, queryString: Map[String, Seq[String]] = this.queryString, headers: Headers = this.headers, remoteAddress: String = this.remoteAddress, secure: Boolean = this.secure): RequestHeader

    Copy the request.

    Copy the request.

    Definition Classes
    RequestHeader
  16. lazy val domain: String

    The HTTP domain

    The HTTP domain

    Definition Classes
    RequestHeader
  17. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. lazy val flash: Flash

    Parses the Flash cookie and returns the Flash data.

    Parses the Flash cookie and returns the Flash data.

    Definition Classes
    RequestHeader
  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def getQueryString(key: String): Option[String]

    Helper method to access a queryString parameter.

    Helper method to access a queryString parameter.

    Definition Classes
    RequestHeader
  23. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  24. def headers: Headers

    The HTTP headers.

    The HTTP headers.

    Definition Classes
    WrappedRequestRequestHeader
  25. lazy val host: String

    The HTTP host (domain, optionally port)

    The HTTP host (domain, optionally port)

    Definition Classes
    RequestHeader
  26. def id: Long

    The request ID.

    The request ID.

    Definition Classes
    WrappedRequestRequestHeader
  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  28. def map[B](f: (A) ⇒ B): Request[B]

    Transform the request body.

    Transform the request body.

    Definition Classes
    Request
  29. 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
  30. def method: String

    The HTTP method.

    The HTTP method.

    Definition Classes
    WrappedRequestRequestHeader
  31. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  34. def path: String

    The URI path.

    The URI path.

    Definition Classes
    WrappedRequestRequestHeader
  35. def queryString: Map[String, Seq[String]]

    The parsed query string.

    The parsed query string.

    Definition Classes
    WrappedRequestRequestHeader
  36. lazy val rawQueryString: String

    Returns the raw query string.

    Returns the raw query string.

    Definition Classes
    RequestHeader
  37. def remoteAddress: String

    The client IP address.

    The client IP address.

    If the X-Forwarded-For header is present, then this method will return the value in that header if either the local address is 127.0.0.1, or if trustxforwarded is configured to be true in the application configuration file.

    Definition Classes
    WrappedRequestRequestHeader
  38. def secure: Boolean

    Is the client using SSL?

    Is the client using SSL?

    If the X-Forwarded-Proto header is present, then this method will return true if the value in that header is "https", if either the local address is 127.0.0.1, or if trustxforwarded is configured to be true in the application configuration file.

    Definition Classes
    WrappedRequestRequestHeader
  39. lazy val session: Session

    Parses the Session cookie and returns the Session data.

    Parses the Session cookie and returns the Session data.

    Definition Classes
    RequestHeader
  40. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  41. def tags: Map[String, String]

    The request Tags.

    The request Tags.

    Definition Classes
    WrappedRequestRequestHeader
  42. def toString(): String

    Definition Classes
    RequestHeader → AnyRef → Any
  43. def uri: String

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

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

    Definition Classes
    WrappedRequestRequestHeader
  44. val user: U

    The user that made the request

  45. def version: String

    The HTTP version.

    The HTTP version.

    Definition Classes
    WrappedRequestRequestHeader
  46. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. lazy val accept: Seq[String]

    returns

    The media types list of the request’s Accept header, not sorted in any particular order.

    Definition Classes
    RequestHeader
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1) Use acceptedTypes instead

Inherited from WrappedRequest[A]

Inherited from Request[A]

Inherited from RequestHeader

Inherited from AnyRef

Inherited from Any

Ungrouped