org.refcodes.component.Closable
, org.refcodes.component.ConnectionComponent<org.refcodes.net.HttpClientContext>
, org.refcodes.component.ConnectionOpenable<org.refcodes.net.HttpClientContext>
, org.refcodes.component.ConnectionStatusAccessor
, org.refcodes.component.LinkComponent
, org.refcodes.component.Openable
, org.refcodes.net.BaseUrlAccessor
, org.refcodes.net.BaseUrlAccessor.BaseUrlBuilder<org.refcodes.net.HttpClientContext>
, 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<org.refcodes.net.HttpClientContext>
, org.refcodes.net.UserAgentAccessor.UserAgentMutator
, org.refcodes.net.UserAgentAccessor.UserAgentProperty
, HttpRestClient
, RestClient
, RestDeleteClient
, RestGetClient
, RestPostClient
, RestPutClient
, RestRequestClient
, org.refcodes.runtime.RequestCorrelation<org.refcodes.net.HttpClientContext>
, org.refcodes.runtime.SessionCorrelation<org.refcodes.net.HttpClientContext>
, org.refcodes.security.TrustStoreDescriptorAccessor
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<org.refcodes.net.HttpClientContext>
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty
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:
ApplicationJsonFactory
ApplicationXmlFactory
TextPlainFactory
ApplicationFormFactory
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.net.BaseUrlAccessor.BaseUrlBuilder<B extends org.refcodes.net.BaseUrlAccessor.BaseUrlBuilder<B>>, org.refcodes.net.BaseUrlAccessor.BaseUrlMutator, org.refcodes.net.BaseUrlAccessor.BaseUrlProperty
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.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup
org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<B extends org.refcodes.component.Openable.OpenBuilder<B>>
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.net.UserAgentAccessor.UserAgentBuilder<B extends org.refcodes.net.UserAgentAccessor.UserAgentBuilder<B>>, org.refcodes.net.UserAgentAccessor.UserAgentMutator, org.refcodes.net.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.net.Url |
getBaseUrl() |
|
org.refcodes.component.ConnectionStatus |
getConnectionStatus() |
|
org.refcodes.security.TrustStoreDescriptor |
getTrustStoreDescriptor() |
|
void |
open(org.refcodes.net.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.net.Url aBaseUrl) |
|
void |
setTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) |
|
HttpRestClient |
withBaseUrl(URL aBaseURL) |
|
HttpRestClient |
withBaseUrl(org.refcodes.net.Url aBaseUrl) |
addMediaTypeFactory, buildRequest, doRequest, doRequest, doRequestCorrelation, doRequestCorrelation, doSessionCorrelation, doSessionCorrelation, getFactoryMediaTypes, getUserAgent, hasRequestCorrelation, hasSessionCorrelation, initMedaTypeFactories, onRestRequest, setRequestCorrelation, setSessionCorrelation, setUserAgent, toMediaTypeFactory
withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl
setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl
closeIn, closeQuietly, closeUnchecked
open, open, open, open, withDisableRequestCorrelation, withDisableSessionCorrelation, withEnableRequestCorrelation, withEnableSessionCorrelation, withRequestCorrelation, withSessionCorrelation, withTrustStoreDescriptor, withUserAgent
getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory
addMediaTypeFactory
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, 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
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
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
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
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, 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
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 setBaseUrl(URL aBaseUrl)
setBaseUrl
in interface org.refcodes.net.BaseUrlAccessor.BaseUrlMutator
public void setTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
setTrustStoreDescriptor
in interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator
public HttpRestClient withBaseUrl(org.refcodes.net.Url aBaseUrl)
withBaseUrl
in interface org.refcodes.net.BaseUrlAccessor.BaseUrlBuilder<org.refcodes.net.HttpClientContext>
public HttpRestClient withBaseUrl(URL aBaseURL)
withBaseUrl
in interface org.refcodes.net.BaseUrlAccessor.BaseUrlBuilder<org.refcodes.net.HttpClientContext>
public void close() throws org.refcodes.component.CloseException
close
in interface org.refcodes.component.Closable
org.refcodes.component.CloseException
public org.refcodes.net.Url getBaseUrl()
getBaseUrl
in interface org.refcodes.net.BaseUrlAccessor
public org.refcodes.security.TrustStoreDescriptor getTrustStoreDescriptor()
getTrustStoreDescriptor
in interface org.refcodes.security.TrustStoreDescriptorAccessor
public void open(org.refcodes.net.Url aBaseUrl, org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) throws org.refcodes.component.OpenException
open
in interface HttpRestClient
aBaseUrl
- The base Url
to be used.aStoreDescriptor
- The TrustStoreDescriptor
pointing to your
KeyStore
.org.refcodes.component.OpenException
- thrown in case something went wrong.public void setBaseUrl(org.refcodes.net.Url aBaseUrl)
setBaseUrl
in interface org.refcodes.net.BaseUrlAccessor.BaseUrlMutator
public org.refcodes.component.ConnectionStatus getConnectionStatus()
getConnectionStatus
in interface org.refcodes.component.ConnectionStatusAccessor
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 © 2018. All rights reserved.