| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.client.config.RequestConfig
@Contract(threading=IMMUTABLE) public class RequestConfig
Immutable class encapsulating request configuration items. The default setting for stale connection checking changed to false, and the feature was deprecated starting with version 4.4.
| Nested Class Summary | |
|---|---|
| static class | RequestConfig.Builder | 
| Field Summary | |
|---|---|
| static RequestConfig | DEFAULT | 
| Constructor Summary | |
|---|---|
| protected  | RequestConfig()Intended for CDI compatibility | 
| Method Summary | |
|---|---|
| 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. | 
|  org.apache.http.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 | isNormalizeUri()Determines whether client should normalize URIs in requests or not. | 
|  boolean | isRedirectsEnabled()Determines whether redirects should be handled automatically. | 
|  boolean | isRelativeRedirectsAllowed()Determines whether relative redirects should be rejected. | 
|  boolean | isStaleConnectionCheckEnabled()Deprecated. (4.4) Use PoolingHttpClientConnectionManager.getValidateAfterInactivity() | 
|  String | toString() | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Field Detail | 
|---|
public static final RequestConfig DEFAULT
| Constructor Detail | 
|---|
protected RequestConfig()
| Method Detail | 
|---|
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 org.apache.http.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 if applicable).
 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 if applicable).
 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 if applicable).
 Default: -1
 
@Deprecated public boolean isDecompressionEnabled()
isContentCompressionEnabled()
 Default: true
 
public boolean isContentCompressionEnabled()
 Default: true
 
public boolean isNormalizeUri()
 Default: true
 
protected RequestConfig clone()
                       throws CloneNotSupportedException
clone in class ObjectCloneNotSupportedExceptionpublic String toString()
toString in class Objectpublic static RequestConfig.Builder custom()
public static RequestConfig.Builder copy(RequestConfig config)
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||