org.refcodes.net.BaseUrlAccessor
, org.refcodes.net.BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>
, org.refcodes.net.BaseUrlAccessor.BaseUrlMutator
, org.refcodes.net.BaseUrlAccessor.BaseUrlProperty
, 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.net.MediaTypeFactoryLookup
, org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup
, org.refcodes.component.Openable
, org.refcodes.runtime.RequestCorrelation<RestClient>
, RestClient
, RestDeleteClient
, RestGetClient
, RestPostClient
, RestPutClient
, RestRequestClient
, org.refcodes.runtime.SessionCorrelation<RestClient>
, org.refcodes.security.TrustStoreDescriptorAccessor
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpRestClient>
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty
, org.refcodes.net.UserAgentAccessor
, org.refcodes.net.UserAgentAccessor.UserAgentBuilder<RestClient>
, org.refcodes.net.UserAgentAccessor.UserAgentMutator
, org.refcodes.net.UserAgentAccessor.UserAgentProperty
HttpDiscoveryRestClient<B>
AbstractHttpDiscoveryRestClientDecorator
, AbstractHttpRestClientDecorator
, HttpRestClientImpl
, HttpRestClientSingleton
public interface HttpRestClient extends org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.ConnectionComponent<org.refcodes.net.HttpClientContext>, RestClient, org.refcodes.component.LinkComponent, org.refcodes.net.BaseUrlAccessor.BaseUrlProperty, org.refcodes.net.BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpRestClient>
RestClient
to be capable of providing a User-Agent with
UserAgentAccessor.UserAgentMutator.setUserAgent(String)
(withUserAgent(String)
) and to be
capable of using base URLs to be set with BaseUrlAccessor.BaseUrlMutator.setBaseUrl(String)
(
BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(String)
).
This type is intended to be used by different separate hierarchy branches by
providing the generic type <B>, ensuring a coherent type hierarchy for
each branch.
To prepare HTTPS connections, use the methods such as:
open(Url, TrustStoreDescriptor)
or open(HttpClientContext)
.
A HttpRestClient
can be shutdown via Closable.close()
.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
Modifier and Type | Field | Description |
---|---|---|
static String |
DEFAULT_KEYSTORE_TYPE |
|
static String |
DEFAULT_SSL_PROTOCOL |
Modifier and Type | Method | Description |
---|---|---|
default void |
open() |
|
default void |
open(org.refcodes.net.HttpClientContext aCtx) |
|
default void |
open(org.refcodes.net.Url aBaseUrl) |
Configures the HTTPS client connection with the provided configuration
parameters.
|
void |
open(org.refcodes.net.Url aBaseUrl,
org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) |
Configures the HTTPS client connection with the provided configuration
parameters.
|
default void |
open(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) |
Configures the HTTPS client connection with the provided configuration
parameters.
|
default HttpRestClient |
withDisableRequestCorrelation() |
|
default HttpRestClient |
withDisableSessionCorrelation() |
|
default HttpRestClient |
withEnableRequestCorrelation() |
|
default HttpRestClient |
withEnableSessionCorrelation() |
|
default HttpRestClient |
withRequestCorrelation(boolean hasRequestCorrelation) |
|
default HttpRestClient |
withSessionCorrelation(boolean hasSessionCorrelation) |
|
default HttpRestClient |
withTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) |
|
default HttpRestClient |
withUserAgent(String aUserAgent) |
withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl, withBaseUrl
setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl
close, closeIn, closeQuietly, closeUnchecked
getConnectionStatus, isConnectionOpened
getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory
addMediaTypeFactory
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
disableSessionCorrelation, enableSessionCorrelation, hasSessionCorrelation, setSessionCorrelation
getTrustStoreDescriptor
static final String DEFAULT_SSL_PROTOCOL
static final String DEFAULT_KEYSTORE_TYPE
default void open() throws org.refcodes.component.OpenException
open
in interface org.refcodes.component.Openable
org.refcodes.component.OpenException
default void open(org.refcodes.net.HttpClientContext aCtx) throws org.refcodes.component.OpenException
open
in interface org.refcodes.component.ConnectionOpenable<org.refcodes.net.HttpClientContext>
org.refcodes.component.OpenException
default void open(org.refcodes.net.Url aBaseUrl) throws org.refcodes.component.OpenException
aBaseUrl
- The base Url
to be used.org.refcodes.component.OpenException
- thrown in case something went wrong.default void open(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) throws org.refcodes.component.OpenException
aStoreDescriptor
- The TrustStoreDescriptor
pointing to your
KeyStore
.org.refcodes.component.OpenException
- thrown in case something went wrong.void open(org.refcodes.net.Url aBaseUrl, org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) throws org.refcodes.component.OpenException
aBaseUrl
- The base Url
to be used.aStoreDescriptor
- The TrustStoreDescriptor
pointing to your
KeyStore
.org.refcodes.component.OpenException
- thrown in case something went wrong.default HttpRestClient withDisableRequestCorrelation()
withDisableRequestCorrelation
in interface org.refcodes.runtime.RequestCorrelation<RestClient>
withDisableRequestCorrelation
in interface RestClient
default HttpRestClient withDisableSessionCorrelation()
withDisableSessionCorrelation
in interface RestClient
withDisableSessionCorrelation
in interface org.refcodes.runtime.SessionCorrelation<RestClient>
default HttpRestClient withEnableRequestCorrelation()
withEnableRequestCorrelation
in interface org.refcodes.runtime.RequestCorrelation<RestClient>
withEnableRequestCorrelation
in interface RestClient
default HttpRestClient withEnableSessionCorrelation()
withEnableSessionCorrelation
in interface RestClient
withEnableSessionCorrelation
in interface org.refcodes.runtime.SessionCorrelation<RestClient>
default HttpRestClient withRequestCorrelation(boolean hasRequestCorrelation)
withRequestCorrelation
in interface org.refcodes.runtime.RequestCorrelation<RestClient>
withRequestCorrelation
in interface RestClient
default HttpRestClient withSessionCorrelation(boolean hasSessionCorrelation)
withSessionCorrelation
in interface RestClient
withSessionCorrelation
in interface org.refcodes.runtime.SessionCorrelation<RestClient>
default HttpRestClient withTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
withTrustStoreDescriptor
in interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpRestClient>
default HttpRestClient withUserAgent(String aUserAgent)
withUserAgent
in interface RestClient
withUserAgent
in interface org.refcodes.net.UserAgentAccessor.UserAgentBuilder<RestClient>
Copyright © 2018. All rights reserved.