Class RequestConfig
- java.lang.Object
-
- org.apache.hc.client5.http.config.RequestConfig
-
- All Implemented Interfaces:
java.lang.Cloneable
@Contract(threading=IMMUTABLE) public class RequestConfig extends java.lang.Object implements java.lang.Cloneable
Immutable class encapsulating request configuration items.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RequestConfig.Builder
-
Field Summary
Fields Modifier and Type Field Description private boolean
authenticationEnabled
private boolean
circularRedirectsAllowed
private org.apache.hc.core5.util.TimeValue
connectionKeepAlive
private org.apache.hc.core5.util.Timeout
connectionRequestTimeout
private org.apache.hc.core5.util.Timeout
connectTimeout
private boolean
contentCompressionEnabled
private java.lang.String
cookieSpec
static RequestConfig
DEFAULT
private static org.apache.hc.core5.util.TimeValue
DEFAULT_CONN_KEEP_ALIVE
private static org.apache.hc.core5.util.Timeout
DEFAULT_CONNECTION_REQUEST_TIMEOUT
private boolean
expectContinueEnabled
private boolean
hardCancellationEnabled
private int
maxRedirects
private org.apache.hc.core5.http.HttpHost
proxy
private java.util.Collection<java.lang.String>
proxyPreferredAuthSchemes
private boolean
redirectsEnabled
private org.apache.hc.core5.util.Timeout
responseTimeout
private java.util.Collection<java.lang.String>
targetPreferredAuthSchemes
-
Constructor Summary
Constructors Modifier Constructor Description protected
RequestConfig()
Intended for CDI compatibility(package private)
RequestConfig(boolean expectContinueEnabled, org.apache.hc.core5.http.HttpHost proxy, java.lang.String cookieSpec, boolean redirectsEnabled, boolean circularRedirectsAllowed, int maxRedirects, boolean authenticationEnabled, java.util.Collection<java.lang.String> targetPreferredAuthSchemes, java.util.Collection<java.lang.String> proxyPreferredAuthSchemes, org.apache.hc.core5.util.Timeout connectionRequestTimeout, org.apache.hc.core5.util.Timeout connectTimeout, org.apache.hc.core5.util.Timeout responseTimeout, org.apache.hc.core5.util.TimeValue connectionKeepAlive, boolean contentCompressionEnabled, boolean hardCancellationEnabled)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected RequestConfig
clone()
static RequestConfig.Builder
copy(RequestConfig config)
static RequestConfig.Builder
custom()
org.apache.hc.core5.util.TimeValue
getConnectionKeepAlive()
org.apache.hc.core5.util.Timeout
getConnectionRequestTimeout()
org.apache.hc.core5.util.Timeout
getConnectTimeout()
Deprecated.java.lang.String
getCookieSpec()
int
getMaxRedirects()
org.apache.hc.core5.http.HttpHost
getProxy()
Deprecated.UseDefaultProxyRoutePlanner
or a customHttpRoutePlanner
.java.util.Collection<java.lang.String>
getProxyPreferredAuthSchemes()
org.apache.hc.core5.util.Timeout
getResponseTimeout()
java.util.Collection<java.lang.String>
getTargetPreferredAuthSchemes()
boolean
isAuthenticationEnabled()
boolean
isCircularRedirectsAllowed()
boolean
isContentCompressionEnabled()
boolean
isExpectContinueEnabled()
boolean
isHardCancellationEnabled()
boolean
isRedirectsEnabled()
java.lang.String
toString()
-
-
-
Field Detail
-
DEFAULT_CONNECTION_REQUEST_TIMEOUT
private static final org.apache.hc.core5.util.Timeout DEFAULT_CONNECTION_REQUEST_TIMEOUT
-
DEFAULT_CONN_KEEP_ALIVE
private static final org.apache.hc.core5.util.TimeValue DEFAULT_CONN_KEEP_ALIVE
-
DEFAULT
public static final RequestConfig DEFAULT
-
expectContinueEnabled
private final boolean expectContinueEnabled
-
proxy
private final org.apache.hc.core5.http.HttpHost proxy
-
cookieSpec
private final java.lang.String cookieSpec
-
redirectsEnabled
private final boolean redirectsEnabled
-
circularRedirectsAllowed
private final boolean circularRedirectsAllowed
-
maxRedirects
private final int maxRedirects
-
authenticationEnabled
private final boolean authenticationEnabled
-
targetPreferredAuthSchemes
private final java.util.Collection<java.lang.String> targetPreferredAuthSchemes
-
proxyPreferredAuthSchemes
private final java.util.Collection<java.lang.String> proxyPreferredAuthSchemes
-
connectionRequestTimeout
private final org.apache.hc.core5.util.Timeout connectionRequestTimeout
-
connectTimeout
private final org.apache.hc.core5.util.Timeout connectTimeout
-
responseTimeout
private final org.apache.hc.core5.util.Timeout responseTimeout
-
connectionKeepAlive
private final org.apache.hc.core5.util.TimeValue connectionKeepAlive
-
contentCompressionEnabled
private final boolean contentCompressionEnabled
-
hardCancellationEnabled
private final boolean hardCancellationEnabled
-
-
Constructor Detail
-
RequestConfig
protected RequestConfig()
Intended for CDI compatibility
-
RequestConfig
RequestConfig(boolean expectContinueEnabled, org.apache.hc.core5.http.HttpHost proxy, java.lang.String cookieSpec, boolean redirectsEnabled, boolean circularRedirectsAllowed, int maxRedirects, boolean authenticationEnabled, java.util.Collection<java.lang.String> targetPreferredAuthSchemes, java.util.Collection<java.lang.String> proxyPreferredAuthSchemes, org.apache.hc.core5.util.Timeout connectionRequestTimeout, org.apache.hc.core5.util.Timeout connectTimeout, org.apache.hc.core5.util.Timeout responseTimeout, org.apache.hc.core5.util.TimeValue connectionKeepAlive, boolean contentCompressionEnabled, boolean hardCancellationEnabled)
-
-
Method Detail
-
isExpectContinueEnabled
public boolean isExpectContinueEnabled()
-
getProxy
@Deprecated public org.apache.hc.core5.http.HttpHost getProxy()
Deprecated.UseDefaultProxyRoutePlanner
or a customHttpRoutePlanner
.- See Also:
RequestConfig.Builder.setProxy(HttpHost)
-
getCookieSpec
public java.lang.String getCookieSpec()
-
isRedirectsEnabled
public boolean isRedirectsEnabled()
-
isCircularRedirectsAllowed
public boolean isCircularRedirectsAllowed()
-
getMaxRedirects
public int getMaxRedirects()
-
isAuthenticationEnabled
public boolean isAuthenticationEnabled()
-
getTargetPreferredAuthSchemes
public java.util.Collection<java.lang.String> getTargetPreferredAuthSchemes()
-
getProxyPreferredAuthSchemes
public java.util.Collection<java.lang.String> getProxyPreferredAuthSchemes()
-
getConnectionRequestTimeout
public org.apache.hc.core5.util.Timeout getConnectionRequestTimeout()
-
getConnectTimeout
@Deprecated public org.apache.hc.core5.util.Timeout getConnectTimeout()
Deprecated.
-
getResponseTimeout
public org.apache.hc.core5.util.Timeout getResponseTimeout()
-
getConnectionKeepAlive
public org.apache.hc.core5.util.TimeValue getConnectionKeepAlive()
-
isContentCompressionEnabled
public boolean isContentCompressionEnabled()
-
isHardCancellationEnabled
public boolean isHardCancellationEnabled()
-
clone
protected RequestConfig clone() throws java.lang.CloneNotSupportedException
- Overrides:
clone
in classjava.lang.Object
- Throws:
java.lang.CloneNotSupportedException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
custom
public static RequestConfig.Builder custom()
-
copy
public static RequestConfig.Builder copy(RequestConfig config)
-
-