public class RestTemplate extends InterceptingHttpAccessor implements RestOperations
Note: by default the RestTemplate relies on standard JDK
facilities to establish HTTP connections. You can switch to use a different
HTTP library such as Apache HttpComponents, Netty, and OkHttp through the
HttpAccessor.setRequestFactory(org.springframework.http.client.ClientHttpRequestFactory) property.
The main entry points of this template are the methods named after the six main HTTP methods:
In addition the exchange and execute methods are generalized versions of
the above methods and can be used to support additional, less frequent combinations (e.g.
HTTP PATCH, HTTP PUT with response body, etc.). Note however that the underlying HTTP
library used must also support the desired combination.
For each HTTP method there are three variants: two accept a URI template string
and URI variables (array or map) while a third accepts a URI.
Note that for URI templates it is assumed encoding is necessary, e.g.
restTemplate.getForObject("https://example.com/hotel list") becomes
"https://example.com/hotel%20list". This also means if the URI template
or URI variables are already encoded, double encoding will occur, e.g.
https://example.com/hotel%20list becomes
https://example.com/hotel%2520list). To avoid that use a URI method
variant to provide (or re-use) a previously encoded URI. To prepare such an URI
with full control over encoding, consider using
UriComponentsBuilder.
Internally the template uses HttpMessageConverter instances to
convert HTTP messages to and from POJOs. Converters for the main mime types
are registered by default but you can also register additional converters
via setMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>>).
This template uses a
SimpleClientHttpRequestFactory and a
DefaultResponseErrorHandler as default strategies for creating HTTP
connections or handling HTTP errors, respectively. These defaults can be overridden
through HttpAccessor.setRequestFactory(org.springframework.http.client.ClientHttpRequestFactory) and setErrorHandler(org.springframework.web.client.ResponseErrorHandler) respectively.
HttpMessageConverter,
RequestCallback,
ResponseExtractor,
ResponseErrorHandler,
AsyncRestTemplatelogger| Constructor and Description |
|---|
RestTemplate()
Create a new instance of the
RestTemplate using default settings. |
RestTemplate(ClientHttpRequestFactory requestFactory)
Create a new instance of the
RestTemplate based on the given ClientHttpRequestFactory. |
RestTemplate(List<HttpMessageConverter<?>> messageConverters)
Create a new instance of the
RestTemplate using the given list of
HttpMessageConverter to use |
| Modifier and Type | Method and Description |
|---|---|
protected <T> RequestCallback |
acceptHeaderRequestCallback(Class<T> responseType)
Returns a request callback implementation that prepares the request
Accept
headers based on the given response type and configured
message converters. |
void |
delete(String url,
Map<String,?> uriVariables)
Delete the resources at the specified URI.
|
void |
delete(String url,
Object... uriVariables)
Delete the resources at the specified URI.
|
void |
delete(URI url)
Delete the resources at the specified URL.
|
protected <T> T |
doExecute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the given method on the provided URI.
|
<T> ResponseEntity<T> |
exchange(RequestEntity<?> requestEntity,
Class<T> responseType)
Execute the request specified in the given
RequestEntity and return
the response as ResponseEntity. |
<T> ResponseEntity<T> |
exchange(RequestEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType)
Execute the request specified in the given
RequestEntity and return
the response as ResponseEntity. |
<T> ResponseEntity<T> |
exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, writing the given request entity to the request, and
returns the response as
ResponseEntity. |
<T> ResponseEntity<T> |
exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType,
Object... uriVariables)
Execute the HTTP method to the given URI template, writing the given request entity to the request, and
returns the response as
ResponseEntity. |
<T> ResponseEntity<T> |
exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, writing the given
request entity to the request, and returns the response as
ResponseEntity. |
<T> ResponseEntity<T> |
exchange(String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
Object... uriVariables)
Execute the HTTP method to the given URI template, writing the given
request entity to the request, and returns the response as
ResponseEntity. |
<T> ResponseEntity<T> |
exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
Class<T> responseType)
Execute the HTTP method to the given URI template, writing the given request entity to the request, and
returns the response as
ResponseEntity. |
<T> ResponseEntity<T> |
exchange(URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType)
Execute the HTTP method to the given URI template, writing the given
request entity to the request, and returns the response as
ResponseEntity. |
<T> T |
execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback, and reading the response with a ResponseExtractor. |
<T> T |
execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... uriVariables)
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback, and reading the response with a ResponseExtractor. |
<T> T |
execute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the HTTP method to the given URL, preparing the request with the
RequestCallback, and reading the response with a ResponseExtractor. |
ResponseErrorHandler |
getErrorHandler()
Return the error handler.
|
<T> ResponseEntity<T> |
getForEntity(String url,
Class<T> responseType,
Map<String,?> uriVariables)
Retrieve a representation by doing a GET on the URI template.
|
<T> ResponseEntity<T> |
getForEntity(String url,
Class<T> responseType,
Object... uriVariables)
Retrieve an entity by doing a GET on the specified URL.
|
<T> ResponseEntity<T> |
getForEntity(URI url,
Class<T> responseType)
Retrieve a representation by doing a GET on the URL .
|
<T> T |
getForObject(String url,
Class<T> responseType,
Map<String,?> uriVariables)
Retrieve a representation by doing a GET on the URI template.
|
<T> T |
getForObject(String url,
Class<T> responseType,
Object... uriVariables)
Retrieve a representation by doing a GET on the specified URL.
|
<T> T |
getForObject(URI url,
Class<T> responseType)
Retrieve a representation by doing a GET on the URL .
|
List<HttpMessageConverter<?>> |
getMessageConverters()
Return the list of message body converters.
|
UriTemplateHandler |
getUriTemplateHandler()
Return the configured URI template handler.
|
protected void |
handleResponse(URI url,
HttpMethod method,
ClientHttpResponse response)
Handle the given response, performing appropriate logging and
invoking the
ResponseErrorHandler if necessary. |
protected ResponseExtractor<HttpHeaders> |
headersExtractor()
Returns a response extractor for
HttpHeaders. |
HttpHeaders |
headForHeaders(String url,
Map<String,?> uriVariables)
Retrieve all headers of the resource specified by the URI template.
|
HttpHeaders |
headForHeaders(String url,
Object... uriVariables)
Retrieve all headers of the resource specified by the URI template.
|
HttpHeaders |
headForHeaders(URI url)
Retrieve all headers of the resource specified by the URL.
|
protected <T> RequestCallback |
httpEntityCallback(Object requestBody)
Returns a request callback implementation that writes the given object to the
request stream.
|
protected <T> RequestCallback |
httpEntityCallback(Object requestBody,
Type responseType)
Returns a request callback implementation that writes the given object to the
request stream.
|
Set<HttpMethod> |
optionsForAllow(String url,
Map<String,?> uriVariables)
Return the value of the Allow header for the given URI.
|
Set<HttpMethod> |
optionsForAllow(String url,
Object... uriVariables)
Return the value of the Allow header for the given URI.
|
Set<HttpMethod> |
optionsForAllow(URI url)
Return the value of the Allow header for the given URL.
|
<T> T |
patchForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables)
Update a resource by PATCHing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
patchForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables)
Update a resource by PATCHing the given object to the URI template,
and return the representation found in the response.
|
<T> T |
patchForObject(URI url,
Object request,
Class<T> responseType)
Update a resource by PATCHing the given object to the URL,
and return the representation found in the response.
|
<T> ResponseEntity<T> |
postForEntity(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables)
Create a new resource by POSTing the given object to the URI template,
and returns the response as
HttpEntity. |
<T> ResponseEntity<T> |
postForEntity(String url,
Object request,
Class<T> responseType,
Object... uriVariables)
Create a new resource by POSTing the given object to the URI template,
and returns the response as
ResponseEntity. |
<T> ResponseEntity<T> |
postForEntity(URI url,
Object request,
Class<T> responseType)
Create a new resource by POSTing the given object to the URL,
and returns the response as
ResponseEntity. |
URI |
postForLocation(String url,
Object request,
Map<String,?> uriVariables)
Create a new resource by POSTing the given object to the URI template, and returns the value of
the
Location header. |
URI |
postForLocation(String url,
Object request,
Object... uriVariables)
Create a new resource by POSTing the given object to the URI template, and returns the value of
the
Location header. |
URI |
postForLocation(URI url,
Object request)
Create a new resource by POSTing the given object to the URL, and returns the value of the
Location header. |
<T> T |
postForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables)
Create a new resource by POSTing the given object to the URI template,
and returns the representation found in the response.
|
<T> T |
postForObject(String url,
Object request,
Class<T> responseType,
Object... uriVariables)
Create a new resource by POSTing the given object to the URI template,
and returns the representation found in the response.
|
<T> T |
postForObject(URI url,
Object request,
Class<T> responseType)
Create a new resource by POSTing the given object to the URL,
and returns the representation found in the response.
|
void |
put(String url,
Object request,
Map<String,?> uriVariables)
Creates a new resource by PUTting the given object to URI template.
|
void |
put(String url,
Object request,
Object... uriVariables)
Create or update a resource by PUTting the given object to the URI.
|
void |
put(URI url,
Object request)
Creates a new resource by PUTting the given object to URL.
|
protected <T> ResponseExtractor<ResponseEntity<T>> |
responseEntityExtractor(Type responseType)
Returns a response extractor for
ResponseEntity. |
void |
setDefaultUriVariables(Map<String,?> defaultUriVariables)
Configure default URI variable values.
|
void |
setErrorHandler(ResponseErrorHandler errorHandler)
Set the error handler.
|
void |
setMessageConverters(List<HttpMessageConverter<?>> messageConverters)
Set the message body converters to use.
|
void |
setUriTemplateHandler(UriTemplateHandler handler)
Configure the
UriTemplateHandler to use to expand URI templates. |
getInterceptors, getRequestFactory, setInterceptorscreateRequest, setRequestFactorypublic RestTemplate()
RestTemplate using default settings.
Default HttpMessageConverters are initialized.public RestTemplate(ClientHttpRequestFactory requestFactory)
RestTemplate based on the given ClientHttpRequestFactory.requestFactory - HTTP request factory to useSimpleClientHttpRequestFactory,
HttpComponentsClientHttpRequestFactorypublic RestTemplate(List<HttpMessageConverter<?>> messageConverters)
RestTemplate using the given list of
HttpMessageConverter to usemessageConverters - the list of HttpMessageConverter to usepublic void setMessageConverters(List<HttpMessageConverter<?>> messageConverters)
These converters are used to convert from and to HTTP requests and responses.
public List<HttpMessageConverter<?>> getMessageConverters()
The returned List is active and may get appended to.
public void setErrorHandler(ResponseErrorHandler errorHandler)
By default, RestTemplate uses a DefaultResponseErrorHandler.
public ResponseErrorHandler getErrorHandler()
public void setDefaultUriVariables(Map<String,?> defaultUriVariables)
DefaultUriTemplateHandler handler = new DefaultUriTemplateHandler(); handler.setDefaultUriVariables(...); RestTemplate restTemplate = new RestTemplate(); restTemplate.setUriTemplateHandler(handler);
defaultUriVariables - the default URI variable valuespublic void setUriTemplateHandler(UriTemplateHandler handler)
UriTemplateHandler to use to expand URI templates.
By default the DefaultUriTemplateHandler is used which relies on
Spring's URI template support and exposes several useful properties that
customize its behavior for encoding and for prepending a common base URL.
An alternative implementation may be used to plug an external URI
template library.handler - the URI template handler to usepublic UriTemplateHandler getUriTemplateHandler()
public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
getForObject in interface RestOperationsurl - the URLresponseType - the type of the return valueuriVariables - the variables to expand the templateRestClientExceptionpublic <T> T getForObject(String url, Class<T> responseType, Map<String,?> uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
getForObject in interface RestOperationsurl - the URLresponseType - the type of the return valueuriVariables - the map containing variables for the URI templateRestClientExceptionpublic <T> T getForObject(URI url, Class<T> responseType) throws RestClientException
RestOperationsgetForObject in interface RestOperationsurl - the URLresponseType - the type of the return valueRestClientExceptionpublic <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException
RestOperationsResponseEntity.
URI Template variables are expanded using the given URI variables, if any.
getForEntity in interface RestOperationsurl - the URLresponseType - the type of the return valueuriVariables - the variables to expand the templateRestClientExceptionpublic <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String,?> uriVariables) throws RestClientException
RestOperationsResponseEntity.
URI Template variables are expanded using the given map.
getForEntity in interface RestOperationsurl - the URLresponseType - the type of the return valueuriVariables - the map containing variables for the URI templateRestClientExceptionpublic <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType) throws RestClientException
RestOperationsResponseEntity.getForEntity in interface RestOperationsurl - the URLresponseType - the type of the return valueRestClientExceptionpublic HttpHeaders headForHeaders(String url, Object... uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
headForHeaders in interface RestOperationsurl - the URLuriVariables - the variables to expand the templateRestClientExceptionpublic HttpHeaders headForHeaders(String url, Map<String,?> uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
headForHeaders in interface RestOperationsurl - the URLuriVariables - the map containing variables for the URI templateRestClientExceptionpublic HttpHeaders headForHeaders(URI url) throws RestClientException
RestOperationsheadForHeaders in interface RestOperationsurl - the URLRestClientExceptionpublic URI postForLocation(String url, Object request, Object... uriVariables) throws RestClientException
RestOperationsLocation header. This header typically indicates where the new resource is stored.
URI Template variables are expanded using the given URI variables, if any.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
postForLocation in interface RestOperationsurl - the URLrequest - the Object to be POSTed (may be null)uriVariables - the variables to expand the templateLocation headerRestClientExceptionHttpEntitypublic URI postForLocation(String url, Object request, Map<String,?> uriVariables) throws RestClientException
RestOperationsLocation header. This header typically indicates where the new resource is stored.
URI Template variables are expanded using the given map.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
postForLocation in interface RestOperationsurl - the URLrequest - the Object to be POSTed (may be null)uriVariables - the variables to expand the templateLocation headerRestClientExceptionHttpEntitypublic URI postForLocation(URI url, Object request) throws RestClientException
RestOperationsLocation header. This header typically indicates where the new resource is stored.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
postForLocation in interface RestOperationsurl - the URLrequest - the Object to be POSTed (may be null)Location headerRestClientExceptionHttpEntitypublic <T> T postForObject(String url, Object request, Class<T> responseType, Object... uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
postForObject in interface RestOperationsurl - the URLrequest - the Object to be POSTed (may be null)responseType - the type of the return valueuriVariables - the variables to expand the templateRestClientExceptionHttpEntitypublic <T> T postForObject(String url, Object request, Class<T> responseType, Map<String,?> uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
postForObject in interface RestOperationsurl - the URLrequest - the Object to be POSTed (may be null)responseType - the type of the return valueuriVariables - the variables to expand the templateRestClientExceptionHttpEntitypublic <T> T postForObject(URI url, Object request, Class<T> responseType) throws RestClientException
RestOperationsThe request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
postForObject in interface RestOperationsurl - the URLrequest - the Object to be POSTed (may be null)responseType - the type of the return valueRestClientExceptionHttpEntitypublic <T> ResponseEntity<T> postForEntity(String url, Object request, Class<T> responseType, Object... uriVariables) throws RestClientException
RestOperationsResponseEntity.
URI Template variables are expanded using the given URI variables, if any.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
postForEntity in interface RestOperationsurl - the URLrequest - the Object to be POSTed (may be null)uriVariables - the variables to expand the templateRestClientExceptionHttpEntitypublic <T> ResponseEntity<T> postForEntity(String url, Object request, Class<T> responseType, Map<String,?> uriVariables) throws RestClientException
RestOperationsHttpEntity.
URI Template variables are expanded using the given map.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
postForEntity in interface RestOperationsurl - the URLrequest - the Object to be POSTed (may be null)uriVariables - the variables to expand the templateRestClientExceptionHttpEntitypublic <T> ResponseEntity<T> postForEntity(URI url, Object request, Class<T> responseType) throws RestClientException
RestOperationsResponseEntity.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
postForEntity in interface RestOperationsurl - the URLrequest - the Object to be POSTed (may be null)RestClientExceptionHttpEntitypublic void put(String url, Object request, Object... uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
put in interface RestOperationsurl - the URLrequest - the Object to be PUT (may be null)uriVariables - the variables to expand the templateRestClientExceptionHttpEntitypublic void put(String url, Object request, Map<String,?> uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
put in interface RestOperationsurl - the URLrequest - the Object to be PUT (may be null)uriVariables - the variables to expand the templateRestClientExceptionHttpEntitypublic void put(URI url, Object request) throws RestClientException
RestOperationsThe request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
put in interface RestOperationsurl - the URLrequest - the Object to be PUT (may be null)RestClientExceptionHttpEntitypublic <T> T patchForObject(String url, Object request, Class<T> responseType, Object... uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
NOTE: The standard JDK HTTP library does not support HTTP PATCH. You need to use the Apache HttpComponents or OkHttp request factory.
patchForObject in interface RestOperationsurl - the URLrequest - the object to be PATCHed (may be null)responseType - the type of the return valueuriVariables - the variables to expand the templateRestClientExceptionHttpEntity,
HttpAccessor.setRequestFactory(org.springframework.http.client.ClientHttpRequestFactory),
HttpComponentsAsyncClientHttpRequestFactory,
OkHttp3ClientHttpRequestFactorypublic <T> T patchForObject(String url, Object request, Class<T> responseType, Map<String,?> uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
The request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
NOTE: The standard JDK HTTP library does not support HTTP PATCH. You need to use the Apache HttpComponents or OkHttp request factory.
patchForObject in interface RestOperationsurl - the URLrequest - the object to be PATCHed (may be null)responseType - the type of the return valueuriVariables - the variables to expand the templateRestClientExceptionHttpEntity,
HttpAccessor.setRequestFactory(org.springframework.http.client.ClientHttpRequestFactory),
HttpComponentsAsyncClientHttpRequestFactory,
OkHttp3ClientHttpRequestFactorypublic <T> T patchForObject(URI url, Object request, Class<T> responseType) throws RestClientException
RestOperationsThe request parameter can be a HttpEntity in order to
add additional HTTP headers to the request.
NOTE: The standard JDK HTTP library does not support HTTP PATCH. You need to use the Apache HttpComponents or OkHttp request factory.
patchForObject in interface RestOperationsurl - the URLrequest - the object to be PATCHed (may be null)responseType - the type of the return valueRestClientExceptionHttpEntity,
HttpAccessor.setRequestFactory(org.springframework.http.client.ClientHttpRequestFactory),
HttpComponentsAsyncClientHttpRequestFactory,
OkHttp3ClientHttpRequestFactorypublic void delete(String url, Object... uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
delete in interface RestOperationsurl - the URLuriVariables - the variables to expand in the templateRestClientExceptionpublic void delete(String url, Map<String,?> uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
delete in interface RestOperationsurl - the URLuriVariables - the variables to expand the templateRestClientExceptionpublic void delete(URI url) throws RestClientException
RestOperationsdelete in interface RestOperationsurl - the URLRestClientExceptionpublic Set<HttpMethod> optionsForAllow(String url, Object... uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
optionsForAllow in interface RestOperationsurl - the URLuriVariables - the variables to expand in the templateRestClientExceptionpublic Set<HttpMethod> optionsForAllow(String url, Map<String,?> uriVariables) throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
optionsForAllow in interface RestOperationsurl - the URLuriVariables - the variables to expand in the templateRestClientExceptionpublic Set<HttpMethod> optionsForAllow(URI url) throws RestClientException
RestOperationsoptionsForAllow in interface RestOperationsurl - the URLRestClientExceptionpublic <T> ResponseEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType, Object... uriVariables) throws RestClientException
RestOperationsResponseEntity.
URI Template variables are expanded using the given URI variables, if any.
exchange in interface RestOperationsurl - the URLmethod - the HTTP method (GET, POST, etc)requestEntity - the entity (headers and/or body) to write to the request
may be null)responseType - the type of the return valueuriVariables - the variables to expand in the templateRestClientExceptionpublic <T> ResponseEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType, Map<String,?> uriVariables) throws RestClientException
RestOperationsResponseEntity.
URI Template variables are expanded using the given URI variables, if any.
exchange in interface RestOperationsurl - the URLmethod - the HTTP method (GET, POST, etc)requestEntity - the entity (headers and/or body) to write to the request
(may be null)responseType - the type of the return valueuriVariables - the variables to expand in the templateRestClientExceptionpublic <T> ResponseEntity<T> exchange(URI url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType) throws RestClientException
RestOperationsResponseEntity.exchange in interface RestOperationsurl - the URLmethod - the HTTP method (GET, POST, etc)requestEntity - the entity (headers and/or body) to write to the request
(may be null)responseType - the type of the return valueRestClientExceptionpublic <T> ResponseEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Object... uriVariables) throws RestClientException
RestOperationsResponseEntity.
The given ParameterizedTypeReference is used to pass generic type information:
ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {};
ResponseEntity<List<MyBean>> response = template.exchange("https://example.com",HttpMethod.GET, null, myBean);
exchange in interface RestOperationsurl - the URLmethod - the HTTP method (GET, POST, etc)requestEntity - the entity (headers and/or body) to write to the
request (may be null)responseType - the type of the return valueuriVariables - the variables to expand in the templateRestClientExceptionpublic <T> ResponseEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Map<String,?> uriVariables) throws RestClientException
RestOperationsResponseEntity.
The given ParameterizedTypeReference is used to pass generic type information:
ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {};
ResponseEntity<List<MyBean>> response = template.exchange("https://example.com",HttpMethod.GET, null, myBean);
exchange in interface RestOperationsurl - the URLmethod - the HTTP method (GET, POST, etc)requestEntity - the entity (headers and/or body) to write to the request
(may be null)responseType - the type of the return valueuriVariables - the variables to expand in the templateRestClientExceptionpublic <T> ResponseEntity<T> exchange(URI url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) throws RestClientException
RestOperationsResponseEntity.
The given ParameterizedTypeReference is used to pass generic type information:
ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {};
ResponseEntity<List<MyBean>> response = template.exchange("https://example.com",HttpMethod.GET, null, myBean);
exchange in interface RestOperationsurl - the URLmethod - the HTTP method (GET, POST, etc)requestEntity - the entity (headers and/or body) to write to the request
(may be null)responseType - the type of the return valueRestClientExceptionpublic <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, Class<T> responseType) throws RestClientException
RestOperationsRequestEntity and return
the response as ResponseEntity. Typically used in combination
with the static builder methods on RequestEntity, for instance:
MyRequest body = ...
RequestEntity request = RequestEntity.post(new URI("https://example.com/foo")).accept(MediaType.APPLICATION_JSON).body(body);
ResponseEntity<MyResponse> response = template.exchange(request, MyResponse.class);
exchange in interface RestOperationsrequestEntity - the entity to write to the requestresponseType - the type of the return valueRestClientExceptionpublic <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) throws RestClientException
RestOperationsRequestEntity and return
the response as ResponseEntity. The given
ParameterizedTypeReference is used to pass generic type information:
MyRequest body = ...
RequestEntity request = RequestEntity.post(new URI("https://example.com/foo")).accept(MediaType.APPLICATION_JSON).body(body);
ParameterizedTypeReference<List<MyResponse>> myBean = new ParameterizedTypeReference<List<MyResponse>>() {};
ResponseEntity<List<MyResponse>> response = template.exchange(request, myBean);
exchange in interface RestOperationsrequestEntity - the entity to write to the requestresponseType - the type of the return valueRestClientExceptionpublic <T> T execute(String url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Object... uriVariables) throws RestClientException
RestOperationsRequestCallback, and reading the response with a ResponseExtractor.
URI Template variables are expanded using the given URI variables, if any.
execute in interface RestOperationsurl - the URLmethod - the HTTP method (GET, POST, etc)requestCallback - object that prepares the requestresponseExtractor - object that extracts the return value from the responseuriVariables - the variables to expand in the templateResponseExtractorRestClientExceptionpublic <T> T execute(String url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Map<String,?> uriVariables) throws RestClientException
RestOperationsRequestCallback, and reading the response with a ResponseExtractor.
URI Template variables are expanded using the given URI variables map.
execute in interface RestOperationsurl - the URLmethod - the HTTP method (GET, POST, etc)requestCallback - object that prepares the requestresponseExtractor - object that extracts the return value from the responseuriVariables - the variables to expand in the templateResponseExtractorRestClientExceptionpublic <T> T execute(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) throws RestClientException
RestOperationsRequestCallback, and reading the response with a ResponseExtractor.execute in interface RestOperationsurl - the URLmethod - the HTTP method (GET, POST, etc)requestCallback - object that prepares the requestresponseExtractor - object that extracts the return value from the responseResponseExtractorRestClientExceptionprotected <T> T doExecute(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) throws RestClientException
The ClientHttpRequest is processed using the RequestCallback;
the response with the ResponseExtractor.
url - the fully-expanded URL to connect tomethod - the HTTP method to execute (GET, POST, etc.)requestCallback - object that prepares the request (can be null)responseExtractor - object that extracts the return value from the response (can be null)ResponseExtractorRestClientExceptionprotected void handleResponse(URI url, HttpMethod method, ClientHttpResponse response) throws IOException
ResponseErrorHandler if necessary.
Can be overridden in subclasses.
url - the fully-expanded URL to connect tomethod - the HTTP method to execute (GET, POST, etc.)response - the resulting ClientHttpResponseIOException - if propagated from ResponseErrorHandlersetErrorHandler(org.springframework.web.client.ResponseErrorHandler)protected <T> RequestCallback acceptHeaderRequestCallback(Class<T> responseType)
Accept
headers based on the given response type and configured
message converters.protected <T> RequestCallback httpEntityCallback(Object requestBody)
protected <T> RequestCallback httpEntityCallback(Object requestBody, Type responseType)
protected <T> ResponseExtractor<ResponseEntity<T>> responseEntityExtractor(Type responseType)
ResponseEntity.protected ResponseExtractor<HttpHeaders> headersExtractor()
HttpHeaders.