Request (Agorava core API 0.7.0 API)

All Known Subinterfaces:

OAuthRequest
```
public interface Request
```
A REST request

Author:

Antoine Sabot-Durand

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBodyParameter(String key, String value)` Add a body Parameter (for POST/ PUT Requests)
`void`	`addBodyParameters(Map<String,? extends Object> params)` Add Body parameters from a map
`void`	`addHeader(String key, String value)` Add an HTTP HEADER to the Request
`void`	`addPayload(byte[] payload)` Add body payload from an Array of bytes
`void`	`addPayload(String payload)` Add body payload from a String
`void`	`addQuerystringParameter(String key, String value)` Add a QueryString parameter
`String`	`getBodyContents()` Returns the body of the request
`HttpParameters`	`getBodyParams()` Obtains a `HttpParameters` of the body parameters.
`String`	`getCharset()` Returns the connection charset.
`String`	`getCompleteUrl()` Returns the complete url (host + resource + encoded querystring parameters).
`Map<String,String>`	`getHeaders()` Returns the connection headers as a `Map`
`HttpParameters`	`getQueryStringParams()` Get a `HttpParameters` with the query string parameters.
`String`	`getSanitizedUrl()` Returns the URL without the port and the query string part.
`String`	`getUrl()` Obtains the URL of the HTTP Request.
`Verb`	`getVerb()` Returns the HTTP Verb
`Response`	`send()` Execute the request and return a `Response`
`Response`	`send(RequestTuner tuner)` Execute the request and return a `Response`
`void`	`setCharset(String charsetName)` Set the charset of the body of the request
`void`	`setConnectionKeepAlive(boolean connectionKeepAlive)` Sets whether the underlying Http Connection is persistent or not.
`void`	`setConnectTimeout(int duration, TimeUnit unit)` Sets the connect timeout for the underlying `HttpURLConnection`
`void`	`setReadTimeout(int duration, TimeUnit unit)` Sets the read timeout for the underlying `HttpURLConnection`

- Method Detail
  - send
```
Response send(RequestTuner tuner)
```
    Execute the request and return a Response
    
    Parameters:
    tuner - a tuner to alter request behavior
    
    Returns:
    the response from remote tier
    
    Throws:
    
    RuntimeException - if the connection cannot be created.
  - send
```
Response send()
```
    Execute the request and return a Response
    
    Returns:
    the response from remote tier
  - getCompleteUrl
```
String getCompleteUrl()
```
    Returns the complete url (host + resource + encoded querystring parameters).
    
    Returns:
    the complete url.
  - addHeader
```
void addHeader(String key,
             String value)
```
    Add an HTTP HEADER to the Request
    
    Parameters:
    key - the header name
    value - the header value
  - addBodyParameter
```
void addBodyParameter(String key,
                    String value)
```
    Add a body Parameter (for POST/ PUT Requests)
    
    Parameters:
    key - the parameter name
    value - the parameter value
  - addQuerystringParameter
```
void addQuerystringParameter(String key,
                           String value)
```
    Add a QueryString parameter
    
    Parameters:
    key - the parameter name
    value - the parameter value
  - addPayload
```
void addPayload(String payload)
```
    Add body payload from a String
    
    Parameters:
    payload - the payload to add to body
  - addPayload
```
void addPayload(byte[] payload)
```
    Add body payload from an Array of bytes
    
    Parameters:
    payload - the payload to add to body
  - getQueryStringParams
```
HttpParameters getQueryStringParams()
```
    Get a HttpParameters with the query string parameters.
    
    Returns:
    a parameter list containing the query string parameters.
    
    Throws:
    
    AgoravaException - if the request URL is not valid.
  - getBodyParams
```
HttpParameters getBodyParams()
```
    Obtains a HttpParameters of the body parameters.
    
    Returns:
    a a parameter list containing the query string parameters containing the body parameters.
  - getUrl
```
String getUrl()
```
    Obtains the URL of the HTTP Request.
    
    Returns:
    the original URL of the HTTP Request
  - getSanitizedUrl
```
String getSanitizedUrl()
```
    Returns the URL without the port and the query string part.
    
    Returns:
    the OAuth-sanitized URL
  - getBodyContents
```
String getBodyContents()
```
    Returns the body of the request
    
    Returns:
    form encoded string
    
    Throws:
    
    AgoravaException - if the charset chosen is not supported
  - getVerb
```
Verb getVerb()
```
    Returns the HTTP Verb
    
    Returns:
    the verb
  - getHeaders
```
Map<String,String> getHeaders()
```
    Returns the connection headers as a Map
    
    Returns:
    map of headers
  - getCharset
```
String getCharset()
```
    Returns the connection charset. Defaults to Charset defaultCharset if not set
    
    Returns:
    charset
  - setCharset
```
void setCharset(String charsetName)
```
    Set the charset of the body of the request
    
    Parameters:
    charsetName - name of the charset of the request
  - setConnectTimeout
```
void setConnectTimeout(int duration,
                     TimeUnit unit)
```
    Sets the connect timeout for the underlying HttpURLConnection
    
    Parameters:
    duration - duration of the timeout
    unit - unit of time (milliseconds, seconds, etc)
  - setReadTimeout
```
void setReadTimeout(int duration,
                  TimeUnit unit)
```
    Sets the read timeout for the underlying HttpURLConnection
    
    Parameters:
    duration - duration of the timeout
    unit - unit of time (milliseconds, seconds, etc)
  - setConnectionKeepAlive
```
void setConnectionKeepAlive(boolean connectionKeepAlive)
```
    Sets whether the underlying Http Connection is persistent or not.
    
    Parameters:
    connectionKeepAlive - if true the connection is persistent
    See Also:
    JSE doc on http keepalive
  - addBodyParameters
```
void addBodyParameters(Map<String,? extends Object> params)
```
    Add Body parameters from a map
    
    Parameters:
    params - map containing parameters to add

Interface Request

Method Summary

Method Detail

send

send

getCompleteUrl

addHeader

addBodyParameter

addQuerystringParameter

addPayload

addPayload

getQueryStringParams

getBodyParams

getUrl

getSanitizedUrl

getBodyContents

getVerb

getHeaders

getCharset

setCharset

setConnectTimeout

setReadTimeout

setConnectionKeepAlive

addBodyParameters