kong.unirest

Class Config

java.lang.Object

kong.unirest.Config

public class Config
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECT_TIMEOUT
static int	DEFAULT_CONNECTION_TIMEOUT
static int	DEFAULT_MAX_CONNECTIONS
static int	DEFAULT_MAX_PER_ROUTE
static int	DEFAULT_SOCKET_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
Config	addDefaultHeader(String name, String value) Add default header to appear on all requests
Config	addInterceptor(org.apache.http.HttpRequestInterceptor interceptor) Add a HttpRequestInterceptor to the clients.
Config	addShutdownHook(boolean value) Register the client with a system shutdown hook.
Config	asyncClient(AsyncClient value) Set the full async configuration including monitors.
Config	asyncClient(java.util.function.Function<Config,AsyncClient> asyncClientBuilder) Set the full async configuration including monitors.
Config	asyncClient(org.apache.http.nio.client.HttpAsyncClient value) Set the asynchronous AbstractHttpAsyncClient implementation to use for every asynchronous request
Config	automaticRetries(boolean value) Automaticly retry certain recoverable errors like socket timeouts.
Config	clearDefaultHeaders() Clear default headers
Config	clientCertificateStore(KeyStore store, String password) Set a custom keystore
Config	clientCertificateStore(String fileLocation, String password) Set a custom keystore via a file path.
Config	concurrency(int total, int perRoute) Set the concurrency levels
Config	connectionTTL(long duration, TimeUnit unit) Total time to live (TTL) defines maximum life span of persistent connections regardless of their expiration setting.
Config	connectTimeout(int inMillies) Set the connection timeout
Config	cookieSpec(String policy) Sets a cookie policy Acceptable values: 'default' (same as Netscape), 'netscape', 'ignoreCookies', 'standard' (RFC 6265 interoprability profile) , 'standard-strict' (RFC 6265 strict profile)
Config	enableCookieManagement(boolean enable) Allow the client to manage cookies.
Config	followRedirects(boolean enable) Allow the client to follow redirects.
AsyncClient	getAsyncClient() Return the current HttpAsyncClient.
Client	getClient() Return the current Client.
int	getConnectionTimeout()
String	getCookieSpec()
Headers	getDefaultHeaders() Return default headers that are added to every request
String	getDefaultResponseEncoding()
boolean	getEnabledCookieManagement()
boolean	getFollowRedirects()
List<org.apache.http.HttpRequestInterceptor>	getInterceptors()
KeyStore	getKeystore()
String	getKeyStorePassword()
int	getMaxConnections()
int	getMaxPerRoutes()
UniMetric	getMetric()
ObjectMapper	getObjectMapper()
Proxy	getProxy()
int	getSocketTimeout()
long	getTTL()
Config	httpClient(Client httpClient) Set the HttpClient implementation to use for every synchronous request
Config	httpClient(java.util.function.Function<Config,Client> httpClient) Provide a builder for a client
Config	httpClient(org.apache.http.client.HttpClient httpClient) Deprecated.
Config	instrumentWith(UniMetric metric) Add a metric object for instrumentation
boolean	isAutomaticRetries()
boolean	isRequestCompressionOn()
boolean	isRunning() Does the config have currently running clients? Find out here.
boolean	isVerifySsl()
Config	proxy(Proxy value) Set a proxy
Config	proxy(String host, int port) Set a proxy
Config	proxy(String host, int port, String username, String password) Set an authenticated proxy
Config	requestCompression(boolean value) Turn on or off requesting all content as compressed.
Config	reset() Shutdown the current config and re-init.
Config	setDefaultBasicAuth(String username, String password) Default basic auth credentials
Config	setDefaultHeader(String name, String value) Set default header to appear on all requests
Config	setDefaultHeader(String name, java.util.function.Supplier<String> value) Set default header to appear on all requests, value is through a Supplier This is useful for adding tracing elements to requests.
Config	setDefaultResponseEncoding(String value) Set the default encoding that will be used for serialization into Strings.
Config	setObjectMapper(ObjectMapper om) Set the ObjectMapper implementation to use for Response to Object binding
boolean	shouldAddShutdownHook()
void	shutDown(boolean clearOptions) Shut down the configuration and its clients.
Config	socketTimeout(int inMillies) Set the socket timeout
boolean	useSystemProperties()
Config	useSystemProperties(boolean value) Tell the HttpClients to use the system properties for things like proxies
Config	verifySsl(boolean value) Toggle verifying SSL/TLS certificates.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

See Also:

Constant Field Values

DEFAULT_MAX_CONNECTIONS

public static final int DEFAULT_MAX_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_MAX_PER_ROUTE

public static final int DEFAULT_MAX_PER_ROUTE

See Also:

Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT

public static final int DEFAULT_SOCKET_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

Config

public Config()

Method Detail

httpClient

@Deprecated
public Config httpClient(org.apache.http.client.HttpClient httpClient)

Deprecated.

Set the HttpClient implementation to use for every synchronous request

Parameters:

httpClient - Custom httpClient implementation

Returns:

this config object

httpClient

public Config httpClient(Client httpClient)

Set the HttpClient implementation to use for every synchronous request

Parameters:

httpClient - Custom httpClient implementation

Returns:

this config object

httpClient

public Config httpClient(java.util.function.Function<Config,Client> httpClient)

Provide a builder for a client

Parameters:

httpClient - Custom httpClient implementation

Returns:

this config object

asyncClient

public Config asyncClient(org.apache.http.nio.client.HttpAsyncClient value)

Set the asynchronous AbstractHttpAsyncClient implementation to use for every asynchronous request

Parameters:

value - Custom CloseableHttpAsyncClient implementation

Returns:

this config object

asyncClient

public Config asyncClient(AsyncClient value)

Set the full async configuration including monitors. These will be shutDown on a Unirest.shudown()

Parameters:

value - Custom AsyncConfig class. The actual AsyncHttpClient is required.

Returns:

this config object

asyncClient

public Config asyncClient(java.util.function.Function<Config,AsyncClient> asyncClientBuilder)

Set the full async configuration including monitors. These will be shutDown on a Unirest.shudown()

Parameters:

asyncClientBuilder - A builder function for creating a AsyncClient

Returns:

this config object

proxy

public Config proxy(Proxy value)

Set a proxy

Parameters:

value - Proxy settings object.

Returns:

this config object

proxy

public Config proxy(String host,
                    int port)

Set a proxy

Parameters:

host - the hostname of the proxy server.

port - the port of the proxy server

Returns:

this config object

proxy

public Config proxy(String host,
                    int port,
                    String username,
                    String password)

Set an authenticated proxy

Parameters:

host - the hostname of the proxy server.

port - the port of the proxy server

username - username for authenticated proxy

password - password for authenticated proxy

Returns:

this config object

setObjectMapper

public Config setObjectMapper(ObjectMapper om)

Set the ObjectMapper implementation to use for Response to Object binding

Parameters:

om - Custom implementation of ObjectMapper interface

Returns:

this config object

clientCertificateStore

public Config clientCertificateStore(KeyStore store,
                                     String password)

Set a custom keystore

Parameters:

store - the keystore to use for a custom ssl context

password - the password for the store

Returns:

this config object

clientCertificateStore

public Config clientCertificateStore(String fileLocation,
                                     String password)

Set a custom keystore via a file path. Must be a valid PKCS12 file

Parameters:

fileLocation - the path keystore to use for a custom ssl context

password - the password for the store

Returns:

this config object

connectTimeout

public Config connectTimeout(int inMillies)

Set the connection timeout

Parameters:

inMillies - The timeout until a connection with the server is established (in milliseconds). Default is 10000. Set to zero to disable the timeout.

Returns:

this config object

socketTimeout

public Config socketTimeout(int inMillies)

Set the socket timeout

Parameters:

inMillies - The timeout to receive data (in milliseconds). Default is 60000. Set to zero to disable the timeout.

Returns:

this config object

concurrency

public Config concurrency(int total,
                          int perRoute)

Set the concurrency levels

Parameters:

total - Defines the overall connection limit for a connection pool. Default is 200.

perRoute - Defines a connection limit per one HTTP route (this can be considered a per target host limit). Default is 20.

Returns:

this config object

clearDefaultHeaders

public Config clearDefaultHeaders()

Clear default headers

Returns:

this config object

setDefaultBasicAuth

public Config setDefaultBasicAuth(String username,
                                  String password)

Default basic auth credentials

Parameters:

username - the username

password - the password

Returns:

this config object

setDefaultHeader

public Config setDefaultHeader(String name,
                               String value)

Set default header to appear on all requests

Parameters:

name - The name of the header.

value - The value of the header.

Returns:

this config object

setDefaultHeader

public Config setDefaultHeader(String name,
                               java.util.function.Supplier<String> value)

Set default header to appear on all requests, value is through a Supplier This is useful for adding tracing elements to requests.

Parameters:

name - The name of the header.

value - a supplier that will get called as part of the request.

Returns:

this config object

addDefaultHeader

public Config addDefaultHeader(String name,
                               String value)

Add default header to appear on all requests

Parameters:

name - The name of the header.

value - The value of the header.

Returns:

this config object

instrumentWith

public Config instrumentWith(UniMetric metric)

Add a metric object for instrumentation

Parameters:

metric - a UniMetric object

Returns:

this config object

addInterceptor

public Config addInterceptor(org.apache.http.HttpRequestInterceptor interceptor)

Add a HttpRequestInterceptor to the clients. This can be called multiple times to add as many as you like. https://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/HttpRequestInterceptor.html

Parameters:

interceptor - The addInterceptor

Returns:

this config object

followRedirects

public Config followRedirects(boolean enable)

Allow the client to follow redirects. Defaults to TRUE

Parameters:

enable - The name of the header.

Returns:

this config object

enableCookieManagement

public Config enableCookieManagement(boolean enable)

Allow the client to manage cookies. Defaults to TRUE

Parameters:

enable - The name of the header.

Returns:

this config object

verifySsl

public Config verifySsl(boolean value)

Toggle verifying SSL/TLS certificates. Defaults to TRUE

Parameters:

value - a bool is its true or not.

Returns:

this config object

useSystemProperties

public Config useSystemProperties(boolean value)

Tell the HttpClients to use the system properties for things like proxies

Parameters:

value - a bool is its true or not.

Returns:

this config object

requestCompression

public Config requestCompression(boolean value)

Turn on or off requesting all content as compressed. (GZIP encoded) Default is true

Parameters:

value - a bool is its true or not.

Returns:

this config object

automaticRetries

public Config automaticRetries(boolean value)

Automaticly retry certain recoverable errors like socket timeouts. Up to 4 times Note that currently this only works on synchronous calls. Default is true

Parameters:

value - a bool is its true or not.

Returns:

this config object

cookieSpec

public Config cookieSpec(String policy)

Sets a cookie policy Acceptable values: 'default' (same as Netscape), 'netscape', 'ignoreCookies', 'standard' (RFC 6265 interoprability profile) , 'standard-strict' (RFC 6265 strict profile)

Parameters:

policy: - the policy for cookies to follow

Returns:

this config object

setDefaultResponseEncoding

public Config setDefaultResponseEncoding(String value)

Set the default encoding that will be used for serialization into Strings. The default-default is UTF-8

Parameters:

value - a bool is its true or not.

Returns:

this config object

connectionTTL

public Config connectionTTL(long duration,
                            TimeUnit unit)

Total time to live (TTL) defines maximum life span of persistent connections regardless of their expiration setting. No persistent connection will be re-used past its TTL value.

Parameters:

duration - of ttl.

unit - the time unit of the ttl

Returns:

this config object

addShutdownHook

public Config addShutdownHook(boolean value)

Register the client with a system shutdown hook. Note that this creates up to two threads (depending on if you use both sync and async clients). default is false

Parameters:

value - a bool is its true or not.

Returns:

this config object

getDefaultHeaders

public Headers getDefaultHeaders()

Return default headers that are added to every request

Returns:

Headers

isRunning

public boolean isRunning()

Does the config have currently running clients? Find out here.

Returns:

boolean

reset

public Config reset()

Shutdown the current config and re-init.

Returns:

this config

shutDown

public void shutDown(boolean clearOptions)

Shut down the configuration and its clients. The config can be re-initialized with its settings

Parameters:

clearOptions - should the current non-client settings be retained.

getClient

public Client getClient()

Return the current Client. One will be build if it does not yet exist.

Returns:

A synchronous Client

getAsyncClient

public AsyncClient getAsyncClient()

Return the current HttpAsyncClient. One will be build if it does not yet exist.

Returns:

Apache HttpAsyncClient

getEnabledCookieManagement

public boolean getEnabledCookieManagement()

Returns:

if cookie management should be enabled. default: true

getFollowRedirects

public boolean getFollowRedirects()

Returns:

if the clients should follow redirects default: true

getMaxConnections

public int getMaxConnections()

Returns:

the maximum number of connections the clients for this config will manage at once default: 200

getMaxPerRoutes

public int getMaxPerRoutes()

Returns:

the maximum number of connections per route the clients for this config will manage at once default: 20

getConnectionTimeout

public int getConnectionTimeout()

Returns:

the connection timeout in milliseconds default: 10000

getSocketTimeout

public int getSocketTimeout()

Returns:

socket timeout in milliseconds default: 60000

getKeystore

public KeyStore getKeystore()

Returns:

a security keystore if one has been provided

getKeyStorePassword

public String getKeyStorePassword()

Returns:

The password for the keystore if provided

getObjectMapper

public ObjectMapper getObjectMapper()

Returns:

a configured object mapper

Throws:

UnirestException - if none has been configured.

getInterceptors

public List<org.apache.http.HttpRequestInterceptor> getInterceptors()

getProxy

public Proxy getProxy()

useSystemProperties

public boolean useSystemProperties()

getDefaultResponseEncoding

public String getDefaultResponseEncoding()

isRequestCompressionOn

public boolean isRequestCompressionOn()

isAutomaticRetries

public boolean isAutomaticRetries()

isVerifySsl

public boolean isVerifySsl()

shouldAddShutdownHook

public boolean shouldAddShutdownHook()

getCookieSpec

public String getCookieSpec()

getMetric

public UniMetric getMetric()

getTTL

public long getTTL()