RequestHeader (Werval API Reference (0.7.5))

All Known Subinterfaces:

Request
```
public interface RequestHeader
```
Request header.
Method, Path, QueryString, Headers and Cookies.

No Entity.

Helper methods.

Parameters are available once bound to a Route, see bind(io.werval.api.routes.ParameterBinders, io.werval.api.routes.Route) and parameters().

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<Lang>`	`acceptedLangs()` Accepted Languages.
`List<MediaRange>`	`acceptedMimeTypes()` Accepted content mime types.
`boolean`	`acceptsMimeType(String mimeType)` Test if this request accepts the given mime type.
`RequestHeader`	`bind(ParameterBinders parameterBinders, Route route)` Bind Route parameters.
`Optional<String>`	`charset()` The HTTP Request Charset, optional.
`Optional<String>`	`contentType()` The HTTP Request content type, optional.
`Cookies`	`cookies()`
`String`	`domain()` The HTTP Domain.
`Headers`	`headers()`
`String`	`host()` The HTTP Host with or without the port.
`String`	`identity()`
`boolean`	`isKeepAlive()` Return true if and only if the connection can remain open.
`Method`	`method()`
`Map<String,Object>`	`parameters()` Bound Route parameters.
`String`	`path()`
`int`	`port()` The HTTP Port.
`Lang`	`preferredLang()` Preferred Language.
`String`	`preferredMimeType(String... mimeTypes)` Preferred Mime Type.
`QueryString`	`queryString()`
`String`	`remoteAddress()` The HTTP Client Address.
`String`	`uri()`
`ProtocolVersion`	`version()`

- Method Detail
  - identity
```
String identity()
```
    Returns:
    
    The HTTP Request ID created by the framework
  - version
```
ProtocolVersion version()
```
    Returns:
    
    The HTTP Request Protocol Version such as "HTTP/1.0" or "HTTP/1.1".
  - method
```
Method method()
```
    Returns:
    
    The HTTP Request Method
  - uri
```
String uri()
```
    Returns:
    
    The HTTP Request URI, URL encoded
  - path
```
String path()
```
    Returns:
    
    The HTTP Request Path, URL decoded
  - queryString
```
QueryString queryString()
```
    Returns:
    
    The HTTP Request Query String
  - headers
```
Headers headers()
```
    Returns:
    
    The HTTP Request Headers
  - cookies
```
Cookies cookies()
```
    Returns:
    
    The HTTP Request Cookies
  - remoteAddress
```
String remoteAddress()
```
    The HTTP Client Address.
    Default value is the underlying socket client address.
    
    If the werval.http.headers.x_forwarded_for.enabled configuration property is yes, then the value is computed from the X-Forwarded-For header value. This is the default behaviour.
    
    If the werval.http.headers.x_forwarded_for.check_proxies configuration property is yes, then X-Forwarded-For value is accepted only if all proxies in the chain are present in the werval.http.headers.x_forwarded_for.trusted_proxies configuration list. This is the default behaviour trusting only 127.0.0.1.
    
    If the X-Forwarded-For cannot be trusted, Werval will respond with a 400 Bad Request.
    
    Returns:
    
    The HTTP Client Address
  - host
```
String host()
```
    The HTTP Host with or without the port.
    HTTP Host header, mandatory since HTTP 1.1.
    
    Returns:
    
    The HTTP Host with or without the port
  - port
```
int port()
```
    The HTTP Port.
    Computed from the request URI or HTTP Host header and standard defaults 80/443.
    
    Returns:
    
    The HTTP Port
  - domain
```
String domain()
```
    The HTTP Domain.
    Computed from the request URI.
    
    Returns:
    
    The HTTP Domain
  - contentType
```
Optional<String> contentType()
```
    The HTTP Request content type, optional.
    Computed from the Content-Type header, charset removed.
    
    Returns:
    
    The HTTP Request content type, optional
  - charset
```
Optional<String> charset()
```
    The HTTP Request Charset, optional.
    Computed from the Content-Type header.
    
    Returns:
    
    The HTTP Request Charset, optional
  - isKeepAlive
```
boolean isKeepAlive()
```
    Return true if and only if the connection can remain open.
    Honnor Headers.Names.CONNECTION header and then protocol version defaults.
    
    Returns:
    
    true if the connection should be kept-alive, false otherwise
  - bind
```
RequestHeader bind(ParameterBinders parameterBinders,
                   Route route)
```
    Bind Route parameters.
    Successive calls to parameters() will return bound parameters.
    
    Parameters:
    
    parameterBinders - Parameter binders
    
    route - Route
    
    Returns:
    
    This very RequestHeader
  - parameters
```
Map<String,Object> parameters()
```
    Bound Route parameters.
    
    Returns:
    
    Request path and query-string bound parameters, or an empty Map if not bound
  - acceptedLangs
```
List<Lang> acceptedLangs()
```
    Accepted Languages.
    
    Returns:
    
    Accepted languages, ordered by the q-values of the Accept-Language header, preferred first
  - preferredLang
```
Lang preferredLang()
```
    Preferred Language.
    Guess the preferred language according to the Accept-Language request header or Application's preferred language, or the language of the default Locale.
    
    Returns:
    
    The preferred language
  - acceptedMimeTypes
```
List<MediaRange> acceptedMimeTypes()
```
    Accepted content mime types.
    
    Returns:
    
    Accepted content mime types, ordered by the q-values of the Accept header
  - acceptsMimeType
```
boolean acceptsMimeType(String mimeType)
```
    Test if this request accepts the given mime type.
    
    Parameters:
    
    mimeType - Mime type
    
    Returns:
    
    true if mimeType matches the Accept header, otherwise return false
  - preferredMimeType
```
String preferredMimeType(String... mimeTypes)
```
    Preferred Mime Type.
    Guess the preferred mime types among given mime types according to the Accept request header.
    
    If the request accepts any mime type and no candidate were given, return *\/*, otherwise return the first candidate.
    
    If no candidate is accepted, return the preferred mime type according the the Accept request header.
    
    Parameters:
    
    mimeTypes - Candidate mime types
    
    Returns:
    
    The preferred mime type or the wildcard mimetype, never return null

Interface RequestHeader

Method Summary

Method Detail

identity

version

method

uri

path

queryString

headers

cookies

remoteAddress

host

port

domain

contentType

charset

isKeepAlive

bind

parameters

acceptedLangs

preferredLang

acceptedMimeTypes

acceptsMimeType

preferredMimeType