Package com.landawn.abacus.http.v2
Class HttpRequest
java.lang.Object
com.landawn.abacus.http.v2.HttpRequest
- Author:
- Haiyang Li
- See Also:
-
Method Summary
Modifier and TypeMethodDescription<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) 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) asyncGet()
<T> CompletableFuture<T>
<T> CompletableFuture<HttpResponse<T>>
asyncGet
(HttpResponse.BodyHandler<T> responseBodyHandler) <T> CompletableFuture<HttpResponse<T>>
asyncGet
(HttpResponse.BodyHandler<T> responseBodyHandler, HttpResponse.PushPromiseHandler<T> pushPromiseHandler) <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) <T> CompletableFuture<T>
<T> CompletableFuture<HttpResponse<T>>
asyncPost
(HttpResponse.BodyHandler<T> responseBodyHandler) <T> CompletableFuture<HttpResponse<T>>
asyncPost
(HttpResponse.BodyHandler<T> responseBodyHandlerr, HttpResponse.PushPromiseHandler<T> pushPromiseHandler) asyncPut()
<T> CompletableFuture<T>
<T> CompletableFuture<HttpResponse<T>>
asyncPut
(HttpResponse.BodyHandler<T> responseBodyHandler) <T> CompletableFuture<HttpResponse<T>>
asyncPut
(HttpResponse.BodyHandler<T> responseBodyHandlerr, HttpResponse.PushPromiseHandler<T> pushPromiseHandler) authenticator
(Authenticator authenticator) body
(HttpRequest.BodyPublisher bodyPublisher) 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.delete()
<T> T
<T> HttpResponse<T>
delete
(HttpResponse.BodyHandler<T> responseBodyHandler) execute
(HttpMethod httpMethod) <T> T
execute
(HttpMethod httpMethod, Class<T> resultClass) <T> HttpResponse<T>
execute
(HttpMethod httpMethod, HttpResponse.BodyHandler<T> responseBodyHandler) get()
<T> T
<T> HttpResponse<T>
get
(HttpResponse.BodyHandler<T> responseBodyHandler) 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
.patch()
<T> T
<T> HttpResponse<T>
patch
(HttpResponse.BodyHandler<T> responseBodyHandler) post()
<T> T
<T> HttpResponse<T>
post
(HttpResponse.BodyHandler<T> responseBodyHandler) put()
<T> T
<T> HttpResponse<T>
put
(HttpResponse.BodyHandler<T> responseBodyHandler) Set query parameters forGET
orDELETE
request.Set query parameters forGET
orDELETE
request.readTimeout
(Duration readTimeout) static HttpRequest
static HttpRequest
static HttpRequest
Sets the URI target of this request.static HttpRequest
static HttpRequest
Sets the URI target of this request.static HttpRequest
-
Method Details
-
create
Sets the URI target of this request.- Parameters:
url
-httpClient
-- Returns:
- Throws:
IllegalArgumentException
- if the scheme ofurl
is nothttp
orhttps
.
-
create
Sets the URI target of this request.- Parameters:
url
-httpClient
-- Returns:
- Throws:
IllegalArgumentException
- if the scheme ofurl
is nothttp
orhttps
.
-
create
Sets the URI target of this request.- Parameters:
uri
-- Returns:
- Throws:
IllegalArgumentException
- if the scheme ofurl
is nothttp
orhttps
.
-
url
- Parameters:
url
-- Returns:
-
url
- Parameters:
url
-connectionTimeoutInMillis
-readTimeoutInMillis
-- Returns:
-
url
Sets the URI target of this request.- Parameters:
url
-- Returns:
- Throws:
IllegalArgumentException
- if the scheme ofurl
is nothttp
orhttps
.
-
url
- Parameters:
url
-connectionTimeoutInMillis
-readTimeoutInMillis
-- Returns:
-
url
Sets the URI target of this request.- Parameters:
uri
-- Returns:
- Throws:
IllegalArgumentException
- if the scheme ofurl
is nothttp
orhttps
.
-
url
- Parameters:
uri
-connectionTimeoutInMillis
-readTimeoutInMillis
-- Returns:
-
connectTimeout
- Parameters:
connectTimeout
-- Returns:
-
readTimeout
- Parameters:
readTimeout
-- Returns:
-
authenticator
- Parameters:
authenticator
-- 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:
-
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:
bodyPublisher
-- Returns:
-
get
- 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
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
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
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
put
- 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
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
patch
- 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
- Type Parameters:
T
-- Parameters:
resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
delete
- 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
- 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
@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
- Type Parameters:
T
-- Parameters:
httpMethod
-resultClass
-- Returns:
- Throws:
UncheckedIOException
- the unchecked IO exception
-
asyncGet
- Returns:
-
asyncGet
public <T> CompletableFuture<HttpResponse<T>> asyncGet(HttpResponse.BodyHandler<T> responseBodyHandler) - Type Parameters:
T
-- Parameters:
responseBodyHandler
-- Returns:
-
asyncGet
- 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
- Returns:
-
asyncPost
public <T> CompletableFuture<HttpResponse<T>> asyncPost(HttpResponse.BodyHandler<T> responseBodyHandler) - Type Parameters:
T
-- Parameters:
responseBodyHandler
-- Returns:
-
asyncPost
- 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
- Returns:
-
asyncPut
public <T> CompletableFuture<HttpResponse<T>> asyncPut(HttpResponse.BodyHandler<T> responseBodyHandler) - Type Parameters:
T
-- Parameters:
responseBodyHandler
-- Returns:
-
asyncPut
- 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
- Returns:
-
asyncPatch
public <T> CompletableFuture<HttpResponse<T>> asyncPatch(HttpResponse.BodyHandler<T> responseBodyHandler) - Type Parameters:
T
-- Parameters:
responseBodyHandler
-- Returns:
-
asyncPatch
- 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
- Returns:
-
asyncDelete
public <T> CompletableFuture<HttpResponse<T>> asyncDelete(HttpResponse.BodyHandler<T> responseBodyHandler) - Type Parameters:
T
-- Parameters:
responseBodyHandler
-- Returns:
-
asyncDelete
- 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
- Returns:
-
asyncExecute
- 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
- 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:
-