play.api.mvc

RequestHeader

trait RequestHeader extends AnyRef

The HTTP request header. Note that it doesn’t contain the request body yet.

Annotations
@implicitNotFound( ... )
Source
Http.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AuthenticatedRequest, FakeRequest, Request, WrappedRequest
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RequestHeader
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def headers: Headers

    The HTTP headers.

  2. abstract def id: Long

    The request ID.

  3. abstract def method: String

    The HTTP method.

  4. abstract def path: String

    The URI path.

  5. abstract def queryString: Map[String, Seq[String]]

    The parsed query string.

  6. abstract 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.

  7. abstract 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.

  8. abstract def tags: Map[String, String]

    The request Tags.

  9. abstract def uri: String

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

  10. abstract def version: String

    The HTTP version.

Concrete 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).

  7. lazy val acceptedTypes: Seq[MediaRange]

    returns

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

  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

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. lazy val charset: Option[String]

    Returns the charset of the request for text-based body

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. lazy val contentType: Option[String]

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

  13. lazy val cookies: Cookies

    The HTTP cookies.

  14. 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.

  15. lazy val domain: String

    The HTTP domain

  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. lazy val flash: Flash

    Parses the Flash cookie and returns the Flash data.

  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  21. def getQueryString(key: String): Option[String]

    Helper method to access a queryString parameter.

  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  23. lazy val host: String

    The HTTP host (domain, optionally port)

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  25. 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.

  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  29. lazy val rawQueryString: String

    Returns the raw query string.

  30. lazy val session: Session

    Parses the Session cookie and returns the Session data.

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  32. def toString(): String

    Definition Classes
    RequestHeader → AnyRef → Any

  33. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.1) Use acceptedTypes instead

Inherited from AnyRef

Inherited from Any

Ungrouped