Class AbstractRestClient

java.lang.Object

org.refcodes.rest.AbstractRestClient

All Implemented Interfaces:

DeleteRestClient, GetRestClient, PostRestClient, PutRestClient, RestClient, RestRequestClient, RestRequestHandler, BasicAuthCredentialsAccessor, BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<RestClient>, BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator, BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty, MediaTypeFactoryLookup, MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, OauthTokenAccessor, OauthTokenAccessor.OauthTokenBuilder<RestClient>, OauthTokenAccessor.OauthTokenMutator, OauthTokenAccessor.OauthTokenProperty, UserAgentAccessor, UserAgentAccessor.UserAgentBuilder<RestClient>, UserAgentAccessor.UserAgentMutator, UserAgentAccessor.UserAgentProperty

Direct Known Subclasses:

JdkHttpRestClient, LoopbackRestClient

public abstract class AbstractRestClient
extends Object
implements RestClient

Abstract base implementation of the RestClient interface being the foundation for various RestClient implementations such as JdkHttpRestClient or LoopbackRestClient. The AbstractRestClient is preconfigured with the following MediaTypeFactory instances:

• JsonMediaTypeFactory
• XmlMediaTypeFactory
• TextMediaTypeFactory
• FormMediaTypeFactory
• HtmlMediaTypeFactory

In your sub-classes, overwrite the method initMedaTypeFactories(), therein calling addMediaTypeFactory(MediaTypeFactory) to add (by also invoking super's initMedaTypeFactories()) or to set your own (without invoking super's initMedaTypeFactories()) MediaTypeFactory instances.

Nested Class Summary

Nested classes/interfaces inherited from interface BasicAuthCredentialsAccessor

BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B>, BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator, BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty

Nested classes/interfaces inherited from interface MediaTypeFactoryLookup

MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

Nested classes/interfaces inherited from interface OauthTokenAccessor

OauthTokenAccessor.OauthTokenBuilder<B>, OauthTokenAccessor.OauthTokenMutator, OauthTokenAccessor.OauthTokenProperty

Nested classes/interfaces inherited from interface UserAgentAccessor

UserAgentAccessor.UserAgentBuilder<B>, UserAgentAccessor.UserAgentMutator, UserAgentAccessor.UserAgentProperty

Constructor Summary

Constructors

Constructor	Description
AbstractRestClient()	Instantiates a new abstract rest client.
AbstractRestClient(ExecutorService aExecutorService)	Instantiates a new abstract rest client.

Method Summary

Modifier and Type	Method	Description
boolean	addMediaTypeFactory(MediaTypeFactory aMediaTypeFactory)
RestRequestBuilder	buildRequest(HttpMethod aHttpMethod, Url aUrl, RequestHeaderFields aHeaderFields, Object aRequest, int aRedirectDepth)	Prepares a request builder with the possible attributes and returns the according request's RestRequestBuilder instance.
RestResponse	doRequest(HttpMethod aHttpMethod, Url aUrl, RequestHeaderFields aHeaderFields, Object aRequest, int aRedirectDepth)	Sends a request with the possible attributes and returns the according request's RestResponse instance synchronously.
BasicAuthCredentials	getBasicAuthCredentials()
MediaType[]	getFactoryMediaTypes()
OauthToken	getOauthToken()
String	getUserAgent()
protected void	initMedaTypeFactories()	Adds the default MediaTypeFactory instances.
RestResponseResult	onResponse(HttpMethod aHttpMethod, Url aUrl, RequestHeaderFields aHeaderFields, Object aRequest, int aRedirectDepth)	Creates a request with the possible attributes and returns the according RestResponseResult instance used for the request.
RestResponseHandler	onResponse(HttpMethod aHttpMethod, Url aUrl, RequestHeaderFields aHeaderFields, Object aRequest, int aRedirectDepth, RestResponseConsumer aResponseConsumer)	Creates a request with the possible attributes and returns the according RestResponseHandler instance used for the request.
protected void	onRestRequest(RestRequestHandler aHandler)	Sets the hook receiving a prepared RestResponseHandler instance to be used to do the technical request with the technology chosen by the implementing sub-class.
protected void	postIntercept(HttpClientRequest aRequest, HttpClientResponse aResponse)	Invoked to post-process a HttpClientRequest alongside a HttpClientResponse.
protected void	preIntercept(HttpClientRequest aRequest, HttpClientResponse aResponse)	Invoked to pre-process a HttpClientRequest alongside a HttpClientResponse.
protected RequestHeaderFields	preProcessHeaderFields(RequestHeaderFields aHeaderFields)	Pre-processes the given header fields before the HTTP-Request is issued.
void	setBasicAuthCredentials(BasicAuthCredentials aBasicAuthCredentials)
void	setOauthToken(OauthToken aOauthToken)
void	setUserAgent(String aUserAgent)
MediaTypeFactory	toMediaTypeFactory(MediaType aMediaType)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder

withBasicAuthCredentials, withBasicAuthCredentials

Methods inherited from interface BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator

setBasicAuthCredentials

Methods inherited from interface BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty

letBasicAuthCredentials, letBasicAuthCredentials

Methods inherited from interface DeleteRestClient

buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, buildDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, doDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete, onDelete

Methods inherited from interface GetRestClient

buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, buildGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet, onGet

Methods inherited from interface MediaTypeFactoryLookup

hasMediaTypeFactory

Methods inherited from interface OauthTokenAccessor.OauthTokenBuilder

withOAuthToken

Methods inherited from interface OauthTokenAccessor.OauthTokenProperty

letOauthToken

Methods inherited from interface PostRestClient

buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, buildPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost, onPost

Methods inherited from interface PutRestClient

buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, buildPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, doPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut, onPut

Methods inherited from interface RestRequestClient

buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, buildRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, doRequest, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse, onResponse

Methods inherited from interface UserAgentAccessor.UserAgentBuilder

withUserAgent

Methods inherited from interface UserAgentAccessor.UserAgentProperty

letUserAgent

Constructor Details

AbstractRestClient

public AbstractRestClient(ExecutorService aExecutorService)

Instantiates a new abstract rest client.

Parameters:

aExecutorService - the executor service

AbstractRestClient

public AbstractRestClient()

Instantiates a new abstract rest client.

Method Details

initMedaTypeFactories

protected void initMedaTypeFactories()

Adds the default MediaTypeFactory instances. Can be overridden.

getBasicAuthCredentials

public BasicAuthCredentials getBasicAuthCredentials()

Specified by:

getBasicAuthCredentials in interface BasicAuthCredentialsAccessor

setBasicAuthCredentials

public void setBasicAuthCredentials(BasicAuthCredentials aBasicAuthCredentials)

Specified by:

setBasicAuthCredentials in interface BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator

setOauthToken

public void setOauthToken(OauthToken aOauthToken)

Specified by:

setOauthToken in interface OauthTokenAccessor.OauthTokenMutator

getOauthToken

public OauthToken getOauthToken()

Specified by:

getOauthToken in interface OauthTokenAccessor

doRequest

public RestResponse doRequest(HttpMethod aHttpMethod,
 Url aUrl,
 RequestHeaderFields aHeaderFields,
 Object aRequest,
 int aRedirectDepth)
                       throws HttpResponseException

Sends a request with the possible attributes and returns the according request's RestResponse instance synchronously.

Specified by:

doRequest in interface RestRequestClient

Parameters:

aHttpMethod - The HTTP-Method for the request.

aUrl - The Url from which to take the URL specific data.

aHeaderFields - The HTTP-Header's fields to be used for the request.

aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.

aRedirectDepth - The redirect depth provides the count of HTTP-Request and HTTP-Response cycles where the response represents a redirect as of HttpStatusCode.isRedirectStatus(). A value of -1 represents the default behavior, e.g. using HttpURLConnection's redirection means.

Returns:

The RestResponse for this request.

Throws:

HttpResponseException - thrown in case of some unexpected response.

onResponse

public RestResponseHandler onResponse(HttpMethod aHttpMethod,
 Url aUrl,
 RequestHeaderFields aHeaderFields,
 Object aRequest,
 int aRedirectDepth,
 RestResponseConsumer aResponseConsumer)

Creates a request with the possible attributes and returns the according RestResponseHandler instance used for the request. The HTTP-Request is actually sent not earlier than you calling RestResponseHandler.open() on the returned RestResponseHandler as the RestResponseHandler still may be modified after invoking this method!

Specified by:

onResponse in interface RestRequestClient

Parameters:

aHttpMethod - The HTTP-Method for the request.

aUrl - The Url from which to take the URL specific data.

aHeaderFields - The HTTP-Header's fields to be used for the request.

aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.

aRedirectDepth - The redirect depth provides the count of HTTP-Request and HTTP-Response cycles where the response represents a redirect as of HttpStatusCode.isRedirectStatus(). A value of -1 represents the default behavior, e.g. using HttpURLConnection's redirection means.

aResponseConsumer - The listener processing a response targeted at this RestResponseHandler.

Returns:

The RestResponseHandler which is used by the request.

onResponse

public RestResponseResult onResponse(HttpMethod aHttpMethod,
 Url aUrl,
 RequestHeaderFields aHeaderFields,
 Object aRequest,
 int aRedirectDepth)

Creates a request with the possible attributes and returns the according RestResponseResult instance used for the request. The HTTP-Request is actually sent not earlier than you calling RestResponseResult.open() on the returned RestResponseResult as the RestResponseResult still may be modified after invoking this method!

Specified by:

onResponse in interface RestRequestClient

Parameters:

aHttpMethod - The HTTP-Method for the request.

aUrl - The Url from which to take the URL specific data.

aHeaderFields - The HTTP-Header's fields to be used for the request.

aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.

aRedirectDepth - The redirect depth provides the count of HTTP-Request and HTTP-Response cycles where the response represents a redirect as of HttpStatusCode.isRedirectStatus(). A value of -1 represents the default behavior, e.g. using HttpURLConnection's redirection means.

Returns:

The RestResponseResult which is used by the request.

buildRequest

public RestRequestBuilder buildRequest(HttpMethod aHttpMethod,
 Url aUrl,
 RequestHeaderFields aHeaderFields,
 Object aRequest,
 int aRedirectDepth)

Prepares a request builder with the possible attributes and returns the according request's RestRequestBuilder instance. Invoking RestRequestBuilder.toRestResponse() starts the request and synchronously returns the response.

Specified by:

buildRequest in interface RestRequestClient

Parameters:

aHttpMethod - The HTTP-Method for the request.

aUrl - The Url from which to take the URL specific data.

aHeaderFields - The HTTP-Header's fields to be used for the request.

aRequest - The body to be sent with the request (e.g. when doing a HttpMethod.POST request.

aRedirectDepth - The number of redirect ping-pong cycles to follow before when issuing the HTTP-Request.

Returns:

The RestRequestBuilder at this request.

addMediaTypeFactory

public boolean addMediaTypeFactory(MediaTypeFactory aMediaTypeFactory)

Specified by:

addMediaTypeFactory in interface MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

toMediaTypeFactory

public MediaTypeFactory toMediaTypeFactory(MediaType aMediaType)

Specified by:

toMediaTypeFactory in interface MediaTypeFactoryLookup

getFactoryMediaTypes

public MediaType[] getFactoryMediaTypes()

Specified by:

getFactoryMediaTypes in interface MediaTypeFactoryLookup

getUserAgent

public String getUserAgent()

Specified by:

getUserAgent in interface UserAgentAccessor

setUserAgent

public void setUserAgent(String aUserAgent)

Specified by:

setUserAgent in interface UserAgentAccessor.UserAgentMutator

preIntercept

protected void preIntercept(HttpClientRequest aRequest,
 HttpClientResponse aResponse)

Invoked to pre-process a HttpClientRequest alongside a HttpClientResponse.

Parameters:

aRequest - The HttpClientRequest to pre-process.

aResponse - The HttpClientResponse to post-process.

postIntercept

protected void postIntercept(HttpClientRequest aRequest,
 HttpClientResponse aResponse)

Invoked to post-process a HttpClientRequest alongside a HttpClientResponse.

Parameters:

aRequest - The HttpClientRequest to post-process.

aResponse - The HttpClientResponse to post-process.

onRestRequest

protected void onRestRequest(RestRequestHandler aHandler)

Sets the hook receiving a prepared RestResponseHandler instance to be used to do the technical request with the technology chosen by the implementing sub-class.

Parameters:

aHandler - The RestRequestHandler for handling the HTTP request.

preProcessHeaderFields

protected RequestHeaderFields preProcessHeaderFields(RequestHeaderFields aHeaderFields)

Pre-processes the given header fields before the HTTP-Request is issued. By default the User-Agent is set and (if present) the OAuth token.

Parameters:

aHeaderFields - The HeaderFields to be pre-prcessed.

Returns:

the request header fields