com.landawn.abacus.http

Class HttpClient

java.lang.Object

com.landawn.abacus.http.AbstractHttpClient

com.landawn.abacus.http.HttpClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class HttpClient
extends AbstractHttpClient

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

Since:

0.8

Author:

Haiyang Li

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpClient.Request

Nested classes/interfaces inherited from class com.landawn.abacus.http.AbstractHttpClient

AbstractHttpClient.HttpSettings

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DO_INPUT Default value is true.
static java.lang.String	DO_OUTPUT Default value is true if the specified request/parameters is not null, otherwise it's false.
static java.lang.String	SSL_SOCKET_FACTORY

Fields inherited from class com.landawn.abacus.http.AbstractHttpClient

DEFAULT_CONNECTION_TIMEOUT, DEFAULT_MAX_CONNECTION, DEFAULT_READ_TIMEOUT

Method Summary

Modifier and Type	Method and Description
static <T> ContinuableFuture<T>	asyncDelete(java.lang.Class<T> resultClass, java.lang.String url, java.lang.Object parameters, java.util.Map<java.lang.String,java.lang.Object> settings)
static ContinuableFuture<java.lang.String>	asyncDelete(java.lang.String url, java.lang.Object parameters, java.util.Map<java.lang.String,java.lang.Object> settings)
static <T> ContinuableFuture<T>	asyncGet(java.lang.Class<T> resultClass, java.lang.String url, java.lang.Object parameters, java.util.Map<java.lang.String,java.lang.Object> settings)
static ContinuableFuture<java.lang.String>	asyncGet(java.lang.String url, java.lang.Object parameters, java.util.Map<java.lang.String,java.lang.Object> settings)
void	close(java.io.OutputStream os, java.io.InputStream is, java.net.HttpURLConnection connection)
static HttpClient	create(java.lang.String url)
static HttpClient	create(java.lang.String url, int maxConnection)
static HttpClient	create(java.lang.String url, int maxConnection, long connTimeout, long readTimeout)
static HttpClient	create(java.lang.String url, int maxConnection, long connTimeout, long readTimeout, java.util.Map<java.lang.String,java.lang.Object> settings)
static HttpClient	create(java.lang.String url, int maxConnection, long connTimeout, long readTimeout, java.util.Map<java.lang.String,java.lang.Object> settings, java.util.concurrent.atomic.AtomicInteger sharedActiveConnectionCounter)
static <T> T	delete(java.lang.Class<T> resultClass, java.lang.String url, java.lang.Object parameters, java.util.Map<java.lang.String,java.lang.Object> settings)
static java.lang.String	delete(java.lang.String url, java.lang.Object parameters, java.util.Map<java.lang.String,java.lang.Object> settings)
<T> T	execute(java.lang.Class<T> resultClass, HttpMethod httpMethod, java.lang.Object request, java.util.Map<java.lang.String,java.lang.Object> settings) Write the specified request to request body.
void	execute(java.io.File output, HttpMethod httpMethod, java.lang.Object request, java.util.Map<java.lang.String,java.lang.Object> settings)
void	execute(java.io.OutputStream output, HttpMethod httpMethod, java.lang.Object request, java.util.Map<java.lang.String,java.lang.Object> settings)
void	execute(java.io.Writer output, HttpMethod httpMethod, java.lang.Object request, java.util.Map<java.lang.String,java.lang.Object> settings)
static <T> T	get(java.lang.Class<T> resultClass, java.lang.String url, java.lang.Object parameters, java.util.Map<java.lang.String,java.lang.Object> settings)
static java.lang.String	get(java.lang.String url, java.lang.Object parameters, java.util.Map<java.lang.String,java.lang.Object> settings)
ContentFormat	getContentFormat(java.net.HttpURLConnection connection)
java.io.InputStream	getInputStream(java.net.HttpURLConnection connection)
java.io.InputStream	getInputStream(java.net.HttpURLConnection connection, ContentFormat contentFormat)
java.io.OutputStream	getOutputStream(java.net.HttpURLConnection connection, ContentFormat contentFormat)
java.io.OutputStream	getOutputStream(java.net.HttpURLConnection connection, java.util.Map<java.lang.String,java.lang.Object> settings)
static HttpClient	of(java.lang.String url)
static HttpClient	of(java.lang.String url, long connTimeout, long readTimeout)
java.net.HttpURLConnection	openConnection(HttpMethod httpMethod)
java.net.HttpURLConnection	openConnection(HttpMethod httpMethod, boolean doOutput)
java.net.HttpURLConnection	openConnection(HttpMethod httpMethod, boolean doOutput, java.util.Map<java.lang.String,java.lang.Object> settings)
java.net.HttpURLConnection	openConnection(HttpMethod httpMethod, java.util.Map<java.lang.String,java.lang.Object> settings)
java.net.HttpURLConnection	openConnection(HttpMethod httpMethod, java.lang.Object request, boolean doOutput, java.util.Map<java.lang.String,java.lang.Object> settings)

Methods inherited from class com.landawn.abacus.http.AbstractHttpClient

asyncDelete, asyncDelete, asyncDelete, asyncDelete, asyncDelete, asyncDelete, asyncExecute, asyncExecute, asyncExecute, asyncExecute, asyncExecute, asyncExecute, asyncExecute, asyncGet, asyncGet, asyncGet, asyncGet, asyncGet, asyncGet, asyncPost, asyncPost, asyncPost, asyncPost, asyncPut, asyncPut, asyncPut, asyncPut, close, delete, delete, delete, delete, delete, delete, execute, execute, execute, get, get, get, get, get, get, post, post, post, post, put, put, put, put, url

Methods inherited from class java.lang.Object

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

Field Detail

DO_INPUT

public static final java.lang.String DO_INPUT

Default value is true.

See Also:

Constant Field Values

DO_OUTPUT

public static final java.lang.String DO_OUTPUT

Default value is true if the specified request/parameters is not null, otherwise it's false.

See Also:

Constant Field Values

SSL_SOCKET_FACTORY

public static final java.lang.String SSL_SOCKET_FACTORY

See Also:

Constant Field Values

Method Detail

create

public static HttpClient create(java.lang.String url)

create

public static HttpClient create(java.lang.String url,
                                int maxConnection)

create

public static HttpClient create(java.lang.String url,
                                int maxConnection,
                                long connTimeout,
                                long readTimeout)

create

public static HttpClient create(java.lang.String url,
                                int maxConnection,
                                long connTimeout,
                                long readTimeout,
                                java.util.Map<java.lang.String,java.lang.Object> settings)

create

public static HttpClient create(java.lang.String url,
                                int maxConnection,
                                long connTimeout,
                                long readTimeout,
                                java.util.Map<java.lang.String,java.lang.Object> settings,
                                java.util.concurrent.atomic.AtomicInteger sharedActiveConnectionCounter)

of

public static HttpClient of(java.lang.String url)

of

public static HttpClient of(java.lang.String url,
                            long connTimeout,
                            long readTimeout)

get

public static java.lang.String get(java.lang.String url,
                                   java.lang.Object parameters,
                                   java.util.Map<java.lang.String,java.lang.Object> settings)

get

public static <T> T get(java.lang.Class<T> resultClass,
                        java.lang.String url,
                        java.lang.Object parameters,
                        java.util.Map<java.lang.String,java.lang.Object> settings)

asyncGet

public static ContinuableFuture<java.lang.String> asyncGet(java.lang.String url,
                                                           java.lang.Object parameters,
                                                           java.util.Map<java.lang.String,java.lang.Object> settings)

asyncGet

public static <T> ContinuableFuture<T> asyncGet(java.lang.Class<T> resultClass,
                                                java.lang.String url,
                                                java.lang.Object parameters,
                                                java.util.Map<java.lang.String,java.lang.Object> settings)

delete

public static java.lang.String delete(java.lang.String url,
                                      java.lang.Object parameters,
                                      java.util.Map<java.lang.String,java.lang.Object> settings)

delete

public static <T> T delete(java.lang.Class<T> resultClass,
                           java.lang.String url,
                           java.lang.Object parameters,
                           java.util.Map<java.lang.String,java.lang.Object> settings)

asyncDelete

public static ContinuableFuture<java.lang.String> asyncDelete(java.lang.String url,
                                                              java.lang.Object parameters,
                                                              java.util.Map<java.lang.String,java.lang.Object> settings)

asyncDelete

public static <T> ContinuableFuture<T> asyncDelete(java.lang.Class<T> resultClass,
                                                   java.lang.String url,
                                                   java.lang.Object parameters,
                                                   java.util.Map<java.lang.String,java.lang.Object> settings)

execute

public <T> T execute(java.lang.Class<T> resultClass,
                     HttpMethod httpMethod,
                     java.lang.Object request,
                     java.util.Map<java.lang.String,java.lang.Object> settings)

Description copied from class: AbstractHttpClient

Write the specified request to request body.

Specified by:

execute in class AbstractHttpClient

request - can be String/Map/Entity/InputStream/Reader...

Returns:

execute

public void execute(java.io.File output,
                    HttpMethod httpMethod,
                    java.lang.Object request,
                    java.util.Map<java.lang.String,java.lang.Object> settings)

Specified by:

execute in class AbstractHttpClient

Parameters:

output - write the InputStream in the response to this specified File.

execute

public void execute(java.io.OutputStream output,
                    HttpMethod httpMethod,
                    java.lang.Object request,
                    java.util.Map<java.lang.String,java.lang.Object> settings)

Specified by:

execute in class AbstractHttpClient

Parameters:

output - write the InputStream in the response to this specified OutputStream.

execute

public void execute(java.io.Writer output,
                    HttpMethod httpMethod,
                    java.lang.Object request,
                    java.util.Map<java.lang.String,java.lang.Object> settings)

Specified by:

execute in class AbstractHttpClient

Parameters:

output - write the InputStream in the response to this specified Writer.

getOutputStream

public java.io.OutputStream getOutputStream(java.net.HttpURLConnection connection,
                                            ContentFormat contentFormat)
                                     throws java.io.IOException

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream(java.net.HttpURLConnection connection,
                                            java.util.Map<java.lang.String,java.lang.Object> settings)
                                     throws java.io.IOException

Throws:

java.io.IOException

getContentFormat

public ContentFormat getContentFormat(java.net.HttpURLConnection connection)

getInputStream

public java.io.InputStream getInputStream(java.net.HttpURLConnection connection)
                                   throws java.io.IOException

Throws:

java.io.IOException

getInputStream

public java.io.InputStream getInputStream(java.net.HttpURLConnection connection,
                                          ContentFormat contentFormat)
                                   throws java.io.IOException

Throws:

java.io.IOException

openConnection

public java.net.HttpURLConnection openConnection(HttpMethod httpMethod)

openConnection

public java.net.HttpURLConnection openConnection(HttpMethod httpMethod,
                                                 boolean doOutput)

openConnection

public java.net.HttpURLConnection openConnection(HttpMethod httpMethod,
                                                 java.util.Map<java.lang.String,java.lang.Object> settings)

openConnection

public java.net.HttpURLConnection openConnection(HttpMethod httpMethod,
                                                 boolean doOutput,
                                                 java.util.Map<java.lang.String,java.lang.Object> settings)

openConnection

public java.net.HttpURLConnection openConnection(HttpMethod httpMethod,
                                                 java.lang.Object request,
                                                 boolean doOutput,
                                                 java.util.Map<java.lang.String,java.lang.Object> settings)

close

public void close(java.io.OutputStream os,
                  java.io.InputStream is,
                  java.net.HttpURLConnection connection)