Package co.arago.hiro.client.connection.token

Class FixedTokenAPIHandler

java.lang.Object

co.arago.util.validation.RequiredFieldChecks

co.arago.hiro.client.connection.AbstractAPIHandler

co.arago.hiro.client.connection.AbstractClientAPIHandler

co.arago.hiro.client.connection.AbstractVersionAPIHandler

co.arago.hiro.client.connection.token.AbstractTokenAPIHandler

co.arago.hiro.client.connection.token.FixedTokenAPIHandler

All Implemented Interfaces:

java.lang.AutoCloseable

public class FixedTokenAPIHandler
extends AbstractTokenAPIHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FixedTokenAPIHandler.Builder
static class	FixedTokenAPIHandler.Conf<T extends FixedTokenAPIHandler.Conf<T>>

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

AbstractClientAPIHandler.ProxySpec

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.String	token

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

connectTimeout, externalHttpClient, followRedirects, httpClient, httpLogger, maxConnectionPool, proxy, sslContext, 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	FixedTokenAPIHandler(FixedTokenAPIHandler.Conf<FixedTokenAPIHandler.Builder> builder)	Constructor

Method Summary

Modifier and Type	Method	Description
java.time.Instant	expiryInstant()	Calculate the Instant after which the token should be refreshed.
java.lang.String	getToken()	Return the current token.
boolean	hasRefreshToken()	Check for existence of a refresh token in the TokenAPIHandler.
boolean	hasToken()	Check for existence of a token in the TokenAPIHandler.
static FixedTokenAPIHandler.Conf<?>	newBuilder()
void	refreshToken()	Refresh an invalid token.
void	revokeToken()	Revoke a token

Methods inherited from class co.arago.hiro.client.connection.token.AbstractTokenAPIHandler

addToHeaders

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

getApiUriOf, getVersionMap, requestVersionMap

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

close, getHttpLogger, getOrBuildClient

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

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

token

protected final java.lang.String token

Constructor Detail

FixedTokenAPIHandler

protected FixedTokenAPIHandler(FixedTokenAPIHandler.Conf<FixedTokenAPIHandler.Builder> builder)

Constructor

Parameters:

builder - The builder to use.

Method Detail

newBuilder

public static FixedTokenAPIHandler.Conf<?> newBuilder()

getToken

public java.lang.String getToken()

Return the current token.

Specified by:

getToken in class AbstractTokenAPIHandler

Returns:

The current token.

refreshToken

public void refreshToken()
                  throws HiroException

Refresh an invalid token.

Specified by:

refreshToken in class AbstractTokenAPIHandler

Throws:

HiroException - On Hiro protocol / handling errors.

revokeToken

public void revokeToken()
                 throws HiroException

Revoke a token

Specified by:

revokeToken in class AbstractTokenAPIHandler

Throws:

HiroException - On Hiro protocol / handling errors.

hasToken

public boolean hasToken()

Check for existence of a token in the TokenAPIHandler.

Specified by:

hasToken in class AbstractTokenAPIHandler

Returns:

true if a token has been set or retrieved, false if the token is empty.

hasRefreshToken

public boolean hasRefreshToken()

Check for existence of a refresh token in the TokenAPIHandler.

Specified by:

hasRefreshToken in class AbstractTokenAPIHandler

Returns:

false

expiryInstant

public java.time.Instant expiryInstant()

Calculate the Instant after which the token should be refreshed.

Specified by:

expiryInstant in class AbstractTokenAPIHandler

Returns:

The Instant after which the token shall be refreshed. null if token cannot be refreshed.