public interface WebTarget
Modifier and Type | Method and Description |
---|---|
default WebTarget |
addContentType(org.apache.http.entity.ContentType contentType)
Sets content type to header
|
WebTarget |
addHeader(org.apache.http.Header header)
Adds the given header to the request.
|
default WebTarget |
addHeader(String name,
String value)
Adds the given name and value as header to the request.
|
default WebTarget |
addHeaders(Collection<? extends org.apache.http.Header> headers)
Adds the given headers to the request.
|
WebTarget |
addParameter(org.apache.http.NameValuePair nameValuePair)
Added parameter into request
|
default WebTarget |
addParameter(String name,
String value)
Add parameter into request name as request parameter name value as request parameter value
|
default WebTarget |
addParameters(Collection<? extends org.apache.http.NameValuePair> parameters)
Add parameters into request
|
default WebTarget |
addParameters(Map<String,String> parameters)
Add parameters into request key as request parameter name Value as request parameter value
|
default WebTarget |
addParameters(org.apache.http.NameValuePair... parameters)
Add parameters into request
|
default WebTarget |
addParameters(String... nameValues)
Add parameters into request as [nameValues[0]: nameValues[1], nameValues[2]: nameValues[3], ...
|
default WebTarget |
addParameters(String queryString)
Add parameters from queryString.
|
default WebTarget |
addParameters(String queryString,
Charset charset)
Add parameters from queryString.
|
default Response |
delete() |
default <T> ResponseHandler<T> |
delete(Class<T> responseType) |
default Response |
delete(org.apache.http.HttpEntity httpEntity) |
default <T> ResponseHandler<T> |
delete(org.apache.http.HttpEntity httpEntity,
Class<T> responseType) |
default <T> ResponseHandler<T> |
delete(org.apache.http.HttpEntity httpEntity,
TypeReference<T> responseType) |
default Response |
delete(String payload) |
default <T> ResponseHandler<T> |
delete(String payload,
Class<T> responseType) |
default <T> ResponseHandler<T> |
delete(String payload,
TypeReference<T> responseType) |
default <T> ResponseHandler<T> |
delete(TypeReference<T> responseType) |
default Response |
get()
Invoke HTTP GET method for the current request
|
default <T> ResponseHandler<T> |
get(Class<T> responseType) |
default Response |
get(org.apache.http.HttpEntity httpEntity)
Invoke HTTP GET method for the current request
|
default <T> ResponseHandler<T> |
get(org.apache.http.HttpEntity httpEntity,
Class<T> responseType) |
default <T> ResponseHandler<T> |
get(org.apache.http.HttpEntity httpEntity,
TypeReference<T> responseType) |
default Response |
get(String payload) |
default <T> ResponseHandler<T> |
get(String payload,
Class<T> responseType) |
default <T> ResponseHandler<T> |
get(String payload,
TypeReference<T> responseType) |
default <T> ResponseHandler<T> |
get(TypeReference<T> responseType) |
default Response |
head() |
default <T> ResponseHandler<T> |
head(Class<T> responseType) |
default Response |
head(org.apache.http.HttpEntity httpEntity) |
default <T> ResponseHandler<T> |
head(org.apache.http.HttpEntity httpEntity,
Class<T> responseType) |
default <T> ResponseHandler<T> |
head(org.apache.http.HttpEntity httpEntity,
TypeReference<T> responseType) |
default Response |
head(String payload) |
default <T> ResponseHandler<T> |
head(String payload,
Class<T> responseType) |
default <T> ResponseHandler<T> |
head(String payload,
TypeReference<T> responseType) |
default <T> ResponseHandler<T> |
head(TypeReference<T> responseType) |
default Response |
options() |
default <T> ResponseHandler<T> |
options(Class<T> responseType) |
default Response |
options(org.apache.http.HttpEntity httpEntity) |
default <T> ResponseHandler<T> |
options(org.apache.http.HttpEntity httpEntity,
Class<T> responseType) |
default <T> ResponseHandler<T> |
options(org.apache.http.HttpEntity httpEntity,
TypeReference<T> responseType) |
default Response |
options(String payload) |
default <T> ResponseHandler<T> |
options(String payload,
Class<T> responseType) |
default <T> ResponseHandler<T> |
options(String payload,
TypeReference<T> responseType) |
default <T> ResponseHandler<T> |
options(TypeReference<T> responseType) |
default Response |
patch() |
default <T> ResponseHandler<T> |
patch(Class<T> responseType) |
default Response |
patch(org.apache.http.HttpEntity httpEntity) |
default <T> ResponseHandler<T> |
patch(org.apache.http.HttpEntity httpEntity,
Class<T> responseType) |
default <T> ResponseHandler<T> |
patch(org.apache.http.HttpEntity httpEntity,
TypeReference<T> responseType) |
default Response |
patch(String payload) |
default <T> ResponseHandler<T> |
patch(String payload,
Class<T> responseType) |
default <T> ResponseHandler<T> |
patch(String payload,
TypeReference<T> responseType) |
default <T> ResponseHandler<T> |
patch(TypeReference<T> responseType) |
WebTarget |
path(String path)
Append path to the URI of the current target instance.
|
default Response |
post() |
default <T> ResponseHandler<T> |
post(Class<T> responseType) |
default Response |
post(org.apache.http.HttpEntity httpEntity) |
default <T> ResponseHandler<T> |
post(org.apache.http.HttpEntity httpEntity,
Class<T> responseType) |
default <T> ResponseHandler<T> |
post(org.apache.http.HttpEntity httpEntity,
TypeReference<T> responseType) |
default Response |
post(String payload) |
default <T> ResponseHandler<T> |
post(String payload,
Class<T> responseType) |
default <T> ResponseHandler<T> |
post(String payload,
TypeReference<T> responseType) |
default <T> ResponseHandler<T> |
post(TypeReference<T> responseType) |
default Response |
put() |
default <T> ResponseHandler<T> |
put(Class<T> responseType) |
default Response |
put(org.apache.http.HttpEntity httpEntity) |
default <T> ResponseHandler<T> |
put(org.apache.http.HttpEntity httpEntity,
Class<T> responseType) |
default <T> ResponseHandler<T> |
put(org.apache.http.HttpEntity httpEntity,
TypeReference<T> responseType) |
default Response |
put(String payload) |
default <T> ResponseHandler<T> |
put(String payload,
Class<T> responseType) |
default <T> ResponseHandler<T> |
put(String payload,
TypeReference<T> responseType) |
default <T> ResponseHandler<T> |
put(TypeReference<T> responseType) |
default ResponseHandler<?> |
rawDelete() |
default ResponseHandler<?> |
rawDelete(org.apache.http.HttpEntity httpEntity)
Invoke HTTP DELETE method for the current request
|
default ResponseHandler<?> |
rawDelete(String payload)
Invoke HTTP DELETE method for the current request
|
default ResponseHandler<?> |
rawGet()
Invoke HTTP GET method for the current request
|
default ResponseHandler<?> |
rawGet(org.apache.http.HttpEntity httpEntity)
Invoke HTTP GET method for the current request
|
default ResponseHandler<?> |
rawGet(String payload)
Invoke HTTP GET method for the current request
|
default ResponseHandler<?> |
rawHead() |
default ResponseHandler<?> |
rawHead(org.apache.http.HttpEntity httpEntity)
Invoke HTTP HEAD method for the current request
|
default ResponseHandler<?> |
rawHead(String payload)
Invoke HTTP HEAD method for the current request
|
default ResponseHandler<?> |
rawOptions() |
default ResponseHandler<?> |
rawOptions(org.apache.http.HttpEntity httpEntity)
Invoke HTTP OPTIONS method for the current request
|
default ResponseHandler<?> |
rawOptions(String payload)
Invoke HTTP OPTIONS method for the current request
|
default ResponseHandler<?> |
rawPatch() |
default ResponseHandler<?> |
rawPatch(org.apache.http.HttpEntity httpEntity)
Invoke HTTP PATCH method for the current request
|
default ResponseHandler<?> |
rawPatch(String payload)
Invoke HTTP PATCH method for the current request
|
default ResponseHandler<?> |
rawPost() |
default ResponseHandler<?> |
rawPost(org.apache.http.HttpEntity httpEntity)
Invoke HTTP POST method for the current request
|
default ResponseHandler<?> |
rawPost(String payload)
Invoke HTTP POST method for the current request
|
default ResponseHandler<?> |
rawPut() |
default ResponseHandler<?> |
rawPut(org.apache.http.HttpEntity httpEntity)
Invoke HTTP PUT method for the current request
|
default ResponseHandler<?> |
rawPut(String payload)
Invoke HTTP PUT method for the current request
|
default ResponseHandler<?> |
rawRequest(HttpMethod method)
Invoke an arbitrary method for the current request.
|
default ResponseHandler<?> |
rawRequest(HttpMethod method,
org.apache.http.HttpEntity httpEntity)
Invoke an arbitrary method for the current request.
|
default ResponseHandler<?> |
rawRequest(HttpMethod method,
String payload)
Invoke an arbitrary method for the current request.
|
default ResponseHandler<?> |
rawTrace() |
WebTarget |
removeHeader(org.apache.http.Header header)
Removes the given header.
|
WebTarget |
removeHeaders(String name)
Removes all headers with name.
|
Response |
request(HttpMethod method)
Invoke an arbitrary method for the current request.
|
<T> ResponseHandler<T> |
request(HttpMethod method,
Class<T> responseType)
Invoke an arbitrary method for the current request.
|
Response |
request(HttpMethod method,
org.apache.http.HttpEntity httpEntity)
Invoke an arbitrary method for the current request.
|
<T> ResponseHandler<T> |
request(HttpMethod method,
org.apache.http.HttpEntity httpEntity,
Class<T> responseType)
Invoke an arbitrary method for the current request.
|
<T> ResponseHandler<T> |
request(HttpMethod method,
org.apache.http.HttpEntity httpEntity,
TypeReference<T> responseType)
Invoke an arbitrary method for the current request.
|
default Response |
request(HttpMethod method,
String payload) |
default <T> ResponseHandler<T> |
request(HttpMethod method,
String payload,
Class<T> responseType)
|
default <T> ResponseHandler<T> |
request(HttpMethod method,
String payload,
TypeReference<T> responseType) |
<T> ResponseHandler<T> |
request(HttpMethod method,
TypeReference<T> responseType)
Invoke an arbitrary method for the current request.
|
WebTarget |
setRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)
Sets the
requestConfig to the request |
default Response |
trace() |
default <T> ResponseHandler<T> |
trace(Class<T> responseType) |
default Response |
trace(org.apache.http.HttpEntity httpEntity) |
default <T> ResponseHandler<T> |
trace(org.apache.http.HttpEntity httpEntity,
Class<T> responseType) |
default <T> ResponseHandler<T> |
trace(org.apache.http.HttpEntity httpEntity,
TypeReference<T> responseType) |
default Response |
trace(String payload) |
default <T> ResponseHandler<T> |
trace(String payload,
Class<T> responseType) |
default <T> ResponseHandler<T> |
trace(String payload,
TypeReference<T> responseType) |
default <T> ResponseHandler<T> |
trace(TypeReference<T> responseType) |
WebTarget |
updateHeader(org.apache.http.Header header)
Replaces the first occurence of the header with the same name.
|
default WebTarget |
updateHeader(String name,
String value)
Replaces the first occurence of the header with the same name by the value.
|
WebTarget path(String path)
path
- the path.NullPointerException
- if path is null
.Response request(HttpMethod method)
method
- the http method.ResponseException
- in case of any IO problem or the connection was aborted.RequestException
- in case of an http protocol error.Response request(HttpMethod method, org.apache.http.HttpEntity httpEntity)
method
- the http method.httpEntity
- httpEntityResponseException
- in case of any IO problem or the connection was aborted.RequestException
- in case of an http protocol error.<T> ResponseHandler<T> request(HttpMethod method, org.apache.http.HttpEntity httpEntity, Class<T> responseType)
T
- response entity type.method
- the http method.httpEntity
- httpEntityresponseType
- Java type the response entity will be converted to.ResponseException
- in case of any IO problem or the connection was aborted.RequestException
- in case of an http protocol error.request(HttpMethod, HttpEntity)
,
ResponseHandler
<T> ResponseHandler<T> request(HttpMethod method, org.apache.http.HttpEntity httpEntity, TypeReference<T> responseType)
T
- response entity type.method
- the http method.httpEntity
- httpEntityresponseType
- representation of a TypeReference Java type the response entity will be converted to.ResponseException
- in case of any IO problem or the connection was aborted.RequestException
- in case of an http protocol error.request(HttpMethod, HttpEntity)
,
ResponseHandler
<T> ResponseHandler<T> request(HttpMethod method, Class<T> responseType)
T
- response entity type.method
- the http method.responseType
- Java type the response entity will be converted to.ResponseException
- in case of any IO problem or the connection was aborted.RequestException
- in case of an http protocol error.request(HttpMethod)
,
ResponseHandler
<T> ResponseHandler<T> request(HttpMethod method, TypeReference<T> responseType)
T
- response entity type.method
- the http method.responseType
- epresentation of a TypeReference Java type the response entity will be converted to.ResponseException
- in case of any IO problem or the connection was aborted.RequestException
- in case of an http protocol error.request(HttpMethod)
,
ResponseHandler
default ResponseHandler<?> rawRequest(HttpMethod method)
Mainly designed to use in case when response body aren't interested.
Any attempt to get content fromResponseHandler
will be thrown exceptionmethod
- the http method.ResponseException
- in case of any IO problem or the connection was aborted.RequestException
- in case of an http protocol error.request(HttpMethod)
,
ResponseHandler
default ResponseHandler<?> rawRequest(HttpMethod method, org.apache.http.HttpEntity httpEntity)
Mainly designed to use in case when response body aren't interested.
Any attempt to get content fromResponseHandler
will be thrown exceptionmethod
- the http method.httpEntity
- httpEntityResponseException
- in case of any IO problem or the connection was aborted.RequestException
- in case of an http protocol error.request(HttpMethod)
,
ResponseHandler
default ResponseHandler<?> rawRequest(HttpMethod method, String payload)
Mainly designed to use in case when response body aren't interested.
Any attempt to get content fromResponseHandler
will be thrown exceptionmethod
- the http method.payload
- payloadResponseException
- in case of any IO problem or the connection was aborted.RequestException
- in case of an http protocol error.request(HttpMethod)
,
ResponseHandler
WebTarget removeHeader(org.apache.http.Header header)
header
- the header to removeWebTarget removeHeaders(String name)
name
- the header nameWebTarget updateHeader(org.apache.http.Header header)
header
- the new header that should replace the first header with the same
name if present in the list.WebTarget addHeader(org.apache.http.Header header)
header
- header instance. Can't be nulldefault <T> ResponseHandler<T> request(HttpMethod method, String payload, Class<T> responseType)
T
- response entity typemethod
- the http method.payload
- payloadresponseType
- Java type the response entity will be converted to.default <T> ResponseHandler<T> request(HttpMethod method, String payload, TypeReference<T> responseType)
default Response request(HttpMethod method, String payload)
default WebTarget addHeader(String name, String value)
name
- name of header. Can't be nullvalue
- value of headerdefault WebTarget addHeaders(Collection<? extends org.apache.http.Header> headers)
headers
- collections of headersdefault WebTarget updateHeader(String name, String value)
name
- name of header. Can't be nullvalue
- value of headerdefault WebTarget addContentType(org.apache.http.entity.ContentType contentType)
contentType
- content type of request headerWebTarget setRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)
requestConfig
to the requestrequestConfig
- requestConfigRequestConfig
WebTarget addParameter(org.apache.http.NameValuePair nameValuePair)
nameValuePair
- nameValuePairdefault WebTarget addParameters(org.apache.http.NameValuePair... parameters)
parameters
- nameValuePairsdefault WebTarget addParameters(String queryString, Charset charset)
For example: queryString = "param1=param1¶m2=param2" is the same as call
addParameter(param1, param1).addParameter(param2, param2);
Default charset is "UTF-8".queryString
- queryStringcharset
- charsetdefault WebTarget addParameters(String queryString)
For example: queryString = "param1=param1¶m2=param2" is the same as call
addParameter(param1, param1).addParameter(param2, param2);
Default charset is "UTF-8".queryString
- queryStringdefault WebTarget addParameters(String... nameValues)
nameValues
- array of nameValueIllegalArgumentException
- When length of parameter nameValues is odd or ZERO.NullPointerException
- when param nameValues is nulldefault WebTarget addParameters(Collection<? extends org.apache.http.NameValuePair> parameters)
parameters
- nameValuePairsdefault WebTarget addParameters(Map<String,String> parameters)
parameters
- parametersdefault WebTarget addParameter(String name, String value)
name
- request parameter namevalue
- request parameter valuedefault Response get()
request(HttpMethod)
default ResponseHandler<?> rawGet()
rawRequest(HttpMethod)
default ResponseHandler<?> rawGet(org.apache.http.HttpEntity httpEntity)
rawRequest(HttpMethod, HttpEntity)
default ResponseHandler<?> rawGet(String payload)
rawRequest(HttpMethod, String)
default Response get(org.apache.http.HttpEntity httpEntity)
httpEntity
- httpEntityrequest(HttpMethod, HttpEntity)
default <T> ResponseHandler<T> get(org.apache.http.HttpEntity httpEntity, Class<T> responseType)
default <T> ResponseHandler<T> get(org.apache.http.HttpEntity httpEntity, TypeReference<T> responseType)
default <T> ResponseHandler<T> get(String payload, Class<T> responseType)
default <T> ResponseHandler<T> get(String payload, TypeReference<T> responseType)
default <T> ResponseHandler<T> get(Class<T> responseType)
default <T> ResponseHandler<T> get(TypeReference<T> responseType)
default Response put()
default ResponseHandler<?> rawPut()
default ResponseHandler<?> rawPut(org.apache.http.HttpEntity httpEntity)
rawRequest(HttpMethod, HttpEntity)
default ResponseHandler<?> rawPut(String payload)
rawRequest(HttpMethod, String)
default Response put(org.apache.http.HttpEntity httpEntity)
default <T> ResponseHandler<T> put(org.apache.http.HttpEntity httpEntity, Class<T> responseType)
default <T> ResponseHandler<T> put(org.apache.http.HttpEntity httpEntity, TypeReference<T> responseType)
default <T> ResponseHandler<T> put(String payload, Class<T> responseType)
default <T> ResponseHandler<T> put(String payload, TypeReference<T> responseType)
default <T> ResponseHandler<T> put(Class<T> responseType)
default <T> ResponseHandler<T> put(TypeReference<T> responseType)
default Response post()
default ResponseHandler<?> rawPost()
default ResponseHandler<?> rawPost(org.apache.http.HttpEntity httpEntity)
rawRequest(HttpMethod, HttpEntity)
default ResponseHandler<?> rawPost(String payload)
rawRequest(HttpMethod, String)
default Response post(org.apache.http.HttpEntity httpEntity)
default <T> ResponseHandler<T> post(org.apache.http.HttpEntity httpEntity, Class<T> responseType)
default <T> ResponseHandler<T> post(org.apache.http.HttpEntity httpEntity, TypeReference<T> responseType)
default <T> ResponseHandler<T> post(String payload, Class<T> responseType)
default <T> ResponseHandler<T> post(String payload, TypeReference<T> responseType)
default <T> ResponseHandler<T> post(Class<T> responseType)
default <T> ResponseHandler<T> post(TypeReference<T> responseType)
default Response head()
default ResponseHandler<?> rawHead()
default ResponseHandler<?> rawHead(org.apache.http.HttpEntity httpEntity)
rawRequest(HttpMethod, HttpEntity)
default ResponseHandler<?> rawHead(String payload)
rawRequest(HttpMethod, String)
default Response head(org.apache.http.HttpEntity httpEntity)
default <T> ResponseHandler<T> head(org.apache.http.HttpEntity httpEntity, Class<T> responseType)
default <T> ResponseHandler<T> head(org.apache.http.HttpEntity httpEntity, TypeReference<T> responseType)
default <T> ResponseHandler<T> head(String payload, Class<T> responseType)
default <T> ResponseHandler<T> head(String payload, TypeReference<T> responseType)
default <T> ResponseHandler<T> head(Class<T> responseType)
default <T> ResponseHandler<T> head(TypeReference<T> responseType)
default Response delete()
default ResponseHandler<?> rawDelete()
default ResponseHandler<?> rawDelete(org.apache.http.HttpEntity httpEntity)
rawRequest(HttpMethod, HttpEntity)
default ResponseHandler<?> rawDelete(String payload)
rawRequest(HttpMethod, String)
default Response delete(org.apache.http.HttpEntity httpEntity)
default <T> ResponseHandler<T> delete(org.apache.http.HttpEntity httpEntity, Class<T> responseType)
default <T> ResponseHandler<T> delete(org.apache.http.HttpEntity httpEntity, TypeReference<T> responseType)
default <T> ResponseHandler<T> delete(String payload, Class<T> responseType)
default <T> ResponseHandler<T> delete(String payload, TypeReference<T> responseType)
default <T> ResponseHandler<T> delete(Class<T> responseType)
default <T> ResponseHandler<T> delete(TypeReference<T> responseType)
default Response options()
default ResponseHandler<?> rawOptions()
default ResponseHandler<?> rawOptions(org.apache.http.HttpEntity httpEntity)
rawRequest(HttpMethod, HttpEntity)
default ResponseHandler<?> rawOptions(String payload)
rawRequest(HttpMethod, String)
default Response options(org.apache.http.HttpEntity httpEntity)
default <T> ResponseHandler<T> options(org.apache.http.HttpEntity httpEntity, Class<T> responseType)
default <T> ResponseHandler<T> options(org.apache.http.HttpEntity httpEntity, TypeReference<T> responseType)
default <T> ResponseHandler<T> options(String payload, Class<T> responseType)
default <T> ResponseHandler<T> options(String payload, TypeReference<T> responseType)
default <T> ResponseHandler<T> options(Class<T> responseType)
default <T> ResponseHandler<T> options(TypeReference<T> responseType)
default Response patch()
default ResponseHandler<?> rawPatch()
default ResponseHandler<?> rawPatch(org.apache.http.HttpEntity httpEntity)
rawRequest(HttpMethod, HttpEntity)
default ResponseHandler<?> rawPatch(String payload)
rawRequest(HttpMethod, String)
default Response patch(org.apache.http.HttpEntity httpEntity)
default <T> ResponseHandler<T> patch(org.apache.http.HttpEntity httpEntity, Class<T> responseType)
default <T> ResponseHandler<T> patch(org.apache.http.HttpEntity httpEntity, TypeReference<T> responseType)
default <T> ResponseHandler<T> patch(String payload, Class<T> responseType)
default <T> ResponseHandler<T> patch(String payload, TypeReference<T> responseType)
default <T> ResponseHandler<T> patch(Class<T> responseType)
default <T> ResponseHandler<T> patch(TypeReference<T> responseType)
default Response trace()
default ResponseHandler<?> rawTrace()
default Response trace(org.apache.http.HttpEntity httpEntity)
default <T> ResponseHandler<T> trace(org.apache.http.HttpEntity httpEntity, Class<T> responseType)
default <T> ResponseHandler<T> trace(org.apache.http.HttpEntity httpEntity, TypeReference<T> responseType)
default <T> ResponseHandler<T> trace(String payload, Class<T> responseType)
default <T> ResponseHandler<T> trace(String payload, TypeReference<T> responseType)
default <T> ResponseHandler<T> trace(Class<T> responseType)
default <T> ResponseHandler<T> trace(TypeReference<T> responseType)
Copyright © 2020. All rights reserved.