com.sghd.common.utils.http.AsyncRestOperations Maven / Gradle / Ivy
package com.sghd.common.utils.http;
import java.net.URI;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Future;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RequestCallback;
import org.springframework.web.client.ResponseExtractor;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestOperations;
public interface AsyncRestOperations extends RestOperations {
// GET
/**
* Retrieve a representation by doing a GET on the specified URL. The response (if any) is converted and returned.
*
* URI Template variables are expanded using the given URI variables, if any.
* @param url the URL
* @param responseType the type of the return value
* @param uriVariables the variables to expand the template
* @return the converted object
*/
Future getForObject(AsyncCallback callback, String url, Class responseType, Object... uriVariables)
throws RestClientException;
/**
* Retrieve a representation by doing a GET on the URI template. The response (if any) is converted and returned.
*
* URI Template variables are expanded using the given map.
* @param url the URL
* @param responseType the type of the return value
* @param uriVariables the map containing variables for the URI template
* @return the converted object
*/
Future getForObject(AsyncCallback callback, String url, Class responseType, Map uriVariables)
throws RestClientException;
/**
* Retrieve a representation by doing a GET on the URL . The response (if any) is converted and returned.
* @param url the URL
* @param responseType the type of the return value
* @return the converted object
*/
Future getForObject(AsyncCallback callback, URI url, Class responseType) throws RestClientException;
/**
* Retrieve an entity by doing a GET on the specified URL. The response is converted and stored in an
* {@link ResponseEntity}.
*
* URI Template variables are expanded using the given URI variables, if any.
* @param url the URL
* @param responseType the type of the return value
* @param uriVariables the variables to expand the template
* @return the entity
* @since 3.0.2
*/
Future> getForEntity(AsyncCallback> callback, String url, Class responseType,
Object... uriVariables) throws RestClientException;
/**
* Retrieve a representation by doing a GET on the URI template. The response is converted and stored in an
* {@link ResponseEntity}.
*
* URI Template variables are expanded using the given map.
* @param url the URL
* @param responseType the type of the return value
* @param uriVariables the map containing variables for the URI template
* @return the converted object
* @since 3.0.2
*/
Future> getForEntity(AsyncCallback> callback, String url, Class responseType,
Map uriVariables) throws RestClientException;
/**
* Retrieve a representation by doing a GET on the URL . The response is converted and stored in an
* {@link ResponseEntity}.
* @param url the URL
* @param responseType the type of the return value
* @return the converted object
* @since 3.0.2
*/
Future> getForEntity(AsyncCallback> callback, URI url, Class responseType)
throws RestClientException;
// HEAD
/**
* Retrieve all headers of the resource specified by the URI template.
*
* URI Template variables are expanded using the given URI variables, if any.
* @param url the URL
* @param uriVariables the variables to expand the template
* @return all HTTP headers of that resource
*/
Future headForHeaders(AsyncCallback callback, String url, Object... uriVariables)
throws RestClientException;
/**
* Retrieve all headers of the resource specified by the URI template.
*
* URI Template variables are expanded using the given map.
* @param url the URL
* @param uriVariables the map containing variables for the URI template
* @return all HTTP headers of that resource
*/
Future headForHeaders(AsyncCallback callback, String url, Map uriVariables)
throws RestClientException;
/**
* Retrieve all headers of the resource specified by the URL.
* @param url the URL
* @return all HTTP headers of that resource
*/
Future headForHeaders(AsyncCallback callback, URI url) throws RestClientException;
// POST
/**
* Create a new resource by POSTing the given object to the URI template, and returns the value of the
* 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 {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be null
* @param uriVariables the variables to expand the template
* @return the value for the Location header
* @see HttpEntity
*/
Future postForLocation(AsyncCallback callback, 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
* Location header. This header typically indicates where the new resource is stored.
*
* URI Template variables are expanded using the given map.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be null
* @param uriVariables the variables to expand the template
* @return the value for the Location header
* @see HttpEntity
*/
Future postForLocation(AsyncCallback callback, String url, Object request, Map uriVariables)
throws RestClientException;
/**
* Create a new resource by POSTing the given object to the URL, and returns the value of the Location
* header. This header typically indicates where the new resource is stored.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be null
* @return the value for the Location header
* @see HttpEntity
*/
Future postForLocation(AsyncCallback callback, URI url, Object request) throws RestClientException;
/**
* Create a new resource by POSTing the given object to the URI template, and returns the representation found in
* the response.
*
* URI Template variables are expanded using the given URI variables, if any.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be null
* @param responseType the type of the return value
* @param uriVariables the variables to expand the template
* @return the converted object
* @see HttpEntity
*/
Future postForObject(AsyncCallback callback, String url, Object request, Class responseType,
Object... uriVariables) throws RestClientException;
/**
* Create a new resource by POSTing the given object to the URI template, and returns the representation found in
* the response.
*
* URI Template variables are expanded using the given map.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be null
* @param responseType the type of the return value
* @param uriVariables the variables to expand the template
* @return the converted object
* @see HttpEntity
*/
Future postForObject(AsyncCallback callback, String url, Object request, Class responseType,
Map uriVariables) throws RestClientException;
/**
* Create a new resource by POSTing the given object to the URL, and returns the representation found in the
* response.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be null
* @param responseType the type of the return value
* @return the converted object
* @see HttpEntity
*/
Future postForObject(AsyncCallback callback, URI url, Object request, Class responseType)
throws RestClientException;
/**
* Create a new resource by POSTing the given object to the URI template, and returns the response as
* {@link ResponseEntity}.
*
* URI Template variables are expanded using the given URI variables, if any.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be null
* @param uriVariables the variables to expand the template
* @return the converted object
* @see HttpEntity
* @since 3.0.2
*/
Future> postForEntity(AsyncCallback> callback, String url, Object request,
Class responseType, Object... uriVariables) throws RestClientException;
/**
* Create a new resource by POSTing the given object to the URI template, and returns the response as
* {@link HttpEntity}.
*
* URI Template variables are expanded using the given map.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be null
* @param uriVariables the variables to expand the template
* @return the converted object
* @see HttpEntity
* @since 3.0.2
*/
Future> postForEntity(AsyncCallback> callback, String url, Object request,
Class responseType, Map uriVariables) throws RestClientException;
/**
* Create a new resource by POSTing the given object to the URL, and returns the response as {@link ResponseEntity}.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be null
* @return the converted object
* @see HttpEntity
* @since 3.0.2
*/
Future> postForEntity(AsyncCallback> callback, URI url, Object request,
Class responseType) throws RestClientException;
// PUT
/**
* Create or update a resource by PUTting the given object to the URI.
*
* URI Template variables are expanded using the given URI variables, if any.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be PUT, may be null
* @param uriVariables the variables to expand the template
* @see HttpEntity
*/
Future put(AsyncCallback callback, String url, Object request, Object... uriVariables)
throws RestClientException;
/**
* Creates a new resource by PUTting the given object to URI template.
*
* URI Template variables are expanded using the given map.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be PUT, may be null
* @param uriVariables the variables to expand the template
* @see HttpEntity
*/
Future put(AsyncCallback callback, String url, Object request, Map uriVariables)
throws RestClientException;
/**
* Creates a new resource by PUTting the given object to URL.
*
* The {@code request} parameter can be a {@link HttpEntity} in order to add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be PUT, may be null
* @see HttpEntity
*/
Future put(AsyncCallback callback, URI url, Object request) throws RestClientException;
// DELETE
/**
* Delete the resources at the specified URI.
*
* URI Template variables are expanded using the given URI variables, if any.
* @param url the URL
* @param uriVariables the variables to expand in the template
*/
Future delete(AsyncCallback callback, String url, Object... uriVariables) throws RestClientException;
/**
* Delete the resources at the specified URI.
*
* URI Template variables are expanded using the given map.
* @param url the URL
* @param uriVariables the variables to expand the template
*/
Future delete(AsyncCallback callback, String url, Map uriVariables)
throws RestClientException;
/**
* Delete the resources at the specified URL.
* @param url the URL
*/
Future delete(AsyncCallback callback, URI url) throws RestClientException;
// OPTIONS
/**
* Return the value of the Allow header for the given URI.
*
* URI Template variables are expanded using the given URI variables, if any.
* @param url the URL
* @param uriVariables the variables to expand in the template
* @return the value of the allow header
*/
Future> optionsForAllow(AsyncCallback> callback, String url, Object... uriVariables)
throws RestClientException;
/**
* Return the value of the Allow header for the given URI.
*
* URI Template variables are expanded using the given map.
* @param url the URL
* @param uriVariables the variables to expand in the template
* @return the value of the allow header
*/
Future> optionsForAllow(AsyncCallback> callback, String url,
Map uriVariables) throws RestClientException;
/**
* Return the value of the Allow header for the given URL.
* @param url the URL
* @return the value of the allow header
*/
Future> optionsForAllow(AsyncCallback> callback, URI url)
throws RestClientException;
// exchange
/**
* Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns
* the response as {@link ResponseEntity}.
*
* URI Template variables are expanded using the given URI variables, if any.
* @param url the URL
* @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 responseType the type of the return value
* @param uriVariables the variables to expand in the template
* @return the response as entity
* @since 3.0.2
*/
Future> exchange(AsyncCallback> callback, String url, HttpMethod method,
HttpEntity requestEntity, Class responseType, Object... uriVariables) throws RestClientException;
/**
* Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns
* the response as {@link ResponseEntity}.
*
* URI Template variables are expanded using the given URI variables, if any.
* @param url the URL
* @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 responseType the type of the return value
* @param uriVariables the variables to expand in the template
* @return the response as entity
* @since 3.0.2
*/
Future> exchange(AsyncCallback> callback, String url, HttpMethod method,
HttpEntity requestEntity, Class responseType, Map uriVariables) throws RestClientException;
/**
* Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns
* the response as {@link ResponseEntity}.
* @param url the URL
* @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 responseType the type of the return value
* @return the response as entity
* @since 3.0.2
*/
Future> exchange(AsyncCallback> callback, URI url, HttpMethod method,
HttpEntity requestEntity, Class responseType) throws RestClientException;
// general execution
/**
* Execute the HTTP method to the given URI template, preparing the request with the {@link RequestCallback}, and
* reading the response with a {@link ResponseExtractor}.
*
* URI Template variables are expanded using the given URI variables, if any.
* @param url the URL
* @param method the HTTP method (GET, POST, etc)
* @param requestCallback object that prepares the request
* @param responseExtractor object that extracts the return value from the response
* @param uriVariables the variables to expand in the template
* @return an arbitrary object, as returned by the {@link ResponseExtractor}
*/
Future execute(AsyncCallback callback, String url, HttpMethod method,
RequestCallback requestCallback, ResponseExtractor responseExtractor, Object... uriVariables)
throws RestClientException;
/**
* Execute the HTTP method to the given URI template, preparing the request with the {@link RequestCallback}, and
* reading the response with a {@link ResponseExtractor}.
*
* URI Template variables are expanded using the given URI variables map.
* @param url the URL
* @param method the HTTP method (GET, POST, etc)
* @param requestCallback object that prepares the request
* @param responseExtractor object that extracts the return value from the response
* @param uriVariables the variables to expand in the template
* @return an arbitrary object, as returned by the {@link ResponseExtractor}
*/
Future execute(AsyncCallback callback, String url, HttpMethod method, RequestCallback requestCallback,
ResponseExtractor responseExtractor, Map uriVariables) throws RestClientException;
/**
* Execute the HTTP method to the given URL, preparing the request with the {@link RequestCallback}, and reading the
* response with a {@link ResponseExtractor}.
* @param url the URL
* @param method the HTTP method (GET, POST, etc)
* @param requestCallback object that prepares the request
* @param responseExtractor object that extracts the return value from the response
* @return an arbitrary object, as returned by the {@link ResponseExtractor}
*/
Future execute(AsyncCallback callback, URI url, HttpMethod method, RequestCallback requestCallback,
ResponseExtractor responseExtractor) throws RestClientException;
}