HttpRequestOptions (OpenID4Java 1.0.0 API)

java.lang.Object
- org.openid4java.util.HttpRequestOptions

```
public class HttpRequestOptions
extends Object
```
Container class for the various options associated with HTTP requests.

Author:

Marius Scurtescu, Johnny Bufu

See Also:
HttpCache

Constructor Summary

Constructors
Constructor and Description
`HttpRequestOptions()` Constructs a set of HTTP request options with the default values.
`HttpRequestOptions(HttpRequestOptions other)` Creates a new HttpRequestOptions object as a clone of the provided parameter.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRequestHeader(String headerName, String headerValue)` Adds a new HTTP request header.
`boolean`	`getAllowCircularRedirects()`
`long`	`getCacheTTLSeconds()` Gets the TTL for the cached response in seconds
`int`	`getConnTimeout()` Gets the HTTP connect timeout, in milliseconds.
`String`	`getContentType()` Gets the required content-type for the HTTP response.
`static HttpRequestOptions`	`getDefaultOptionsForDiscovery()` Returns an `HttpRequestOptions` object suitable to use for HTTP requests to perform discovery.
`static HttpRequestOptions`	`getDefaultOptionsForOpCalls()` Returns an `HttpRequestOptions` object suitable to use for HTTP requests to OP endpoints for the purpose of creating associations or verifying signatures.
`int`	`getMaxBodySize()` Gets configuration parameter for the maximum HTTP body size that will be downloaded.
`int`	`getMaxRedirects()` Gets the internal limit configured for the maximum number of redirects to be followed for the HTTP calls.
`Map`	`getRequestHeaders()` Gets the HTTP request headers that will be used when placing HTTP requests using the options in this object.
`int`	`getSocketTimeout()` Gets the HTTP socket (read) timeout, in milliseconds.
`boolean`	`isUseCache()` Returns true if a cached copy can be used when placing HTTP requests using the options in this object.
`void`	`setAllowCircularRedirects(boolean allow)`
`void`	`setCacheTTLSeconds(long ttl)` Sets the TTL for the cached response in seconds
`void`	`setConnTimeout(int connTimeout)` Sets the HTTP connect timeout, in milliseconds.
`void`	`setContentType(String contentType)` Sets the required content-type for the HTTP response.
`void`	`setMaxBodySize(int maxBodySize)` Sets the maximum HTTP body size that will be downloaded.
`void`	`setMaxRedirects(int maxRedirects)` Sets the maximum number of redirects to be followed for the HTTP calls.
`void`	`setRequestHeaders(Map requestHeaders)` Sets the HTTP request headers that will be used when placing HTTP requests using the options in this object.
`void`	`setSocketTimeout(int socketTimeout)` Sets HTTP socket (read) timeout, in milliseconds.
`void`	`setUseCache(boolean useCache)` Sets the flag for allowing cached copy to be used when placing HTTP requests using the options in this object.

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

- Constructor Detail
  - HttpRequestOptions
```
public HttpRequestOptions()
```
    Constructs a set of HTTP request options with the default values.
  - HttpRequestOptions
```
public HttpRequestOptions(HttpRequestOptions other)
```
    Creates a new HttpRequestOptions object as a clone of the provided parameter.
    
    Parameters:
    other - HttpRequestOptions instance to be cloned.
- Method Detail
  - getDefaultOptionsForDiscovery
```
public static HttpRequestOptions getDefaultOptionsForDiscovery()
```
    Returns an HttpRequestOptions object suitable to use for HTTP requests to perform discovery.
  - getDefaultOptionsForOpCalls
```
public static HttpRequestOptions getDefaultOptionsForOpCalls()
```
    Returns an HttpRequestOptions object suitable to use for HTTP requests to OP endpoints for the purpose of creating associations or verifying signatures.
  - getConnTimeout
```
public int getConnTimeout()
```
    Gets the HTTP connect timeout, in milliseconds.
  - setConnTimeout
```
public void setConnTimeout(int connTimeout)
```
    Sets the HTTP connect timeout, in milliseconds.
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Gets the HTTP socket (read) timeout, in milliseconds.
  - setSocketTimeout
```
public void setSocketTimeout(int socketTimeout)
```
    Sets HTTP socket (read) timeout, in milliseconds.
  - getMaxRedirects
```
public int getMaxRedirects()
```
    Gets the internal limit configured for the maximum number of redirects to be followed for the HTTP calls.
  - setMaxRedirects
```
public void setMaxRedirects(int maxRedirects)
```
    Sets the maximum number of redirects to be followed for the HTTP calls.
  - getMaxBodySize
```
public int getMaxBodySize()
```
    Gets configuration parameter for the maximum HTTP body size that will be downloaded.
  - setMaxBodySize
```
public void setMaxBodySize(int maxBodySize)
```
    Sets the maximum HTTP body size that will be downloaded.
  - getRequestHeaders
```
public Map getRequestHeaders()
```
    Gets the HTTP request headers that will be used when placing HTTP requests using the options in this object.
  - setRequestHeaders
```
public void setRequestHeaders(Map requestHeaders)
```
    Sets the HTTP request headers that will be used when placing HTTP requests using the options in this object.
  - addRequestHeader
```
public void addRequestHeader(String headerName,
                    String headerValue)
```
    Adds a new HTTP request header.
  - isUseCache
```
public boolean isUseCache()
```
    Returns true if a cached copy can be used when placing HTTP requests using the options in this object. This applies to the internally implemented HTTP cache, NOT to the HTTP protocol cache-control.
  - setUseCache
```
public void setUseCache(boolean useCache)
```
    Sets the flag for allowing cached copy to be used when placing HTTP requests using the options in this object. This applies to the internally implemented HTTP cache, NOT to the HTTP protocol cache-control.
  - getContentType
```
public String getContentType()
```
    Gets the required content-type for the HTTP response. If this option matches the content-type of a cached response, the cached copy is used; otherwise a new HTTP request is made.
  - setContentType
```
public void setContentType(String contentType)
```
    Sets the required content-type for the HTTP response. If this option matches the content-type of a cached response, the cached copy is used; otherwise a new HTTP request is made.
  - getAllowCircularRedirects
```
public boolean getAllowCircularRedirects()
```
  - setAllowCircularRedirects
```
public void setAllowCircularRedirects(boolean allow)
```
  - getCacheTTLSeconds
```
public long getCacheTTLSeconds()
```
    Gets the TTL for the cached response in seconds
  - setCacheTTLSeconds
```
public void setCacheTTLSeconds(long ttl)
```
    Sets the TTL for the cached response in seconds

Class HttpRequestOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpRequestOptions

HttpRequestOptions

Method Detail

getDefaultOptionsForDiscovery

getDefaultOptionsForOpCalls

getConnTimeout

setConnTimeout

getSocketTimeout

setSocketTimeout

getMaxRedirects

setMaxRedirects

getMaxBodySize

setMaxBodySize

getRequestHeaders

setRequestHeaders

addRequestHeader

isUseCache

setUseCache

getContentType

setContentType

getAllowCircularRedirects

setAllowCircularRedirects

getCacheTTLSeconds

setCacheTTLSeconds