Package com.landawn.abacus.http

Class HttpRequest

java.lang.Object

com.landawn.abacus.http.HttpRequest

public final class HttpRequest
extends Object

Since:

1.3

Author:

Haiyang Li

Method Summary

Modifier and Type	Method	Description
ContinuableFuture<String>	asyncDelete()
<T> ContinuableFuture<T>	asyncDelete(Class<T> resultClass)
<T> ContinuableFuture<T>	asyncDelete(Class<T> resultClass, Object query)
ContinuableFuture<String>	asyncDelete(Object query)
ContinuableFuture<String>	asyncExecute(HttpMethod httpMethod)
ContinuableFuture<String>	asyncExecute(HttpMethod httpMethod, Object body)
ContinuableFuture<Void>	asyncExecute(File output, HttpMethod httpMethod, Object body)
ContinuableFuture<Void>	asyncExecute(OutputStream output, HttpMethod httpMethod, Object body)
ContinuableFuture<Void>	asyncExecute(Writer output, HttpMethod httpMethod, Object body)
<T> ContinuableFuture<T>	asyncExecute(Class<T> resultClass, HttpMethod httpMethod)
<T> ContinuableFuture<T>	asyncExecute(Class<T> resultClass, HttpMethod httpMethod, Object body)
ContinuableFuture<String>	asyncGet()
<T> ContinuableFuture<T>	asyncGet(Class<T> resultClass)
<T> ContinuableFuture<T>	asyncGet(Class<T> resultClass, Object query)
ContinuableFuture<String>	asyncGet(Object query)
<T> ContinuableFuture<T>	asyncPost(Class<T> resultClass, Object body)
ContinuableFuture<String>	asyncPost(Object body)
<T> ContinuableFuture<T>	asyncPut(Class<T> resultClass, Object body)
ContinuableFuture<String>	asyncPut(Object body)
HttpRequest	basicAuth(String user, Object password)
HttpRequest	connectionTimeout(int connectionTimeout)
static HttpRequest	create(HttpClient httpClient)
String	delete()
<T> T	delete(Class<T> resultClass)
<T> T	delete(Class<T> resultClass, Object query)
String	delete(Object query)
String	execute(HttpMethod httpMethod)
String	execute(HttpMethod httpMethod, Object body)
void	execute(File output, HttpMethod httpMethod, Object body)
void	execute(OutputStream output, HttpMethod httpMethod, Object body)
void	execute(Writer output, HttpMethod httpMethod, Object body)
<T> T	execute(Class<T> resultClass, HttpMethod httpMethod)
<T> T	execute(Class<T> resultClass, HttpMethod httpMethod, Object body)
String	get()
<T> T	get(Class<T> resultClass)
<T> T	get(Class<T> resultClass, Object query)
String	get(Object query)
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.
<T> T	post(Class<T> resultClass, Object body)
String	post(Object body)
<T> T	put(Class<T> resultClass, Object body)
String	put(Object body)
HttpRequest	readTimeout(int readTimeout)
static HttpRequest	url(String url)
static HttpRequest	url(String url, long connectionTimeoutInMillis, long readTimeoutInMillis)
HttpRequest	useCaches(boolean useCaches)

Methods inherited from class java.lang.Object

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

Method Details

create

public static HttpRequest create(HttpClient httpClient)

Parameters:

httpClient -

Returns:

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:

basicAuth

public HttpRequest basicAuth(String user,
 Object password)

Parameters:

user -

password -

Returns:

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:

• HttpSettings.header(String, Object)

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:

• HttpSettings.headers(String, Object, String, Object)

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:

• HttpSettings.headers(String, Object, String, Object, String, Object)

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:

• HttpSettings.headers(Map)

headers

public HttpRequest headers(HttpHeaders headers)

Removes all headers on this HttpSettings and adds headers.

Parameters:

headers -

Returns:

See Also:

• HttpSettings.headers(HttpHeaders)

connectionTimeout

public HttpRequest connectionTimeout(int connectionTimeout)

readTimeout

public HttpRequest readTimeout(int readTimeout)

useCaches

public HttpRequest useCaches(boolean useCaches)

get

public String get()
           throws UncheckedIOException

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 String get(Object query)

Parameters:

query -

Returns:

get

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

Type Parameters:

T -

Parameters:

resultClass -

query -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

post

public String post(Object body)

Parameters:

body -

Returns:

post

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

Type Parameters:

T -

Parameters:

resultClass -

body -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

put

public String put(Object body)
           throws UncheckedIOException

Parameters:

body -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

put

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

Type Parameters:

T -

Parameters:

resultClass -

body -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

public String delete()
              throws UncheckedIOException

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 String delete(Object query)
              throws UncheckedIOException

Parameters:

query -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

delete

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

Type Parameters:

T -

Parameters:

resultClass -

query -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

execute

public String execute(HttpMethod httpMethod)
               throws UncheckedIOException

Parameters:

httpMethod -

Returns:

Throws:

UncheckedIOException

execute

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

Type Parameters:

T -

Parameters:

resultClass -

httpMethod -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

execute

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

Parameters:

httpMethod -

body -

Returns:

Throws:

UncheckedIOException

execute

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

Type Parameters:

T -

Parameters:

resultClass -

httpMethod -

body -

Returns:

Throws:

UncheckedIOException - the unchecked IO exception

execute

public void execute(File output,
 HttpMethod httpMethod,
 Object body)
             throws UncheckedIOException

Throws:

UncheckedIOException

execute

public void execute(OutputStream output,
 HttpMethod httpMethod,
 Object body)
             throws UncheckedIOException

Throws:

UncheckedIOException

execute

public void execute(Writer output,
 HttpMethod httpMethod,
 Object body)
             throws UncheckedIOException

Throws:

UncheckedIOException

asyncGet

public ContinuableFuture<String> asyncGet()

asyncGet

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

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncGet

public ContinuableFuture<String> asyncGet(Object query)

Parameters:

query -

Returns:

asyncGet

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

Type Parameters:

T -

Parameters:

resultClass -

query -

Returns:

asyncPost

public ContinuableFuture<String> asyncPost(Object body)

Parameters:

body -

Returns:

asyncPost

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

Type Parameters:

T -

Parameters:

resultClass -

body -

Returns:

asyncPut

public ContinuableFuture<String> asyncPut(Object body)

Parameters:

body -

Returns:

asyncPut

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

Type Parameters:

T -

Parameters:

resultClass -

body -

Returns:

asyncDelete

public ContinuableFuture<String> asyncDelete()

asyncDelete

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

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncDelete

public ContinuableFuture<String> asyncDelete(Object query)

Parameters:

query -

Returns:

asyncDelete

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

Type Parameters:

T -

Parameters:

resultClass -

query -

Returns:

asyncExecute

public ContinuableFuture<String> asyncExecute(HttpMethod httpMethod)

asyncExecute

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

Type Parameters:

T -

Parameters:

resultClass -

Returns:

asyncExecute

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

Parameters:

body -

Returns:

asyncExecute

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

Type Parameters:

T -

Parameters:

resultClass -

body -

Returns:

asyncExecute

public ContinuableFuture<Void> asyncExecute(File output,
 HttpMethod httpMethod,
 Object body)

asyncExecute

public ContinuableFuture<Void> asyncExecute(OutputStream output,
 HttpMethod httpMethod,
 Object body)

asyncExecute

public ContinuableFuture<Void> asyncExecute(Writer output,
 HttpMethod httpMethod,
 Object body)