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.OpenedAccessor
, HttpRestClient
, RestClient
, RestDeleteClient
, RestGetClient
, RestPostClient
, RestPutClient
, RestRequestClient
, RestRequestHandler
, org.refcodes.runtime.RequestCorrelation<org.refcodes.web.HttpClientContext>
, org.refcodes.runtime.SessionCorrelation<org.refcodes.web.HttpClientContext>
, org.refcodes.security.TrustStoreDescriptorAccessor
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<org.refcodes.web.HttpClientContext>
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty
, org.refcodes.web.BaseUrlAccessor
, org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<org.refcodes.web.HttpClientContext>
, org.refcodes.web.BaseUrlAccessor.BaseUrlMutator
, org.refcodes.web.BaseUrlAccessor.BaseUrlProperty
, org.refcodes.web.BasicAuthCredentialsAccessor
, org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<org.refcodes.web.HttpClientContext>
, 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<org.refcodes.web.HttpClientContext>
, org.refcodes.web.OauthTokenAccessor.OauthTokenMutator
, org.refcodes.web.OauthTokenAccessor.OauthTokenProperty
, org.refcodes.web.UserAgentAccessor
, org.refcodes.web.UserAgentAccessor.UserAgentBuilder<org.refcodes.web.HttpClientContext>
, org.refcodes.web.UserAgentAccessor.UserAgentMutator
, org.refcodes.web.UserAgentAccessor.UserAgentProperty
HttpRestClientSingleton
public class HttpRestClientImpl extends AbstractRestClient implements HttpRestClient
HttpRestClientImpl
implements the HttpRestClient
interface. The HttpRestClientImpl
is being initialized with some
common MediaTypeFactory
instances (as implemented by the
AbstractRestClient
). At the time of writing this document the
MediaTypeFactory
instances being pre-configured are:
JsonMediaTypeFactory
XmlMediaTypeFactory
TextMediaTypeFactory
FormMediaTypeFactory
HtmlMediaTypeFactory
HttpRestClientImpl
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)
.org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B extends org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<B>>, org.refcodes.web.BaseUrlAccessor.BaseUrlMutator, org.refcodes.web.BaseUrlAccessor.BaseUrlProperty
org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B extends org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B>>, org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator, org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty
org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>
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>>
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>>
org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty
org.refcodes.component.LinkComponent.LinkAutomaton, org.refcodes.component.LinkComponent.LinkComponentBuilder<B extends org.refcodes.component.LinkComponent.LinkComponentBuilder<B>>
org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup
org.refcodes.web.OauthTokenAccessor.OauthTokenBuilder<B extends org.refcodes.web.OauthTokenAccessor.OauthTokenBuilder<B>>, org.refcodes.web.OauthTokenAccessor.OauthTokenMutator, org.refcodes.web.OauthTokenAccessor.OauthTokenProperty
org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<B extends org.refcodes.component.Openable.OpenBuilder<B>>
org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty
org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B extends org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty
org.refcodes.web.UserAgentAccessor.UserAgentBuilder<B extends org.refcodes.web.UserAgentAccessor.UserAgentBuilder<B>>, org.refcodes.web.UserAgentAccessor.UserAgentMutator, org.refcodes.web.UserAgentAccessor.UserAgentProperty
_hasRequestCorrelation, _hasSessionCorrelation
DEFAULT_KEYSTORE_TYPE, DEFAULT_SSL_PROTOCOL
Constructor | Description |
---|---|
HttpRestClientImpl() |
Constructs a
HttpRestClientImpl . |
HttpRestClientImpl(ExecutorService aExecutorService) |
Constructs a
HttpRestClientImpl . |
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
|
org.refcodes.web.Url |
getBaseUrl() |
|
org.refcodes.component.ConnectionStatus |
getConnectionStatus() |
|
org.refcodes.security.TrustStoreDescriptor |
getTrustStoreDescriptor() |
|
void |
open(org.refcodes.web.Url aBaseUrl,
org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) |
Configures the HTTPS client connection with the provided configuration
parameters.
|
protected static void |
pipe(InputStream aInputStream,
OutputStream aOutoutStream) |
Pipe.
|
void |
setBaseUrl(URL aBaseUrl) |
|
void |
setBaseUrl(org.refcodes.web.Url aBaseUrl) |
|
void |
setTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) |
addMediaTypeFactory, buildRequest, doRequest, doRequestCorrelation, doRequestCorrelation, doSessionCorrelation, doSessionCorrelation, getBasicAuthCredentials, getFactoryMediaTypes, getOauthToken, getUserAgent, hasRequestCorrelation, hasSessionCorrelation, initMedaTypeFactories, onResponse, onResponse, onRestRequest, preProcessHeaderFields, setBasicAuthCredentials, setOauthToken, setRequestCorrelation, setSessionCorrelation, setUserAgent, toMediaTypeFactory
withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl
setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl
letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl
getBasicAuthCredentials
setBasicAuthCredentials, setBasicAuthCredentials
letBasicAuthCredentials, letBasicAuthCredentials
closeIn, closeQuietly, closeUnchecked
open, open, open, open, withBaseUrl, withBaseUrl, withBaseUrl, withBasicAuthCredentials, withBasicAuthCredentials, withDisableRequestCorrelation, withDisableSessionCorrelation, withEnableRequestCorrelation, withEnableSessionCorrelation, withOAuthToken, withRequestCorrelation, withSessionCorrelation, withTrustStoreDescriptor, withUserAgent
getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory
addMediaTypeFactory
setOauthToken
letOauthToken
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
disableRequestCorrelation, enableRequestCorrelation, hasRequestCorrelation, setRequestCorrelation
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
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
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
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
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
disableSessionCorrelation, enableSessionCorrelation, hasSessionCorrelation, setSessionCorrelation
public HttpRestClientImpl()
HttpRestClientImpl
. Use HttpRestClient.open()
or similar
to activate it.public HttpRestClientImpl(ExecutorService aExecutorService)
HttpRestClientImpl
. Use HttpRestClient.open()
or similar
to activate it.aExecutorService
- An executor service to be used when creating
Thread
s.public void close() throws IOException
close
in interface org.refcodes.component.Closable
IOException
public org.refcodes.web.Url getBaseUrl()
getBaseUrl
in interface org.refcodes.web.BaseUrlAccessor
public org.refcodes.component.ConnectionStatus getConnectionStatus()
getConnectionStatus
in interface org.refcodes.component.ConnectionStatusAccessor
public org.refcodes.security.TrustStoreDescriptor getTrustStoreDescriptor()
getTrustStoreDescriptor
in interface org.refcodes.security.TrustStoreDescriptorAccessor
public void open(org.refcodes.web.Url aBaseUrl, org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) throws IOException
open
in interface HttpRestClient
aBaseUrl
- The base Url
to be used.aStoreDescriptor
- The TrustStoreDescriptor
pointing to your
KeyStore
.IOException
- thrown in case something went wrong.public void setBaseUrl(org.refcodes.web.Url aBaseUrl)
setBaseUrl
in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator
public void setBaseUrl(URL aBaseUrl)
setBaseUrl
in interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator
public void setTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
setTrustStoreDescriptor
in interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator
protected static void pipe(InputStream aInputStream, OutputStream aOutoutStream) throws IOException
aInputStream
- the input streamaOutoutStream
- the output streamIOException
- Signals that an I/O exception has occurred.Copyright © 2021. All rights reserved.