Interface HttpRestClient

All Superinterfaces:

BaseUrlAccessor, BasicAuthCredentialsAccessor, BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<RestClient>, BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator, BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty, Closable, Closable.CloseBuilder<LinkComponent.LinkComponentBuilder<HttpRestClient>>, ConnectionStatusAccessor, DeleteRestClient, GetRestClient, HttpClientInterceptable, LinkComponent, LinkComponent.LinkComponentBuilder<HttpRestClient>, MediaTypeFactoryLookup, MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, OauthTokenAccessor, OauthTokenAccessor.OauthTokenBuilder<RestClient>, OauthTokenAccessor.OauthTokenMutator, OauthTokenAccessor.OauthTokenProperty, Openable, Openable.OpenBuilder<LinkComponent.LinkComponentBuilder<HttpRestClient>>, OpenedAccessor, PostHttpClientInterceptable, PostHttpInterceptable<PostHttpClientInterceptor>, PostRestClient, PreHttpClientInterceptable, PreHttpInterceptable<PreHttpClientInterceptor>, PutRestClient, RestClient, RestRequestClient, RestRequestHandler, TrustStoreDescriptorAccessor, UserAgentAccessor, UserAgentAccessor.UserAgentBuilder<RestClient>, UserAgentAccessor.UserAgentMutator, UserAgentAccessor.UserAgentProperty

All Known Subinterfaces:

HttpRestDiscoveryClient<B>

All Known Implementing Classes:

AbstractHttpRestClientDecorator, AbstractHttpRestDiscoveryClientDecorator, JdkHttpRestClient

public interface HttpRestClient
extends RestClient, HttpClientInterceptable, ConnectionStatusAccessor, LinkComponent.LinkComponentBuilder<HttpRestClient>, BaseUrlAccessor, TrustStoreDescriptorAccessor

Extends a RestClient to be capable of HTTP specifics. .

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

Modifier and Type	Field	Description
static final String	DEFAULT_KEYSTORE_TYPE
static final String	DEFAULT_SSL_PROTOCOL

Method Summary

Modifier and Type	Method	Description
default HttpRestClient	withBasicAuthCredentials(String aUserName, String aSecret)
default HttpRestClient	withBasicAuthCredentials(BasicAuthCredentials aBasicAuthCredentials)
default HttpRestClient	withOAuthToken(OauthToken aOauthToken)
default HttpRestClient	withOpen()	Open the component's connection(s).
default HttpRestClient	withUserAgent(String aUserAgent)

Methods inherited from interface BaseUrlAccessor

getBaseUrl

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

close, closeIn, closeQuietly, closeUnchecked

Methods inherited from interface Closable.CloseBuilder

withClose, withCloseIn, withCloseQuietly, withCloseUnchecked

Methods inherited from interface ConnectionStatusAccessor

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

open

Methods inherited from interface PostHttpInterceptable

addPostHttpInterceptor, hasPostHttpInterceptor, removePostHttpInterceptor

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 PreHttpInterceptable

addPreHttpInterceptor, hasPreHttpInterceptor, removePreHttpInterceptor

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

getTrustStoreDescriptor

Methods inherited from interface UserAgentAccessor

getUserAgent

Methods inherited from interface UserAgentAccessor.UserAgentMutator

setUserAgent

Methods inherited from interface UserAgentAccessor.UserAgentProperty

letUserAgent

Field Details

DEFAULT_KEYSTORE_TYPE

static final String DEFAULT_KEYSTORE_TYPE

DEFAULT_SSL_PROTOCOL

static final String DEFAULT_SSL_PROTOCOL

See Also:

• Constant Field Values

Method Details

withOpen

default HttpRestClient withOpen()
                         throws IOException

Open the component's connection(s).

Specified by:

withOpen in interface Openable.OpenBuilder<LinkComponent.LinkComponentBuilder<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.

withBasicAuthCredentials

default HttpRestClient withBasicAuthCredentials(BasicAuthCredentials aBasicAuthCredentials)

Specified by:

withBasicAuthCredentials in interface BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<RestClient>

withBasicAuthCredentials

default HttpRestClient withBasicAuthCredentials(String aUserName,
 String aSecret)

Specified by:

withBasicAuthCredentials in interface BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<RestClient>

withOAuthToken

default HttpRestClient withOAuthToken(OauthToken aOauthToken)

Specified by:

withOAuthToken in interface OauthTokenAccessor.OauthTokenBuilder<RestClient>

withUserAgent

default HttpRestClient withUserAgent(String aUserAgent)

Specified by:

withUserAgent in interface UserAgentAccessor.UserAgentBuilder<RestClient>