com.landawn.abacus.http

Class HttpSettings

java.lang.Object

com.landawn.abacus.http.HttpSettings

All Implemented Interfaces:

Cloneable

public final class HttpSettings
extends Object
implements Cloneable

Since:

1.3

Author:

Haiyang Li

Constructor Summary

Constructors

Constructor and Description
HttpSettings()

Method Summary

Modifier and Type	Method and Description
HttpSettings	basicAuth(String user, Object password)
HttpSettings	copy()
static HttpSettings	create()
boolean	doInput()
HttpSettings	doInput(boolean doInput) Note: Only for HttpClient, not for OKHttpClient.
boolean	doOutput()
HttpSettings	doOutput(boolean doOutput) Note: Only for HttpClient, not for OKHttpClient.
int	getConnectionTimeout() Gets the connection timeout.
String	getContentEncoding()
ContentFormat	getContentFormat() Gets the content format.
String	getContentType()
int	getReadTimeout() Gets the read timeout.
SSLSocketFactory	getSSLSocketFactory() Gets the SSL socket factory.
boolean	getUseCaches() Gets the use caches.
HttpSettings	header(String name, Object value) Set http header specified by name/value.
HttpHeaders	headers()
HttpSettings	headers(HttpHeaders headers) Removes all headers on this HttpSettings and adds headers.
HttpSettings	headers(Map<String,?> headers) Set http headers specified by the key/value entities from Map.
HttpSettings	headers(String name1, Object value1, String name2, Object value2) Set http headers specified by name1/value1, name2/value2.
HttpSettings	headers(String name1, Object value1, String name2, Object value2, String name3, Object value3) Set http headers specified by name1/value1, name2/value2, name3/value3.
boolean	isOneWayRequest() Checks if is one way request.
HttpSettings	isOneWayRequest(boolean isOneWayRequest) Checks if is one way request.
HttpSettings	setConnectionTimeout(int connectionTimeout) Note: Only for HttpClient, not for OKHttpClient.
HttpSettings	setContentEncoding(String contentEncoding)
HttpSettings	setContentFormat(ContentFormat contentFormat) Sets the content format.
HttpSettings	setContentType(String contentType)
HttpSettings	setReadTimeout(int readTimeout) Note: Only for HttpClient, not for OKHttpClient.
HttpSettings	setSSLSocketFactory(SSLSocketFactory sslSocketFactory) Sets the SSL socket factory.
HttpSettings	setUseCaches(boolean useCaches) Note: Only for HttpClient, not for OKHttpClient.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSettings

public HttpSettings()

Method Detail

create

public static HttpSettings create()

getConnectionTimeout

public int getConnectionTimeout()

Gets the connection timeout.

Returns:

setConnectionTimeout

public HttpSettings setConnectionTimeout(int connectionTimeout)

Note: Only for HttpClient, not for OKHttpClient.

Parameters:

connectionTimeout -

Returns:

getReadTimeout

public int getReadTimeout()

Gets the read timeout.

Returns:

setReadTimeout

public HttpSettings setReadTimeout(int readTimeout)

Note: Only for HttpClient, not for OKHttpClient.

Parameters:

readTimeout -

Returns:

getSSLSocketFactory

public SSLSocketFactory getSSLSocketFactory()

Gets the SSL socket factory.

Returns:

setSSLSocketFactory

public HttpSettings setSSLSocketFactory(SSLSocketFactory sslSocketFactory)

Sets the SSL socket factory.

Parameters:

sslSocketFactory -

Returns:

getUseCaches

public boolean getUseCaches()

Gets the use caches.

Returns:

setUseCaches

public HttpSettings setUseCaches(boolean useCaches)

Note: Only for HttpClient, not for OKHttpClient.

Parameters:

useCaches -

Returns:

doInput

public boolean doInput()

Returns:

true, if successful

See Also:

URLConnection.setDoInput(boolean)

doInput

public HttpSettings doInput(boolean doInput)

Note: Only for HttpClient, not for OKHttpClient.

Parameters:

doInput -

Returns:

See Also:

URLConnection.setDoInput(boolean)

doOutput

public boolean doOutput()

Returns:

true, if successful

See Also:

URLConnection.setDoOutput(boolean)

doOutput

public HttpSettings doOutput(boolean doOutput)

Note: Only for HttpClient, not for OKHttpClient.

Parameters:

doOutput -

Returns:

See Also:

URLConnection.setDoOutput(boolean)

isOneWayRequest

public boolean isOneWayRequest()

Checks if is one way request.

Returns:

true, if is one way request

isOneWayRequest

public HttpSettings isOneWayRequest(boolean isOneWayRequest)

Checks if is one way request.

Parameters:

isOneWayRequest -

Returns:

getContentFormat

public ContentFormat getContentFormat()

Gets the content format.

Returns:

setContentFormat

public HttpSettings setContentFormat(ContentFormat contentFormat)

Sets the content format.

Parameters:

contentFormat -

Returns:

setContentType

public HttpSettings setContentType(String contentType)

getContentType

public String getContentType()

setContentEncoding

public HttpSettings setContentEncoding(String contentEncoding)

getContentEncoding

public String getContentEncoding()

basicAuth

public HttpSettings basicAuth(String user,
                              Object password)

Parameters:

user -

password -

Returns:

header

public HttpSettings header(String name,
                           Object value)

Set http header specified by name/value. If this HttpSettings already has any headers with that name, they are all replaced.

Parameters:

name -

value -

Returns:

headers

public HttpSettings headers(String name1,
                            Object value1,
                            String name2,
                            Object value2)

Set http headers specified by name1/value1, name2/value2. If this HttpSettings already has any headers with that name, they are all replaced.

Parameters:

name1 -

value1 -

name2 -

value2 -

Returns:

headers

public HttpSettings headers(String name1,
                            Object value1,
                            String name2,
                            Object value2,
                            String name3,
                            Object value3)

Set http headers specified by name1/value1, name2/value2, name3/value3. If this HttpSettings already has any headers with that name, they are all replaced.

Parameters:

name1 -

value1 -

name2 -

value2 -

name3 -

value3 -

Returns:

headers

public HttpSettings headers(Map<String,?> headers)

Set http headers specified by the key/value entities from Map. If this HttpSettings already has any headers with that name, they are all replaced.

Parameters:

headers -

Returns:

headers

public HttpSettings headers(HttpHeaders headers)

Removes all headers on this HttpSettings and adds headers.

Parameters:

headers -

Returns:

headers

public HttpHeaders headers()

copy

public HttpSettings copy()

toString

public String toString()

Overrides:

toString in class Object