org.apache.hc.client5.http.config

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 and Description
static class	RequestConfig.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static RequestConfig	DEFAULT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestConfig() Intended for CDI compatibility

Method Summary

Modifier and Type	Method and Description
protected RequestConfig	clone()
static RequestConfig.Builder	copy(RequestConfig config)
static RequestConfig.Builder	custom()
TimeValue	getConnectionKeepAlive()
Timeout	getConnectionRequestTimeout()
Timeout	getConnectTimeout() Deprecated. Use ConnectionConfig.getConnectTimeout().
String	getCookieSpec()
PriorityValue	getH2Priority() Returns the HTTP/2+ priority preference for this request or null if unset.
int	getMaxRedirects()
HttpHost	getProxy()
Collection<String>	getProxyPreferredAuthSchemes()
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 java.lang.Object

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

Field Detail

DEFAULT

public static final RequestConfig DEFAULT

Constructor Detail

RequestConfig

protected RequestConfig()

Intended for CDI compatibility

Method Detail

isExpectContinueEnabled

public boolean isExpectContinueEnabled()

See Also:

RequestConfig.Builder.setExpectContinueEnabled(boolean)

getProxy

public 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 Timeout getConnectionRequestTimeout()

See Also:

RequestConfig.Builder.setConnectionRequestTimeout(Timeout)

getConnectTimeout

@Deprecated
public Timeout getConnectTimeout()

Deprecated. Use ConnectionConfig.getConnectTimeout().

See Also:

RequestConfig.Builder.setConnectTimeout(Timeout)

getResponseTimeout

public Timeout getResponseTimeout()

See Also:

RequestConfig.Builder.setResponseTimeout(Timeout)

getConnectionKeepAlive

public 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 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)