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<B>, org.refcodes.component.ConnectionOpenable<B>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.LinkComponent, org.refcodes.component.Openable, org.refcodes.net.BaseUrlAccessor, org.refcodes.net.BaseUrlAccessor.BaseUrlBuilder<B>, org.refcodes.net.BaseUrlAccessor.BaseUrlMutator, org.refcodes.net.BaseUrlAccessor.BaseUrlProperty, org.refcodes.net.MediaTypeFactoryLookup, org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, org.refcodes.net.UserAgentAccessor, org.refcodes.net.UserAgentAccessor.UserAgentBuilder<B>, org.refcodes.net.UserAgentAccessor.UserAgentMutator, org.refcodes.net.UserAgentAccessor.UserAgentProperty, HttpRestClient, RestClient, RestDeleteClient, RestGetClient, RestPostClient, RestPutClient, RestRequestClient, org.refcodes.runtime.RequestCorrelation<B>, org.refcodes.runtime.SessionCorrelation<B>, org.refcodes.security.TrustStoreDescriptorAccessor, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

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.net.BaseUrlAccessor

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

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.net.MediaTypeFactoryLookup

org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

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.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.net.UserAgentAccessor

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

Field Summary

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.net.MediaTypeFactory aMediaTypeFactory)
RestRequestBuilder	buildRequest(org.refcodes.net.HttpMethod aHttpMethod, org.refcodes.net.Url aUrl, org.refcodes.net.RequestHeaderFields aHeaderFields, Object aRequest)	Prepares a request builder with the possible attributes and returns the according request's RestRequestBuilder instance.
void	close()
void	closeIn(int aCloseInMillis)
void	closeQuietly()
void	closeUnchecked()
void	disableRequestCorrelation()
void	disableSessionCorrelation()
RestResponse	doRequest(org.refcodes.net.HttpMethod aHttpMethod, org.refcodes.net.Url aUrl, org.refcodes.net.RequestHeaderFields aHeaderFields, Object aRequest)	Sends a request with the possible attributes and returns the according request's RestResponse instance synchronously.
RestCallerBuilder	doRequest(org.refcodes.net.HttpMethod aHttpMethod, org.refcodes.net.Url aUrl, org.refcodes.net.RequestHeaderFields aHeaderFields, Object aRequest, RestResponseObserver aResponseObserver)	Creates a request with the possible attributes and returns the according RestCallerBuilder instance used for the request.
void	enableRequestCorrelation()
void	enableSessionCorrelation()
org.refcodes.net.Url	getBaseUrl()
org.refcodes.component.ConnectionStatus	getConnectionStatus()
org.refcodes.net.MediaType[]	getFactoryMediaTypes()
org.refcodes.security.TrustStoreDescriptor	getTrustStoreDescriptor()
String	getUserAgent()
boolean	hasMediaTypeFactory(org.refcodes.net.MediaType aMediaType)
boolean	hasRequestCorrelation()
boolean	hasSessionCorrelation()
void	open()
void	open(org.refcodes.net.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.net.Url aBaseUrl)
void	setRequestCorrelation(boolean hasRequestCorrelation)
void	setSessionCorrelation(boolean hasSessionCorrelation)
void	setTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
void	setUserAgent(String aUserAgent)
org.refcodes.net.MediaTypeFactory	toMediaTypeFactory(org.refcodes.net.MediaType aMediaType)
protected org.refcodes.net.Url	toUrl(org.refcodes.net.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.net.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 interface org.refcodes.component.ConnectionOpenable

openUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

isConnectionOpened

Methods inherited from interface org.refcodes.rest.HttpRestClient

open, open, open, withTrustStoreDescriptor

Methods inherited from class java.lang.Object

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

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, 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

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, 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

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, 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

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, 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

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, 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, 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

Constructor Detail

AbstractHttpRestClientDecorator

public AbstractHttpRestClientDecorator(HttpRestClient aClient)

Decorates the given HttpRestClient.

Parameters:

aClient - The HttpRestClient to be decorated.

Method Detail

getConnectionStatus

public org.refcodes.component.ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor

addMediaTypeFactory

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

Specified by:

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

close

public void close()
           throws org.refcodes.component.CloseException

Specified by:

close in interface org.refcodes.component.Closable

Throws:

org.refcodes.component.CloseException

closeIn

public void closeIn(int aCloseInMillis)

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.net.Url getBaseUrl()

Specified by:

getBaseUrl in interface org.refcodes.net.BaseUrlAccessor

getFactoryMediaTypes

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

Specified by:

getFactoryMediaTypes in interface org.refcodes.net.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.net.UserAgentAccessor

hasMediaTypeFactory

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

Specified by:

hasMediaTypeFactory in interface org.refcodes.net.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 org.refcodes.component.OpenException

Specified by:

open in interface HttpRestClient

Specified by:

open in interface org.refcodes.component.Openable

Throws:

org.refcodes.component.OpenException

open

public void open(org.refcodes.net.Url aBaseUrl,
                 org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
          throws org.refcodes.component.OpenException

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:

org.refcodes.component.OpenException - 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.net.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.net.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.net.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.net.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

public void setBaseUrl(String aBaseUrl)
                throws MalformedURLException

Specified by:

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

Throws:

MalformedURLException

setBaseUrl

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

Specified by:

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

Throws:

MalformedURLException

setBaseUrl

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

Specified by:

setBaseUrl in interface org.refcodes.net.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.net.BaseUrlAccessor.BaseUrlMutator

Throws:

MalformedURLException

setBaseUrl

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

Specified by:

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

Throws:

MalformedURLException

setBaseUrl

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

Specified by:

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

setBaseUrl

public void setBaseUrl(URL aBaseUrl)

Specified by:

setBaseUrl in interface org.refcodes.net.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 aStoreDescriptor)

Specified by:

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

setUserAgent

public void setUserAgent(String aUserAgent)

Specified by:

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

toMediaTypeFactory

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

Specified by:

toMediaTypeFactory in interface org.refcodes.net.MediaTypeFactoryLookup

withBaseUrl

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

Specified by:

withBaseUrl in interface org.refcodes.net.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.net.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.net.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.net.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public B withBaseUrl(String aBaseUrl)
              throws MalformedURLException

Specified by:

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

Throws:

MalformedURLException

withBaseUrl

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

Specified by:

withBaseUrl in interface org.refcodes.net.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.net.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.net.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.net.BaseUrlAccessor.BaseUrlBuilder<B extends HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

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

Specified by:

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

withBaseUrl

public B withBaseUrl(URL aBaseURL)

Specified by:

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

withDisableRequestCorrelation

public B withDisableRequestCorrelation()

Specified by:

withDisableRequestCorrelation in interface HttpRestClient

Specified by:

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

Specified by:

withDisableRequestCorrelation in interface RestClient

withDisableSessionCorrelation

public B withDisableSessionCorrelation()

Specified by:

withDisableSessionCorrelation in interface HttpRestClient

Specified by:

withDisableSessionCorrelation in interface RestClient

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>

Specified by:

withEnableRequestCorrelation in interface RestClient

withEnableSessionCorrelation

public B withEnableSessionCorrelation()

Specified by:

withEnableSessionCorrelation in interface HttpRestClient

Specified by:

withEnableSessionCorrelation in interface RestClient

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>

Specified by:

withRequestCorrelation in interface RestClient

withSessionCorrelation

public B withSessionCorrelation(boolean hasSessionCorrelation)

Specified by:

withSessionCorrelation in interface HttpRestClient

Specified by:

withSessionCorrelation in interface RestClient

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 RestClient

Specified by:

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

buildRequest

public RestRequestBuilder buildRequest(org.refcodes.net.HttpMethod aHttpMethod,
                                       org.refcodes.net.Url aUrl,
                                       org.refcodes.net.RequestHeaderFields aHeaderFields,
                                       Object aRequest)

Description copied from interface: RestRequestClient

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.

Returns:

The RestRequestBuilder at this request.

doRequest

public RestResponse doRequest(org.refcodes.net.HttpMethod aHttpMethod,
                              org.refcodes.net.Url aUrl,
                              org.refcodes.net.RequestHeaderFields aHeaderFields,
                              Object aRequest)
                       throws org.refcodes.net.HttpResponseException

Description copied from interface: RestRequestClient

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.

Returns:

The RestResponse for this request.

Throws:

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

doRequest

public RestCallerBuilder doRequest(org.refcodes.net.HttpMethod aHttpMethod,
                                   org.refcodes.net.Url aUrl,
                                   org.refcodes.net.RequestHeaderFields aHeaderFields,
                                   Object aRequest,
                                   RestResponseObserver aResponseObserver)

Description copied from interface: RestRequestClient

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

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.

aResponseObserver - The listener processing a response targeted at this RestCallerBuilder.

Returns:

The RestCallerBuilder which is used by the request.

toUrl

protected org.refcodes.net.Url toUrl(org.refcodes.net.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.