Http.RequestHeader (Play 2.7.0)

All Known Subinterfaces:

Http.Request

All Known Implementing Classes:

Http.RequestImpl, play.core.j.RequestHeaderImpl, play.core.j.RequestImpl

Enclosing class:

Http
```
public static interface Http.RequestHeader
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.util.List<play.api.http.MediaRange>`	`acceptedTypes()`
`java.util.List<Lang>`	`acceptLanguages()` The Request Langs extracted from the Accept-Language header and sorted by preference (preferred first).
`boolean`	`accepts(java.lang.String mimeType)` Check if this request accepts a given media type.
`<A> Http.RequestHeader`	`addAttr(TypedKey<A> key, A value)` Create a new versions of this object with the given attribute attached to it.
`play.api.mvc.RequestHeader`	`asScala()` Return the Scala version of the request header.
`TypedMap`	`attrs()`
`java.util.Optional<java.lang.String>`	`charset()` Get the charset of the request.
`java.util.Optional<java.util.List<java.security.cert.X509Certificate>>`	`clientCertificateChain()` The X509 certificate chain presented by a client during SSL requests.
`java.util.Optional<java.lang.String>`	`contentType()` Get the content type of the request.
`Http.Cookie`	`cookie(java.lang.String name)`
`Http.Cookies`	`cookies()`
`default Http.Flash`	`flash()` Parses the Flash cookie and returns the Flash data.
`Http.Headers`	`getHeaders()` Retrieve all headers.
`java.lang.String`	`getQueryString(java.lang.String key)` Helper method to access a queryString parameter.
`boolean`	`hasBody()` Checks if the request has a body.
`default boolean`	`hasHeader(java.lang.String headerName)` Checks if the request has the header.
`default java.util.Optional<java.lang.String>`	`header(java.lang.String headerName)` Retrieves a single header.
`java.lang.String`	`host()` The request host.
`default java.lang.Long`	`id()` The request id.
`java.lang.String`	`method()` The HTTP Method.
`java.lang.String`	`path()` The URI path.
`java.util.Map<java.lang.String,java.lang.String[]>`	`queryString()` The query string content.
`java.lang.String`	`remoteAddress()` The client IP address.
`Http.RequestHeader`	`removeAttr(TypedKey<?> key)` Create a new versions of this object with the given attribute removed.
`boolean`	`secure()` Is the client using SSL?
`default Http.Session`	`session()` Parses the Session cookie and returns the Session data.
`default java.util.Optional<Lang>`	`transientLang()` The transient language will be taken into account when using `MessagesApi#preferred(RequestHeader)`} (It will take precedence over any other language).
`java.lang.String`	`uri()` The complete request URI, containing both path and query string.
`java.lang.String`	`version()` The HTTP version.
`Http.RequestHeader`	`withAttrs(TypedMap newAttrs)` Create a new version of this object with the given attributes attached to it.
`Http.Request`	`withBody(Http.RequestBody body)` Attach a body to this header.
`default Http.RequestHeader`	`withoutTransientLang()` Create a new version of this object with the given transient language removed.
`default Http.RequestHeader`	`withTransientLang(Lang lang)` Create a new version of this object with the given transient language set.
`default Http.RequestHeader`	`withTransientLang(java.util.Locale locale)` Create a new version of this object with the given transient language set.
`default Http.RequestHeader`	`withTransientLang(java.lang.String code)` Create a new version of this object with the given transient language set.

- Method Detail
  - id
```
default java.lang.Long id()
```
    The request id. The request id is stored as an attribute indexed by RequestAttrKey.Id().
  - uri
```
java.lang.String uri()
```
    The complete request URI, containing both path and query string.
    
    Returns:
    
    the uri
  - method
```
java.lang.String method()
```
    The HTTP Method.
    
    Returns:
    
    the http method
  - version
```
java.lang.String version()
```
    The HTTP version.
    
    Returns:
    
    the version
  - remoteAddress
```
java.lang.String remoteAddress()
```
    The client IP address. retrieves the last untrusted proxy from the Forwarded-Headers or the X-Forwarded-*-Headers.
    
    Returns:
    
    the remote address
  - secure
```
boolean secure()
```
    Is the client using SSL?
    
    Returns:
    
    true that the client is using SSL
  - attrs
```
TypedMap attrs()
```
    Returns:
    
    a map of typed attributes associated with the request.
  - withAttrs
```
Http.RequestHeader withAttrs(TypedMap newAttrs)
```
    Create a new version of this object with the given attributes attached to it.
    
    Parameters:
    
    newAttrs - The new attributes to add.
    
    Returns:
    
    The new version of this object with the attributes attached.
  - addAttr
```
<A> Http.RequestHeader addAttr(TypedKey<A> key,
                               A value)
```
    Create a new versions of this object with the given attribute attached to it.
    
    Type Parameters:
    
    A - the attribute type
    
    Parameters:
    
    key - The new attribute key.
    
    value - The attribute value.
    
    Returns:
    
    The new version of this object with the new attribute.
  - removeAttr
```
Http.RequestHeader removeAttr(TypedKey<?> key)
```
    Create a new versions of this object with the given attribute removed.
    
    Parameters:
    
    key - The key of the attribute to remove.
    
    Returns:
    
    The new version of this object with the attribute removed.
  - withBody
```
Http.Request withBody(Http.RequestBody body)
```
    Attach a body to this header.
    
    Parameters:
    
    body - The body to attach.
    
    Returns:
    
    A new request with the body attached to the header.
  - host
```
java.lang.String host()
```
    The request host.
    
    Returns:
    
    the host
  - path
```
java.lang.String path()
```
    The URI path.
    
    Returns:
    
    the path
  - acceptLanguages
```
java.util.List<Lang> acceptLanguages()
```
    The Request Langs extracted from the Accept-Language header and sorted by preference (preferred first).
    
    Returns:
    
    the preference-ordered list of languages accepted by the client
  - acceptedTypes
```
java.util.List<play.api.http.MediaRange> acceptedTypes()
```
    Returns:
    
    The media types set in the request Accept header, sorted by preference (preferred first)
  - accepts
```
boolean accepts(java.lang.String mimeType)
```
    Check if this request accepts a given media type.
    
    Parameters:
    
    mimeType - the mimeType to check for support.
    
    Returns:
    
    true if mimeType is in the Accept header, otherwise false
  - queryString
```
java.util.Map<java.lang.String,java.lang.String[]> queryString()
```
    The query string content.
    
    Returns:
    
    the query string map
  - getQueryString
```
java.lang.String getQueryString(java.lang.String key)
```
    Helper method to access a queryString parameter.
    
    Parameters:
    
    key - the query string parameter to look up
    
    Returns:
    
    the value for the provided key.
  - cookies
```
Http.Cookies cookies()
```
    Returns:
    
    the request cookies
  - cookie
```
Http.Cookie cookie(java.lang.String name)
```
    Parameters:
    
    name - Name of the cookie to retrieve
    
    Returns:
    
    the cookie, if found, otherwise null
  - session
```
default Http.Session session()
```
    Parses the Session cookie and returns the Session data. The request's session cookie is stored in an attribute indexed by RequestAttrKey.Session(). The attribute uses a Cell to store the session cookie, to allow it to be evaluated on-demand.
  - flash
```
default Http.Flash flash()
```
    Parses the Flash cookie and returns the Flash data. The request's flash cookie is stored in an attribute indexed by RequestAttrKey.Flash()}. The attribute uses a Cell to store the flash, to allow it to be evaluated on-demand.
  - getHeaders
```
Http.Headers getHeaders()
```
    Retrieve all headers.
    
    Returns:
    
    the request headers for this request.
  - header
```
default java.util.Optional<java.lang.String> header(java.lang.String headerName)
```
    Retrieves a single header.
    
    Parameters:
    
    headerName - The name of the header (case-insensitive)
    
    Returns:
    
    the value corresponding to headerName, or empty if it was not present
  - hasHeader
```
default boolean hasHeader(java.lang.String headerName)
```
    Checks if the request has the header.
    
    Parameters:
    
    headerName - The name of the header (case-insensitive)
    
    Returns:
    
    true if the request did contain the header.
  - hasBody
```
boolean hasBody()
```
    Checks if the request has a body.
    
    Returns:
    
    true if request has a body, false otherwise.
  - contentType
```
java.util.Optional<java.lang.String> contentType()
```
    Get the content type of the request.
    
    Returns:
    
    The request content type excluding the charset, if it exists.
  - charset
```
java.util.Optional<java.lang.String> charset()
```
    Get the charset of the request.
    
    Returns:
    
    The request charset, which comes from the content type header, if it exists.
  - clientCertificateChain
```
java.util.Optional<java.util.List<java.security.cert.X509Certificate>> clientCertificateChain()
```
    The X509 certificate chain presented by a client during SSL requests.
    
    Returns:
    
    The chain of X509Certificates used for the request if the request is secure and the server supports it.
  - withTransientLang
```
default Http.RequestHeader withTransientLang(Lang lang)
```
    Create a new version of this object with the given transient language set. The transient language will be taken into account when using MessagesApi#preferred(RequestHeader)} (It will take precedence over any other language).
    
    Parameters:
    
    lang - The language to use.
    
    Returns:
    
    The new version of this object with the given transient language set.
  - withTransientLang
```
default Http.RequestHeader withTransientLang(java.lang.String code)
```
    Create a new version of this object with the given transient language set. The transient language will be taken into account when using MessagesApi#preferred(RequestHeader)} (It will take precedence over any other language).
    
    Parameters:
    
    code - The language to use.
    
    Returns:
    
    The new version of this object with the given transient language set.
  - withTransientLang
```
default Http.RequestHeader withTransientLang(java.util.Locale locale)
```
    Create a new version of this object with the given transient language set. The transient language will be taken into account when using MessagesApi#preferred(RequestHeader)} (It will take precedence over any other language).
    
    Parameters:
    
    locale - The language to use.
    
    Returns:
    
    The new version of this object with the given transient language set.
  - withoutTransientLang
```
default Http.RequestHeader withoutTransientLang()
```
    Create a new version of this object with the given transient language removed.
    
    Returns:
    
    The new version of this object with the transient language removed.
  - transientLang
```
default java.util.Optional<Lang> transientLang()
```
    The transient language will be taken into account when using MessagesApi#preferred(RequestHeader)} (It will take precedence over any other language).
    
    Returns:
    
    The current transient language of this request.
  - asScala
```
play.api.mvc.RequestHeader asScala()
```
    Return the Scala version of the request header.
    
    Returns:
    
    the Scala version for this request header.
    
    See Also:
    
    RequestHeader

Interface Http.RequestHeader

Method Summary

Method Detail

id

uri

method

version

remoteAddress

secure

attrs

withAttrs

addAttr

removeAttr

withBody

host

path

acceptLanguages

acceptedTypes

accepts

queryString

getQueryString

cookies

cookie

session

flash

getHeaders

header

hasHeader

hasBody

contentType

charset

clientCertificateChain

withTransientLang

withTransientLang

withTransientLang

withoutTransientLang

transientLang

asScala