Package co.arago.hiro.client.connection

Class AbstractClientAPIHandler

java.lang.Object

co.arago.util.validation.RequiredFieldChecks

co.arago.hiro.client.connection.AbstractAPIHandler

co.arago.hiro.client.connection.AbstractClientAPIHandler

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

AbstractVersionAPIHandler

public abstract class AbstractClientAPIHandler
extends AbstractAPIHandler
implements java.lang.AutoCloseable

Class for API httpRequests that contains a HttpClient and a HttpLogger.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractClientAPIHandler.Conf<T extends AbstractClientAPIHandler.Conf<T>>
static class	AbstractClientAPIHandler.ProxySpec	A simple data class for a proxy

Nested classes/interfaces inherited from class co.arago.hiro.client.connection.AbstractAPIHandler

AbstractAPIHandler.GetterConf

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Long	connectTimeout
protected boolean	externalHttpClient
protected boolean	followRedirects
protected java.net.http.HttpClient	httpClient
protected HttpLogger	httpLogger
protected int	maxConnectionPool
protected AbstractClientAPIHandler.ProxySpec	proxy
protected javax.net.ssl.SSLContext	sslContext
protected javax.net.ssl.SSLParameters	sslParameters

Fields inherited from class co.arago.hiro.client.connection.AbstractAPIHandler

apiUrl, httpRequestTimeout, maxRetries, title, userAgent, version, webSocketUri

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractClientAPIHandler(AbstractClientAPIHandler.Conf<?> builder)	Protected Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Shut the httpClient down by shutting down its ExecutorService.
HttpLogger	getHttpLogger()	Abstract class that needs to be overwritten by a supplier of a HttpLogger.
java.net.http.HttpClient	getOrBuildClient()	Return httpClient.

Methods inherited from class co.arago.hiro.client.connection.AbstractAPIHandler

addQueryAndFragment, addToHeaders, buildApiURI, buildEndpointURI, buildURI, buildWebSocketURI, checkResponse, delete, executeAsyncWithStreamBody, executeAsyncWithStringBody, executeBinary, executeWithStreamBody, executeWithStringBody, get, getApiUrl, getBinary, getHttpRequestTimeout, getMaxRetries, getRequestBuilder, getUserAgent, getWebSocketUri, patch, patchBinary, post, postBinary, put, putBinary, send, sendAsync

Methods inherited from class co.arago.util.validation.RequiredFieldChecks

anyError, notBlank, notEmpty, notEmpty, notEmpty, notEmpty, notNull, notNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

proxy

protected final AbstractClientAPIHandler.ProxySpec proxy

followRedirects

protected final boolean followRedirects

connectTimeout

protected final java.lang.Long connectTimeout

sslParameters

protected final javax.net.ssl.SSLParameters sslParameters

httpClient

protected java.net.http.HttpClient httpClient

sslContext

protected javax.net.ssl.SSLContext sslContext

maxConnectionPool

protected final int maxConnectionPool

httpLogger

protected final HttpLogger httpLogger

externalHttpClient

protected boolean externalHttpClient

Constructor Detail

AbstractClientAPIHandler

protected AbstractClientAPIHandler(AbstractClientAPIHandler.Conf<?> builder)

Protected Constructor. Attributes shall be filled via builders.

Parameters:

builder - The builder to use.

Method Detail

getOrBuildClient

public java.net.http.HttpClient getOrBuildClient()

Return httpClient. Build a new client if necessary.

Specified by:

getOrBuildClient in class AbstractAPIHandler

Returns:

The cached HttpClient

close

public void close()

Shut the httpClient down by shutting down its ExecutorService. If the httpClient has been provided externally, this call will be ignored.

Specified by:

close in interface java.lang.AutoCloseable

getHttpLogger

public HttpLogger getHttpLogger()

Description copied from class: AbstractAPIHandler

Abstract class that needs to be overwritten by a supplier of a HttpLogger.

Specified by:

getHttpLogger in class AbstractAPIHandler

Returns:

The HttpLogger to use with this class.