Module org.refcodes.rest

Package org.refcodes.rest

Class AbstractHttpRestClientDecorator<B extends HttpRestClient>

java.lang.Object

org.refcodes.rest.AbstractHttpRestClientDecorator<B>

All Implemented Interfaces:

org.refcodes.component.Closable, org.refcodes.component.ConnectionComponent<org.refcodes.web.HttpClientContext>, org.refcodes.component.ConnectionOpenable<org.refcodes.web.HttpClientContext>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.LinkComponent, org.refcodes.component.Openable, org.refcodes.component.Openable.OpenBuilder<HttpRestClient>, org.refcodes.component.OpenedAccessor, HttpRestClient, RestClient, RestDeleteClient, RestGetClient, RestPostClient, RestPutClient, RestRequestClient, RestRequestHandler, org.refcodes.runtime.RequestCorrelation<RestClient>, org.refcodes.runtime.SessionCorrelation<RestClient>, org.refcodes.security.TrustStoreDescriptorAccessor, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpRestClient>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty, org.refcodes.web.BaseUrlAccessor, org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>, org.refcodes.web.BaseUrlAccessor.BaseUrlMutator, org.refcodes.web.BaseUrlAccessor.BaseUrlProperty, org.refcodes.web.BasicAuthCredentialsAccessor, org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<RestClient>, org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator, org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty, org.refcodes.web.MediaTypeFactoryLookup, org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, org.refcodes.web.OauthTokenAccessor, org.refcodes.web.OauthTokenAccessor.OauthTokenBuilder<RestClient>, org.refcodes.web.OauthTokenAccessor.OauthTokenMutator, org.refcodes.web.OauthTokenAccessor.OauthTokenProperty, org.refcodes.web.UserAgentAccessor, org.refcodes.web.UserAgentAccessor.UserAgentBuilder<RestClient>, org.refcodes.web.UserAgentAccessor.UserAgentMutator, org.refcodes.web.UserAgentAccessor.UserAgentProperty

Direct Known Subclasses:

AbstractHttpDiscoveryRestClientDecorator

public abstract class AbstractHttpRestClientDecorator<B extends HttpRestClient>
extends Object
implements HttpRestClient

Abstract class for easily decorating a HttpRestClient.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.web.BaseUrlAccessor

org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B>>, org.refcodes.web.BaseUrlAccessor.BaseUrlMutator, org.refcodes.web.BaseUrlAccessor.BaseUrlProperty

Nested classes/interfaces inherited from interface org.refcodes.web.BasicAuthCredentialsAccessor

org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B extends org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B>>, org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator, org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Closable

org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionComponent

org.refcodes.component.ConnectionComponent.ConnectionAutomaton<CON extends Object>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON extends Object,B extends org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON,B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionOpenable

org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<CON extends Object>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON extends Object,B extends org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON,B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor

org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.component.LinkComponent

org.refcodes.component.LinkComponent.LinkAutomaton, org.refcodes.component.LinkComponent.LinkComponentBuilder<B extends org.refcodes.component.LinkComponent.LinkComponentBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.web.MediaTypeFactoryLookup

org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

Nested classes/interfaces inherited from interface org.refcodes.web.OauthTokenAccessor

org.refcodes.web.OauthTokenAccessor.OauthTokenBuilder<B extends org.refcodes.web.OauthTokenAccessor.OauthTokenBuilder<B>>, org.refcodes.web.OauthTokenAccessor.OauthTokenMutator, org.refcodes.web.OauthTokenAccessor.OauthTokenProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Openable

org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<B extends org.refcodes.component.Openable.OpenBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor

org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor

org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B extends org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

Nested classes/interfaces inherited from interface org.refcodes.web.UserAgentAccessor

org.refcodes.web.UserAgentAccessor.UserAgentBuilder<B extends org.refcodes.web.UserAgentAccessor.UserAgentBuilder<B>>, org.refcodes.web.UserAgentAccessor.UserAgentMutator, org.refcodes.web.UserAgentAccessor.UserAgentProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected HttpRestClient	_client

Fields inherited from interface org.refcodes.rest.HttpRestClient

DEFAULT_KEYSTORE_TYPE, DEFAULT_SSL_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
AbstractHttpRestClientDecorator(HttpRestClient aClient)	Decorates the given HttpRestClient.

Method Summary

Modifier and Type	Method	Description
boolean	addMediaTypeFactory(org.refcodes.web.MediaTypeFactory aMediaTypeFactory)
RestRequestBuilder	buildRequest(org.refcodes.web.HttpMethod aHttpMethod, org.refcodes.web.Url aUrl, org.refcodes.web.RequestHeaderFields aHeaderFields, Object aRequest, int aRedirectDepth)	Prepares a request builder with the possible attributes and returns the according request's RestRequestBuilder instance.
void	close()
void	closeIn(int aCloseMillis)
void	closeQuietly()
void	closeUnchecked()
void	disableRequestCorrelation()
void	disableSessionCorrelation()
RestResponse	doRequest(org.refcodes.web.HttpMethod aHttpMethod, org.refcodes.web.Url aUrl, org.refcodes.web.RequestHeaderFields aHeaderFields, Object aRequest, int aRedirectDepth)	Sends a request with the possible attributes and returns the according request's RestResponse instance synchronously.
void	enableRequestCorrelation()
void	enableSessionCorrelation()
org.refcodes.web.Url	getBaseUrl()
org.refcodes.component.ConnectionStatus	getConnectionStatus()
org.refcodes.web.MediaType[]	getFactoryMediaTypes()
org.refcodes.web.OauthToken	getOauthToken()
org.refcodes.security.TrustStoreDescriptor	getTrustStoreDescriptor()
String	getUserAgent()
boolean	hasMediaTypeFactory(org.refcodes.web.MediaType aMediaType)
boolean	hasRequestCorrelation()
boolean	hasSessionCorrelation()
RestResponseResult	onResponse(org.refcodes.web.HttpMethod aHttpMethod, org.refcodes.web.Url aUrl, org.refcodes.web.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(org.refcodes.web.HttpMethod aHttpMethod, org.refcodes.web.Url aUrl, org.refcodes.web.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.
void	open()
void	open(org.refcodes.web.Url aBaseUrl, org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)	Configures the HTTPS client connection with the provided configuration parameters.
void	openUnchecked()
void	setBaseUrl(String aBaseUrl)
void	setBaseUrl(String aProtocol, String aHost)
void	setBaseUrl(String aProtocol, String aHost, int aPort)
void	setBaseUrl(String aProtocol, String aHost, int aPort, String aPath)
void	setBaseUrl(String aProtocol, String aHost, String aPath)
void	setBaseUrl(URL aBaseUrl)
void	setBaseUrl(org.refcodes.data.Scheme aProtocol, String aHost)
void	setBaseUrl(org.refcodes.data.Scheme aProtocol, String aHost, int aPort)
void	setBaseUrl(org.refcodes.data.Scheme aProtocol, String aHost, int aPort, String aPath)
void	setBaseUrl(org.refcodes.data.Scheme aProtocol, String aHost, String aPath)
void	setBaseUrl(org.refcodes.web.Url aBaseUrl)
void	setOauthToken(org.refcodes.web.OauthToken aOauthToken)
void	setRequestCorrelation(boolean hasRequestCorrelation)
void	setSessionCorrelation(boolean hasSessionCorrelation)
void	setTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aTrustStoreDescriptor)
void	setUserAgent(String aUserAgent)
org.refcodes.web.MediaTypeFactory	toMediaTypeFactory(org.refcodes.web.MediaType aMediaType)
protected org.refcodes.web.Url	toUrl(org.refcodes.web.Url aUrl)	Hook for sub-classes to modify the request URL.
B	withBaseUrl(String aBaseUrl)
B	withBaseUrl(String aProtocol, String aHost)
B	withBaseUrl(String aProtocol, String aHost, int aPort)
B	withBaseUrl(String aProtocol, String aHost, int aPort, String aPath)
B	withBaseUrl(String aProtocol, String aHost, String aPath)
B	withBaseUrl(URL aBaseURL)
B	withBaseUrl(org.refcodes.data.Scheme aProtocol, String aHost)
B	withBaseUrl(org.refcodes.data.Scheme aProtocol, String aHost, int aPort)
B	withBaseUrl(org.refcodes.data.Scheme aProtocol, String aHost, int aPort, String aPath)
B	withBaseUrl(org.refcodes.data.Scheme aProtocol, String aHost, String aPath)
B	withBaseUrl(org.refcodes.web.Url aBaseUrl)
B	withDisableRequestCorrelation()
B	withDisableSessionCorrelation()
B	withEnableRequestCorrelation()
B	withEnableSessionCorrelation()
B	withRequestCorrelation(boolean hasRequestCorrelation)
B	withSessionCorrelation(boolean hasSessionCorrelation)
B	withUserAgent(String aUserAgent)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.web.BaseUrlAccessor.BaseUrlProperty

letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl

Methods inherited from interface org.refcodes.web.BasicAuthCredentialsAccessor

getBasicAuthCredentials

Methods inherited from interface org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator

setBasicAuthCredentials, setBasicAuthCredentials

Methods inherited from interface org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty

letBasicAuthCredentials, letBasicAuthCredentials

Methods inherited from interface org.refcodes.component.ConnectionOpenable

openUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

isOpened

Methods inherited from interface org.refcodes.rest.HttpRestClient

open, open, open, withBasicAuthCredentials, withBasicAuthCredentials, withOAuthToken, withOpen, withOpen, withOpen, withOpen, withOpen, withTrustStoreDescriptor

Methods inherited from interface org.refcodes.web.OauthTokenAccessor.OauthTokenProperty

letOauthToken

Methods inherited from interface org.refcodes.component.Openable.OpenBuilder

withOpenUnchecked

Methods inherited from interface org.refcodes.rest.RestDeleteClient

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 org.refcodes.rest.RestGetClient

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 org.refcodes.rest.RestPostClient

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 org.refcodes.rest.RestPutClient

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 org.refcodes.rest.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 org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

letTrustStoreDescriptor

Methods inherited from interface org.refcodes.web.UserAgentAccessor.UserAgentProperty

letUserAgent

Field Details

_client

protected HttpRestClient _client

Constructor Details

AbstractHttpRestClientDecorator

public AbstractHttpRestClientDecorator(HttpRestClient aClient)

Decorates the given HttpRestClient.

Parameters:

aClient - The HttpRestClient to be decorated.

Method Details

getOauthToken

public org.refcodes.web.OauthToken getOauthToken()

Specified by:

getOauthToken in interface org.refcodes.web.OauthTokenAccessor

setOauthToken

public void setOauthToken(org.refcodes.web.OauthToken aOauthToken)

Specified by:

setOauthToken in interface org.refcodes.web.OauthTokenAccessor.OauthTokenMutator

getConnectionStatus

public org.refcodes.component.ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor

addMediaTypeFactory

public boolean addMediaTypeFactory(org.refcodes.web.MediaTypeFactory aMediaTypeFactory)

Specified by:

addMediaTypeFactory in interface org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

close

public void close()
           throws IOException

Specified by:

close in interface org.refcodes.component.Closable

Throws:

IOException

closeIn

public void closeIn(int aCloseMillis)

Specified by:

closeIn in interface org.refcodes.component.Closable

closeQuietly

public void closeQuietly()

Specified by:

closeQuietly in interface org.refcodes.component.Closable

closeUnchecked

public void closeUnchecked()

Specified by:

closeUnchecked in interface org.refcodes.component.Closable

disableRequestCorrelation

public void disableRequestCorrelation()

Specified by:

disableRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<B extends HttpRestClient>

disableSessionCorrelation

public void disableSessionCorrelation()

Specified by:

disableSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<B extends HttpRestClient>

enableRequestCorrelation

public void enableRequestCorrelation()

Specified by:

enableRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<B extends HttpRestClient>

enableSessionCorrelation

public void enableSessionCorrelation()

Specified by:

enableSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<B extends HttpRestClient>

getBaseUrl

public org.refcodes.web.Url getBaseUrl()

Specified by:

getBaseUrl in interface org.refcodes.web.BaseUrlAccessor

getFactoryMediaTypes

public org.refcodes.web.MediaType[] getFactoryMediaTypes()

Specified by:

getFactoryMediaTypes in interface org.refcodes.web.MediaTypeFactoryLookup

getTrustStoreDescriptor

public org.refcodes.security.TrustStoreDescriptor getTrustStoreDescriptor()

Specified by:

getTrustStoreDescriptor in interface org.refcodes.security.TrustStoreDescriptorAccessor

getUserAgent

public String getUserAgent()

Specified by:

getUserAgent in interface org.refcodes.web.UserAgentAccessor

hasMediaTypeFactory

public boolean hasMediaTypeFactory(org.refcodes.web.MediaType aMediaType)

Specified by:

hasMediaTypeFactory in interface org.refcodes.web.MediaTypeFactoryLookup

hasRequestCorrelation

public boolean hasRequestCorrelation()

Specified by:

hasRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<B extends HttpRestClient>

hasSessionCorrelation

public boolean hasSessionCorrelation()

Specified by:

hasSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<B extends HttpRestClient>

open

public void open()
          throws IOException

Specified by:

open in interface HttpRestClient

Specified by:

open in interface org.refcodes.component.Openable

Throws:

IOException

open

public void open(org.refcodes.web.Url aBaseUrl,
 org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
          throws IOException

Configures the HTTPS client connection with the provided configuration parameters.

Specified by:

open in interface HttpRestClient

Parameters:

aBaseUrl - The base Url to be used.

aStoreDescriptor - The TrustStoreDescriptor pointing to your KeyStore.

Throws:

IOException - thrown in case something went wrong.

openUnchecked

public void openUnchecked()

Specified by:

openUnchecked in interface org.refcodes.component.Openable

setBaseUrl

public void setBaseUrl(org.refcodes.data.Scheme aProtocol,
 String aHost)
                throws MalformedURLException

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(org.refcodes.data.Scheme aProtocol,
 String aHost,
 int aPort)
                throws MalformedURLException

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(org.refcodes.data.Scheme aProtocol,
 String aHost,
 int aPort,
 String aPath)
                throws MalformedURLException

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(org.refcodes.data.Scheme aProtocol,
 String aHost,
 String aPath)
                throws MalformedURLException

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(String aBaseUrl)
                throws MalformedURLException

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(String aProtocol,
 String aHost)
                throws MalformedURLException

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(String aProtocol,
 String aHost,
 int aPort)
                throws MalformedURLException

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(String aProtocol,
 String aHost,
 int aPort,
 String aPath)
                throws MalformedURLException

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(String aProtocol,
 String aHost,
 String aPath)
                throws MalformedURLException

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(org.refcodes.web.Url aBaseUrl)

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

setBaseUrl

public void setBaseUrl(URL aBaseUrl)

Specified by:

setBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

setRequestCorrelation

public void setRequestCorrelation(boolean hasRequestCorrelation)

Specified by:

setRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<B extends HttpRestClient>

setSessionCorrelation

public void setSessionCorrelation(boolean hasSessionCorrelation)

Specified by:

setSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<B extends HttpRestClient>

setTrustStoreDescriptor

public void setTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aTrustStoreDescriptor)

Specified by:

setTrustStoreDescriptor in interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator

setUserAgent

public void setUserAgent(String aUserAgent)

Specified by:

setUserAgent in interface org.refcodes.web.UserAgentAccessor.UserAgentMutator

toMediaTypeFactory

public org.refcodes.web.MediaTypeFactory toMediaTypeFactory(org.refcodes.web.MediaType aMediaType)

Specified by:

toMediaTypeFactory in interface org.refcodes.web.MediaTypeFactoryLookup

withBaseUrl

public B withBaseUrl(org.refcodes.data.Scheme aProtocol,
 String aHost)
              throws MalformedURLException

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(org.refcodes.data.Scheme aProtocol,
 String aHost,
 int aPort)
              throws MalformedURLException

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(org.refcodes.data.Scheme aProtocol,
 String aHost,
 int aPort,
 String aPath)
              throws MalformedURLException

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(org.refcodes.data.Scheme aProtocol,
 String aHost,
 String aPath)
              throws MalformedURLException

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(String aBaseUrl)
              throws MalformedURLException

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Specified by:

withBaseUrl in interface HttpRestClient

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(String aProtocol,
 String aHost)
              throws MalformedURLException

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(String aProtocol,
 String aHost,
 int aPort)
              throws MalformedURLException

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(String aProtocol,
 String aHost,
 int aPort,
 String aPath)
              throws MalformedURLException

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(String aProtocol,
 String aHost,
 String aPath)
              throws MalformedURLException

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(org.refcodes.web.Url aBaseUrl)

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Specified by:

withBaseUrl in interface HttpRestClient

withBaseUrl

public B withBaseUrl(URL aBaseURL)

Specified by:

withBaseUrl in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Specified by:

withBaseUrl in interface HttpRestClient

withDisableRequestCorrelation

public B withDisableRequestCorrelation()

Specified by:

withDisableRequestCorrelation in interface HttpRestClient

Specified by:

withDisableRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<B extends HttpRestClient>

withDisableSessionCorrelation

public B withDisableSessionCorrelation()

Specified by:

withDisableSessionCorrelation in interface HttpRestClient

Specified by:

withDisableSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<B extends HttpRestClient>

withEnableRequestCorrelation

public B withEnableRequestCorrelation()

Specified by:

withEnableRequestCorrelation in interface HttpRestClient

Specified by:

withEnableRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<B extends HttpRestClient>

withEnableSessionCorrelation

public B withEnableSessionCorrelation()

Specified by:

withEnableSessionCorrelation in interface HttpRestClient

Specified by:

withEnableSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<B extends HttpRestClient>

withRequestCorrelation

public B withRequestCorrelation(boolean hasRequestCorrelation)

Specified by:

withRequestCorrelation in interface HttpRestClient

Specified by:

withRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<B extends HttpRestClient>

withSessionCorrelation

public B withSessionCorrelation(boolean hasSessionCorrelation)

Specified by:

withSessionCorrelation in interface HttpRestClient

Specified by:

withSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<B extends HttpRestClient>

withUserAgent

public B withUserAgent(String aUserAgent)

Specified by:

withUserAgent in interface HttpRestClient

Specified by:

withUserAgent in interface org.refcodes.web.UserAgentAccessor.UserAgentBuilder<B extends HttpRestClient>

buildRequest

public RestRequestBuilder buildRequest(org.refcodes.web.HttpMethod aHttpMethod,
 org.refcodes.web.Url aUrl,
 org.refcodes.web.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.

doRequest

public RestResponse doRequest(org.refcodes.web.HttpMethod aHttpMethod,
 org.refcodes.web.Url aUrl,
 org.refcodes.web.RequestHeaderFields aHeaderFields,
 Object aRequest,
 int aRedirectDepth)
                       throws org.refcodes.web.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:

org.refcodes.web.HttpResponseException - thrown in case of some unexpected response.

onResponse

public RestResponseHandler onResponse(org.refcodes.web.HttpMethod aHttpMethod,
 org.refcodes.web.Url aUrl,
 org.refcodes.web.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(org.refcodes.web.HttpMethod aHttpMethod,
 org.refcodes.web.Url aUrl,
 org.refcodes.web.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.

toUrl

protected org.refcodes.web.Url toUrl(org.refcodes.web.Url aUrl)

Hook for sub-classes to modify the request URL.

Parameters:

aUrl - The Url for the request.

Returns:

The tinkered Url, by default it returns the provided Url unmodified.