io.github.openunirest.http

Class Unirest

java.lang.Object

io.github.openunirest.http.Unirest

public class Unirest
extends Object

Constructor Summary

Constructors

Constructor and Description
Unirest()

Method Summary

Modifier and Type	Method and Description
static void	clearDefaultHeaders() Clear default headers
static HttpRequestWithBody	delete(String url)
static GetRequest	get(String url)
static GetRequest	head(String url)
static boolean	isRunning()
static JsonPatchRequest	jsonPatch(String url)
static HttpRequestWithBody	options(String url)
static HttpRequestWithBody	patch(String url)
static HttpRequestWithBody	post(String url)
static HttpRequestWithBody	put(String url)
static void	setAsyncHttpClient(org.apache.http.impl.nio.client.CloseableHttpAsyncClient asyncHttpClient) Set the asynchronous AbstractHttpAsyncClient implementation to use for every asynchronous request
static void	setConcurrency(int maxTotal, int maxPerRoute) Set the concurrency levels
static void	setDefaultHeader(String name, String value) Set default header to appear on all requests
static void	setHttpClient(org.apache.http.client.HttpClient httpClient) Set the HttpClient implementation to use for every synchronous request
static void	setObjectMapper(ObjectMapper objectMapper) Set the ObjectMapper implementation to use for Response to Object binding
static void	setProxy(org.apache.http.HttpHost proxy) Set a proxy
static void	setTimeouts(int connectionTimeout, int socketTimeout) Set the connection timeout and socket timeout
static void	shutdown() Close the asynchronous client and its event loop.
static void	shutdown(boolean clearOptions) Close the asynchronous client and its event loop.

Methods inherited from class java.lang.Object

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

Constructor Detail

Unirest

public Unirest()

Method Detail

setHttpClient

public static void setHttpClient(org.apache.http.client.HttpClient httpClient)

Set the HttpClient implementation to use for every synchronous request

Parameters:

httpClient - Custom httpClient implementation

setAsyncHttpClient

public static void setAsyncHttpClient(org.apache.http.impl.nio.client.CloseableHttpAsyncClient asyncHttpClient)

Set the asynchronous AbstractHttpAsyncClient implementation to use for every asynchronous request

Parameters:

asyncHttpClient - Custom CloseableHttpAsyncClient implementation

setProxy

public static void setProxy(org.apache.http.HttpHost proxy)

Set a proxy

Parameters:

proxy - Proxy settings object.

setObjectMapper

public static void setObjectMapper(ObjectMapper objectMapper)

Set the ObjectMapper implementation to use for Response to Object binding

Parameters:

objectMapper - Custom implementation of ObjectMapper interface

setTimeouts

public static void setTimeouts(int connectionTimeout,
                               int socketTimeout)

Set the connection timeout and socket timeout

Parameters:

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

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

setConcurrency

public static void setConcurrency(int maxTotal,
                                  int maxPerRoute)

Set the concurrency levels

Parameters:

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

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

clearDefaultHeaders

public static void clearDefaultHeaders()

Clear default headers

setDefaultHeader

public static void 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.

shutdown

public static void shutdown()

Close the asynchronous client and its event loop. Use this method to close all the threads and allow an application to exit. This will also clear any options returning Unirest to a default state

shutdown

public static void shutdown(boolean clearOptions)

Close the asynchronous client and its event loop. Use this method to close all the threads and allow an application to exit.

Parameters:

clearOptions - indicates if options should be cleared. Note that the HttpClient, AsyncClient and thread monitors will not be retained after shutdown.

get

public static GetRequest get(String url)

head

public static GetRequest head(String url)

options

public static HttpRequestWithBody options(String url)

post

public static HttpRequestWithBody post(String url)

delete

public static HttpRequestWithBody delete(String url)

patch

public static HttpRequestWithBody patch(String url)

put

public static HttpRequestWithBody put(String url)

jsonPatch

public static JsonPatchRequest jsonPatch(String url)

isRunning

public static boolean isRunning()