@Contract(threading=IMMUTABLE) public class RequestConfig extends Object implements Cloneable
Modifier and Type | Class and Description |
---|---|
static class |
RequestConfig.Builder |
Modifier and Type | Field and Description |
---|---|
private boolean |
authenticationEnabled |
private boolean |
circularRedirectsAllowed |
private int |
connectionRequestTimeout |
private int |
connectTimeout |
private boolean |
contentCompressionEnabled |
private String |
cookieSpec |
static RequestConfig |
DEFAULT |
private boolean |
expectContinueEnabled |
private InetAddress |
localAddress |
private int |
maxRedirects |
private HttpHost |
proxy |
private Collection<String> |
proxyPreferredAuthSchemes |
private boolean |
redirectsEnabled |
private boolean |
relativeRedirectsAllowed |
private int |
socketTimeout |
private boolean |
staleConnectionCheckEnabled |
private Collection<String> |
targetPreferredAuthSchemes |
Modifier | Constructor and Description |
---|---|
protected |
RequestConfig()
Intended for CDI compatibility
|
(package private) |
RequestConfig(boolean expectContinueEnabled,
HttpHost proxy,
InetAddress localAddress,
boolean staleConnectionCheckEnabled,
String cookieSpec,
boolean redirectsEnabled,
boolean relativeRedirectsAllowed,
boolean circularRedirectsAllowed,
int maxRedirects,
boolean authenticationEnabled,
Collection<String> targetPreferredAuthSchemes,
Collection<String> proxyPreferredAuthSchemes,
int connectionRequestTimeout,
int connectTimeout,
int socketTimeout,
boolean contentCompressionEnabled) |
Modifier and Type | Method and Description |
---|---|
protected RequestConfig |
clone() |
static RequestConfig.Builder |
copy(RequestConfig config) |
static RequestConfig.Builder |
custom() |
int |
getConnectionRequestTimeout()
Returns the timeout in milliseconds used when requesting a connection
from the connection manager.
|
int |
getConnectTimeout()
Determines the timeout in milliseconds until a connection is established.
|
String |
getCookieSpec()
Determines the name of the cookie specification to be used for HTTP state
management.
|
InetAddress |
getLocalAddress()
Returns local address to be used for request execution.
|
int |
getMaxRedirects()
Returns the maximum number of redirects to be followed.
|
HttpHost |
getProxy()
Returns HTTP proxy to be used for request execution.
|
Collection<String> |
getProxyPreferredAuthSchemes()
Determines the order of preference for supported authentication schemes
when authenticating with the proxy host.
|
int |
getSocketTimeout()
Defines the socket timeout (
SO_TIMEOUT ) in milliseconds,
which is the timeout for waiting for data or, put differently,
a maximum period inactivity between two consecutive data packets). |
Collection<String> |
getTargetPreferredAuthSchemes()
Determines the order of preference for supported authentication schemes
when authenticating with the target host.
|
boolean |
isAuthenticationEnabled()
Determines whether authentication should be handled automatically.
|
boolean |
isCircularRedirectsAllowed()
Determines whether circular redirects (redirects to the same location) should
be allowed.
|
boolean |
isContentCompressionEnabled()
Determines whether the target server is requested to compress content.
|
boolean |
isDecompressionEnabled()
Deprecated.
(4.5) Use
isContentCompressionEnabled() |
boolean |
isExpectContinueEnabled()
Determines whether the 'Expect: 100-Continue' handshake is enabled
for entity enclosing methods.
|
boolean |
isRedirectsEnabled()
Determines whether redirects should be handled automatically.
|
boolean |
isRelativeRedirectsAllowed()
Determines whether relative redirects should be rejected.
|
boolean |
isStaleConnectionCheckEnabled()
Deprecated.
|
String |
toString() |
public static final RequestConfig DEFAULT
private final boolean expectContinueEnabled
private final InetAddress localAddress
private final boolean staleConnectionCheckEnabled
private final String cookieSpec
private final boolean redirectsEnabled
private final boolean relativeRedirectsAllowed
private final boolean circularRedirectsAllowed
private final int maxRedirects
private final boolean authenticationEnabled
private final Collection<String> targetPreferredAuthSchemes
private final Collection<String> proxyPreferredAuthSchemes
private final int connectionRequestTimeout
private final int connectTimeout
private final int socketTimeout
private final boolean contentCompressionEnabled
protected RequestConfig()
RequestConfig(boolean expectContinueEnabled, HttpHost proxy, InetAddress localAddress, boolean staleConnectionCheckEnabled, String cookieSpec, boolean redirectsEnabled, boolean relativeRedirectsAllowed, boolean circularRedirectsAllowed, int maxRedirects, boolean authenticationEnabled, Collection<String> targetPreferredAuthSchemes, Collection<String> proxyPreferredAuthSchemes, int connectionRequestTimeout, int connectTimeout, int socketTimeout, boolean contentCompressionEnabled)
public boolean isExpectContinueEnabled()
The use of the 'Expect: 100-continue' handshake can result in a noticeable performance improvement for entity enclosing requests (such as POST and PUT) that require the target server's authentication.
'Expect: 100-continue' handshake should be used with caution, as it may cause problems with HTTP servers and proxies that do not support HTTP/1.1 protocol.
Default: false
public HttpHost getProxy()
Default: null
public InetAddress getLocalAddress()
On machines with multiple network interfaces, this parameter can be used to select the network interface from which the connection originates.
Default: null
@Deprecated public boolean isStaleConnectionCheckEnabled()
PoolingHttpClientConnectionManager.getValidateAfterInactivity()
Default: false
since 4.4
public String getCookieSpec()
Default: null
public boolean isRedirectsEnabled()
Default: true
public boolean isRelativeRedirectsAllowed()
Default: true
public boolean isCircularRedirectsAllowed()
Default: false
public int getMaxRedirects()
Default: 50
public boolean isAuthenticationEnabled()
Default: true
public Collection<String> getTargetPreferredAuthSchemes()
Default: null
public Collection<String> getProxyPreferredAuthSchemes()
Default: null
public int getConnectionRequestTimeout()
A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).
Default: -1
public int getConnectTimeout()
A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).
Default: -1
public int getSocketTimeout()
SO_TIMEOUT
) in milliseconds,
which is the timeout for waiting for data or, put differently,
a maximum period inactivity between two consecutive data packets).
A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).
Default: -1
@Deprecated public boolean isDecompressionEnabled()
isContentCompressionEnabled()
Default: true
public boolean isContentCompressionEnabled()
Default: true
protected RequestConfig clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
public static RequestConfig.Builder custom()
public static RequestConfig.Builder copy(RequestConfig config)
WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses