Class RequestConfig

java.lang.Object

org.apache.hc.client5.http.config.RequestConfig

All Implemented Interfaces:

Cloneable

@Contract(threading=IMMUTABLE)
public class RequestConfig
extends Object
implements 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 final boolean	authenticationEnabled
private final boolean	circularRedirectsAllowed
private final org.apache.hc.core5.util.TimeValue	connectionKeepAlive
private final org.apache.hc.core5.util.Timeout	connectionRequestTimeout
private final org.apache.hc.core5.util.Timeout	connectTimeout
private final boolean	contentCompressionEnabled
private final String	cookieSpec
static final RequestConfig	DEFAULT
private static final org.apache.hc.core5.util.TimeValue	DEFAULT_CONN_KEEP_ALIVE
private static final org.apache.hc.core5.util.Timeout	DEFAULT_CONNECTION_REQUEST_TIMEOUT
private final boolean	expectContinueEnabled
private final org.apache.hc.core5.http2.priority.PriorityValue	h2Priority	HTTP/2 Priority header value to emit when using H2+.
private final boolean	hardCancellationEnabled
private final int	maxRedirects
private final boolean	protocolUpgradeEnabled
private final org.apache.hc.core5.http.HttpHost	proxy
private final Collection<String>	proxyPreferredAuthSchemes
private final boolean	redirectsEnabled
private final org.apache.hc.core5.util.Timeout	responseTimeout
private final Collection<String>	targetPreferredAuthSchemes
private final Path	unixDomainSocket

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestConfig()	Intended for CDI compatibility
(package private)	RequestConfig(boolean expectContinueEnabled, org.apache.hc.core5.http.HttpHost proxy, String cookieSpec, boolean redirectsEnabled, boolean circularRedirectsAllowed, int maxRedirects, boolean authenticationEnabled, Collection<String> targetPreferredAuthSchemes, Collection<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, boolean protocolUpgradeEnabled, Path unixDomainSocket, org.apache.hc.core5.http2.priority.PriorityValue h2Priority)

Method Summary

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. Use ConnectionConfig.getConnectTimeout().
String	getCookieSpec()
org.apache.hc.core5.http2.priority.PriorityValue	getH2Priority()	Returns the HTTP/2+ priority preference for this request or null if unset.
int	getMaxRedirects()
org.apache.hc.core5.http.HttpHost	getProxy()
Collection<String>	getProxyPreferredAuthSchemes()
org.apache.hc.core5.util.Timeout	getResponseTimeout()
Collection<String>	getTargetPreferredAuthSchemes()
Path	getUnixDomainSocket()
boolean	isAuthenticationEnabled()
boolean	isCircularRedirectsAllowed()
boolean	isContentCompressionEnabled()
boolean	isExpectContinueEnabled()
boolean	isHardCancellationEnabled()
boolean	isProtocolUpgradeEnabled()
boolean	isRedirectsEnabled()
String	toString()

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

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 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 Collection<String> targetPreferredAuthSchemes

proxyPreferredAuthSchemes

private final Collection<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

protocolUpgradeEnabled

private final boolean protocolUpgradeEnabled

unixDomainSocket

private final Path unixDomainSocket

h2Priority

private final org.apache.hc.core5.http2.priority.PriorityValue h2Priority

HTTP/2 Priority header value to emit when using H2+. Null means “don’t emit”.

Constructor Details

RequestConfig

protected RequestConfig()

Intended for CDI compatibility

RequestConfig

RequestConfig(boolean expectContinueEnabled,
 org.apache.hc.core5.http.HttpHost proxy,
 String cookieSpec,
 boolean redirectsEnabled,
 boolean circularRedirectsAllowed,
 int maxRedirects,
 boolean authenticationEnabled,
 Collection<String> targetPreferredAuthSchemes,
 Collection<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,
 boolean protocolUpgradeEnabled,
 Path unixDomainSocket,
 org.apache.hc.core5.http2.priority.PriorityValue h2Priority)

Method Details

isExpectContinueEnabled

public boolean isExpectContinueEnabled()

See Also:

• RequestConfig.Builder.setExpectContinueEnabled(boolean)

getProxy

public org.apache.hc.core5.http.HttpHost getProxy()

See Also:

• RequestConfig.Builder.setProxy(HttpHost)

getCookieSpec

public String getCookieSpec()

See Also:

• RequestConfig.Builder.setCookieSpec(String)

isRedirectsEnabled

public boolean isRedirectsEnabled()

See Also:

• RequestConfig.Builder.setRedirectsEnabled(boolean)

isCircularRedirectsAllowed

public boolean isCircularRedirectsAllowed()

See Also:

• RequestConfig.Builder.setCircularRedirectsAllowed(boolean)

getMaxRedirects

public int getMaxRedirects()

See Also:

• RequestConfig.Builder.setMaxRedirects(int)

isAuthenticationEnabled

public boolean isAuthenticationEnabled()

See Also:

• RequestConfig.Builder.setAuthenticationEnabled(boolean)

getTargetPreferredAuthSchemes

public Collection<String> getTargetPreferredAuthSchemes()

See Also:

• RequestConfig.Builder.setTargetPreferredAuthSchemes(Collection)

getProxyPreferredAuthSchemes

public Collection<String> getProxyPreferredAuthSchemes()

See Also:

• RequestConfig.Builder.setProxyPreferredAuthSchemes(Collection)

getConnectionRequestTimeout

public org.apache.hc.core5.util.Timeout getConnectionRequestTimeout()

See Also:

• RequestConfig.Builder.setConnectionRequestTimeout(Timeout)

getConnectTimeout

@Deprecated
public org.apache.hc.core5.util.Timeout getConnectTimeout()

Deprecated.

Use ConnectionConfig.getConnectTimeout().

See Also:

• RequestConfig.Builder.setConnectTimeout(Timeout)

getResponseTimeout

public org.apache.hc.core5.util.Timeout getResponseTimeout()

See Also:

• RequestConfig.Builder.setResponseTimeout(Timeout)

getConnectionKeepAlive

public org.apache.hc.core5.util.TimeValue getConnectionKeepAlive()

See Also:

• RequestConfig.Builder.setConnectionKeepAlive(TimeValue)

isContentCompressionEnabled

public boolean isContentCompressionEnabled()

See Also:

• RequestConfig.Builder.setContentCompressionEnabled(boolean)

isHardCancellationEnabled

public boolean isHardCancellationEnabled()

See Also:

• RequestConfig.Builder.setHardCancellationEnabled(boolean)

isProtocolUpgradeEnabled

public boolean isProtocolUpgradeEnabled()

See Also:

• (boolean)

getUnixDomainSocket

public Path getUnixDomainSocket()

See Also:

• RequestConfig.Builder.setUnixDomainSocket(Path)

getH2Priority

@Experimental
public org.apache.hc.core5.http2.priority.PriorityValue getH2Priority()

Returns the HTTP/2+ priority preference for this request or null if unset.

Since:

5.6

clone

protected RequestConfig clone()
                       throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

toString

public String toString()

Overrides:

toString in class Object

custom

public static RequestConfig.Builder custom()

copy

public static RequestConfig.Builder copy(RequestConfig config)