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() Creates and returns a copy of this object.
static RequestConfig.Builder	copy(RequestConfig config)
static RequestConfig.Builder	custom()
TimeValue	getConnectionKeepAlive()
Timeout	getConnectionRequestTimeout()
Timeout	getConnectTimeout()
String	getCookieSpec()
int	getMaxRedirects()
HttpHost	getProxy()
Collection<String>	getProxyPreferredAuthSchemes()
Timeout	getResponseTimeout()
Collection<String>	getTargetPreferredAuthSchemes()
boolean	isAuthenticationEnabled()
boolean	isCircularRedirectsAllowed()
boolean	isContentCompressionEnabled()
boolean	isExpectContinueEnabled()
boolean	isHardCancellationEnabled()
boolean	isRedirectsEnabled()
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

equals, 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

clone

protected RequestConfig clone()
                       throws CloneNotSupportedException

Description copied from class: Object

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.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Overrides:

clone in class Object

Returns:

a clone of this instance.

Throws:

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.

See Also:

Cloneable

copy

public static RequestConfig.Builder copy(RequestConfig config)

custom

public static RequestConfig.Builder custom()

getConnectionKeepAlive

public TimeValue getConnectionKeepAlive()

See Also:

RequestConfig.Builder.setConnectionKeepAlive(TimeValue)

getConnectionRequestTimeout

public Timeout getConnectionRequestTimeout()

See Also:

RequestConfig.Builder.setConnectionRequestTimeout(Timeout)

getConnectTimeout

public Timeout getConnectTimeout()

See Also:

RequestConfig.Builder.setConnectTimeout(Timeout)

getCookieSpec

public String getCookieSpec()

See Also:

RequestConfig.Builder.setCookieSpec(String)

getMaxRedirects

public int getMaxRedirects()

See Also:

RequestConfig.Builder.setMaxRedirects(int)

getProxy

public HttpHost getProxy()

See Also:

RequestConfig.Builder.setProxy(HttpHost)

getProxyPreferredAuthSchemes

public Collection<String> getProxyPreferredAuthSchemes()

See Also:

RequestConfig.Builder.setProxyPreferredAuthSchemes(Collection)

getResponseTimeout

public Timeout getResponseTimeout()

See Also:

RequestConfig.Builder.setResponseTimeout(Timeout)

getTargetPreferredAuthSchemes

public Collection<String> getTargetPreferredAuthSchemes()

See Also:

RequestConfig.Builder.setTargetPreferredAuthSchemes(Collection)

isAuthenticationEnabled

public boolean isAuthenticationEnabled()

See Also:

RequestConfig.Builder.setAuthenticationEnabled(boolean)

isCircularRedirectsAllowed

public boolean isCircularRedirectsAllowed()

See Also:

RequestConfig.Builder.setCircularRedirectsAllowed(boolean)

isContentCompressionEnabled

public boolean isContentCompressionEnabled()

See Also:

RequestConfig.Builder.setContentCompressionEnabled(boolean)

isExpectContinueEnabled

public boolean isExpectContinueEnabled()

See Also:

RequestConfig.Builder.setExpectContinueEnabled(boolean)

isHardCancellationEnabled

public boolean isHardCancellationEnabled()

See Also:

RequestConfig.Builder.setHardCancellationEnabled(boolean)

isRedirectsEnabled

public boolean isRedirectsEnabled()

See Also:

RequestConfig.Builder.setRedirectsEnabled(boolean)

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.