play.mvc

Interface Http.RequestHeader

All Known Subinterfaces:

Http.Request

All Known Implementing Classes:

Http.RequestImpl, play.core.j.RequestHeaderImpl

Enclosing class:

Http

public static interface Http.RequestHeader

Method Summary

Modifier and Type	Method and Description
play.api.mvc.RequestHeader	_underlyingHeader() For internal Play-use only
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.
Http.Cookie	cookie(java.lang.String name)
Http.Cookies	cookies()
java.lang.String	getHeader(java.lang.String headerName) Retrieves a single header.
java.lang.String	getQueryString(java.lang.String key) Helper method to access a queryString parameter.
boolean	hasHeader(java.lang.String headerName) Checks if the request has the header.
java.util.Map<java.lang.String,java.lang.String[]>	headers() Retrieves all headers.
java.lang.String	host() The request host.
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.
boolean	secure() Is the client using SSL?
java.lang.String	uri() The complete request URI, containing both path and query string.
java.lang.String	version() The HTTP version.

Method Detail

uri

java.lang.String uri()

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

method

java.lang.String method()

The HTTP Method.

version

java.lang.String version()

The HTTP version.

remoteAddress

java.lang.String remoteAddress()

The client IP address. retrieves the last untrusted proxy from the Forwarded-Headers or the X-Forwarded-*-Headers.

secure

boolean secure()

Is the client using SSL?

host

java.lang.String host()

The request host.

path

java.lang.String path()

The URI path.

acceptLanguages

java.util.List<Lang> acceptLanguages()

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

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.

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.

getQueryString

java.lang.String getQueryString(java.lang.String key)

Helper method to access a queryString parameter.

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

headers

java.util.Map<java.lang.String,java.lang.String[]> headers()

Retrieves all headers.

Returns:

a map of of header name to headers with case-insensitive keys

getHeader

java.lang.String getHeader(java.lang.String headerName)

Retrieves a single header.

Parameters:

headerName - The name of the header (case-insensitive)

hasHeader

boolean hasHeader(java.lang.String headerName)

Checks if the request has the header.

Parameters:

headerName - The name of the header (case-insensitive)

_underlyingHeader

play.api.mvc.RequestHeader _underlyingHeader()

For internal Play-use only