Class JdkHttpRestClient

java.lang.Object

org.refcodes.rest.AbstractRestClient

org.refcodes.rest.JdkHttpRestClient

All Implemented Interfaces:

Closable, ConnectionComponent<HttpClientContext>, ConnectionOpenable<HttpClientContext>, ConnectionStatusAccessor, LinkComponent, Openable, Openable.OpenBuilder<HttpRestClient>, OpenedAccessor, DeleteRestClient, GetRestClient, HttpRestClient, PostRestClient, PutRestClient, RestClient, RestRequestClient, RestRequestHandler, TrustStoreDescriptorAccessor, TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpRestClient>, TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty, BaseUrlAccessor, BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>, BaseUrlAccessor.BaseUrlMutator, BaseUrlAccessor.BaseUrlProperty, BasicAuthCredentialsAccessor, BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<RestClient>, BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator, BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty, HttpClientInterceptable, MediaTypeFactoryLookup, MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, OauthTokenAccessor, OauthTokenAccessor.OauthTokenBuilder<RestClient>, OauthTokenAccessor.OauthTokenMutator, OauthTokenAccessor.OauthTokenProperty, PostHttpClientInterceptable, PostHttpInterceptable<PostHttpClientInterceptor>, PreHttpClientInterceptable, PreHttpInterceptable<PreHttpClientInterceptor>, UserAgentAccessor, UserAgentAccessor.UserAgentBuilder<RestClient>, UserAgentAccessor.UserAgentMutator, UserAgentAccessor.UserAgentProperty

Direct Known Subclasses:

JdkHttpRestClientSingleton

public class JdkHttpRestClient
extends AbstractRestClient
implements HttpRestClient

The JdkHttpRestClient implements the HttpRestClient interface. The JdkHttpRestClient is being initialized with some common MediaTypeFactory instances (as implemented by the AbstractRestClient). At the time of writing this document the MediaTypeFactory instances being preconfigured are:

• JsonMediaTypeFactory
• XmlMediaTypeFactory
• TextMediaTypeFactory
• FormMediaTypeFactory
• HtmlMediaTypeFactory

The JdkHttpRestClient supports HTTP as well as HTTPS protocols as being based on the HttpURLConnection. For configuring HTTPS capabilities, refer to the methods such as open(Url, TrustStoreDescriptor) or open(Url, TrustStoreDescriptor).

Nested Class Summary

Nested classes/interfaces inherited from interface BaseUrlAccessor

BaseUrlAccessor.BaseUrlBuilder<B>, BaseUrlAccessor.BaseUrlMutator, BaseUrlAccessor.BaseUrlProperty

Nested classes/interfaces inherited from interface BasicAuthCredentialsAccessor

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

Nested classes/interfaces inherited from interface Closable

Closable.CloseAutomaton, Closable.CloseBuilder<B>

Nested classes/interfaces inherited from interface ConnectionComponent

ConnectionComponent.ConnectionAutomaton<CON>, ConnectionComponent.ConnectionComponentBuilder<CON,B>

Nested classes/interfaces inherited from interface ConnectionOpenable

ConnectionOpenable.ConnectionOpenAutomaton<CON>, ConnectionOpenable.ConnectionOpenBuilder<CON,B>

Nested classes/interfaces inherited from interface ConnectionStatusAccessor

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface LinkComponent

LinkComponent.LinkAutomaton, LinkComponent.LinkComponentBuilder<B>

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 Openable

Openable.OpenAutomaton, Openable.OpenBuilder<B>

Nested classes/interfaces inherited from interface OpenedAccessor

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface TrustStoreDescriptorAccessor

TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>, TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

Nested classes/interfaces inherited from interface UserAgentAccessor

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

Field Summary

Fields inherited from interface HttpRestClient

DEFAULT_KEYSTORE_TYPE, DEFAULT_SSL_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
JdkHttpRestClient()	Constructs a JdkHttpRestClient.
JdkHttpRestClient(ExecutorService aExecutorService)	Constructs a JdkHttpRestClient.

Method Summary

Modifier and Type	Method	Description
boolean	addPostHttpInterceptor(PostHttpClientInterceptor aPostInterceptor)
boolean	addPreHttpInterceptor(PreHttpClientInterceptor aPreInterceptor)
void	close()
Url	getBaseUrl()
ConnectionStatus	getConnectionStatus()
TrustStoreDescriptor	getTrustStoreDescriptor()
boolean	hasPostHttpInterceptor(PostHttpClientInterceptor aPostInterceptor)
boolean	hasPreHttpInterceptor(PreHttpClientInterceptor aPreInterceptor)
void	open(Url aBaseUrl, TrustStoreDescriptor aStoreDescriptor)	Configures the HTTPS client connection with the provided configuration parameters.
protected static void	pipe(InputStream aInputStream, OutputStream aOutoutStream)	Pipes the InputStream to the OutputStream.
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.
boolean	removePostHttpInterceptor(PostHttpClientInterceptor aPostInterceptor)
boolean	removePreHttpInterceptor(PreHttpClientInterceptor aPreInterceptor)
void	setBaseUrl(URL aBaseUrl)
void	setBaseUrl(Url aBaseUrl)
void	setTrustStoreDescriptor(TrustStoreDescriptor aTrustStoreDescriptor)
JdkHttpRestClient	withBaseUrl(String aBaseUrl)
JdkHttpRestClient	withBaseUrl(String aProtocol, String aHost)
JdkHttpRestClient	withBaseUrl(String aProtocol, String aHost, int aPort)
JdkHttpRestClient	withBaseUrl(String aProtocol, String aHost, int aPort, String aPath)
JdkHttpRestClient	withBaseUrl(String aProtocol, String aHost, String aPath)
JdkHttpRestClient	withBaseUrl(URL aBaseURL)
JdkHttpRestClient	withBaseUrl(Scheme aScheme, String aHost)
JdkHttpRestClient	withBaseUrl(Scheme aScheme, String aHost, int aPort)
JdkHttpRestClient	withBaseUrl(Scheme aScheme, String aHost, int aPort, String aPath)
JdkHttpRestClient	withBaseUrl(Scheme aScheme, String aHost, String aPath)
JdkHttpRestClient	withBaseUrl(Url aBaseUrl)
JdkHttpRestClient	withBasicAuthCredentials(String aUserName, String aSecret)
JdkHttpRestClient	withBasicAuthCredentials(BasicAuthCredentials aBasicAuthCredentials)
JdkHttpRestClient	withOAuthToken(OauthToken aOauthToken)
JdkHttpRestClient	withOpen()	Open the component's connection(s).
JdkHttpRestClient	withOpen(TrustStoreDescriptor aStoreDescriptor)	Configures the HTTPS client connection with the provided configuration parameters.
JdkHttpRestClient	withOpen(HttpClientContext aCtx)	Opens the component with the given connection.
JdkHttpRestClient	withOpen(Url aBaseUrl)	Configures the HTTPS client connection with the provided configuration parameters.
JdkHttpRestClient	withOpen(Url aBaseUrl, TrustStoreDescriptor aStoreDescriptor)	Configures the HTTPS client connection with the provided configuration parameters.
JdkHttpRestClient	withOpenUnchecked()
JdkHttpRestClient	withTrustStoreDescriptor(TrustStoreDescriptor aStoreDescriptor)
JdkHttpRestClient	withUserAgent(String aUserAgent)

Methods inherited from class AbstractRestClient

addMediaTypeFactory, buildRequest, doRequest, getBasicAuthCredentials, getFactoryMediaTypes, getOauthToken, getUserAgent, initMedaTypeFactories, onResponse, onResponse, onRestRequest, preProcessHeaderFields, setBasicAuthCredentials, setOauthToken, setUserAgent, toMediaTypeFactory

Methods inherited from class Object

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

Methods inherited from interface BaseUrlAccessor.BaseUrlMutator

setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl

Methods inherited from interface BaseUrlAccessor.BaseUrlProperty

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

Methods inherited from interface BasicAuthCredentialsAccessor

getBasicAuthCredentials

Methods inherited from interface BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator

setBasicAuthCredentials, setBasicAuthCredentials

Methods inherited from interface BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty

letBasicAuthCredentials, letBasicAuthCredentials

Methods inherited from interface Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface ConnectionOpenable

openUnchecked

Methods inherited from interface ConnectionStatusAccessor

isOpened

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 HttpClientInterceptable

addHttpInterceptor, hasHttpInterceptor, removeHttpInterceptor

Methods inherited from interface HttpRestClient

open, open, open, open

Methods inherited from interface MediaTypeFactoryLookup

getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory

Methods inherited from interface MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

addMediaTypeFactory

Methods inherited from interface OauthTokenAccessor

getOauthToken

Methods inherited from interface OauthTokenAccessor.OauthTokenMutator

setOauthToken

Methods inherited from interface OauthTokenAccessor.OauthTokenProperty

letOauthToken

Methods inherited from interface Openable

openUnchecked

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

Methods inherited from interface TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

letTrustStoreDescriptor

Methods inherited from interface UserAgentAccessor

getUserAgent

Methods inherited from interface UserAgentAccessor.UserAgentMutator

setUserAgent

Methods inherited from interface UserAgentAccessor.UserAgentProperty

letUserAgent

Constructor Details

JdkHttpRestClient

public JdkHttpRestClient()

Constructs a JdkHttpRestClient. Use HttpRestClient.open() or similar to activate it.

JdkHttpRestClient

public JdkHttpRestClient(ExecutorService aExecutorService)

Constructs a JdkHttpRestClient. Use HttpRestClient.open() or similar to activate it.

Parameters:

aExecutorService - An executor service to be used when creating Threads.

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface Closable

Throws:

IOException

getBaseUrl

public Url getBaseUrl()

Specified by:

getBaseUrl in interface BaseUrlAccessor

getConnectionStatus

public ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface ConnectionStatusAccessor

getTrustStoreDescriptor

public TrustStoreDescriptor getTrustStoreDescriptor()

Specified by:

getTrustStoreDescriptor in interface TrustStoreDescriptorAccessor

open

public void open(Url aBaseUrl,
 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.

setBaseUrl

public void setBaseUrl(Url aBaseUrl)

Specified by:

setBaseUrl in interface BaseUrlAccessor.BaseUrlMutator

setBaseUrl

public void setBaseUrl(URL aBaseUrl)

Specified by:

setBaseUrl in interface BaseUrlAccessor.BaseUrlMutator

setTrustStoreDescriptor

public void setTrustStoreDescriptor(TrustStoreDescriptor aTrustStoreDescriptor)

Specified by:

setTrustStoreDescriptor in interface TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator

hasPreHttpInterceptor

public boolean hasPreHttpInterceptor(PreHttpClientInterceptor aPreInterceptor)

Specified by:

hasPreHttpInterceptor in interface PreHttpInterceptable<PreHttpClientInterceptor>

addPreHttpInterceptor

public boolean addPreHttpInterceptor(PreHttpClientInterceptor aPreInterceptor)

Specified by:

addPreHttpInterceptor in interface PreHttpInterceptable<PreHttpClientInterceptor>

removePreHttpInterceptor

public boolean removePreHttpInterceptor(PreHttpClientInterceptor aPreInterceptor)

Specified by:

removePreHttpInterceptor in interface PreHttpInterceptable<PreHttpClientInterceptor>

hasPostHttpInterceptor

public boolean hasPostHttpInterceptor(PostHttpClientInterceptor aPostInterceptor)

Specified by:

hasPostHttpInterceptor in interface PostHttpInterceptable<PostHttpClientInterceptor>

addPostHttpInterceptor

public boolean addPostHttpInterceptor(PostHttpClientInterceptor aPostInterceptor)

Specified by:

addPostHttpInterceptor in interface PostHttpInterceptable<PostHttpClientInterceptor>

removePostHttpInterceptor

public boolean removePostHttpInterceptor(PostHttpClientInterceptor aPostInterceptor)

Specified by:

removePostHttpInterceptor in interface PostHttpInterceptable<PostHttpClientInterceptor>

withOpen

public JdkHttpRestClient withOpen()
                           throws IOException

Open the component's connection(s).

Specified by:

withOpen in interface HttpRestClient

Specified by:

withOpen in interface Openable.OpenBuilder<HttpRestClient>

Returns:

This instance as of the builder pattern.

Throws:

IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

withOpen

public JdkHttpRestClient withOpen(HttpClientContext aCtx)
                           throws IOException

Opens the component with the given connection.

Specified by:

withOpen in interface HttpRestClient

Parameters:

aCtx - The context used for opening the connection.

Returns:

This instance as of the builder pattern.

Throws:

IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

withOpen

public JdkHttpRestClient withOpen(TrustStoreDescriptor aStoreDescriptor)
                           throws IOException

Configures the HTTPS client connection with the provided configuration parameters.

Specified by:

withOpen in interface HttpRestClient

Parameters:

aStoreDescriptor - The TrustStoreDescriptor pointing to your KeyStore.

Returns:

This instance as of the builder pattern.

Throws:

IOException - thrown in case something went wrong.

withOpen

public JdkHttpRestClient withOpen(Url aBaseUrl)
                           throws IOException

Configures the HTTPS client connection with the provided configuration parameters.

Specified by:

withOpen in interface HttpRestClient

Parameters:

aBaseUrl - The base Url to be used.

Returns:

This instance as of the builder pattern.

Throws:

IOException - thrown in case something went wrong.

withOpen

public JdkHttpRestClient withOpen(Url aBaseUrl,
 TrustStoreDescriptor aStoreDescriptor)
                           throws IOException

Configures the HTTPS client connection with the provided configuration parameters.

Specified by:

withOpen in interface HttpRestClient

Parameters:

aBaseUrl - The base Url to be used.

aStoreDescriptor - The TrustStoreDescriptor pointing to your KeyStore.

Returns:

This instance as of the builder pattern.

Throws:

IOException - thrown in case something went wrong.

withBaseUrl

public JdkHttpRestClient withBaseUrl(String aBaseUrl)
                              throws MalformedURLException

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Specified by:

withBaseUrl in interface HttpRestClient

Throws:

MalformedURLException

withBaseUrl

public JdkHttpRestClient withBaseUrl(Url aBaseUrl)

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Specified by:

withBaseUrl in interface HttpRestClient

withBaseUrl

public JdkHttpRestClient withBaseUrl(URL aBaseURL)

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Specified by:

withBaseUrl in interface HttpRestClient

withBasicAuthCredentials

public JdkHttpRestClient withBasicAuthCredentials(BasicAuthCredentials aBasicAuthCredentials)

Specified by:

withBasicAuthCredentials in interface BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<RestClient>

Specified by:

withBasicAuthCredentials in interface HttpRestClient

withBasicAuthCredentials

public JdkHttpRestClient withBasicAuthCredentials(String aUserName,
 String aSecret)

Specified by:

withBasicAuthCredentials in interface BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<RestClient>

Specified by:

withBasicAuthCredentials in interface HttpRestClient

withOAuthToken

public JdkHttpRestClient withOAuthToken(OauthToken aOauthToken)

Specified by:

withOAuthToken in interface HttpRestClient

Specified by:

withOAuthToken in interface OauthTokenAccessor.OauthTokenBuilder<RestClient>

withTrustStoreDescriptor

public JdkHttpRestClient withTrustStoreDescriptor(TrustStoreDescriptor aStoreDescriptor)

Specified by:

withTrustStoreDescriptor in interface HttpRestClient

Specified by:

withTrustStoreDescriptor in interface TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpRestClient>

withUserAgent

public JdkHttpRestClient withUserAgent(String aUserAgent)

Specified by:

withUserAgent in interface HttpRestClient

Specified by:

withUserAgent in interface UserAgentAccessor.UserAgentBuilder<RestClient>

withBaseUrl

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

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public JdkHttpRestClient withBaseUrl(Scheme aScheme,
 String aHost)
                              throws MalformedURLException

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

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

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public JdkHttpRestClient withBaseUrl(Scheme aScheme,
 String aHost,
 String aPath)
                              throws MalformedURLException

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

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

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public JdkHttpRestClient withBaseUrl(Scheme aScheme,
 String aHost,
 int aPort)
                              throws MalformedURLException

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

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

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Throws:

MalformedURLException

withBaseUrl

public JdkHttpRestClient withBaseUrl(Scheme aScheme,
 String aHost,
 int aPort,
 String aPath)
                              throws MalformedURLException

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>

Throws:

MalformedURLException

withOpenUnchecked

public JdkHttpRestClient withOpenUnchecked()

Specified by:

withOpenUnchecked in interface Openable.OpenBuilder<HttpRestClient>

pipe

protected static void pipe(InputStream aInputStream,
 OutputStream aOutoutStream)
                    throws IOException

Pipes the InputStream to the OutputStream.

Parameters:

aInputStream - The InputStream from which to pipe.

aOutoutStream - The OutputStream to pipe to.

Throws:

IOException - Signals that an I/O exception has occurred.

preIntercept

protected void preIntercept(HttpClientRequest aRequest,
 HttpClientResponse aResponse)

Invoked to pre-process a HttpClientRequest alongside a HttpClientResponse.

Overrides:

preIntercept in class AbstractRestClient

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.

Overrides:

postIntercept in class AbstractRestClient

Parameters:

aRequest - The HttpClientRequest to post-process.

aResponse - The HttpClientResponse to post-process.