org.springframework.http.client.support.HttpAccessor
org.springframework.web.client.RestTemplate
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class RestTemplate
The central class for client-side HTTP access. It simplifies communication with HTTP servers, and enforces RESTful principles. It handles HTTP connections, leaving application code to provide URLs (with possible template variables) and extract results.
The main entry points of this template are the methods named after the six main HTTP methods:
For each of these HTTP methods, there are three corresponding Java methods in the RestTemplate. Two
variant 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| Field Summary |
|---|
| Fields inherited from class org.springframework.http.client.support.HttpAccessor |
|---|
logger |
| Constructor Summary | |
|---|---|
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. |
|
| Method Summary | ||
|---|---|---|
void |
delete(String url,
Map<String,?> urlVariables)
Delete the resources at the specified URI. |
|
void |
delete(String url,
Object... urlVariables)
Delete the resources at the specified URI. |
|
void |
delete(URI url)
Delete the resources at the specified URL. |
|
protected
|
doExecute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the given method on the provided URI. |
|
|
execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> urlVariables)
Execute the HTTP methods to the given URI template, preparing the request with the RequestCallback, and reading the response with a ResponseExtractor. |
|
|
execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... urlVariables)
Execute the HTTP methods to the given URI template, preparing the request with the RequestCallback, and reading the response with aResponseExtractor. |
|
|
execute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
Execute the HTTP methods to the given URL, preparing the request with the RequestCallback, and reading the response with a ResponseExtractor. |
|
ResponseErrorHandler |
getErrorHandler()
Return the error handler. |
|
|
getForObject(String url,
Class<T> responseType,
Map<String,?> urlVariables)
Retrieve a representation by doing a GET on the URI template. |
|
|
getForObject(String url,
Class<T> responseType,
Object... urlVariables)
Retrieve a representation by doing a GET on the specified URL. |
|
|
getForObject(URI url,
Class<T> responseType)
Retrieve a representation by doing a GET on the URL . |
|
List<HttpMessageConverter<?>> |
getMessageConverters()
Returns the message body converters. |
|
HttpHeaders |
headForHeaders(String url,
Map<String,?> urlVariables)
Retrieve all headers of the resource specified by the URI template. |
|
HttpHeaders |
headForHeaders(String url,
Object... urlVariables)
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. |
|
Set<HttpMethod> |
optionsForAllow(String url,
Map<String,?> urlVariables)
Return the value of the Allow header for the given URI. |
|
Set<HttpMethod> |
optionsForAllow(String url,
Object... urlVariables)
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. |
|
URI |
postForLocation(String url,
Object request,
Map<String,?> urlVariables)
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... urlVariables)
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. |
|
|
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. |
|
|
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. |
|
|
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,?> urlVariables)
Creates a new resource by PUTting the given object to URI template. |
|
void |
put(String url,
Object request,
Object... urlVariables)
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. |
|
void |
setErrorHandler(ResponseErrorHandler errorHandler)
Set the error handler. |
|
void |
setMessageConverters(List<HttpMessageConverter<?>> messageConverters)
Set the message body converters to use. |
|
| Methods inherited from class org.springframework.http.client.support.HttpAccessor |
|---|
createRequest, getRequestFactory, setRequestFactory |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public RestTemplate()
RestTemplate using default settings.
public RestTemplate(ClientHttpRequestFactory requestFactory)
RestTemplate based on the given ClientHttpRequestFactory.
requestFactory - HTTP request factory to useSimpleClientHttpRequestFactory,
CommonsClientHttpRequestFactory| Method Detail |
|---|
public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters)
public List<HttpMessageConverter<?>> getMessageConverters()
public void setErrorHandler(ResponseErrorHandler errorHandler)
public ResponseErrorHandler getErrorHandler()
DefaultResponseErrorHandler.
public <T> T getForObject(String url,
Class<T> responseType,
Object... urlVariables)
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 valueurlVariables - the variables to expand the template
RestClientException
public <T> T getForObject(String url,
Class<T> responseType,
Map<String,?> urlVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
getForObject in interface RestOperationsurl - the URLresponseType - the type of the return valueurlVariables - the map containing variables for the URI template
RestClientException
public <T> T getForObject(URI url,
Class<T> responseType)
throws RestClientException
RestOperations
getForObject in interface RestOperationsurl - the URLresponseType - the type of the return value
RestClientException
public HttpHeaders headForHeaders(String url,
Object... urlVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
headForHeaders in interface RestOperationsurl - the URLurlVariables - the variables to expand the template
RestClientException
public HttpHeaders headForHeaders(String url,
Map<String,?> urlVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
headForHeaders in interface RestOperationsurl - the URLurlVariables - the map containing variables for the URI template
RestClientException
public HttpHeaders headForHeaders(URI url)
throws RestClientException
RestOperations
headForHeaders in interface RestOperationsurl - the URL
RestClientException
public URI postForLocation(String url,
Object request,
Object... urlVariables)
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.
postForLocation in interface RestOperationsurl - the URLrequest - the Object to be POSTed, may be nullurlVariables - the variables to expand the template
Location header
RestClientException
public URI postForLocation(String url,
Object request,
Map<String,?> urlVariables)
throws RestClientException
RestOperationsLocation header. This header typically indicates where the new resource is stored.
URI Template variables are expanded using the given map.
postForLocation in interface RestOperationsurl - the URLrequest - the Object to be POSTed, may be nullurlVariables - the variables to expand the template
Location header
RestClientException
public URI postForLocation(URI url,
Object request)
throws RestClientException
RestOperationsLocation header. This header typically indicates where the new resource is stored.
postForLocation in interface RestOperationsurl - the URLrequest - the Object to be POSTed, may be null
Location header
RestClientException
public <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.
postForObject in interface RestOperationsurl - the URLrequest - the Object to be POSTed, may be nulluriVariables - the variables to expand the template
RestClientException
public <T> T postForObject(String url,
Object request,
Class<T> responseType,
Map<String,?> uriVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
postForObject in interface RestOperationsurl - the URLrequest - the Object to be POSTed, may be nulluriVariables - the variables to expand the template
RestClientException
public <T> T postForObject(URI url,
Object request,
Class<T> responseType)
throws RestClientException
RestOperations
postForObject in interface RestOperationsurl - the URLrequest - the Object to be POSTed, may be null
RestClientException
public void put(String url,
Object request,
Object... urlVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
put in interface RestOperationsurl - the URLrequest - the Object to be PUT, may be nullurlVariables - the variables to expand the template
RestClientException
public void put(String url,
Object request,
Map<String,?> urlVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
put in interface RestOperationsurl - the URLrequest - the Object to be PUT, may be nullurlVariables - the variables to expand the template
RestClientException
public void put(URI url,
Object request)
throws RestClientException
RestOperations
put in interface RestOperationsurl - the URLrequest - the Object to be PUT, may be null
RestClientException
public void delete(String url,
Object... urlVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
delete in interface RestOperationsurl - the URLurlVariables - the variables to expand in the template
RestClientException
public void delete(String url,
Map<String,?> urlVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
delete in interface RestOperationsurl - the URLurlVariables - the variables to expand the template
RestClientException
public void delete(URI url)
throws RestClientException
RestOperations
delete in interface RestOperationsurl - the URL
RestClientException
public Set<HttpMethod> optionsForAllow(String url,
Object... urlVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given URI variables, if any.
optionsForAllow in interface RestOperationsurl - the URLurlVariables - the variables to expand in the template
RestClientException
public Set<HttpMethod> optionsForAllow(String url,
Map<String,?> urlVariables)
throws RestClientException
RestOperationsURI Template variables are expanded using the given map.
optionsForAllow in interface RestOperationsurl - the URLurlVariables - the variables to expand in the template
RestClientException
public Set<HttpMethod> optionsForAllow(URI url)
throws RestClientException
RestOperations
optionsForAllow in interface RestOperationsurl - the URL
RestClientException
public <T> T execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Object... urlVariables)
throws RestClientException
RestOperationsRequestCallback, and reading the response with aResponseExtractor.
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 responseurlVariables - the variables to expand in the template
ResponseExtractor
RestClientException
public <T> T execute(String url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor,
Map<String,?> urlVariables)
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 responseurlVariables - the variables to expand in the template
ResponseExtractor
RestClientException
public <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 response
ResponseExtractor
RestClientException
protected <T> T doExecute(URI url,
HttpMethod method,
RequestCallback requestCallback,
ResponseExtractor<T> responseExtractor)
throws RestClientException
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
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||