Package com.landawn.abacus.http
Class HttpRequest
java.lang.Object
com.landawn.abacus.http.HttpRequest
- Since:
- 1.3
- Author:
- Haiyang Li
- See Also:
-
Method Summary
Modifier and TypeMethodDescription<T> ContinuableFuture<T>
asyncDelete
(Class<T> resultClass) <T> ContinuableFuture<T>
asyncDelete
(Class<T> resultClass, Executor executor) asyncDelete
(Executor executor) asyncExecute
(HttpMethod httpMethod) asyncExecute
(HttpMethod httpMethod, File output) asyncExecute
(HttpMethod httpMethod, File output, Executor executor) asyncExecute
(HttpMethod httpMethod, OutputStream output) asyncExecute
(HttpMethod httpMethod, OutputStream output, Executor executor) asyncExecute
(HttpMethod httpMethod, Writer output) asyncExecute
(HttpMethod httpMethod, Writer output, Executor executor) <T> ContinuableFuture<T>
asyncExecute
(HttpMethod httpMethod, Class<T> resultClass) <T> ContinuableFuture<T>
asyncExecute
(HttpMethod httpMethod, Class<T> resultClass, Executor executor) asyncExecute
(HttpMethod httpMethod, Executor executor) asyncGet()
<T> ContinuableFuture<T>
<T> ContinuableFuture<T>
<T> ContinuableFuture<T>
<T> ContinuableFuture<T>
asyncPut()
<T> ContinuableFuture<T>
<T> ContinuableFuture<T>
connectionTimeout
(long connectionTimeout) connectionTimeout
(Duration connectionTimeout) static HttpRequest
create
(HttpClient httpClient) delete()
<T> T
execute
(HttpMethod httpMethod) void
execute
(HttpMethod httpMethod, File output) void
execute
(HttpMethod httpMethod, OutputStream output) void
execute
(HttpMethod httpMethod, Writer output) <T> T
execute
(HttpMethod httpMethod, Class<T> resultClass) get()
<T> T
head()
Set http header specified byname/value
.headers
(HttpHeaders headers) Removes all headers on thisHttpSettings
and addsheaders
.Set http headers specified byname1/value1
,name2/value2
.Set http headers specified byname1/value1
,name2/value2
,name3/value3
.Set http headers specified by the key/value entities fromMap
.post()
<T> T
put()
<T> T
Set query parameters forGET
orDELETE
request.Set query parameters forGET
orDELETE
request.readTimeout
(long readTimeout) readTimeout
(Duration readTimeout) static HttpRequest
static HttpRequest
static HttpRequest
Sets the URL target of this request.static HttpRequest
useCaches
(boolean useCaches)
-
Method Details
-
create
- Parameters:
httpClient
-- Returns:
-
url
- Parameters:
url
-- Returns:
-
url
- Parameters:
url
-connectionTimeoutInMillis
-readTimeoutInMillis
-- Returns:
-
url
Sets the URL target of this request.- Parameters:
url
-- Returns:
- Throws:
IllegalArgumentException
- if the scheme ofurl
is nothttp
orhttps
.
-
url
- Parameters:
url
-connectionTimeoutInMillis
-readTimeoutInMillis
-- Returns:
-
basicAuth
- Parameters:
user
-password
-- Returns:
- See Also:
-
header
Set http header specified byname/value
. If thisHttpSettings
already has any headers with that name, they are all replaced.- Parameters:
name
-value
-- Returns:
- See Also:
-
headers
Set http headers specified byname1/value1
,name2/value2
. If thisHttpSettings
already has any headers with that name, they are all replaced.- Parameters:
name1
-value1
-name2
-value2
-- Returns:
- See Also:
-
headers
public HttpRequest headers(String name1, Object value1, String name2, Object value2, String name3, Object value3) Set http headers specified byname1/value1
,name2/value2
,name3/value3
. If thisHttpSettings
already has any headers with that name, they are all replaced.- Parameters:
name1
-value1
-name2
-value2
-name3
-value3
-- Returns:
- See Also:
-
headers
Set http headers specified by the key/value entities fromMap
. If thisHttpSettings
already has any headers with that name, they are all replaced.- Parameters:
headers
-- Returns:
- See Also:
-
headers
Removes all headers on thisHttpSettings
and addsheaders
.- Parameters:
headers
-- Returns:
- See Also:
-
connectionTimeout
- Parameters:
connectionTimeout
-- Returns:
-
connectionTimeout
- Parameters:
connectionTimeout
-- Returns:
-
readTimeout
- Parameters:
readTimeout
-- Returns:
-
readTimeout
- Parameters:
readTimeout
-- Returns:
-
useCaches
- Parameters:
useCaches
-- Returns:
-
query
Set query parameters forGET
orDELETE
request.- Parameters:
query
-- Returns:
-
query
Set query parameters forGET
orDELETE
request.- Parameters:
queryParams
-- Returns:
-
jsonBody
- Parameters:
json
-- Returns:
-
jsonBody
- Parameters:
obj
-- Returns:
-
xmlBody
- Parameters:
xml
-- Returns:
-
xmlBody
- Parameters:
obj
-- Returns:
-
formBody
- Parameters:
formBodyByMap
-- Returns:
-
formBody
- Parameters:
formBodyByBean
-- Returns:
-
body
- Parameters:
requestBody
-- Returns:
-
get
- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
get
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
post
- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
post
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
put
- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
put
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
delete
- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
delete
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
head
- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
execute
- Parameters:
httpMethod
-- Returns:
- Throws:
UncheckedIOException
-
execute
- Type Parameters:
T
-- Parameters:
httpMethod
-resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
execute
- Parameters:
httpMethod
-output
-- Throws:
UncheckedIOException
-
execute
- Parameters:
httpMethod
-output
-- Throws:
UncheckedIOException
-
execute
- Parameters:
httpMethod
-output
-- Throws:
UncheckedIOException
-
asyncGet
- Returns:
-
asyncGet
- Parameters:
executor
-- Returns:
-
asyncGet
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
-
asyncGet
- Type Parameters:
T
-- Parameters:
resultClass
-executor
-- Returns:
-
asyncPost
- Returns:
-
asyncPost
- Parameters:
executor
-- Returns:
-
asyncPost
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
-
asyncPost
- Type Parameters:
T
-- Parameters:
resultClass
-executor
-- Returns:
-
asyncPut
- Returns:
-
asyncPut
- Parameters:
executor
-- Returns:
-
asyncPut
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
-
asyncPut
- Type Parameters:
T
-- Parameters:
resultClass
-executor
-- Returns:
-
asyncDelete
- Returns:
-
asyncDelete
- Parameters:
executor
-- Returns:
-
asyncDelete
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
-
asyncDelete
- Type Parameters:
T
-- Parameters:
resultClass
-executor
-- Returns:
-
asyncHead
- Returns:
-
asyncHead
- Parameters:
executor
-- Returns:
-
asyncExecute
- Parameters:
httpMethod
-- Returns:
-
asyncExecute
- Parameters:
httpMethod
-executor
-- Returns:
-
asyncExecute
- Type Parameters:
T
-- Parameters:
httpMethod
-resultClass
-- Returns:
-
asyncExecute
@Beta public <T> ContinuableFuture<T> asyncExecute(HttpMethod httpMethod, Class<T> resultClass, Executor executor) - Type Parameters:
T
-- Parameters:
httpMethod
-resultClass
-executor
-- Returns:
-
asyncExecute
- Parameters:
httpMethod
-output
-- Returns:
-
asyncExecute
@Beta public ContinuableFuture<Void> asyncExecute(HttpMethod httpMethod, File output, Executor executor) - Parameters:
httpMethod
-output
-executor
-- Returns:
-
asyncExecute
- Parameters:
httpMethod
-output
-- Returns:
-
asyncExecute
@Beta public ContinuableFuture<Void> asyncExecute(HttpMethod httpMethod, OutputStream output, Executor executor) - Parameters:
httpMethod
-output
-executor
-- Returns:
-
asyncExecute
- Parameters:
httpMethod
-output
-- Returns:
-
asyncExecute
@Beta public ContinuableFuture<Void> asyncExecute(HttpMethod httpMethod, Writer output, Executor executor) - Parameters:
httpMethod
-output
-executor
-- Returns:
-