root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Polishing

This commit is contained in:
Juergen Hoeller 2016-12-08 18:39:30 +01:00
parent 313c89dd5c
commit cf6a5835cc
6 changed files with 80 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
spring-oxm/src/main/java/org/springframework/oxm/Marshaller.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2016 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -35,7 +35,7 @@ import javax.xml.transform.Result;
public interface Marshaller { public interface Marshaller {
/** /**
* Indicates whether this marshaller can marshal instances of the supplied type. * Indicate whether this marshaller can marshal instances of the supplied type.
* @param clazz the class that this marshaller is being asked if it can marshal * @param clazz the class that this marshaller is being asked if it can marshal
* @return {@code true} if this marshaller can indeed marshal instances of the supplied class; * @return {@code true} if this marshaller can indeed marshal instances of the supplied class;
* {@code false} otherwise * {@code false} otherwise
@ -43,7 +43,7 @@ public interface Marshaller {
boolean supports(Class<?> clazz); boolean supports(Class<?> clazz);
/** /**
* Marshals the object graph with the given root into the provided {@link Result}. * Marshal the object graph with the given root into the provided {@link Result}.
* @param graph the root of the object graph to marshal * @param graph the root of the object graph to marshal
* @param result the result to marshal to * @param result the result to marshal to
* @throws IOException if an I/O error occurs * @throws IOException if an I/O error occurs

6
spring-oxm/src/main/java/org/springframework/oxm/Unmarshaller.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2016 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -30,7 +30,7 @@ import javax.xml.transform.Source;
public interface Unmarshaller { public interface Unmarshaller {
/** /**
* Indicates whether this unmarshaller can unmarshal instances of the supplied type. * Indicate whether this unmarshaller can unmarshal instances of the supplied type.
* @param clazz the class that this unmarshaller is being asked if it can marshal * @param clazz the class that this unmarshaller is being asked if it can marshal
* @return {@code true} if this unmarshaller can indeed unmarshal to the supplied class; * @return {@code true} if this unmarshaller can indeed unmarshal to the supplied class;
* {@code false} otherwise * {@code false} otherwise
@ -38,7 +38,7 @@ public interface Unmarshaller {
boolean supports(Class<?> clazz); boolean supports(Class<?> clazz);
/** /**
* Unmarshals the given {@link Source} into an object graph. * Unmarshal the given {@link Source} into an object graph.
* @param source the source to marshal from * @param source the source to marshal from
* @return the object graph * @return the object graph
* @throws IOException if an I/O error occurs * @throws IOException if an I/O error occurs

52
spring-web/src/main/java/org/springframework/web/client/AsyncRestOperations.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2013 the original author or authors. * Copyright 2002-2016 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -29,12 +29,14 @@ import org.springframework.http.ResponseEntity;
import org.springframework.util.concurrent.ListenableFuture; import org.springframework.util.concurrent.ListenableFuture;
/** /**
* Interface specifying a basic set of asynchronous RESTful operations. Implemented by * Interface specifying a basic set of asynchronous RESTful operations.
* {@link AsyncRestTemplate}. Not often used directly, but a useful option to enhance * Implemented by {@link AsyncRestTemplate}. Not often used directly, but a useful
* testability, as it can easily be mocked or stubbed. * option to enhance testability, as it can easily be mocked or stubbed.
* *
* @author Arjen Poutsma * @author Arjen Poutsma
* @since 4.0 * @since 4.0
* @see AsyncRestTemplate
* @see RestOperations
*/ */
public interface AsyncRestOperations { public interface AsyncRestOperations {
@ -47,8 +49,8 @@ public interface AsyncRestOperations {
// GET // GET
/** /**
* Asynchronously retrieve an entity by doing a GET on the specified URL. The response is * Asynchronously retrieve an entity by doing a GET on the specified URL.
* converted and stored in an {@link ResponseEntity}. * The response is converted and stored in an {@link ResponseEntity}.
* <p>URI Template variables are expanded using the given URI variables, if any. * <p>URI Template variables are expanded using the given URI variables, if any.
* @param url the URL * @param url the URL
* @param responseType the type of the return value * @param responseType the type of the return value
@ -59,8 +61,8 @@ public interface AsyncRestOperations {
Object... uriVariables) throws RestClientException; Object... uriVariables) throws RestClientException;
/** /**
* Asynchronously retrieve a representation by doing a GET on the URI template. The * Asynchronously retrieve a representation by doing a GET on the URI template.
* response is converted and stored in an {@link ResponseEntity}. * The response is converted and stored in an {@link ResponseEntity}.
* <p>URI Template variables are expanded using the given map. * <p>URI Template variables are expanded using the given map.
* @param url the URL * @param url the URL
* @param responseType the type of the return value * @param responseType the type of the return value
@ -80,6 +82,7 @@ public interface AsyncRestOperations {
<T> ListenableFuture<ResponseEntity<T>> getForEntity(URI url, Class<T> responseType) <T> ListenableFuture<ResponseEntity<T>> getForEntity(URI url, Class<T> responseType)
throws RestClientException; throws RestClientException;
// HEAD // HEAD
/** /**
@ -109,6 +112,7 @@ public interface AsyncRestOperations {
*/ */
ListenableFuture<HttpHeaders> headForHeaders(URI url) throws RestClientException; ListenableFuture<HttpHeaders> headForHeaders(URI url) throws RestClientException;
// POST // POST
/** /**
@ -117,7 +121,7 @@ public interface AsyncRestOperations {
* typically indicates where the new resource is stored. * typically indicates where the new resource is stored.
* <p>URI Template variables are expanded using the given URI variables, if any. * <p>URI Template variables are expanded using the given URI variables, if any.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the value for the {@code Location} header wrapped in a {@link Future} * @return the value for the {@code Location} header wrapped in a {@link Future}
* @see org.springframework.http.HttpEntity * @see org.springframework.http.HttpEntity
@ -131,7 +135,7 @@ public interface AsyncRestOperations {
* typically indicates where the new resource is stored. * typically indicates where the new resource is stored.
* <p>URI Template variables are expanded using the given map. * <p>URI Template variables are expanded using the given map.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the value for the {@code Location} header wrapped in a {@link Future} * @return the value for the {@code Location} header wrapped in a {@link Future}
* @see org.springframework.http.HttpEntity * @see org.springframework.http.HttpEntity
@ -144,7 +148,7 @@ public interface AsyncRestOperations {
* returns the value of the {@code Location} header. This header typically indicates * returns the value of the {@code Location} header. This header typically indicates
* where the new resource is stored. * where the new resource is stored.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @return the value for the {@code Location} header wrapped in a {@link Future} * @return the value for the {@code Location} header wrapped in a {@link Future}
* @see org.springframework.http.HttpEntity * @see org.springframework.http.HttpEntity
*/ */
@ -155,7 +159,7 @@ public interface AsyncRestOperations {
* and asynchronously returns the response as {@link ResponseEntity}. * and asynchronously returns the response as {@link ResponseEntity}.
* <p>URI Template variables are expanded using the given URI variables, if any. * <p>URI Template variables are expanded using the given URI variables, if any.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the entity wrapped in a {@link Future} * @return the entity wrapped in a {@link Future}
* @see org.springframework.http.HttpEntity * @see org.springframework.http.HttpEntity
@ -168,26 +172,26 @@ public interface AsyncRestOperations {
* and asynchronously returns the response as {@link ResponseEntity}. * and asynchronously returns the response as {@link ResponseEntity}.
* <p>URI Template variables are expanded using the given map. * <p>URI Template variables are expanded using the given map.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the entity wrapped in a {@link Future} * @return the entity wrapped in a {@link Future}
* @see org.springframework.http.HttpEntity * @see org.springframework.http.HttpEntity
*/ */
<T> ListenableFuture<ResponseEntity<T>> postForEntity(String url, HttpEntity<?> request, <T> ListenableFuture<ResponseEntity<T>> postForEntity(String url, HttpEntity<?> request,
Class<T> responseType, Map<String, ?> uriVariables) Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException;
throws RestClientException;
/** /**
* Create a new resource by POSTing the given object to the URL, * Create a new resource by POSTing the given object to the URL,
* and asynchronously returns the response as {@link ResponseEntity}. * and asynchronously returns the response as {@link ResponseEntity}.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @return the entity wrapped in a {@link Future} * @return the entity wrapped in a {@link Future}
* @see org.springframework.http.HttpEntity * @see org.springframework.http.HttpEntity
*/ */
<T> ListenableFuture<ResponseEntity<T>> postForEntity(URI url, HttpEntity<?> request, <T> ListenableFuture<ResponseEntity<T>> postForEntity(URI url, HttpEntity<?> request,
Class<T> responseType) throws RestClientException; Class<T> responseType) throws RestClientException;
// PUT // PUT
/** /**
@ -195,7 +199,7 @@ public interface AsyncRestOperations {
* <p>URI Template variables are expanded using the given URI variables, if any. * <p>URI Template variables are expanded using the given URI variables, if any.
* <p>The Future will return a {@code null} result upon completion. * <p>The Future will return a {@code null} result upon completion.
* @param url the URL * @param url the URL
* @param request the Object to be PUT, may be {@code null} * @param request the Object to be PUT (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @see HttpEntity * @see HttpEntity
*/ */
@ -207,7 +211,7 @@ public interface AsyncRestOperations {
* <p>URI Template variables are expanded using the given map. * <p>URI Template variables are expanded using the given map.
* <p>The Future will return a {@code null} result upon completion. * <p>The Future will return a {@code null} result upon completion.
* @param url the URL * @param url the URL
* @param request the Object to be PUT, may be {@code null} * @param request the Object to be PUT (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @see HttpEntity * @see HttpEntity
*/ */
@ -218,11 +222,12 @@ public interface AsyncRestOperations {
* Creates a new resource by PUTting the given object to URL. * Creates a new resource by PUTting the given object to URL.
* <p>The Future will return a {@code null} result upon completion. * <p>The Future will return a {@code null} result upon completion.
* @param url the URL * @param url the URL
* @param request the Object to be PUT, may be {@code null} * @param request the Object to be PUT (may be {@code null})
* @see HttpEntity * @see HttpEntity
*/ */
ListenableFuture<?> put(URI url, HttpEntity<?> request) throws RestClientException; ListenableFuture<?> put(URI url, HttpEntity<?> request) throws RestClientException;
// DELETE // DELETE
/** /**
@ -251,6 +256,7 @@ public interface AsyncRestOperations {
*/ */
ListenableFuture<?> delete(URI url) throws RestClientException; ListenableFuture<?> delete(URI url) throws RestClientException;
// OPTIONS // OPTIONS
/** /**
@ -344,7 +350,7 @@ public interface AsyncRestOperations {
* @param url the URL * @param url the URL
* @param method the HTTP method (GET, POST, etc) * @param method the HTTP method (GET, POST, etc)
* @param requestEntity the entity (headers and/or body) to write to the * @param requestEntity the entity (headers and/or body) to write to the
* request, may be {@code null} * request (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand in the template * @param uriVariables the variables to expand in the template
* @return the response as entity wrapped in a {@link Future} * @return the response as entity wrapped in a {@link Future}
@ -364,7 +370,8 @@ public interface AsyncRestOperations {
* </pre> * </pre>
* @param url the URL * @param url the URL
* @param method the HTTP method (GET, POST, etc) * @param method the HTTP method (GET, POST, etc)
* @param requestEntity the entity (headers and/or body) to write to the request, may be {@code null} * @param requestEntity the entity (headers and/or body) to write to the request
* (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand in the template * @param uriVariables the variables to expand in the template
* @return the response as entity wrapped in a {@link Future} * @return the response as entity wrapped in a {@link Future}
@ -384,7 +391,8 @@ public interface AsyncRestOperations {
* </pre> * </pre>
* @param url the URL * @param url the URL
* @param method the HTTP method (GET, POST, etc) * @param method the HTTP method (GET, POST, etc)
* @param requestEntity the entity (headers and/or body) to write to the request, may be {@code null} * @param requestEntity the entity (headers and/or body) to write to the request
* (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @return the response as entity wrapped in a {@link Future} * @return the response as entity wrapped in a {@link Future}
*/ */

6
spring-web/src/main/java/org/springframework/web/client/AsyncRestTemplate.java
View File

@ -53,10 +53,8 @@ import org.springframework.web.util.UriTemplateHandler;
* wrappers as opposed to concrete results. * wrappers as opposed to concrete results.
* *
* <p>The {@code AsyncRestTemplate} exposes a synchronous {@link RestTemplate} via the * <p>The {@code AsyncRestTemplate} exposes a synchronous {@link RestTemplate} via the
* {@link #getRestOperations()} method, and it shares its * {@link #getRestOperations()} method and shares its {@linkplain #setErrorHandler error handler}
* {@linkplain #setErrorHandler(ResponseErrorHandler) error handler} and * and {@linkplain #setMessageConverters message converters} with that {@code RestTemplate}.
* {@linkplain #setMessageConverters(List) message converters} with this
* {@code RestTemplate}.
* *
* <p><strong>Note:</strong> by default {@code AsyncRestTemplate} relies on * <p><strong>Note:</strong> by default {@code AsyncRestTemplate} relies on
* standard JDK facilities to establish HTTP connections. You can switch to use * standard JDK facilities to establish HTTP connections. You can switch to use

71
spring-web/src/main/java/org/springframework/web/client/RestOperations.java
View File

@ -28,9 +28,9 @@ import org.springframework.http.RequestEntity;
import org.springframework.http.ResponseEntity; import org.springframework.http.ResponseEntity;
/** /**
* Interface specifying a basic set of RESTful operations. Implemented by {@link RestTemplate}. * Interface specifying a basic set of RESTful operations.
* Not often used directly, but a useful option to enhance testability, as it can easily * Implemented by {@link RestTemplate}. Not often used directly, but a useful
* be mocked or stubbed. * option to enhance testability, as it can easily be mocked or stubbed.
* *
* @author Arjen Poutsma * @author Arjen Poutsma
* @author Juergen Hoeller * @author Juergen Hoeller
@ -139,13 +139,13 @@ public interface RestOperations {
// POST // POST
/** /**
* Create a new resource by POSTing the given object to the URI template, and returns the value of the * Create a new resource by POSTing the given object to the URI template, and returns the value of
* {@code Location} header. This header typically indicates where the new resource is stored. * the {@code Location} header. This header typically indicates where the new resource is stored.
* <p>URI Template variables are expanded using the given URI variables, if any. * <p>URI Template variables are expanded using the given URI variables, if any.
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the value for the {@code Location} header * @return the value for the {@code Location} header
* @see HttpEntity * @see HttpEntity
@ -153,13 +153,13 @@ public interface RestOperations {
URI postForLocation(String url, Object request, Object... uriVariables) throws RestClientException; URI postForLocation(String url, Object request, Object... uriVariables) throws RestClientException;
/** /**
* Create a new resource by POSTing the given object to the URI template, and returns the value of the * Create a new resource by POSTing the given object to the URI template, and returns the value of
* {@code Location} header. This header typically indicates where the new resource is stored. * the {@code Location} header. This header typically indicates where the new resource is stored.
* <p>URI Template variables are expanded using the given map. * <p>URI Template variables are expanded using the given map.
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the value for the {@code Location} header * @return the value for the {@code Location} header
* @see HttpEntity * @see HttpEntity
@ -172,7 +172,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @return the value for the {@code Location} header * @return the value for the {@code Location} header
* @see HttpEntity * @see HttpEntity
*/ */
@ -185,7 +185,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the converted object * @return the converted object
@ -201,7 +201,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the converted object * @return the converted object
@ -216,7 +216,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @return the converted object * @return the converted object
* @see HttpEntity * @see HttpEntity
@ -230,11 +230,11 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the converted object * @return the converted object
* @see HttpEntity
* @since 3.0.2 * @since 3.0.2
* @see HttpEntity
*/ */
<T> ResponseEntity<T> postForEntity(String url, Object request, Class<T> responseType, Object... uriVariables) <T> ResponseEntity<T> postForEntity(String url, Object request, Class<T> responseType, Object... uriVariables)
throws RestClientException; throws RestClientException;
@ -246,11 +246,11 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the converted object * @return the converted object
* @see HttpEntity
* @since 3.0.2 * @since 3.0.2
* @see HttpEntity
*/ */
<T> ResponseEntity<T> postForEntity(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) <T> ResponseEntity<T> postForEntity(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables)
throws RestClientException; throws RestClientException;
@ -261,10 +261,10 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be POSTed (may be {@code null})
* @return the converted object * @return the converted object
* @see HttpEntity
* @since 3.0.2 * @since 3.0.2
* @see HttpEntity
*/ */
<T> ResponseEntity<T> postForEntity(URI url, Object request, Class<T> responseType) throws RestClientException; <T> ResponseEntity<T> postForEntity(URI url, Object request, Class<T> responseType) throws RestClientException;
@ -277,7 +277,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be PUT, may be {@code null} * @param request the Object to be PUT (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @see HttpEntity * @see HttpEntity
*/ */
@ -289,7 +289,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be PUT, may be {@code null} * @param request the Object to be PUT (may be {@code null})
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @see HttpEntity * @see HttpEntity
*/ */
@ -300,7 +300,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be PUT, may be {@code null} * @param request the Object to be PUT (may be {@code null})
* @see HttpEntity * @see HttpEntity
*/ */
void put(URI url, Object request) throws RestClientException; void put(URI url, Object request) throws RestClientException;
@ -315,12 +315,12 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be PATCHed, may be {@code null} * @param request the Object to be PATCHed (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the converted object * @return the converted object
* @since 4.3.5
* @see HttpEntity * @see HttpEntity
* @since 5.0
*/ */
<T> T patchForObject(String url, Object request, Class<T> responseType, Object... uriVariables) <T> T patchForObject(String url, Object request, Class<T> responseType, Object... uriVariables)
throws RestClientException; throws RestClientException;
@ -332,10 +332,11 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be PATCHed, may be {@code null} * @param request the Object to be PATCHed (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand the template * @param uriVariables the variables to expand the template
* @return the converted object * @return the converted object
* @since 4.3.5
* @see HttpEntity * @see HttpEntity
*/ */
<T> T patchForObject(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) <T> T patchForObject(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables)
@ -347,9 +348,10 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request. * add additional HTTP headers to the request.
* @param url the URL * @param url the URL
* @param request the Object to be POSTed, may be {@code null} * @param request the Object to be PATCHed (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @return the converted object * @return the converted object
* @since 4.3.5
* @see HttpEntity * @see HttpEntity
*/ */
<T> T patchForObject(URI url, Object request, Class<T> responseType) throws RestClientException; <T> T patchForObject(URI url, Object request, Class<T> responseType) throws RestClientException;
@ -418,7 +420,8 @@ public interface RestOperations {
* <p>URI Template variables are expanded using the given URI variables, if any. * <p>URI Template variables are expanded using the given URI variables, if any.
* @param url the URL * @param url the URL
* @param method the HTTP method (GET, POST, etc) * @param method the HTTP method (GET, POST, etc)
* @param requestEntity the entity (headers and/or body) to write to the request, may be {@code null} * @param requestEntity the entity (headers and/or body) to write to the request
* may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand in the template * @param uriVariables the variables to expand in the template
* @return the response as entity * @return the response as entity
@ -433,7 +436,8 @@ public interface RestOperations {
* <p>URI Template variables are expanded using the given URI variables, if any. * <p>URI Template variables are expanded using the given URI variables, if any.
* @param url the URL * @param url the URL
* @param method the HTTP method (GET, POST, etc) * @param method the HTTP method (GET, POST, etc)
* @param requestEntity the entity (headers and/or body) to write to the request, may be {@code null} * @param requestEntity the entity (headers and/or body) to write to the request
* (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand in the template * @param uriVariables the variables to expand in the template
* @return the response as entity * @return the response as entity
@ -447,7 +451,8 @@ public interface RestOperations {
* returns the response as {@link ResponseEntity}. * returns the response as {@link ResponseEntity}.
* @param url the URL * @param url the URL
* @param method the HTTP method (GET, POST, etc) * @param method the HTTP method (GET, POST, etc)
* @param requestEntity the entity (headers and/or body) to write to the request, may be {@code null} * @param requestEntity the entity (headers and/or body) to write to the request
* (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @return the response as entity * @return the response as entity
* @since 3.0.2 * @since 3.0.2
@ -466,7 +471,7 @@ public interface RestOperations {
* @param url the URL * @param url the URL
* @param method the HTTP method (GET, POST, etc) * @param method the HTTP method (GET, POST, etc)
* @param requestEntity the entity (headers and/or body) to write to the * @param requestEntity the entity (headers and/or body) to write to the
* request, may be {@code null} * request (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand in the template * @param uriVariables the variables to expand in the template
* @return the response as entity * @return the response as entity
@ -485,7 +490,8 @@ public interface RestOperations {
* </pre> * </pre>
* @param url the URL * @param url the URL
* @param method the HTTP method (GET, POST, etc) * @param method the HTTP method (GET, POST, etc)
* @param requestEntity the entity (headers and/or body) to write to the request, may be {@code null} * @param requestEntity the entity (headers and/or body) to write to the request
* (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @param uriVariables the variables to expand in the template * @param uriVariables the variables to expand in the template
* @return the response as entity * @return the response as entity
@ -504,7 +510,8 @@ public interface RestOperations {
* </pre> * </pre>
* @param url the URL * @param url the URL
* @param method the HTTP method (GET, POST, etc) * @param method the HTTP method (GET, POST, etc)
* @param requestEntity the entity (headers and/or body) to write to the request, may be {@code null} * @param requestEntity the entity (headers and/or body) to write to the request
* (may be {@code null})
* @param responseType the type of the return value * @param responseType the type of the return value
* @return the response as entity * @return the response as entity
* @since 3.2 * @since 3.2

4
spring-web/src/main/java/org/springframework/web/client/RestTemplate.java
View File

@ -458,6 +458,7 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
execute(url, HttpMethod.PUT, requestCallback, null); execute(url, HttpMethod.PUT, requestCallback, null);
} }
// PATCH // PATCH
@Override @Override
@ -490,6 +491,7 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
return execute(url, HttpMethod.PATCH, requestCallback, responseExtractor); return execute(url, HttpMethod.PATCH, requestCallback, responseExtractor);
} }
// DELETE // DELETE
@Override @Override
@ -692,8 +694,8 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
* @param method the HTTP method to execute (GET, POST, etc.) * @param method the HTTP method to execute (GET, POST, etc.)
* @param response the resulting {@link ClientHttpResponse} * @param response the resulting {@link ClientHttpResponse}
* @throws IOException if propagated from {@link ResponseErrorHandler} * @throws IOException if propagated from {@link ResponseErrorHandler}
* @see #setErrorHandler
* @since 4.1.6 * @since 4.1.6
* @see #setErrorHandler
*/ */
protected void handleResponse(URI url, HttpMethod method, ClientHttpResponse response) throws IOException { protected void handleResponse(URI url, HttpMethod method, ClientHttpResponse response) throws IOException {
ResponseErrorHandler errorHandler = getErrorHandler(); ResponseErrorHandler errorHandler = getErrorHandler();