| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| private final boolean | |
| private final boolean | |
| private final int | |
| private final int | |
| private final boolean | |
| private final String | |
| public static final RequestConfig | |
| private final boolean | |
| private final InetAddress | |
| private final int | |
| private final boolean | |
| private final HttpHost | |
| private final Collection | |
| private final boolean | |
| private final boolean | |
| private final int | |
| private final boolean | |
| private final Collection |
| Access | Constructor and Description |
|---|---|
| protected | |
| pack-priv | RequestConfig(final boolean expectContinueEnabled, final HttpHost proxy, final InetAddress localAddress, final boolean staleConnectionCheckEnabled, final String cookieSpec, final boolean redirectsEnabled, final boolean relativeRedirectsAllowed, final boolean circularRedirectsAllowed, final int maxRedirects, final boolean authenticationEnabled, final Collection<String> targetPreferredAuthSchemes, final Collection<String> proxyPreferredAuthSchemes, final int connectionRequestTimeout, final int connectTimeout, final int socketTimeout, final boolean contentCompressionEnabled, final boolean normalizeUri)
|
| Modifier and Type | Method and Description |
|---|---|
| protected RequestConfig | |
| public static RequestConfig. | |
| public static RequestConfig. | |
| public int | getConnectionRequestTimeout()
Returns the timeout in milliseconds used when requesting a connection from the connection manager. |
| public int | |
| public String | getCookieSpec()
Determines the name of the cookie specification to be used for HTTP state management. |
| public InetAddress | |
| public int | |
| public HttpHost | |
| public Collection | getProxyPreferredAuthSchemes()
Determines the order of preference for supported authentication schemes when authenticating with the proxy host. |
| public int | getSocketTimeout()
Defines the socket timeout ( |
| public Collection | getTargetPreferredAuthSchemes()
Determines the order of preference for supported authentication schemes when authenticating with the target host. |
| public boolean | |
| public boolean | isCircularRedirectsAllowed()
Determines whether circular redirects (redirects to the same location) should be allowed. |
| public boolean | |
| public boolean | isDecompressionEnabled()
Deprecated
(4.5) Use
Determines whether compressed entities should be decompressed automatically.
isContentCompressionEnabled()
|
| public boolean | isExpectContinueEnabled()
Determines whether the 'Expect: 100-Continue' handshake is enabled for entity enclosing methods. |
| public boolean | |
| public boolean | |
| public boolean | |
| public boolean | isStaleConnectionCheckEnabled()
Determines whether stale connection check is to be used.
|
| public String |
| authenticationEnabled | back to summary |
|---|---|
| private final boolean authenticationEnabled | |
| circularRedirectsAllowed | back to summary |
|---|---|
| private final boolean circularRedirectsAllowed | |
| connectionRequestTimeout | back to summary |
|---|---|
| private final int connectionRequestTimeout | |
| connectTimeout | back to summary |
|---|---|
| private final int connectTimeout | |
| contentCompressionEnabled | back to summary |
|---|---|
| private final boolean contentCompressionEnabled | |
| cookieSpec | back to summary |
|---|---|
| private final String cookieSpec | |
| DEFAULT | back to summary |
|---|---|
| public static final RequestConfig DEFAULT | |
| expectContinueEnabled | back to summary |
|---|---|
| private final boolean expectContinueEnabled | |
| localAddress | back to summary |
|---|---|
| private final InetAddress localAddress | |
| maxRedirects | back to summary |
|---|---|
| private final int maxRedirects | |
| normalizeUri | back to summary |
|---|---|
| private final boolean normalizeUri | |
| proxy | back to summary |
|---|---|
| private final HttpHost proxy | |
| proxyPreferredAuthSchemes | back to summary |
|---|---|
| private final Collection<String> proxyPreferredAuthSchemes | |
| redirectsEnabled | back to summary |
|---|---|
| private final boolean redirectsEnabled | |
| relativeRedirectsAllowed | back to summary |
|---|---|
| private final boolean relativeRedirectsAllowed | |
| socketTimeout | back to summary |
|---|---|
| private final int socketTimeout | |
| staleConnectionCheckEnabled | back to summary |
|---|---|
| private final boolean staleConnectionCheckEnabled | |
| targetPreferredAuthSchemes | back to summary |
|---|---|
| private final Collection<String> targetPreferredAuthSchemes | |
| RequestConfig | back to summary |
|---|---|
| protected RequestConfig() Intended for CDI compatibility | |
| RequestConfig | back to summary |
|---|---|
| pack-priv RequestConfig(final boolean expectContinueEnabled, final HttpHost proxy, final InetAddress localAddress, final boolean staleConnectionCheckEnabled, final String cookieSpec, final boolean redirectsEnabled, final boolean relativeRedirectsAllowed, final boolean circularRedirectsAllowed, final int maxRedirects, final boolean authenticationEnabled, final Collection<String> targetPreferredAuthSchemes, final Collection<String> proxyPreferredAuthSchemes, final int connectionRequestTimeout, final int connectTimeout, final int socketTimeout, final boolean contentCompressionEnabled, final boolean normalizeUri) | |
| clone | back to summary |
|---|---|
| protected RequestConfig clone() throws CloneNotSupportedException Overrides java. Doc from java. Creates and returns a copy of this object. The precise meaning
of "copy" may depend on the class of the object. The general
intent is that, for any object will be true, and that the expression:x.clone() != x will bex.clone().getClass() == x.getClass() true, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x) true, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by
| |
| copy | back to summary |
|---|---|
public static RequestConfig.
| |
| custom | back to summary |
|---|---|
| public static RequestConfig. | |
| getConnectionRequestTimeout | back to summary |
|---|---|
| public int getConnectionRequestTimeout() Returns the timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default if applicable).
Default: | |
| getConnectTimeout | back to summary |
|---|---|
| public int getConnectTimeout() Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default if applicable).
Default: | |
| getCookieSpec | back to summary |
|---|---|
| public String getCookieSpec() Determines the name of the cookie specification to be used for HTTP state management.
Default: | |
| getLocalAddress | back to summary |
|---|---|
| public InetAddress getLocalAddress() Returns local address to be used for request execution. On machines with multiple network interfaces, this parameter can be used to select the network interface from which the connection originates.
Default: | |
| getMaxRedirects | back to summary |
|---|---|
| public int getMaxRedirects() Returns the maximum number of redirects to be followed. The limit on number of redirects is intended to prevent infinite loops.
Default: | |
| getProxy | back to summary |
|---|---|
| public HttpHost getProxy() Returns HTTP proxy to be used for request execution.
Default: | |
| getProxyPreferredAuthSchemes | back to summary |
|---|---|
| public Collection Determines the order of preference for supported authentication schemes when authenticating with the proxy host.
Default: | |
| getSocketTimeout | back to summary |
|---|---|
| public int getSocketTimeout() Defines the socket timeout ( A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default if applicable).
Default: | |
| getTargetPreferredAuthSchemes | back to summary |
|---|---|
| public Collection Determines the order of preference for supported authentication schemes when authenticating with the target host.
Default: | |
| isAuthenticationEnabled | back to summary |
|---|---|
| public boolean isAuthenticationEnabled() Determines whether authentication should be handled automatically.
Default: | |
| isCircularRedirectsAllowed | back to summary |
|---|---|
| public boolean isCircularRedirectsAllowed() Determines whether circular redirects (redirects to the same location) should be allowed. The HTTP spec is not sufficiently clear whether circular redirects are permitted, therefore optionally they can be enabled
Default: | |
| isContentCompressionEnabled | back to summary |
|---|---|
| public boolean isContentCompressionEnabled() Determines whether the target server is requested to compress content.
Default:
| |
| isDecompressionEnabled | back to summary |
|---|---|
| public boolean isDecompressionEnabled()
Deprecated (4.5) Use Determines whether compressed entities should be decompressed automatically.
Default:
| |
| isExpectContinueEnabled | back to summary |
|---|---|
| public boolean isExpectContinueEnabled() Determines whether the 'Expect: 100-Continue' handshake is enabled for entity enclosing methods. The purpose of the 'Expect: 100-Continue' handshake is to allow a client that is sending a request message with a request body to determine if the origin server is willing to accept the request (based on the request headers) before the client sends the request body. 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: | |
| isNormalizeUri | back to summary |
|---|---|
| public boolean isNormalizeUri() Determines whether client should normalize URIs in requests or not.
Default:
| |
| isRedirectsEnabled | back to summary |
|---|---|
| public boolean isRedirectsEnabled() Determines whether redirects should be handled automatically.
Default: | |
| isRelativeRedirectsAllowed | back to summary |
|---|---|
| public boolean isRelativeRedirectsAllowed() Determines whether relative redirects should be rejected. HTTP specification requires the location value be an absolute URI.
Default: | |
| isStaleConnectionCheckEnabled | back to summary |
|---|---|
| public boolean isStaleConnectionCheckEnabled()
Deprecated (4.4) Use Determines whether stale connection check is to be used. The stale connection check can cause up to 30 millisecond overhead per request and should be used only when appropriate. For performance critical operations this check should be disabled.
Default:
| |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Doc from java. Returns a string representation of the object. | |
| Modifier and Type | Field and Description |
|---|---|
| private boolean | |
| private boolean | |
| private int | |
| private int | |
| private boolean | |
| private String | |
| private boolean | |
| private InetAddress | |
| private int | |
| private boolean | |
| private HttpHost | |
| private Collection | |
| private boolean | |
| private boolean | |
| private int | |
| private boolean | |
| private Collection |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| public RequestConfig | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | setDecompressionEnabled(final boolean decompressionEnabled)
Deprecated
(4.5) Set
setContentCompressionEnabled(boolean) to false and
add the Accept-Encoding request header.
|
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | |
| public RequestConfig. | setStaleConnectionCheckEnabled(final boolean staleConnectionCheckEnabled)
|
| public RequestConfig. |
| authenticationEnabled | back to summary |
|---|---|
| private boolean authenticationEnabled | |
| circularRedirectsAllowed | back to summary |
|---|---|
| private boolean circularRedirectsAllowed | |
| connectionRequestTimeout | back to summary |
|---|---|
| private int connectionRequestTimeout | |
| connectTimeout | back to summary |
|---|---|
| private int connectTimeout | |
| contentCompressionEnabled | back to summary |
|---|---|
| private boolean contentCompressionEnabled | |
| cookieSpec | back to summary |
|---|---|
| private String cookieSpec | |
| expectContinueEnabled | back to summary |
|---|---|
| private boolean expectContinueEnabled | |
| localAddress | back to summary |
|---|---|
| private InetAddress localAddress | |
| maxRedirects | back to summary |
|---|---|
| private int maxRedirects | |
| normalizeUri | back to summary |
|---|---|
| private boolean normalizeUri | |
| proxy | back to summary |
|---|---|
| private HttpHost proxy | |
| proxyPreferredAuthSchemes | back to summary |
|---|---|
| private Collection<String> proxyPreferredAuthSchemes | |
| redirectsEnabled | back to summary |
|---|---|
| private boolean redirectsEnabled | |
| relativeRedirectsAllowed | back to summary |
|---|---|
| private boolean relativeRedirectsAllowed | |
| socketTimeout | back to summary |
|---|---|
| private int socketTimeout | |
| staleConnectionCheckEnabled | back to summary |
|---|---|
| private boolean staleConnectionCheckEnabled | |
| targetPreferredAuthSchemes | back to summary |
|---|---|
| private Collection<String> targetPreferredAuthSchemes | |
| Builder | back to summary |
|---|---|
| pack-priv Builder() | |
| build | back to summary |
|---|---|
| public RequestConfig build() | |
| setAuthenticationEnabled | back to summary |
|---|---|
| public RequestConfig. | |
| setCircularRedirectsAllowed | back to summary |
|---|---|
| public RequestConfig. | |
| setConnectionRequestTimeout | back to summary |
|---|---|
| public RequestConfig. | |
| setConnectTimeout | back to summary |
|---|---|
| public RequestConfig. | |
| setContentCompressionEnabled | back to summary |
|---|---|
| public RequestConfig. | |
| setCookieSpec | back to summary |
|---|---|
| public RequestConfig. | |
| setDecompressionEnabled | back to summary |
|---|---|
| public RequestConfig. Deprecated (4.5) Set
| |
| setExpectContinueEnabled | back to summary |
|---|---|
| public RequestConfig. | |
| setLocalAddress | back to summary |
|---|---|
| public RequestConfig. | |
| setMaxRedirects | back to summary |
|---|---|
| public RequestConfig. | |
| setNormalizeUri | back to summary |
|---|---|
| public RequestConfig. | |
| setProxy | back to summary |
|---|---|
| public RequestConfig. | |
| setProxyPreferredAuthSchemes | back to summary |
|---|---|
| public RequestConfig. | |
| setRedirectsEnabled | back to summary |
|---|---|
| public RequestConfig. | |
| setRelativeRedirectsAllowed | back to summary |
|---|---|
| public RequestConfig. | |
| setSocketTimeout | back to summary |
|---|---|
| public RequestConfig. | |
| setStaleConnectionCheckEnabled | back to summary |
|---|---|
| public RequestConfig. Deprecated (4.4) Use
| |
| setTargetPreferredAuthSchemes | back to summary |
|---|---|
| public RequestConfig. | |