Package org.apache.hc.client5.http.config

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 org.apache.hc.core5.http2.priority.PriorityValue	h2Priority	HTTP/2 Priority header value to emit when using H2+.
private boolean	hardCancellationEnabled
private int	maxRedirects
private boolean	protocolUpgradeEnabled
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
private java.nio.file.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, 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, boolean protocolUpgradeEnabled, java.nio.file.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().
java.lang.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()
java.util.Collection<java.lang.String>	getProxyPreferredAuthSchemes()
org.apache.hc.core5.util.Timeout	getResponseTimeout()
java.util.Collection<java.lang.String>	getTargetPreferredAuthSchemes()
java.nio.file.Path	getUnixDomainSocket()
boolean	isAuthenticationEnabled()
boolean	isCircularRedirectsAllowed()
boolean	isContentCompressionEnabled()
boolean	isExpectContinueEnabled()
boolean	isHardCancellationEnabled()
boolean	isProtocolUpgradeEnabled()
boolean	isRedirectsEnabled()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

protocolUpgradeEnabled

private final boolean protocolUpgradeEnabled

unixDomainSocket

private final java.nio.file.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 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,
              boolean protocolUpgradeEnabled,
              java.nio.file.Path unixDomainSocket,
              org.apache.hc.core5.http2.priority.PriorityValue h2Priority)

Method Detail

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 java.lang.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 java.util.Collection<java.lang.String> getTargetPreferredAuthSchemes()

See Also:

RequestConfig.Builder.setTargetPreferredAuthSchemes(Collection)

getProxyPreferredAuthSchemes

public java.util.Collection<java.lang.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 java.nio.file.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 java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

custom

public static RequestConfig.Builder custom()

copy

public static RequestConfig.Builder copy(RequestConfig config)