Modifier and Type	Class and Description
public static class	RequestConfig.Builder

Modifier and Type	Field and Description
private final boolean	authenticationEnabled
private final boolean	circularRedirectsAllowed
private final TimeValue	connectionKeepAlive
private final Timeout	connectionRequestTimeout
private final Timeout	connectTimeout
private final boolean	contentCompressionEnabled
private final String	cookieSpec
public static final RequestConfig	DEFAULT
private static final TimeValue	DEFAULT_CONN_KEEP_ALIVE
private static final Timeout	DEFAULT_CONNECTION_REQUEST_TIMEOUT
private final boolean	expectContinueEnabled
private final boolean	hardCancellationEnabled
private final int	maxRedirects
private final HttpHost	proxy
private final Collection<String>	proxyPreferredAuthSchemes
private final boolean	redirectsEnabled
private final Timeout	responseTimeout
private final Collection<String>	targetPreferredAuthSchemes

Access	Constructor and Description
protected	RequestConfig() Intended for CDI compatibility
pack-priv	RequestConfig(final boolean expectContinueEnabled, final HttpHost proxy, final String cookieSpec, final boolean redirectsEnabled, final boolean circularRedirectsAllowed, final int maxRedirects, final boolean authenticationEnabled, final Collection<String> targetPreferredAuthSchemes, final Collection<String> proxyPreferredAuthSchemes, final Timeout connectionRequestTimeout, final Timeout connectTimeout, final Timeout responseTimeout, final TimeValue connectionKeepAlive, final boolean contentCompressionEnabled, final boolean hardCancellationEnabled)

Modifier and Type	Method and Description
protected RequestConfig	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public static RequestConfig.Builder	copy(final RequestConfig config)
public static RequestConfig.Builder	custom()
public TimeValue	getConnectionKeepAlive()
public Timeout	getConnectionRequestTimeout()
public Timeout	getConnectTimeout() Deprecated Use `ConnectionConfig#getConnectTimeout()`.
public String	getCookieSpec()
public int	getMaxRedirects()
public HttpHost	getProxy() Deprecated Use `org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner` or a custom `org.apache.hc.client5.http.routing.HttpRoutePlanner`.
public Collection<String>	getProxyPreferredAuthSchemes()
public Timeout	getResponseTimeout()
public Collection<String>	getTargetPreferredAuthSchemes()
public boolean	isAuthenticationEnabled()
public boolean	isCircularRedirectsAllowed()
public boolean	isContentCompressionEnabled()
public boolean	isExpectContinueEnabled()
public boolean	isHardCancellationEnabled()
public boolean	isRedirectsEnabled()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

authenticationEnabled	back to summary
private final boolean authenticationEnabled

circularRedirectsAllowed	back to summary
private final boolean circularRedirectsAllowed

connectionKeepAlive	back to summary
private final TimeValue connectionKeepAlive

connectionRequestTimeout	back to summary
private final Timeout connectionRequestTimeout

connectTimeout	back to summary
private final Timeout connectTimeout

contentCompressionEnabled	back to summary
private final boolean contentCompressionEnabled

DEFAULT	back to summary
public static final RequestConfig DEFAULT

DEFAULT_CONN_KEEP_ALIVE	back to summary
private static final TimeValue DEFAULT_CONN_KEEP_ALIVE

DEFAULT_CONNECTION_REQUEST_TIMEOUT	back to summary
private static final Timeout DEFAULT_CONNECTION_REQUEST_TIMEOUT

expectContinueEnabled	back to summary
private final boolean expectContinueEnabled

hardCancellationEnabled	back to summary
private final boolean hardCancellationEnabled

maxRedirects	back to summary
private final int maxRedirects

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

responseTimeout	back to summary
private final Timeout responseTimeout

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 String cookieSpec, final boolean redirectsEnabled, final boolean circularRedirectsAllowed, final int maxRedirects, final boolean authenticationEnabled, final Collection<String> targetPreferredAuthSchemes, final Collection<String> proxyPreferredAuthSchemes, final Timeout connectionRequestTimeout, final Timeout connectTimeout, final Timeout responseTimeout, final TimeValue connectionKeepAlive, final boolean contentCompressionEnabled, final boolean hardCancellationEnabled)

Method Detail

clone back to summary

clone	back to summary
protected RequestConfig clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. 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 `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. 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 `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:RequestConfig a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

protected RequestConfig clone() throws CloneNotSupportedException

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 x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

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 super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:RequestConfig

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

copy	back to summary
public static RequestConfig.Builder copy(final RequestConfig config) Annotations @SuppressWarnings:deprecation

custom	back to summary
public static RequestConfig.Builder custom()

getConnectionKeepAlive	back to summary
public TimeValue getConnectionKeepAlive() See Also `Builder#setConnectionKeepAlive(TimeValue)`

getConnectionRequestTimeout	back to summary
public Timeout getConnectionRequestTimeout() See Also `Builder#setConnectionRequestTimeout(Timeout)`

getConnectTimeout	back to summary
public Timeout getConnectTimeout() Deprecated Use `ConnectionConfig#getConnectTimeout()`. Annotations @Deprecated See Also `Builder#setConnectTimeout(Timeout)`

getCookieSpec	back to summary
public String getCookieSpec() See Also `Builder#setCookieSpec(String)`

getMaxRedirects	back to summary
public int getMaxRedirects() See Also `Builder#setMaxRedirects(int)`

getProxy	back to summary
public HttpHost getProxy() Deprecated Use `org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner` or a custom `org.apache.hc.client5.http.routing.HttpRoutePlanner`. Annotations @Deprecated See Also `Builder#setProxy(HttpHost)`

getProxyPreferredAuthSchemes	back to summary
public Collection<String> getProxyPreferredAuthSchemes() See Also `Builder#setProxyPreferredAuthSchemes(Collection)`

getResponseTimeout	back to summary
public Timeout getResponseTimeout() See Also `Builder#setResponseTimeout(Timeout)`

getTargetPreferredAuthSchemes	back to summary
public Collection<String> getTargetPreferredAuthSchemes() See Also `Builder#setTargetPreferredAuthSchemes(Collection)`

isAuthenticationEnabled	back to summary
public boolean isAuthenticationEnabled() See Also `Builder#setAuthenticationEnabled(boolean)`

isCircularRedirectsAllowed	back to summary
public boolean isCircularRedirectsAllowed() See Also `Builder#setCircularRedirectsAllowed(boolean)`

isContentCompressionEnabled	back to summary
public boolean isContentCompressionEnabled() See Also `Builder#setContentCompressionEnabled(boolean)`

isExpectContinueEnabled	back to summary
public boolean isExpectContinueEnabled() See Also `Builder#setExpectContinueEnabled(boolean)`

isHardCancellationEnabled	back to summary
public boolean isHardCancellationEnabled() See Also `Builder#setHardCancellationEnabled(boolean)`

isRedirectsEnabled	back to summary
public boolean isRedirectsEnabled() See Also `Builder#setRedirectsEnabled(boolean)`

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.apache.hc.client5.http.config back to summary

public Class RequestConfig.Builder

Class Inheritance

extends Object

java.lang.Object
org.apache.hc.client5.http.config.RequestConfig.Builder

Field Summary

Modifier and Type	Field and Description
private boolean	authenticationEnabled
private boolean	circularRedirectsAllowed
private TimeValue	connectionKeepAlive
private Timeout	connectionRequestTimeout
private Timeout	connectTimeout
private boolean	contentCompressionEnabled
private String	cookieSpec
private boolean	expectContinueEnabled
private boolean	hardCancellationEnabled
private int	maxRedirects
private HttpHost	proxy
private Collection<String>	proxyPreferredAuthSchemes
private boolean	redirectsEnabled
private Timeout	responseTimeout
private Collection<String>	targetPreferredAuthSchemes

Constructor Summary

Access	Constructor and Description
pack-priv	Builder()

Method Summary

Modifier and Type	Method and Description
public RequestConfig	build()
public RequestConfig.Builder	setAuthenticationEnabled(final boolean authenticationEnabled) Determines whether authentication should be handled automatically.
public RequestConfig.Builder	setCircularRedirectsAllowed(final boolean circularRedirectsAllowed) Determines whether circular redirects (redirects to the same location) should be allowed.
public RequestConfig.Builder	setConnectionKeepAlive(final TimeValue connectionKeepAlive) Determines the default of value of connection keep-alive time period when not explicitly communicated by the origin server with a `Keep-Alive` response header.
public RequestConfig.Builder	setConnectionRequestTimeout(final Timeout connectionRequestTimeout) Returns the connection lease request timeout used when requesting a connection from the connection manager.
public RequestConfig.Builder	setConnectionRequestTimeout(final long connectionRequestTimeout, final TimeUnit timeUnit)
public RequestConfig.Builder	setConnectTimeout(final Timeout connectTimeout) Deprecated Use `ConnectionConfig.Builder#setConnectTimeout(Timeout)`. Determines the timeout until a new connection is fully established.
public RequestConfig.Builder	setConnectTimeout(final long connectTimeout, final TimeUnit timeUnit) Deprecated Use `ConnectionConfig.Builder#setConnectTimeout(long, TimeUnit)`.
public RequestConfig.Builder	setContentCompressionEnabled(final boolean contentCompressionEnabled) Determines whether the target server is requested to compress content.
public RequestConfig.Builder	setCookieSpec(final String cookieSpec) Determines the name of the cookie specification to be used for HTTP state management.
public RequestConfig.Builder	setDefaultKeepAlive(final long defaultKeepAlive, final TimeUnit timeUnit)
public RequestConfig.Builder	setExpectContinueEnabled(final boolean expectContinueEnabled) Determines whether the 'Expect: 100-Continue' handshake is enabled for entity enclosing methods.
public RequestConfig.Builder	setHardCancellationEnabled(final boolean hardCancellationEnabled) Determines whether request cancellation, such as through `Future#cancel(boolean)`, should kill the underlying connection.
public RequestConfig.Builder	setMaxRedirects(final int maxRedirects) Returns the maximum number of redirects to be followed.
public RequestConfig.Builder	setProxy(final HttpHost proxy) Deprecated Use `org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner` or a custom `org.apache.hc.client5.http.routing.HttpRoutePlanner`. Returns HTTP proxy to be used for request execution.
public RequestConfig.Builder	setProxyPreferredAuthSchemes(final Collection<String> proxyPreferredAuthSchemes) Determines the order of preference for supported authentication schemes by their names when authenticating with the proxy host.
public RequestConfig.Builder	setRedirectsEnabled(final boolean redirectsEnabled) Determines whether redirects should be handled automatically.
public RequestConfig.Builder	setResponseTimeout(final Timeout responseTimeout) Determines the timeout until arrival of a response from the opposite endpoint.
public RequestConfig.Builder	setResponseTimeout(final long responseTimeout, final TimeUnit timeUnit)
public RequestConfig.Builder	setTargetPreferredAuthSchemes(final Collection<String> targetPreferredAuthSchemes) Determines the order of preference for supported authentication schemes by their names when authenticating with the target host.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

authenticationEnabled	back to summary
private boolean authenticationEnabled

circularRedirectsAllowed	back to summary
private boolean circularRedirectsAllowed

connectionKeepAlive	back to summary
private TimeValue connectionKeepAlive

connectionRequestTimeout	back to summary
private Timeout connectionRequestTimeout

connectTimeout	back to summary
private Timeout connectTimeout

contentCompressionEnabled	back to summary
private boolean contentCompressionEnabled

cookieSpec	back to summary
private String cookieSpec

expectContinueEnabled	back to summary
private boolean expectContinueEnabled

hardCancellationEnabled	back to summary
private boolean hardCancellationEnabled

maxRedirects	back to summary
private int maxRedirects

proxy	back to summary
private HttpHost proxy

proxyPreferredAuthSchemes	back to summary
private Collection<String> proxyPreferredAuthSchemes

redirectsEnabled	back to summary
private boolean redirectsEnabled

responseTimeout	back to summary
private Timeout responseTimeout

targetPreferredAuthSchemes	back to summary
private Collection<String> targetPreferredAuthSchemes

Constructor Detail

Builder	back to summary
pack-priv Builder()

Method Detail

build	back to summary
public RequestConfig build()

setAuthenticationEnabled back to summary

public RequestConfig.Builder setAuthenticationEnabled(final boolean authenticationEnabled)

Determines whether authentication should be handled automatically.

Default: true

setCircularRedirectsAllowed back to summary

public RequestConfig.Builder setCircularRedirectsAllowed(final boolean circularRedirectsAllowed)

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: false

setConnectionKeepAlive back to summary

public RequestConfig.Builder setConnectionKeepAlive(final TimeValue connectionKeepAlive)

Determines the default of value of connection keep-alive time period when not explicitly communicated by the origin server with a Keep-Alive response header.

A negative value is interpreted as an infinite keep-alive period.

Default: 3 minutes

Since: 5.0

setConnectionRequestTimeout

back to summary

public RequestConfig.Builder setConnectionRequestTimeout(final Timeout connectionRequestTimeout)

Returns the connection lease request timeout used when requesting a connection from the connection manager.

Default: 3 minutes.

setConnectionRequestTimeout	back to summary
public RequestConfig.Builder setConnectionRequestTimeout(final long connectionRequestTimeout, final TimeUnit timeUnit) See Also `setConnectionRequestTimeout(Timeout)`

setConnectTimeout back to summary

public RequestConfig.Builder setConnectTimeout(final Timeout connectTimeout)

Deprecated

Use ConnectionConfig.Builder#setConnectTimeout(Timeout).

Determines the timeout until a new connection is fully established. This may also include transport security negotiation exchanges such as SSL or TLS protocol negotiation).

A timeout value of zero is interpreted as an infinite timeout.

Default: 3 minutes

Annotations

@Deprecated

setConnectTimeout	back to summary
public RequestConfig.Builder setConnectTimeout(final long connectTimeout, final TimeUnit timeUnit) Deprecated Use `ConnectionConfig.Builder#setConnectTimeout(long, TimeUnit)`. Annotations @Deprecated See Also `setConnectTimeout(Timeout)`

setContentCompressionEnabled back to summary

public RequestConfig.Builder setContentCompressionEnabled(final boolean contentCompressionEnabled)

Determines whether the target server is requested to compress content.

Default: true

Since: 4.5

setCookieSpec back to summary

public RequestConfig.Builder setCookieSpec(final String cookieSpec)

Determines the name of the cookie specification to be used for HTTP state management.

Default: null

setDefaultKeepAlive	back to summary
public RequestConfig.Builder setDefaultKeepAlive(final long defaultKeepAlive, final TimeUnit timeUnit) See Also `setConnectionKeepAlive(TimeValue)`

setExpectContinueEnabled back to summary

public RequestConfig.Builder setExpectContinueEnabled(final boolean expectContinueEnabled)

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: false

setHardCancellationEnabled back to summary

public RequestConfig.Builder setHardCancellationEnabled(final boolean hardCancellationEnabled)

Determines whether request cancellation, such as through Future#cancel(boolean), should kill the underlying connection. If this option is set to false, the client will attempt to preserve the underlying connection by allowing the request to complete in the background, discarding the response.

Note that when this option is true, cancelling a request may cause other requests to fail, if they are waiting to use the same connection.

On HTTP/2, this option has no effect. Request cancellation will always result in the stream being cancelled with a RST_STREAM. This has no effect on connection reuse.

On non-asynchronous clients, this option has no effect. Request cancellation, such as through HttpUriRequestBase#cancel(), will always kill the underlying connection.

Default: true

Since: 5.0

setMaxRedirects back to summary

public RequestConfig.Builder setMaxRedirects(final int maxRedirects)

Returns the maximum number of redirects to be followed. The limit on number of redirects is intended to prevent infinite loops.

Default: 50

setProxy back to summary

public RequestConfig.Builder setProxy(final HttpHost proxy)

Deprecated

Use org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner or a custom org.apache.hc.client5.http.routing.HttpRoutePlanner.

Returns HTTP proxy to be used for request execution.

Default: null

Annotations

@Deprecated

setProxyPreferredAuthSchemes back to summary

public RequestConfig.Builder setProxyPreferredAuthSchemes(final Collection<String> proxyPreferredAuthSchemes)

Determines the order of preference for supported authentication schemes by their names when authenticating with the proxy host.

Default: null

setRedirectsEnabled back to summary

public RequestConfig.Builder setRedirectsEnabled(final boolean redirectsEnabled)

Determines whether redirects should be handled automatically.

Default: true

setResponseTimeout back to summary

public RequestConfig.Builder setResponseTimeout(final Timeout responseTimeout)

Determines the timeout until arrival of a response from the opposite endpoint.

A timeout value of zero is interpreted as an infinite timeout.

Please note that response timeout may be unsupported by HTTP transports with message multiplexing.

Default: null

Since: 5.0

setResponseTimeout	back to summary
public RequestConfig.Builder setResponseTimeout(final long responseTimeout, final TimeUnit timeUnit) See Also `setResponseTimeout(Timeout)`

setTargetPreferredAuthSchemes back to summary

public RequestConfig.Builder setTargetPreferredAuthSchemes(final Collection<String> targetPreferredAuthSchemes)

Determines the order of preference for supported authentication schemes by their names when authenticating with the target host.

Default: null

public Class RequestConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class RequestConfig.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail