Package com.landawn.abacus.http.v2

Class HttpRequest

java.lang.Object

com.landawn.abacus.http.v2.HttpRequest

public final class HttpRequest
extends Object

Author:

Haiyang Li

See Also:

• URLEncodedUtil
• HttpHeaders

Method Summary

Modifier and Type	Method	Description
CompletableFuture<HttpResponse<String>>	asyncDelete()
<T> CompletableFuture<T>	asyncDelete(Class<T> resultClass)
<T> CompletableFuture<HttpResponse<T>>	asyncDelete(HttpResponse.BodyHandler<T> responseBodyHandler)
<T> CompletableFuture<HttpResponse<T>>	asyncDelete(HttpResponse.BodyHandler<T> responseBodyHandlerr, HttpResponse.PushPromiseHandler<T> pushPromiseHandler)
CompletableFuture<HttpResponse<String>>	asyncExecute(HttpMethod httpMethod)
<T> CompletableFuture<T>	asyncExecute(HttpMethod httpMethod, Class<T> resultClass)
<T> CompletableFuture<HttpResponse<T>>	asyncExecute(HttpMethod httpMethod, HttpResponse.BodyHandler<T> responseBodyHandler)
<T> CompletableFuture<HttpResponse<T>>	asyncExecute(HttpMethod httpMethod, HttpResponse.BodyHandler<T> responseBodyHandler, HttpResponse.PushPromiseHandler<T> pushPromiseHandler)
CompletableFuture<HttpResponse<String>>	asyncGet()
<T> CompletableFuture<T>	asyncGet(Class<T> resultClass)
<T> CompletableFuture<HttpResponse<T>>	asyncGet(HttpResponse.BodyHandler<T> responseBodyHandler)
<T> CompletableFuture<HttpResponse<T>>	asyncGet(HttpResponse.BodyHandler<T> responseBodyHandler, HttpResponse.PushPromiseHandler<T> pushPromiseHandler)
CompletableFuture<HttpResponse<Void>>	asyncHead()
CompletableFuture<HttpResponse<String>>	asyncPatch()
<T> CompletableFuture<T>	asyncPatch(Class<T> resultClass)
<T> CompletableFuture<HttpResponse<T>>	asyncPatch(HttpResponse.BodyHandler<T> responseBodyHandler)
<T> CompletableFuture<HttpResponse<T>>	asyncPatch(HttpResponse.BodyHandler<T> responseBodyHandlerr, HttpResponse.PushPromiseHandler<T> pushPromiseHandler)
CompletableFuture<HttpResponse<String>>	asyncPost()
<T> CompletableFuture<T>	asyncPost(Class<T> resultClass)
<T> CompletableFuture<HttpResponse<T>>	asyncPost(HttpResponse.BodyHandler<T> responseBodyHandler)
<T> CompletableFuture<HttpResponse<T>>	asyncPost(HttpResponse.BodyHandler<T> responseBodyHandlerr, HttpResponse.PushPromiseHandler<T> pushPromiseHandler)
CompletableFuture<HttpResponse<String>>	asyncPut()
<T> CompletableFuture<T>	asyncPut(Class<T> resultClass)
<T> CompletableFuture<HttpResponse<T>>	asyncPut(HttpResponse.BodyHandler<T> responseBodyHandler)
<T> CompletableFuture<HttpResponse<T>>	asyncPut(HttpResponse.BodyHandler<T> responseBodyHandlerr, HttpResponse.PushPromiseHandler<T> pushPromiseHandler)
HttpRequest	authenticator(Authenticator authenticator)
HttpRequest	basicAuth(String user, Object password)
HttpRequest	body(HttpRequest.BodyPublisher bodyPublisher)
HttpRequest	connectTimeout(Duration connectTimeout)
static HttpRequest	create(String url, HttpClient httpClient)	Sets the URI target of this request.
static HttpRequest	create(URI uri, HttpClient httpClient)	Sets the URI target of this request.
static HttpRequest	create(URL url, HttpClient httpClient)	Sets the URI target of this request.
HttpResponse<String>	delete()
<T> T	delete(Class<T> resultClass)
<T> HttpResponse<T>	delete(HttpResponse.BodyHandler<T> responseBodyHandler)
HttpResponse<String>	execute(HttpMethod httpMethod)
<T> T	execute(HttpMethod httpMethod, Class<T> resultClass)
<T> HttpResponse<T>	execute(HttpMethod httpMethod, HttpResponse.BodyHandler<T> responseBodyHandler)
HttpRequest	formBody(Object formBodyByBean)
HttpRequest	formBody(Map<?,?> formBodyByMap)
HttpResponse<String>	get()
<T> T	get(Class<T> resultClass)
<T> HttpResponse<T>	get(HttpResponse.BodyHandler<T> responseBodyHandler)
HttpResponse<Void>	head()
HttpRequest	header(String name, Object value)	Set http header specified by name/value.
HttpRequest	headers(HttpHeaders headers)	Removes all headers on this HttpSettings and adds headers.
HttpRequest	headers(String name1, Object value1, String name2, Object value2)	Set http headers specified by name1/value1, name2/value2.
HttpRequest	headers(String name1, Object value1, String name2, Object value2, String name3, Object value3)	Set http headers specified by name1/value1, name2/value2, name3/value3.
HttpRequest	headers(Map<String,?> headers)	Set http headers specified by the key/value entities from Map.
HttpRequest	jsonBody(Object obj)
HttpRequest	jsonBody(String json)
HttpResponse<String>	patch()
<T> T	patch(Class<T> resultClass)
<T> HttpResponse<T>	patch(HttpResponse.BodyHandler<T> responseBodyHandler)
HttpResponse<String>	post()
<T> T	post(Class<T> resultClass)
<T> HttpResponse<T>	post(HttpResponse.BodyHandler<T> responseBodyHandler)
HttpResponse<String>	put()
<T> T	put(Class<T> resultClass)
<T> HttpResponse<T>	put(HttpResponse.BodyHandler<T> responseBodyHandler)
HttpRequest	query(String query)	Set query parameters for GET or DELETE request.
HttpRequest	query(Map<String,?> queryParams)	Set query parameters for GET or DELETE request.
HttpRequest	readTimeout(Duration readTimeout)
static HttpRequest	url(String url)
static HttpRequest	url(String url, long connectionTimeoutInMillis, long readTimeoutInMillis)
static HttpRequest	url(URI uri)	Sets the URI target of this request.
static HttpRequest	url(URI uri, long connectionTimeoutInMillis, long readTimeoutInMillis)
static HttpRequest	url(URL url)	Sets the URI target of this request.
static HttpRequest	url(URL url, long connectionTimeoutInMillis, long readTimeoutInMillis)
HttpRequest	xmlBody(Object obj)
HttpRequest	xmlBody(String xml)

Methods inherited from class java.lang.Object

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

Method Details

create

public static HttpRequest create(String url,
 HttpClient httpClient)

Sets the URI target of this request.

Parameters:

url -

httpClient -

Returns:

Throws:

IllegalArgumentException - if the scheme of url is not http or https.

create

public static HttpRequest create(URL url,
 HttpClient httpClient)

Sets the URI target of this request.

Parameters:

url -

httpClient -

Returns:

Throws:

IllegalArgumentException - if the scheme of url is not http or https.

create

public static HttpRequest create(URI uri,
 HttpClient httpClient)

Sets the URI target of this request.

Parameters:

uri -

Returns:

Throws:

IllegalArgumentException - if the scheme of url is not http or https.

url

public static HttpRequest url(String url)

Parameters:

url -

Returns:

url

public static HttpRequest url(String url,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis)

Parameters:

url -

connectionTimeoutInMillis -

readTimeoutInMillis -

Returns:

url

public static HttpRequest url(URL url)

Sets the URI target of this request.

Parameters:

url -

Returns:

Throws:

IllegalArgumentException - if the scheme of url is not http or https.

url

public static HttpRequest url(URL url,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis)

Parameters:

url -

connectionTimeoutInMillis -

readTimeoutInMillis -

Returns:

url

public static HttpRequest url(URI uri)

Sets the URI target of this request.

Parameters:

uri -

Returns:

Throws:

IllegalArgumentException - if the scheme of url is not http or https.

url

public static HttpRequest url(URI uri,
 long connectionTimeoutInMillis,
 long readTimeoutInMillis)

Parameters:

uri -

connectionTimeoutInMillis -

readTimeoutInMillis -

Returns:

connectTimeout

public HttpRequest connectTimeout(Duration connectTimeout)

Parameters:

connectTimeout -

Returns:

readTimeout

public HttpRequest readTimeout(Duration readTimeout)

Parameters:

readTimeout -

Returns:

authenticator

public HttpRequest authenticator(Authenticator authenticator)

Parameters:

authenticator -

Returns:

basicAuth

public HttpRequest basicAuth(String user,
 Object password)

Parameters:

user -

password -

Returns:

See Also:

• HttpHeaders

header

public HttpRequest 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:

See Also:

• HttpHeaders

headers

public HttpRequest 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:

See Also:

• HttpHeaders

headers

public HttpRequest 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:

See Also:

• HttpHeaders

headers

public HttpRequest 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:

See Also:

• HttpHeaders

headers

public HttpRequest headers(HttpHeaders headers)

Removes all headers on this HttpSettings and adds headers.

Parameters:

headers -

Returns:

See Also:

• HttpHeaders

query

public HttpRequest query(String query)

Set query parameters for GET or DELETE request.

Parameters:

query -

Returns:

query

public HttpRequest query(Map<String,?> queryParams)

Set query parameters for GET or DELETE request.

Parameters:

queryParams -

Returns:

jsonBody

public HttpRequest jsonBody(String json)

Parameters:

json -

Returns:

jsonBody

public HttpRequest jsonBody(Object obj)

Parameters:

obj -

Returns:

xmlBody

public HttpRequest xmlBody(String xml)

Parameters:

xml -

Returns:

xmlBody

public HttpRequest xmlBody(Object obj)

Parameters:

obj -

Returns:

formBody

public HttpRequest formBody(Map<?,?> formBodyByMap)

Parameters:

formBodyByMap -

Returns:

formBody

public HttpRequest formBody(Object formBodyByBean)

Parameters:

formBodyByBean -

Returns:

body

public HttpRequest body(HttpRequest.BodyPublisher bodyPublisher)

Parameters:

bodyPublisher -

Returns:

get

public HttpResponse<String> get()
                         throws UncheckedIOException

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

get

public <T> HttpResponse<T> get(HttpResponse.BodyHandler<T> responseBodyHandler)
                        throws UncheckedIOException

Type Parameters:

T -

Parameters:

responseBodyHandler -

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

post

public HttpResponse<String> post()

Returns:

post

public <T> HttpResponse<T> post(HttpResponse.BodyHandler<T> responseBodyHandler)
                         throws UncheckedIOException

Type Parameters:

T -

Parameters:

responseBodyHandler -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

post

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

Type Parameters:

T -

Parameters:

resultClass -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

put

public HttpResponse<String> put()
                         throws UncheckedIOException

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

put

public <T> HttpResponse<T> put(HttpResponse.BodyHandler<T> responseBodyHandler)
                        throws UncheckedIOException

Type Parameters:

T -

Parameters:

responseBodyHandler -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

put

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

Type Parameters:

T -

Parameters:

resultClass -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

patch

public HttpResponse<String> patch()
                           throws UncheckedIOException

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

patch

public <T> HttpResponse<T> patch(HttpResponse.BodyHandler<T> responseBodyHandler)
                          throws UncheckedIOException

Type Parameters:

T -

Parameters:

responseBodyHandler -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

patch

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

Type Parameters:

T -

Parameters:

resultClass -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public HttpResponse<String> delete()
                            throws UncheckedIOException

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public <T> HttpResponse<T> delete(HttpResponse.BodyHandler<T> responseBodyHandler)
                           throws UncheckedIOException

Type Parameters:

T -

Parameters:

responseBodyHandler -

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

head

public HttpResponse<Void> head()
                        throws UncheckedIOException

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

execute

@Beta
public HttpResponse<String> execute(HttpMethod httpMethod)
                             throws UncheckedIOException

Parameters:

httpMethod -

Returns:

Throws:

UncheckedIOException

execute

@Beta
public <T> HttpResponse<T> execute(HttpMethod httpMethod,
 HttpResponse.BodyHandler<T> responseBodyHandler)
                            throws UncheckedIOException

Type Parameters:

T -

Parameters:

httpMethod -

responseBodyHandler -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

execute

@Beta
public <T> T execute(HttpMethod httpMethod,
 Class<T> resultClass)
              throws UncheckedIOException

Type Parameters:

T -

Parameters:

httpMethod -

resultClass -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

asyncGet

public CompletableFuture<HttpResponse<String>> asyncGet()

Returns:

asyncGet

public <T> CompletableFuture<HttpResponse<T>> asyncGet(HttpResponse.BodyHandler<T> responseBodyHandler)

Type Parameters:

T -

Parameters:

responseBodyHandler -

Returns:

asyncGet

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

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncGet

public <T> CompletableFuture<HttpResponse<T>> asyncGet(HttpResponse.BodyHandler<T> responseBodyHandler,
 HttpResponse.PushPromiseHandler<T> pushPromiseHandler)

Type Parameters:

T -

Parameters:

responseBodyHandler -

pushPromiseHandler -

Returns:

asyncPost

public CompletableFuture<HttpResponse<String>> asyncPost()

Returns:

asyncPost

public <T> CompletableFuture<HttpResponse<T>> asyncPost(HttpResponse.BodyHandler<T> responseBodyHandler)

Type Parameters:

T -

Parameters:

responseBodyHandler -

Returns:

asyncPost

public <T> CompletableFuture<T> asyncPost(Class<T> resultClass)

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncPost

public <T> CompletableFuture<HttpResponse<T>> asyncPost(HttpResponse.BodyHandler<T> responseBodyHandlerr,
 HttpResponse.PushPromiseHandler<T> pushPromiseHandler)

Type Parameters:

T -

Parameters:

responseBodyHandlerr -

pushPromiseHandler -

Returns:

asyncPut

public CompletableFuture<HttpResponse<String>> asyncPut()

Returns:

asyncPut

public <T> CompletableFuture<HttpResponse<T>> asyncPut(HttpResponse.BodyHandler<T> responseBodyHandler)

Type Parameters:

T -

Parameters:

responseBodyHandler -

Returns:

asyncPut

public <T> CompletableFuture<T> asyncPut(Class<T> resultClass)

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncPut

public <T> CompletableFuture<HttpResponse<T>> asyncPut(HttpResponse.BodyHandler<T> responseBodyHandlerr,
 HttpResponse.PushPromiseHandler<T> pushPromiseHandler)

Type Parameters:

T -

Parameters:

responseBodyHandlerr -

pushPromiseHandler -

Returns:

asyncPatch

public CompletableFuture<HttpResponse<String>> asyncPatch()

Returns:

asyncPatch

public <T> CompletableFuture<HttpResponse<T>> asyncPatch(HttpResponse.BodyHandler<T> responseBodyHandler)

Type Parameters:

T -

Parameters:

responseBodyHandler -

Returns:

asyncPatch

public <T> CompletableFuture<T> asyncPatch(Class<T> resultClass)

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncPatch

public <T> CompletableFuture<HttpResponse<T>> asyncPatch(HttpResponse.BodyHandler<T> responseBodyHandlerr,
 HttpResponse.PushPromiseHandler<T> pushPromiseHandler)

Type Parameters:

T -

Parameters:

responseBodyHandlerr -

pushPromiseHandler -

Returns:

asyncDelete

public CompletableFuture<HttpResponse<String>> asyncDelete()

Returns:

asyncDelete

public <T> CompletableFuture<HttpResponse<T>> asyncDelete(HttpResponse.BodyHandler<T> responseBodyHandler)

Type Parameters:

T -

Parameters:

responseBodyHandler -

Returns:

asyncDelete

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

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncDelete

public <T> CompletableFuture<HttpResponse<T>> asyncDelete(HttpResponse.BodyHandler<T> responseBodyHandlerr,
 HttpResponse.PushPromiseHandler<T> pushPromiseHandler)

Type Parameters:

T -

Parameters:

responseBodyHandlerr -

pushPromiseHandler -

Returns:

asyncHead

public CompletableFuture<HttpResponse<Void>> asyncHead()

Returns:

asyncExecute

@Beta
public CompletableFuture<HttpResponse<String>> asyncExecute(HttpMethod httpMethod)

Parameters:

httpMethod -

Returns:

asyncExecute

@Beta
public <T> CompletableFuture<HttpResponse<T>> asyncExecute(HttpMethod httpMethod,
 HttpResponse.BodyHandler<T> responseBodyHandler)

Type Parameters:

T -

Parameters:

httpMethod -

responseBodyHandler -

Returns:

asyncExecute

@Beta
public <T> CompletableFuture<T> asyncExecute(HttpMethod httpMethod,
 Class<T> resultClass)

Type Parameters:

T -

Parameters:

httpMethod -

resultClass -

Returns:

asyncExecute

@Beta
public <T> CompletableFuture<HttpResponse<T>> asyncExecute(HttpMethod httpMethod,
 HttpResponse.BodyHandler<T> responseBodyHandler,
 HttpResponse.PushPromiseHandler<T> pushPromiseHandler)

Type Parameters:

T -

Parameters:

httpMethod -

responseBodyHandler -

pushPromiseHandler -

Returns: