Package com.landawn.abacus.http

Class HttpClient

java.lang.Object

com.landawn.abacus.http.HttpClient

public final class HttpClient
extends Object

Any header can be set into the parameter settings
HttpClient is thread safe.

Since:

0.8

Author:

Haiyang Li

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CONNECTION_TIMEOUT	Unit is milliseconds.
static final int	DEFAULT_MAX_CONNECTION
static final int	DEFAULT_READ_TIMEOUT

Method Summary

Modifier and Type	Method	Description
ContinuableFuture<String>	asyncDelete()
ContinuableFuture<String>	asyncDelete(HttpSettings settings)
<T> ContinuableFuture<T>	asyncDelete(Class<T> resultClass)
<T> ContinuableFuture<T>	asyncDelete(Class<T> resultClass, HttpSettings settings)
<T> ContinuableFuture<T>	asyncDelete(Class<T> resultClass, Object queryParameters)
<T> ContinuableFuture<T>	asyncDelete(Class<T> resultClass, Object queryParameters, HttpSettings settings)
ContinuableFuture<String>	asyncDelete(Object queryParameters)
ContinuableFuture<String>	asyncDelete(Object queryParameters, HttpSettings settings)
ContinuableFuture<String>	asyncExecute(HttpMethod httpMethod, Object request)
ContinuableFuture<String>	asyncExecute(HttpMethod httpMethod, Object request, HttpSettings settings)
ContinuableFuture<Void>	asyncExecute(File output, HttpMethod httpMethod, Object request, HttpSettings settings)
ContinuableFuture<Void>	asyncExecute(OutputStream output, HttpMethod httpMethod, Object request, HttpSettings settings)
ContinuableFuture<Void>	asyncExecute(Writer output, HttpMethod httpMethod, Object request, HttpSettings settings)
<T> ContinuableFuture<T>	asyncExecute(Class<T> resultClass, HttpMethod httpMethod, Object request)
<T> ContinuableFuture<T>	asyncExecute(Class<T> resultClass, HttpMethod httpMethod, Object request, HttpSettings settings)
ContinuableFuture<String>	asyncGet()
ContinuableFuture<String>	asyncGet(HttpSettings settings)
<T> ContinuableFuture<T>	asyncGet(Class<T> resultClass)
<T> ContinuableFuture<T>	asyncGet(Class<T> resultClass, HttpSettings settings)
<T> ContinuableFuture<T>	asyncGet(Class<T> resultClass, Object queryParameters)
<T> ContinuableFuture<T>	asyncGet(Class<T> resultClass, Object queryParameters, HttpSettings settings)
ContinuableFuture<String>	asyncGet(Object queryParameters)
ContinuableFuture<String>	asyncGet(Object queryParameters, HttpSettings settings)
<T> ContinuableFuture<T>	asyncPost(Class<T> resultClass, Object request)
<T> ContinuableFuture<T>	asyncPost(Class<T> resultClass, Object request, HttpSettings settings)
ContinuableFuture<String>	asyncPost(Object request)
ContinuableFuture<String>	asyncPost(Object request, HttpSettings settings)
<T> ContinuableFuture<T>	asyncPut(Class<T> resultClass, Object request)
<T> ContinuableFuture<T>	asyncPut(Class<T> resultClass, Object request, HttpSettings settings)
ContinuableFuture<String>	asyncPut(Object request)
ContinuableFuture<String>	asyncPut(Object request, HttpSettings settings)
void	close()	Close.
static HttpClient	create(String url)
static HttpClient	create(String url, int maxConnection)
static HttpClient	create(String url, int maxConnection, long connectionTimeoutInMillis, long readTimeoutInMillis)
static HttpClient	create(String url, int maxConnection, long connectionTimeoutInMillis, long readTimeoutInMillis, HttpSettings settings)
static HttpClient	create(String url, int maxConnection, long connectionTimeoutInMillis, long readTimeoutInMillis, HttpSettings settings, AtomicInteger sharedActiveConnectionCounter)
static HttpClient	create(String url, int maxConnection, long connectionTimeoutInMillis, long readTimeoutInMillis, HttpSettings settings, AtomicInteger sharedActiveConnectionCounter, Executor executor)
static HttpClient	create(String url, int maxConnection, long connectionTimeoutInMillis, long readTimeoutInMillis, HttpSettings settings, Executor executor)
static HttpClient	create(String url, int maxConnection, long connectionTimeoutInMillis, long readTimeoutInMillis, Executor executor)
static HttpClient	create(String url, long connectionTimeoutInMillis, long readTimeoutInMillis)
String	delete()
String	delete(HttpSettings settings)
<T> T	delete(Class<T> resultClass)
<T> T	delete(Class<T> resultClass, HttpSettings settings)
<T> T	delete(Class<T> resultClass, Object queryParameters)
<T> T	delete(Class<T> resultClass, Object queryParameters, HttpSettings settings)
String	delete(Object queryParameters)
String	delete(Object queryParameters, HttpSettings settings)
String	execute(HttpMethod httpMethod, Object request)
String	execute(HttpMethod httpMethod, Object request, HttpSettings settings)
void	execute(File output, HttpMethod httpMethod, Object request, HttpSettings settings)
void	execute(OutputStream output, HttpMethod httpMethod, Object request, HttpSettings settings)
void	execute(Writer output, HttpMethod httpMethod, Object request, HttpSettings settings)
<T> T	execute(Class<T> resultClass, HttpMethod httpMethod, Object request)
<T> T	execute(Class<T> resultClass, HttpMethod httpMethod, Object request, HttpSettings settings)
String	get()
String	get(HttpSettings settings)
<T> T	get(Class<T> resultClass)
<T> T	get(Class<T> resultClass, HttpSettings settings)
<T> T	get(Class<T> resultClass, Object queryParameters)
<T> T	get(Class<T> resultClass, Object queryParameters, HttpSettings settings)
String	get(Object queryParameters)
String	get(Object queryParameters, HttpSettings settings)
<T> T	post(Class<T> resultClass, Object request)
<T> T	post(Class<T> resultClass, Object request, HttpSettings settings)
String	post(Object request)
String	post(Object request, HttpSettings settings)
<T> T	put(Class<T> resultClass, Object request)
<T> T	put(Class<T> resultClass, Object request, HttpSettings settings)
String	put(Object request)
String	put(Object request, HttpSettings settings)
String	url()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_CONNECTION

public static final int DEFAULT_MAX_CONNECTION

See Also:

• Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

Unit is milliseconds.

See Also:

• Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

See Also:

• Constant Field Values

Method Details

create

public static HttpClient create(String url)

Parameters:

url -

Returns:

create

public static HttpClient create(String url,
 int maxConnection)

Parameters:

url -

maxConnection -

Returns:

create

public static HttpClient create(String url,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis)

Parameters:

url -

connectionTimeoutInMillis -

readTimeoutInMillis -

Returns:

create

public static HttpClient create(String url,
 int maxConnection,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis)

Parameters:

url -

maxConnection -

connectionTimeoutInMillis -

readTimeoutInMillis -

Returns:

create

public static HttpClient create(String url,
 int maxConnection,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis,
 HttpSettings settings)
                         throws UncheckedIOException

Parameters:

url -

maxConnection -

connectionTimeoutInMillis -

readTimeoutInMillis -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

create

public static HttpClient create(String url,
 int maxConnection,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis,
 HttpSettings settings,
 AtomicInteger sharedActiveConnectionCounter)

Parameters:

url -

maxConnection -

connectionTimeoutInMillis -

readTimeoutInMillis -

settings -

sharedActiveConnectionCounter -

Returns:

create

public static HttpClient create(String url,
 int maxConnection,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis,
 Executor executor)

Parameters:

url -

maxConnection -

connectionTimeoutInMillis -

readTimeoutInMillis -

executor -

Returns:

create

public static HttpClient create(String url,
 int maxConnection,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis,
 HttpSettings settings,
 Executor executor)
                         throws UncheckedIOException

Parameters:

url -

maxConnection -

connectionTimeoutInMillis -

readTimeoutInMillis -

settings -

executor -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

create

public static HttpClient create(String url,
 int maxConnection,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis,
 HttpSettings settings,
 AtomicInteger sharedActiveConnectionCounter,
 Executor executor)

Parameters:

url -

maxConnection -

connectionTimeoutInMillis -

readTimeoutInMillis -

settings -

sharedActiveConnectionCounter -

executor -

Returns:

url

public String url()

Returns:

get

public String get()
           throws UncheckedIOException

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

get

public String get(HttpSettings settings)
           throws UncheckedIOException

Parameters:

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

get

public String get(Object queryParameters)
           throws UncheckedIOException

Parameters:

queryParameters -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

get

public String get(Object queryParameters,
 HttpSettings settings)
           throws UncheckedIOException

Parameters:

queryParameters -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

get

public <T> T get(Class<T> resultClass)
          throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

get

public <T> T get(Class<T> resultClass,
 HttpSettings settings)
          throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

get

public <T> T get(Class<T> resultClass,
 Object queryParameters)
          throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

queryParameters -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

get

public <T> T get(Class<T> resultClass,
 Object queryParameters,
 HttpSettings settings)
          throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

queryParameters -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

asyncGet

public ContinuableFuture<String> asyncGet()

Returns:

asyncGet

public ContinuableFuture<String> asyncGet(HttpSettings settings)

Parameters:

settings -

Returns:

asyncGet

public ContinuableFuture<String> asyncGet(Object queryParameters)

Parameters:

queryParameters -

Returns:

asyncGet

public ContinuableFuture<String> asyncGet(Object queryParameters,
 HttpSettings settings)

Parameters:

queryParameters -

settings -

Returns:

asyncGet

public <T> ContinuableFuture<T> asyncGet(Class<T> resultClass)

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncGet

public <T> ContinuableFuture<T> asyncGet(Class<T> resultClass,
 HttpSettings settings)

Type Parameters:

T -

Parameters:

resultClass -

settings -

Returns:

asyncGet

public <T> ContinuableFuture<T> asyncGet(Class<T> resultClass,
 Object queryParameters)

Type Parameters:

T -

Parameters:

resultClass -

queryParameters -

Returns:

asyncGet

public <T> ContinuableFuture<T> asyncGet(Class<T> resultClass,
 Object queryParameters,
 HttpSettings settings)

Type Parameters:

T -

Parameters:

resultClass -

queryParameters -

settings -

Returns:

delete

public String delete()
              throws UncheckedIOException

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public String delete(HttpSettings settings)
              throws UncheckedIOException

Parameters:

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public String delete(Object queryParameters)
              throws UncheckedIOException

Parameters:

queryParameters -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public String delete(Object queryParameters,
 HttpSettings settings)
              throws UncheckedIOException

Parameters:

queryParameters -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public <T> T delete(Class<T> resultClass)
             throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public <T> T delete(Class<T> resultClass,
 HttpSettings settings)
             throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public <T> T delete(Class<T> resultClass,
 Object queryParameters)
             throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

queryParameters -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public <T> T delete(Class<T> resultClass,
 Object queryParameters,
 HttpSettings settings)
             throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

queryParameters -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

asyncDelete

public ContinuableFuture<String> asyncDelete()

Returns:

asyncDelete

public ContinuableFuture<String> asyncDelete(HttpSettings settings)

Parameters:

settings -

Returns:

asyncDelete

public ContinuableFuture<String> asyncDelete(Object queryParameters)

Parameters:

queryParameters -

Returns:

asyncDelete

public ContinuableFuture<String> asyncDelete(Object queryParameters,
 HttpSettings settings)

Parameters:

queryParameters -

settings -

Returns:

asyncDelete

public <T> ContinuableFuture<T> asyncDelete(Class<T> resultClass)

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncDelete

public <T> ContinuableFuture<T> asyncDelete(Class<T> resultClass,
 HttpSettings settings)

Type Parameters:

T -

Parameters:

resultClass -

settings -

Returns:

asyncDelete

public <T> ContinuableFuture<T> asyncDelete(Class<T> resultClass,
 Object queryParameters)

Type Parameters:

T -

Parameters:

resultClass -

queryParameters -

Returns:

asyncDelete

public <T> ContinuableFuture<T> asyncDelete(Class<T> resultClass,
 Object queryParameters,
 HttpSettings settings)

Type Parameters:

T -

Parameters:

resultClass -

queryParameters -

settings -

Returns:

post

public String post(Object request)
            throws UncheckedIOException

Parameters:

request -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

post

public String post(Object request,
 HttpSettings settings)
            throws UncheckedIOException

Parameters:

request -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

post

public <T> T post(Class<T> resultClass,
 Object request)
           throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

request -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

post

public <T> T post(Class<T> resultClass,
 Object request,
 HttpSettings settings)
           throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

request -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

asyncPost

public ContinuableFuture<String> asyncPost(Object request)

Parameters:

request -

Returns:

asyncPost

public ContinuableFuture<String> asyncPost(Object request,
 HttpSettings settings)

Parameters:

request -

settings -

Returns:

asyncPost

public <T> ContinuableFuture<T> asyncPost(Class<T> resultClass,
 Object request)

Type Parameters:

T -

Parameters:

resultClass -

request -

Returns:

asyncPost

public <T> ContinuableFuture<T> asyncPost(Class<T> resultClass,
 Object request,
 HttpSettings settings)

Type Parameters:

T -

Parameters:

resultClass -

request -

settings -

Returns:

put

public String put(Object request)
           throws UncheckedIOException

Parameters:

request -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

put

public String put(Object request,
 HttpSettings settings)
           throws UncheckedIOException

Parameters:

request -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

put

public <T> T put(Class<T> resultClass,
 Object request)
          throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

request -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

put

public <T> T put(Class<T> resultClass,
 Object request,
 HttpSettings settings)
          throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

request -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

asyncPut

public ContinuableFuture<String> asyncPut(Object request)

Parameters:

request -

Returns:

asyncPut

public ContinuableFuture<String> asyncPut(Object request,
 HttpSettings settings)

Parameters:

request -

settings -

Returns:

asyncPut

public <T> ContinuableFuture<T> asyncPut(Class<T> resultClass,
 Object request)

Type Parameters:

T -

Parameters:

resultClass -

request -

Returns:

asyncPut

public <T> ContinuableFuture<T> asyncPut(Class<T> resultClass,
 Object request,
 HttpSettings settings)

Type Parameters:

T -

Parameters:

resultClass -

request -

settings -

Returns:

execute

public String execute(HttpMethod httpMethod,
 Object request)
               throws UncheckedIOException

Parameters:

httpMethod -

request -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

execute

public String execute(HttpMethod httpMethod,
 Object request,
 HttpSettings settings)
               throws UncheckedIOException

Parameters:

httpMethod -

request -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

execute

public <T> T execute(Class<T> resultClass,
 HttpMethod httpMethod,
 Object request)
              throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

httpMethod -

request -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

execute

public <T> T execute(Class<T> resultClass,
 HttpMethod httpMethod,
 Object request,
 HttpSettings settings)
              throws UncheckedIOException

Type Parameters:

T -

Parameters:

resultClass -

httpMethod -

request -

settings -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

execute

public void execute(File output,
 HttpMethod httpMethod,
 Object request,
 HttpSettings settings)
             throws UncheckedIOException

Parameters:

output -

httpMethod -

request -

settings -

Throws:

UncheckedIOException - the unchecked IO exception

execute

public void execute(OutputStream output,
 HttpMethod httpMethod,
 Object request,
 HttpSettings settings)
             throws UncheckedIOException

Parameters:

output -

httpMethod -

request -

settings -

Throws:

UncheckedIOException - the unchecked IO exception

execute

public void execute(Writer output,
 HttpMethod httpMethod,
 Object request,
 HttpSettings settings)
             throws UncheckedIOException

Parameters:

output -

httpMethod -

request -

settings -

Throws:

UncheckedIOException - the unchecked IO exception

asyncExecute

public ContinuableFuture<String> asyncExecute(HttpMethod httpMethod,
 Object request)

Parameters:

httpMethod -

request -

Returns:

asyncExecute

public ContinuableFuture<String> asyncExecute(HttpMethod httpMethod,
 Object request,
 HttpSettings settings)

Parameters:

httpMethod -

request -

settings -

Returns:

asyncExecute

public <T> ContinuableFuture<T> asyncExecute(Class<T> resultClass,
 HttpMethod httpMethod,
 Object request)

Type Parameters:

T -

Parameters:

resultClass -

httpMethod -

request -

Returns:

asyncExecute

public <T> ContinuableFuture<T> asyncExecute(Class<T> resultClass,
 HttpMethod httpMethod,
 Object request,
 HttpSettings settings)

Type Parameters:

T -

Parameters:

resultClass -

httpMethod -

request -

settings -

Returns:

asyncExecute

public ContinuableFuture<Void> asyncExecute(File output,
 HttpMethod httpMethod,
 Object request,
 HttpSettings settings)

Parameters:

output -

httpMethod -

request -

settings -

Returns:

asyncExecute

public ContinuableFuture<Void> asyncExecute(OutputStream output,
 HttpMethod httpMethod,
 Object request,
 HttpSettings settings)

Parameters:

output -

httpMethod -

request -

settings -

Returns:

asyncExecute

public ContinuableFuture<Void> asyncExecute(Writer output,
 HttpMethod httpMethod,
 Object request,
 HttpSettings settings)

Parameters:

output -

httpMethod -

request -

settings -

Returns:

close

public void close()

Close.