HttpRequest

java.lang.Object
- ej.hoka.http.HttpRequest

```
public class HttpRequest
extends Object
```
Represents a HTTP Request.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`AFTER` after filter code.
`protected static int`	`AFTER_ALL` after all filter code.
`protected static int`	`BEFORE` before filter code.
`protected static int`	`BEFORE_ALL` before all filter code.
`static int`	`CONNECT` Value returned by `getMethod()` if the request method is `CONNECT`.
`static int`	`DELETE` Value returned by `getMethod()` if the request method is `DELETE`.
`static int`	`GET` Value returned by `getMethod()` if the request method is `GET`.
`static int`	`HEAD` Value returned by `getMethod()` if the request method is `HEAD`.
`static int`	`OPTIONS` Value returned by `getMethod()` if the request method is `OPTIONS`.
`static int`	`PATCH` Value returned by `getMethod()` if the request method is `PATCH`.
`static int`	`POST` Value returned by `getMethod()` if the request method is `POST`.
`static int`	`PUT` Value returned by `getMethod()` if the request method is `PUT`.
`static int`	`TRACE` Value returned by `getMethod()` if the request method is `TRACE`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected HttpRequest(InputStream inputStream, EncodingRegistry encodingRegistry)
Constructs a new instance of HTTPRequest.

Constructors
Modifier	Constructor and Description
`protected`	`HttpRequest(InputStream inputStream, EncodingRegistry encodingRegistry)` Constructs a new instance of HTTPRequest.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addPathParameters(Map<String,String> parameters)` Adds path parameters from a given list to the list of path path parameters of the request.
`protected void`	`addSplatParameters(List<String> splatParameters)` Sets the splat Parameters.
`Object`	`getAttribute(String key)` Get request server-side attribute by key.
`String`	`getCookie(String name)` Return the cookie of the request with given name.
`Map<String,String>`	`getCookies()` Returns the cookies of the request.
`String`	`getHeader(String name)` Returns the header field value associated to the given header field `name`.
`Map<String,String>`	`getHeaders()` Returns all HTTP header fields of the request.
`int`	`getMethod()` Returns the request method as an integer value which is one of `POST`, `GET`, `PUT` or `DELETE`.
`String`	`getPathParam(String param)` Returns the path parameter value mapped to the given name.
`String`	`getQueryParam(String name)` Returns the query parameter mapped to the given name.
`Map<String,String>`	`getQueryParams()` Returns the Query parameters as `Map`.
`InputStream`	`getRequestBody()` use `parseBody(BodyParser)` for more option on request body provided parsers.
`List<String>`	`getSplatParams()` Returns the list of splat parameters.
`String`	`getURI()` Returns the request URI.
`String`	`getVersion()` Returns the HTTP version request.
`<T> T`	`parseBody(BodyParser<T> bodyParser)` Request the body to be parsed.
`void`	`setAttribute(String key, Object value)` Set a request server-side attribute.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AFTER
```
protected static final int AFTER
```
    after filter code.
    
    See Also:
    
    Constant Field Values
  - AFTER_ALL
```
protected static final int AFTER_ALL
```
    after all filter code.
    
    See Also:
    
    Constant Field Values
  - BEFORE
```
protected static final int BEFORE
```
    before filter code.
    
    See Also:
    
    Constant Field Values
  - BEFORE_ALL
```
protected static final int BEFORE_ALL
```
    before all filter code.
    
    See Also:
    
    Constant Field Values
  - CONNECT
```
public static final int CONNECT
```
    Value returned by getMethod() if the request method is CONNECT.
    
    See Also:
    
    Constant Field Values
  - DELETE
```
public static final int DELETE
```
    Value returned by getMethod() if the request method is DELETE.
    
    See Also:
    
    Constant Field Values
  - GET
```
public static final int GET
```
    Value returned by getMethod() if the request method is GET.
    
    See Also:
    
    Constant Field Values
  - HEAD
```
public static final int HEAD
```
    Value returned by getMethod() if the request method is HEAD.
    
    See Also:
    
    Constant Field Values
  - OPTIONS
```
public static final int OPTIONS
```
    Value returned by getMethod() if the request method is OPTIONS.
    
    See Also:
    
    Constant Field Values
  - PATCH
```
public static final int PATCH
```
    Value returned by getMethod() if the request method is PATCH.
    
    See Also:
    
    Constant Field Values
  - POST
```
public static final int POST
```
    Value returned by getMethod() if the request method is POST.
    
    See Also:
    
    Constant Field Values
  - PUT
```
public static final int PUT
```
    Value returned by getMethod() if the request method is PUT.
    
    See Also:
    
    Constant Field Values
  - TRACE
```
public static final int TRACE
```
    Value returned by getMethod() if the request method is TRACE.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpRequest
```
protected HttpRequest(InputStream inputStream,
                      EncodingRegistry encodingRegistry)
               throws IOException
```
    Constructs a new instance of HTTPRequest.
    
    Parameters:
    
    inputStream - the input stream of the request.
    
    encodingRegistry - the register of available encoding and transfer coding handlers.
    
    Throws:
    
    IOException - if connection is lost during processing the request.
    
    IllegalArgumentException - if parsing the request failed.
- Method Detail
  - addPathParameters
```
protected void addPathParameters(Map<String,String> parameters)
```
    Adds path parameters from a given list to the list of path path parameters of the request.
    
    Parameters:
    
    parameters - path parameters to be added to the request
  - addSplatParameters
```
protected void addSplatParameters(List<String> splatParameters)
```
    Sets the splat Parameters.
    
    Parameters:
    
    splatParameters - the splat parameters to set.
  - getAttribute
```
@Nullable
public Object getAttribute(String key)
```
    Get request server-side attribute by key.
    
    Parameters:
    
    key - attribute key
    
    Returns:
    
    value mapped to key
  - getCookie
```
@Nullable
public String getCookie(@Nullable
                                  String name)
```
    Return the cookie of the request with given name.
    Cookies are lazily parsed.
    
    Parameters:
    
    name - the name of the cookie.
    
    Returns:
    
    the cookie, or null if name is null.
  - getCookies
```
public Map<String,String> getCookies()
```
    Returns the cookies of the request.
    Cookies are lazily parsed.
    
    Returns:
    
    a Map of (String,String) representing the HTTP cookies (may be empty)
  - getHeader
```
@Nullable
public String getHeader(@Nullable
                                  String name)
```
    Returns the header field value associated to the given header field name.
    
    Parameters:
    
    name - the header field name.
    
    Returns:
    
    the requested header field value, null if the header field is not found or name is null.
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Returns all HTTP header fields of the request.
    
    Returns:
    
    a Map of (String,String) representing the HTTP header fields (may be empty).
  - getMethod
```
public int getMethod()
```
    Returns the request method as an integer value which is one of POST, GET, PUT or DELETE.
    
    Returns:
    
    the request method (one of POST, GET, PUT or DELETE).
  - getPathParam
```
@Nullable
public String getPathParam(String param)
```
    Returns the path parameter value mapped to the given name.
    
    Parameters:
    
    param - path parameter name
    
    Returns:
    
    path parameter value if exist, null otherwise
  - getQueryParam
```
@Nullable
public String getQueryParam(String name)
```
    Returns the query parameter mapped to the given name.
    
    Parameters:
    
    name - of query parameter
    
    Returns:
    
    the parameter mapped to name
  - getQueryParams
```
public Map<String,String> getQueryParams()
```
    Returns the Query parameters as Map.
    
    Returns:
    
    a Map of (String,String) representing the HTTP query parameters.
  - getRequestBody
```
public InputStream getRequestBody()
```
    use parseBody(BodyParser) for more option on request body provided parsers.
    
    Returns:
    
    request request body as an input stream.
  - getSplatParams
```
public List<String> getSplatParams()
```
    Returns the list of splat parameters.
    
    Returns:
    
    a List of splat parameters.
  - getURI
```
public String getURI()
```
    Returns the request URI.
    
    Returns:
    
    the request URI string.
  - getVersion
```
public String getVersion()
```
    Returns the HTTP version request.
    
    Returns:
    
    the HTTP version request string.
  - parseBody
```
public <T> T parseBody(BodyParser<T> bodyParser)
                throws IOException
```
    Request the body to be parsed.
    
    Type Parameters:
    
    T - the type of body.
    
    Parameters:
    
    bodyParser - the parser.
    
    Returns:
    
    the parsed body.
    
    Throws:
    
    IOException - if an IOException occurs during parsing.
  - setAttribute
```
public void setAttribute(String key,
                         Object value)
```
    Set a request server-side attribute.
    
    Parameters:
    
    key - attribute key
    
    value - attribute value

Class HttpRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AFTER

AFTER_ALL

BEFORE

BEFORE_ALL

CONNECT

DELETE

GET

HEAD

OPTIONS

PATCH

POST

PUT

TRACE

Constructor Detail

HttpRequest

Method Detail

addPathParameters

addSplatParameters

getAttribute

getCookie

getCookies

getHeader

getHeaders

getMethod

getPathParam

getQueryParam

getQueryParams

getRequestBody

getSplatParams

getURI

getVersion

parseBody

setAttribute