Request (The Adobe Experience Manager SDK 2020.6.3800.20200626T210738Z-200604)

java.lang.Object
- org.scribe.model.Request

Direct Known Subclasses:

OAuthRequest
```
public class Request
extends Object
```
Represents an HTTP Request object

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_CONTENT_TYPE

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CONTENT_TYPE`

Constructor Summary

Constructors
Constructor and Description

Request(Verb verb, String url)
Creates a new Http Request

Constructors
Constructor and Description
`Request(Verb verb, String url)` Creates a new Http Request

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBodyParameter(String key, String value)` Add a body Parameter (for POST/ PUT Requests)
`void`	`addHeader(String key, String value)` Add an HTTP Header to the Request
`void`	`addPayload(byte[] payload)` Overloaded version for byte arrays
`void`	`addPayload(String payload)` Add body payload.
`void`	`addQuerystringParameter(String key, String value)` Add a QueryString parameter
`String`	`getBodyContents()` Returns the body of the request
`ParameterList`	`getBodyParams()` Obtains a `ParameterList` 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`
`ParameterList`	`getQueryStringParams()` Get a `ParameterList` 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()`
`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`	`setFollowRedirects(boolean followRedirects)` Sets whether the underlying Http Connection follows redirects or not.
`void`	`setReadTimeout(int duration, TimeUnit unit)` Sets the read timeout for the underlying `HttpURLConnection`
`String`	`toString()`

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

- Field Detail
  - DEFAULT_CONTENT_TYPE
```
public static final String DEFAULT_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Request
```
public Request(Verb verb,
               String url)
```
    Creates a new Http Request
    
    Parameters:
    
    verb - Http Verb (GET, POST, etc)
    
    url - url with optional querystring parameters.
- Method Detail
  - send
```
public Response send(RequestTuner tuner)
```
    Execute the request and return a Response
    
    Returns:
    
    Http Response
    
    Throws:
    
    RuntimeException - if the connection cannot be created.
  - send
```
public Response send()
```
  - getCompleteUrl
```
public String getCompleteUrl()
```
    Returns the complete url (host + resource + encoded querystring parameters).
    
    Returns:
    
    the complete url.
  - addHeader
```
public void addHeader(String key,
                      String value)
```
    Add an HTTP Header to the Request
    
    Parameters:
    
    key - the header name
    
    value - the header value
  - addBodyParameter
```
public void addBodyParameter(String key,
                             String value)
```
    Add a body Parameter (for POST/ PUT Requests)
    
    Parameters:
    
    key - the parameter name
    
    value - the parameter value
  - addQuerystringParameter
```
public void addQuerystringParameter(String key,
                                    String value)
```
    Add a QueryString parameter
    
    Parameters:
    
    key - the parameter name
    
    value - the parameter value
  - addPayload
```
public 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. Note: The contents are not part of the OAuth signature
    
    Parameters:
    
    payload - the body of the request
  - addPayload
```
public void addPayload(byte[] payload)
```
    Overloaded version for byte arrays
    
    Parameters:
    
    payload -
  - getQueryStringParams
```
public ParameterList getQueryStringParams()
```
    Get a ParameterList with the query string parameters.
    
    Returns:
    
    a ParameterList containing the query string parameters.
    
    Throws:
    
    OAuthException - if the request URL is not valid.
  - getBodyParams
```
public ParameterList getBodyParams()
```
    Obtains a ParameterList of the body parameters.
    
    Returns:
    
    a ParameterListcontaining the body parameters.
  - getUrl
```
public String getUrl()
```
    Obtains the URL of the HTTP Request.
    
    Returns:
    
    the original URL of the HTTP Request
  - getSanitizedUrl
```
public String getSanitizedUrl()
```
    Returns the URL without the port and the query string part.
    
    Returns:
    
    the OAuth-sanitized URL
  - getBodyContents
```
public String getBodyContents()
```
    Returns the body of the request
    
    Returns:
    
    form encoded string
    
    Throws:
    
    OAuthException - if the charset chosen is not supported
  - getVerb
```
public Verb getVerb()
```
    Returns the HTTP Verb
    
    Returns:
    
    the verb
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Returns the connection headers as a Map
    
    Returns:
    
    map of headers
  - getCharset
```
public String getCharset()
```
    Returns the connection charset. Defaults to Charset defaultCharset if not set
    
    Returns:
    
    charset
  - setConnectTimeout
```
public 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
```
public 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)
  - setCharset
```
public void setCharset(String charsetName)
```
    Set the charset of the body of the request
    
    Parameters:
    
    charsetName - name of the charset of the request
  - setConnectionKeepAlive
```
public void setConnectionKeepAlive(boolean connectionKeepAlive)
```
    Sets whether the underlying Http Connection is persistent or not.
    
    Parameters:
    
    connectionKeepAlive -
    
    See Also:
    
    http://download.oracle.com/javase/1.5.0/docs/guide/net/http-keepalive.html
  - setFollowRedirects
```
public void setFollowRedirects(boolean followRedirects)
```
    Sets whether the underlying Http Connection follows redirects or not. Defaults to true (follow redirects)
    
    Parameters:
    
    followRedirects -
    
    See Also:
    
    http://docs.oracle.com/javase/6/docs/api/java/net/HttpURLConnection.html#setInstanceFollowRedirects(boolean)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Request

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CONTENT_TYPE

Constructor Detail

Request

Method Detail

send

send

getCompleteUrl

addHeader

addBodyParameter

addQuerystringParameter

addPayload

addPayload

getQueryStringParams

getBodyParams

getUrl

getSanitizedUrl

getBodyContents

getVerb

getHeaders

getCharset

setConnectTimeout

setReadTimeout

setCharset

setConnectionKeepAlive

setFollowRedirects

toString