RestRequest (Seam Social Module API 3.2.0.Final API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

OAuthRequest
```
public interface RestRequest
extends Serializable
```
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> toAdd)`
`void`	`addHeader(String key, String value)` Add an HTTP Header to the Request
`void`	`addPayload(byte[] payload)`
`void`	`addPayload(String payload)` Add body payload.
`void`	`addQuerystringParameter(String key, String value)` Add a QueryString parameter
`String`	`getBodyContents()`
`RestParameterList`	`getBodyParams()` Obtains a `Map` of the body parameters.
`String`	`getCharset()`
`String`	`getCompleteUrl()`
`Map<String,String>`	`getHeaders()` Returns the connection headers as a `Map`
`RestParameterList`	`getQueryStringParams()` Get a `Map` of 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.
`RestVerb`	`getVerb()`
`RestResponse`	`send()` Execute the request and return a `HttpResonse`
`void`	`setCharset(String charsetName)`
`void`	`setConnectionKeepAlive(boolean connectionKeepAlive)`
`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
```
RestResponse send()
```
    Execute the request and return a HttpResonse
    
    Returns:
    Rest Response
  - 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
  - addBodyParameters
```
void addBodyParameters(Map<String,? extends Object> toAdd)
```
  - 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. This method is used when the HTTP body is not a form-url-encoded string, but another thing. Like for example XML.
    
    Parameters:
    payload - the body of the request
  - getQueryStringParams
```
RestParameterList getQueryStringParams()
```
    Get a Map of the query string parameters.
    
    Returns:
    a map containing the query string parameters
    
    Throws:
    
    OAuthException - if the URL is not valid
  - getBodyParams
```
RestParameterList getBodyParams()
```
    Obtains a Map of the body parameters.
    
    Returns:
    a map 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 sanitized URL
  - getBodyContents
```
String getBodyContents()
```
    Returns:
    the Body of the request
  - getVerb
```
RestVerb getVerb()
```
    Returns:
    the REST verb
  - getHeaders
```
Map<String,String> getHeaders()
```
    Returns the connection headers as a Map
    
    Returns:
    map of headers
  - 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)
  - getCompleteUrl
```
String getCompleteUrl()
```
    Returns:
  - addPayload
```
void addPayload(byte[] payload)
```
    Parameters:
    payload -
  - getCharset
```
String getCharset()
```
    Returns:
  - setCharset
```
void setCharset(String charsetName)
```
    Parameters:
    charsetName -
  - setConnectionKeepAlive
```
void setConnectionKeepAlive(boolean connectionKeepAlive)
```
    Parameters:
    connectionKeepAlive -

Interface RestRequest

Method Summary

Method Detail

send

addHeader

addBodyParameter

addBodyParameters

addQuerystringParameter

addPayload

getQueryStringParams

getBodyParams

getUrl

getSanitizedUrl

getBodyContents

getVerb

getHeaders

setConnectTimeout

setReadTimeout

getCompleteUrl

addPayload

getCharset

setCharset

setConnectionKeepAlive