org.refcodes.web.BaseUrlAccessor
, org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>
, 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.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.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.component.Openable
, org.refcodes.component.OpenedAccessor
, org.refcodes.runtime.RequestCorrelation<org.refcodes.web.HttpClientContext>
, RestClient
, RestDeleteClient
, RestGetClient
, RestPostClient
, RestPutClient
, RestRequestClient
, RestRequestHandler
, org.refcodes.runtime.SessionCorrelation<org.refcodes.web.HttpClientContext>
, org.refcodes.security.TrustStoreDescriptorAccessor
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpRestClient>
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator
, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty
, org.refcodes.web.UserAgentAccessor
, org.refcodes.web.UserAgentAccessor.UserAgentBuilder<org.refcodes.web.HttpClientContext>
, org.refcodes.web.UserAgentAccessor.UserAgentMutator
, org.refcodes.web.UserAgentAccessor.UserAgentProperty
HttpDiscoveryRestClient<B>
AbstractHttpDiscoveryRestClientDecorator
, AbstractHttpRestClientDecorator
, HttpRestClientImpl
, HttpRestClientSingleton
public interface HttpRestClient extends org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.ConnectionComponent<org.refcodes.web.HttpClientContext>, RestClient, org.refcodes.component.LinkComponent, org.refcodes.web.BaseUrlAccessor.BaseUrlProperty, org.refcodes.web.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)
(
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.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
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.security.TrustStoreDescriptor aStoreDescriptor) |
Configures the HTTPS client connection with the provided configuration
parameters.
|
default void |
open(org.refcodes.web.HttpClientContext aCtx) |
|
default void |
open(org.refcodes.web.Url aBaseUrl) |
Configures the HTTPS client connection with the provided configuration
parameters.
|
void |
open(org.refcodes.web.Url aBaseUrl,
org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) |
Configures the HTTPS client connection with the provided configuration
parameters.
|
default HttpRestClient |
withBaseUrl(String aBaseUrl) |
|
default HttpRestClient |
withBaseUrl(URL aBaseURL) |
|
default HttpRestClient |
withBaseUrl(org.refcodes.web.Url aBaseUrl) |
|
default HttpRestClient |
withBasicAuthCredentials(String aUserName,
String aSecret) |
|
default HttpRestClient |
withBasicAuthCredentials(org.refcodes.web.BasicAuthCredentials aBasicAuthCredentials) |
|
default HttpRestClient |
withDisableRequestCorrelation() |
|
default HttpRestClient |
withDisableSessionCorrelation() |
|
default HttpRestClient |
withEnableRequestCorrelation() |
|
default HttpRestClient |
withEnableSessionCorrelation() |
|
default HttpRestClient |
withOAuthToken(org.refcodes.web.OauthToken aOauthToken) |
|
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
setBaseUrl, setBaseUrl, 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
close, closeIn, closeQuietly, closeUnchecked
getConnectionStatus, isOpened
getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory
addMediaTypeFactory
setOauthToken
letOauthToken
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
getTrustStoreDescriptor
setTrustStoreDescriptor
static final String DEFAULT_KEYSTORE_TYPE
static final String DEFAULT_SSL_PROTOCOL
default void open() throws IOException
open
in interface org.refcodes.component.Openable
IOException
default void open(org.refcodes.web.HttpClientContext aCtx) throws IOException
open
in interface org.refcodes.component.ConnectionOpenable<org.refcodes.web.HttpClientContext>
IOException
default void open(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) throws IOException
aStoreDescriptor
- The TrustStoreDescriptor
pointing to your
KeyStore
.IOException
- thrown in case something went wrong.default void open(org.refcodes.web.Url aBaseUrl) throws IOException
aBaseUrl
- The base Url
to be used.IOException
- thrown in case something went wrong.void open(org.refcodes.web.Url aBaseUrl, org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) throws IOException
aBaseUrl
- The base Url
to be used.aStoreDescriptor
- The TrustStoreDescriptor
pointing to your
KeyStore
.IOException
- thrown in case something went wrong.default HttpRestClient withBaseUrl(String aBaseUrl) throws MalformedURLException
withBaseUrl
in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>
MalformedURLException
default HttpRestClient withBaseUrl(org.refcodes.web.Url aBaseUrl)
withBaseUrl
in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>
default HttpRestClient withBaseUrl(URL aBaseURL)
withBaseUrl
in interface org.refcodes.web.BaseUrlAccessor.BaseUrlBuilder<HttpRestClient>
default HttpRestClient withBasicAuthCredentials(org.refcodes.web.BasicAuthCredentials aBasicAuthCredentials)
withBasicAuthCredentials
in interface org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<org.refcodes.web.HttpClientContext>
default HttpRestClient withBasicAuthCredentials(String aUserName, String aSecret)
withBasicAuthCredentials
in interface org.refcodes.web.BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<org.refcodes.web.HttpClientContext>
default HttpRestClient withDisableRequestCorrelation()
withDisableRequestCorrelation
in interface org.refcodes.runtime.RequestCorrelation<org.refcodes.web.HttpClientContext>
default HttpRestClient withDisableSessionCorrelation()
withDisableSessionCorrelation
in interface org.refcodes.runtime.SessionCorrelation<org.refcodes.web.HttpClientContext>
default HttpRestClient withEnableRequestCorrelation()
withEnableRequestCorrelation
in interface org.refcodes.runtime.RequestCorrelation<org.refcodes.web.HttpClientContext>
default HttpRestClient withEnableSessionCorrelation()
withEnableSessionCorrelation
in interface org.refcodes.runtime.SessionCorrelation<org.refcodes.web.HttpClientContext>
default HttpRestClient withOAuthToken(org.refcodes.web.OauthToken aOauthToken)
withOAuthToken
in interface org.refcodes.web.OauthTokenAccessor.OauthTokenBuilder<org.refcodes.web.HttpClientContext>
default HttpRestClient withRequestCorrelation(boolean hasRequestCorrelation)
withRequestCorrelation
in interface org.refcodes.runtime.RequestCorrelation<org.refcodes.web.HttpClientContext>
default HttpRestClient withSessionCorrelation(boolean hasSessionCorrelation)
withSessionCorrelation
in interface org.refcodes.runtime.SessionCorrelation<org.refcodes.web.HttpClientContext>
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 org.refcodes.web.UserAgentAccessor.UserAgentBuilder<org.refcodes.web.HttpClientContext>
Copyright © 2021. All rights reserved.