public class RestTemplate extends InterceptingHttpAccessor implements RestOperations
The main entry points of this template are the methods named after the six main HTTP methods:
The exchange
and execute
methods are generalized versions of the more specific methods listed
above them. They support additional, less frequently used combinations including support for requests using the
HTTP PATCH method. However, note that the underlying HTTP library must also support the desired combination.
For each of these HTTP methods, there are three corresponding Java methods in the RestTemplate
.
Two variants take a String
URI as first argument (eg. getForObject(String, Class, Object[])
,
getForObject(String, Class, Map)
), and are capable of substituting any URI templates
in that URL using either a String
variable arguments array, or a Map<String, String>
.
The string varargs variant expands the given template variables in order, so that
String result = restTemplate.getForObject("http://example.com/hotels/{hotel}/bookings/{booking}", String.class, "42", "21");will perform a GET on
http://example.com/hotels/42/bookings/21
. The map variant expands the template based
on variable name, and is therefore more useful when using many variables, or when a single variable is used multiple
times. For example:
Map<String, String> vars = Collections.singletonMap("hotel", "42"); String result = restTemplate.getForObject("http://example.com/hotels/{hotel}/rooms/{hotel}", String.class, vars);will perform a GET on
http://example.com/hotels/42/rooms/42
. Alternatively, there are URI
variant
methods (getForObject(URI, Class)
), which do not allow for URI templates, but allow you to reuse a single,
expanded URI multiple times.
Furthermore, the String
-argument methods assume that the URL String is unencoded. This means that
restTemplate.getForObject("http://example.com/hotel list");will perform a GET on
http://example.com/hotel%20list
. As a result, any URL passed that is already encoded
will be encoded twice (i.e. http://example.com/hotel%20list
will become http://example.com/hotel%2520list
). If this behavior is undesirable, use the URI
-argument methods, which
will not perform any URL encoding.
Objects passed to and returned from these methods are converted to and from HTTP messages by
HttpMessageConverter
instances. Converters for the main mime types are registered by default,
but you can also write your own converter and register it via the messageConverters
bean property.
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 the requestFactory
and errorHandler
bean properties.
HttpMessageConverter
,
RequestCallback
,
ResponseExtractor
,
ResponseErrorHandler
,
AsyncRestTemplate
Modifier and Type | Class and Description |
---|---|
private class |
RestTemplate.AcceptHeaderRequestCallback
Request callback implementation that prepares the request's accept headers.
|
private static class |
RestTemplate.HeadersExtractor
Response extractor that extracts the response
HttpHeaders . |
private class |
RestTemplate.HttpEntityRequestCallback
Request callback implementation that writes the given object to the request stream.
|
private class |
RestTemplate.ResponseEntityResponseExtractor<T>
Response extractor for
HttpEntity . |
Modifier and Type | Field and Description |
---|---|
private ResponseErrorHandler |
errorHandler |
private static boolean |
gsonPresent |
private ResponseExtractor<HttpHeaders> |
headersExtractor |
private static boolean |
jackson2Present |
private static boolean |
jaxb2Present |
private java.util.List<HttpMessageConverter<?>> |
messageConverters |
private static boolean |
romePresent |
logger
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(java.util.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(java.lang.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(java.lang.String url,
java.util.Map<java.lang.String,?> urlVariables)
Delete the resources at the specified URI.
|
void |
delete(java.lang.String url,
java.lang.Object... urlVariables)
Delete the resources at the specified URI.
|
void |
delete(java.net.URI url)
Delete the resources at the specified URL.
|
protected <T> T |
doExecute(java.net.URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the given method on the provided URI.
|
<T> ResponseEntity<T> |
exchange(RequestEntity<?> requestEntity,
java.lang.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(java.lang.String url,
HttpMethod method,
HttpEntity<?> requestEntity,
java.lang.Class<T> responseType,
java.util.Map<java.lang.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(java.lang.String url,
HttpMethod method,
HttpEntity<?> requestEntity,
java.lang.Class<T> responseType,
java.lang.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(java.lang.String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
java.util.Map<java.lang.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(java.lang.String url,
HttpMethod method,
HttpEntity<?> requestEntity,
ParameterizedTypeReference<T> responseType,
java.lang.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(java.net.URI url,
HttpMethod method,
HttpEntity<?> requestEntity,
java.lang.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(java.net.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(java.lang.String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
java.util.Map<java.lang.String,?> urlVariables)
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(java.lang.String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
java.lang.Object... urlVariables)
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(java.net.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(java.lang.String url,
java.lang.Class<T> responseType,
java.util.Map<java.lang.String,?> urlVariables)
Retrieve a representation by doing a GET on the URI template.
|
<T> ResponseEntity<T> |
getForEntity(java.lang.String url,
java.lang.Class<T> responseType,
java.lang.Object... urlVariables)
Retrieve an entity by doing a GET on the specified URL.
|
<T> ResponseEntity<T> |
getForEntity(java.net.URI url,
java.lang.Class<T> responseType)
Retrieve a representation by doing a GET on the URL .
|
<T> T |
getForObject(java.lang.String url,
java.lang.Class<T> responseType,
java.util.Map<java.lang.String,?> urlVariables)
Retrieve a representation by doing a GET on the URI template.
|
<T> T |
getForObject(java.lang.String url,
java.lang.Class<T> responseType,
java.lang.Object... urlVariables)
Retrieve a representation by doing a GET on the specified URL.
|
<T> T |
getForObject(java.net.URI url,
java.lang.Class<T> responseType)
Retrieve a representation by doing a GET on the URL .
|
java.util.List<HttpMessageConverter<?>> |
getMessageConverters()
Return the message body converters.
|
private void |
handleResponseError(HttpMethod method,
java.net.URI url,
ClientHttpResponse response) |
protected ResponseExtractor<HttpHeaders> |
headersExtractor()
Returns a response extractor for
HttpHeaders . |
HttpHeaders |
headForHeaders(java.lang.String url,
java.util.Map<java.lang.String,?> urlVariables)
Retrieve all headers of the resource specified by the URI template.
|
HttpHeaders |
headForHeaders(java.lang.String url,
java.lang.Object... urlVariables)
Retrieve all headers of the resource specified by the URI template.
|
HttpHeaders |
headForHeaders(java.net.URI url)
Retrieve all headers of the resource specified by the URL.
|
protected <T> RequestCallback |
httpEntityCallback(java.lang.Object requestBody)
Returns a request callback implementation that writes the given object to the
request stream.
|
protected <T> RequestCallback |
httpEntityCallback(java.lang.Object requestBody,
java.lang.reflect.Type responseType)
Returns a request callback implementation that writes the given object to the
request stream.
|
private void |
logResponseStatus(HttpMethod method,
java.net.URI url,
ClientHttpResponse response) |
java.util.Set<HttpMethod> |
optionsForAllow(java.lang.String url,
java.util.Map<java.lang.String,?> urlVariables)
Return the value of the Allow header for the given URI.
|
java.util.Set<HttpMethod> |
optionsForAllow(java.lang.String url,
java.lang.Object... urlVariables)
Return the value of the Allow header for the given URI.
|
java.util.Set<HttpMethod> |
optionsForAllow(java.net.URI url)
Return the value of the Allow header for the given URL.
|
<T> ResponseEntity<T> |
postForEntity(java.lang.String url,
java.lang.Object request,
java.lang.Class<T> responseType,
java.util.Map<java.lang.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(java.lang.String url,
java.lang.Object request,
java.lang.Class<T> responseType,
java.lang.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(java.net.URI url,
java.lang.Object request,
java.lang.Class<T> responseType)
Create a new resource by POSTing the given object to the URL,
and returns the response as
ResponseEntity . |
java.net.URI |
postForLocation(java.lang.String url,
java.lang.Object request,
java.util.Map<java.lang.String,?> urlVariables)
Create a new resource by POSTing the given object to the URI template, and returns the value of the
Location header. |
java.net.URI |
postForLocation(java.lang.String url,
java.lang.Object request,
java.lang.Object... urlVariables)
Create a new resource by POSTing the given object to the URI template, and returns the value of the
Location header. |
java.net.URI |
postForLocation(java.net.URI url,
java.lang.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(java.lang.String url,
java.lang.Object request,
java.lang.Class<T> responseType,
java.util.Map<java.lang.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(java.lang.String url,
java.lang.Object request,
java.lang.Class<T> responseType,
java.lang.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(java.net.URI url,
java.lang.Object request,
java.lang.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(java.lang.String url,
java.lang.Object request,
java.util.Map<java.lang.String,?> urlVariables)
Creates a new resource by PUTting the given object to URI template.
|
void |
put(java.lang.String url,
java.lang.Object request,
java.lang.Object... urlVariables)
Create or update a resource by PUTting the given object to the URI.
|
void |
put(java.net.URI url,
java.lang.Object request)
Creates a new resource by PUTting the given object to URL.
|
protected <T> ResponseExtractor<ResponseEntity<T>> |
responseEntityExtractor(java.lang.reflect.Type responseType)
Returns a response extractor for
ResponseEntity . |
void |
setErrorHandler(ResponseErrorHandler errorHandler)
Set the error handler.
|
void |
setMessageConverters(java.util.List<HttpMessageConverter<?>> messageConverters)
Set the message body converters to use.
|
getInterceptors, getRequestFactory, setInterceptors
createRequest, setRequestFactory
private static boolean romePresent
private static final boolean jaxb2Present
private static final boolean jackson2Present
private static final boolean gsonPresent
private final java.util.List<HttpMessageConverter<?>> messageConverters
private ResponseErrorHandler errorHandler
private final ResponseExtractor<HttpHeaders> headersExtractor
public RestTemplate()
RestTemplate
using default settings.
Default HttpMessageConverter
s are initialized.public RestTemplate(ClientHttpRequestFactory requestFactory)
RestTemplate
based on the given ClientHttpRequestFactory
.requestFactory
- HTTP request factory to useSimpleClientHttpRequestFactory
,
HttpComponentsClientHttpRequestFactory
public RestTemplate(java.util.List<HttpMessageConverter<?>> messageConverters)
RestTemplate
using the given list of
HttpMessageConverter
to usemessageConverters
- the list of HttpMessageConverter
to usepublic void setMessageConverters(java.util.List<HttpMessageConverter<?>> messageConverters)
These converters are used to convert from and to HTTP requests and responses.
public java.util.List<HttpMessageConverter<?>> getMessageConverters()
public void setErrorHandler(ResponseErrorHandler errorHandler)
By default, RestTemplate uses a DefaultResponseErrorHandler
.
public ResponseErrorHandler getErrorHandler()
public <T> T getForObject(java.lang.String url, java.lang.Class<T> responseType, java.lang.Object... urlVariables) throws RestClientException
RestOperations
URI Template variables are expanded using the given URI variables, if any.
getForObject
in interface RestOperations
url
- the URLresponseType
- the type of the return valueurlVariables
- the variables to expand the templateRestClientException
public <T> T getForObject(java.lang.String url, java.lang.Class<T> responseType, java.util.Map<java.lang.String,?> urlVariables) throws RestClientException
RestOperations
URI Template variables are expanded using the given map.
getForObject
in interface RestOperations
url
- the URLresponseType
- the type of the return valueurlVariables
- the map containing variables for the URI templateRestClientException
public <T> T getForObject(java.net.URI url, java.lang.Class<T> responseType) throws RestClientException
RestOperations
getForObject
in interface RestOperations
url
- the URLresponseType
- the type of the return valueRestClientException
public <T> ResponseEntity<T> getForEntity(java.lang.String url, java.lang.Class<T> responseType, java.lang.Object... urlVariables) throws RestClientException
RestOperations
ResponseEntity
.
URI Template variables are expanded using the given URI variables, if any.
getForEntity
in interface RestOperations
url
- the URLresponseType
- the type of the return valueurlVariables
- the variables to expand the templateRestClientException
public <T> ResponseEntity<T> getForEntity(java.lang.String url, java.lang.Class<T> responseType, java.util.Map<java.lang.String,?> urlVariables) throws RestClientException
RestOperations
ResponseEntity
.
URI Template variables are expanded using the given map.
getForEntity
in interface RestOperations
url
- the URLresponseType
- the type of the return valueurlVariables
- the map containing variables for the URI templateRestClientException
public <T> ResponseEntity<T> getForEntity(java.net.URI url, java.lang.Class<T> responseType) throws RestClientException
RestOperations
ResponseEntity
.getForEntity
in interface RestOperations
url
- the URLresponseType
- the type of the return valueRestClientException
public HttpHeaders headForHeaders(java.lang.String url, java.lang.Object... urlVariables) throws RestClientException
RestOperations
URI Template variables are expanded using the given URI variables, if any.
headForHeaders
in interface RestOperations
url
- the URLurlVariables
- the variables to expand the templateRestClientException
public HttpHeaders headForHeaders(java.lang.String url, java.util.Map<java.lang.String,?> urlVariables) throws RestClientException
RestOperations
URI Template variables are expanded using the given map.
headForHeaders
in interface RestOperations
url
- the URLurlVariables
- the map containing variables for the URI templateRestClientException
public HttpHeaders headForHeaders(java.net.URI url) throws RestClientException
RestOperations
headForHeaders
in interface RestOperations
url
- the URLRestClientException
public java.net.URI postForLocation(java.lang.String url, java.lang.Object request, java.lang.Object... urlVariables) throws RestClientException
RestOperations
Location
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 RestOperations
url
- the URLrequest
- the Object to be POSTed, may be null
urlVariables
- the variables to expand the templateLocation
headerRestClientException
HttpEntity
public java.net.URI postForLocation(java.lang.String url, java.lang.Object request, java.util.Map<java.lang.String,?> urlVariables) throws RestClientException
RestOperations
Location
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 RestOperations
url
- the URLrequest
- the Object to be POSTed, may be null
urlVariables
- the variables to expand the templateLocation
headerRestClientException
HttpEntity
public java.net.URI postForLocation(java.net.URI url, java.lang.Object request) throws RestClientException
RestOperations
Location
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 RestOperations
url
- the URLrequest
- the Object to be POSTed, may be null
Location
headerRestClientException
HttpEntity
public <T> T postForObject(java.lang.String url, java.lang.Object request, java.lang.Class<T> responseType, java.lang.Object... uriVariables) throws RestClientException
RestOperations
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.
postForObject
in interface RestOperations
url
- the URLrequest
- the Object to be POSTed, may be null
responseType
- the type of the return valueuriVariables
- the variables to expand the templateRestClientException
HttpEntity
public <T> T postForObject(java.lang.String url, java.lang.Object request, java.lang.Class<T> responseType, java.util.Map<java.lang.String,?> uriVariables) throws RestClientException
RestOperations
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.
postForObject
in interface RestOperations
url
- the URLrequest
- the Object to be POSTed, may be null
responseType
- the type of the return valueuriVariables
- the variables to expand the templateRestClientException
HttpEntity
public <T> T postForObject(java.net.URI url, java.lang.Object request, java.lang.Class<T> responseType) throws RestClientException
RestOperations
The request
parameter can be a HttpEntity
in order to
add additional HTTP headers to the request.
postForObject
in interface RestOperations
url
- the URLrequest
- the Object to be POSTed, may be null
responseType
- the type of the return valueRestClientException
HttpEntity
public <T> ResponseEntity<T> postForEntity(java.lang.String url, java.lang.Object request, java.lang.Class<T> responseType, java.lang.Object... uriVariables) throws RestClientException
RestOperations
ResponseEntity
.
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 RestOperations
url
- the URLrequest
- the Object to be POSTed, may be null
uriVariables
- the variables to expand the templateRestClientException
HttpEntity
public <T> ResponseEntity<T> postForEntity(java.lang.String url, java.lang.Object request, java.lang.Class<T> responseType, java.util.Map<java.lang.String,?> uriVariables) throws RestClientException
RestOperations
HttpEntity
.
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 RestOperations
url
- the URLrequest
- the Object to be POSTed, may be null
uriVariables
- the variables to expand the templateRestClientException
HttpEntity
public <T> ResponseEntity<T> postForEntity(java.net.URI url, java.lang.Object request, java.lang.Class<T> responseType) throws RestClientException
RestOperations
ResponseEntity
.
The request
parameter can be a HttpEntity
in order to
add additional HTTP headers to the request.
postForEntity
in interface RestOperations
url
- the URLrequest
- the Object to be POSTed, may be null
RestClientException
HttpEntity
public void put(java.lang.String url, java.lang.Object request, java.lang.Object... urlVariables) throws RestClientException
RestOperations
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.
put
in interface RestOperations
url
- the URLrequest
- the Object to be PUT, may be null
urlVariables
- the variables to expand the templateRestClientException
HttpEntity
public void put(java.lang.String url, java.lang.Object request, java.util.Map<java.lang.String,?> urlVariables) throws RestClientException
RestOperations
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.
put
in interface RestOperations
url
- the URLrequest
- the Object to be PUT, may be null
urlVariables
- the variables to expand the templateRestClientException
HttpEntity
public void put(java.net.URI url, java.lang.Object request) throws RestClientException
RestOperations
The request
parameter can be a HttpEntity
in order to
add additional HTTP headers to the request.
put
in interface RestOperations
url
- the URLrequest
- the Object to be PUT, may be null
RestClientException
HttpEntity
public void delete(java.lang.String url, java.lang.Object... urlVariables) throws RestClientException
RestOperations
URI Template variables are expanded using the given URI variables, if any.
delete
in interface RestOperations
url
- the URLurlVariables
- the variables to expand in the templateRestClientException
public void delete(java.lang.String url, java.util.Map<java.lang.String,?> urlVariables) throws RestClientException
RestOperations
URI Template variables are expanded using the given map.
delete
in interface RestOperations
url
- the URLurlVariables
- the variables to expand the templateRestClientException
public void delete(java.net.URI url) throws RestClientException
RestOperations
delete
in interface RestOperations
url
- the URLRestClientException
public java.util.Set<HttpMethod> optionsForAllow(java.lang.String url, java.lang.Object... urlVariables) throws RestClientException
RestOperations
URI Template variables are expanded using the given URI variables, if any.
optionsForAllow
in interface RestOperations
url
- the URLurlVariables
- the variables to expand in the templateRestClientException
public java.util.Set<HttpMethod> optionsForAllow(java.lang.String url, java.util.Map<java.lang.String,?> urlVariables) throws RestClientException
RestOperations
URI Template variables are expanded using the given map.
optionsForAllow
in interface RestOperations
url
- the URLurlVariables
- the variables to expand in the templateRestClientException
public java.util.Set<HttpMethod> optionsForAllow(java.net.URI url) throws RestClientException
RestOperations
optionsForAllow
in interface RestOperations
url
- the URLRestClientException
public <T> ResponseEntity<T> exchange(java.lang.String url, HttpMethod method, HttpEntity<?> requestEntity, java.lang.Class<T> responseType, java.lang.Object... uriVariables) throws RestClientException
RestOperations
ResponseEntity
.
URI Template variables are expanded using the given URI variables, if any.
exchange
in interface RestOperations
url
- 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 templateRestClientException
public <T> ResponseEntity<T> exchange(java.lang.String url, HttpMethod method, HttpEntity<?> requestEntity, java.lang.Class<T> responseType, java.util.Map<java.lang.String,?> uriVariables) throws RestClientException
RestOperations
ResponseEntity
.
URI Template variables are expanded using the given URI variables, if any.
exchange
in interface RestOperations
url
- 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 templateRestClientException
public <T> ResponseEntity<T> exchange(java.net.URI url, HttpMethod method, HttpEntity<?> requestEntity, java.lang.Class<T> responseType) throws RestClientException
RestOperations
ResponseEntity
.exchange
in interface RestOperations
url
- 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 valueRestClientException
public <T> ResponseEntity<T> exchange(java.lang.String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, java.lang.Object... uriVariables) throws RestClientException
RestOperations
ResponseEntity
.
The given ParameterizedTypeReference
is used to pass generic type information:
ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {}; ResponseEntity<List<MyBean>> response = template.exchange("http://example.com",HttpMethod.GET, null, myBean);
exchange
in interface RestOperations
url
- 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 templateRestClientException
public <T> ResponseEntity<T> exchange(java.lang.String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, java.util.Map<java.lang.String,?> uriVariables) throws RestClientException
RestOperations
ResponseEntity
.
The given ParameterizedTypeReference
is used to pass generic type information:
ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {}; ResponseEntity<List<MyBean>> response = template.exchange("http://example.com",HttpMethod.GET, null, myBean);
exchange
in interface RestOperations
url
- 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 templateRestClientException
public <T> ResponseEntity<T> exchange(java.net.URI url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) throws RestClientException
RestOperations
ResponseEntity
.
The given ParameterizedTypeReference
is used to pass generic type information:
ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {}; ResponseEntity<List<MyBean>> response = template.exchange("http://example.com",HttpMethod.GET, null, myBean);
exchange
in interface RestOperations
url
- 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 valueRestClientException
public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, java.lang.Class<T> responseType) throws RestClientException
RestOperations
RequestEntity
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("http://example.com/{foo}", "bar").accept(MediaType.APPLICATION_JSON).body(body); ResponseEntity<MyResponse> response = template.exchange(request, MyResponse.class);
exchange
in interface RestOperations
requestEntity
- the entity to write to the requestresponseType
- the type of the return valueRestClientException
public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) throws RestClientException
RestOperations
RequestEntity
and return
the response as ResponseEntity
. The given
ParameterizedTypeReference
is used to pass generic type information:
MyRequest body = ... RequestEntity request = RequestEntity.post("http://example.com/{foo}", "bar").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 RestOperations
requestEntity
- the entity to write to the requestresponseType
- the type of the return valueRestClientException
public <T> T execute(java.lang.String url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, java.lang.Object... urlVariables) throws RestClientException
RestOperations
RequestCallback
, and reading the response with a ResponseExtractor
.
URI Template variables are expanded using the given URI variables, if any.
execute
in interface RestOperations
url
- the URLmethod
- the HTTP method (GET, POST, etc)requestCallback
- object that prepares the requestresponseExtractor
- object that extracts the return value from the responseurlVariables
- the variables to expand in the templateResponseExtractor
RestClientException
public <T> T execute(java.lang.String url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, java.util.Map<java.lang.String,?> urlVariables) throws RestClientException
RestOperations
RequestCallback
, and reading the response with a ResponseExtractor
.
URI Template variables are expanded using the given URI variables map.
execute
in interface RestOperations
url
- the URLmethod
- the HTTP method (GET, POST, etc)requestCallback
- object that prepares the requestresponseExtractor
- object that extracts the return value from the responseurlVariables
- the variables to expand in the templateResponseExtractor
RestClientException
public <T> T execute(java.net.URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) throws RestClientException
RestOperations
RequestCallback
, and reading the response with a ResponseExtractor
.execute
in interface RestOperations
url
- the URLmethod
- the HTTP method (GET, POST, etc)requestCallback
- object that prepares the requestresponseExtractor
- object that extracts the return value from the responseResponseExtractor
RestClientException
protected <T> T doExecute(java.net.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
)ResponseExtractor
RestClientException
private void logResponseStatus(HttpMethod method, java.net.URI url, ClientHttpResponse response)
private void handleResponseError(HttpMethod method, java.net.URI url, ClientHttpResponse response) throws java.io.IOException
java.io.IOException
protected <T> RequestCallback acceptHeaderRequestCallback(java.lang.Class<T> responseType)
Accept
headers based on the given response type and configured
message converters.protected <T> RequestCallback httpEntityCallback(java.lang.Object requestBody)
protected <T> RequestCallback httpEntityCallback(java.lang.Object requestBody, java.lang.reflect.Type responseType)
protected <T> ResponseExtractor<ResponseEntity<T>> responseEntityExtractor(java.lang.reflect.Type responseType)
ResponseEntity
.protected ResponseExtractor<HttpHeaders> headersExtractor()
HttpHeaders
.