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

Class PasswordAuthTokenAPIHandler.Conf<T extends PasswordAuthTokenAPIHandler.Conf<T>>

java.lang.Object

co.arago.hiro.client.connection.AbstractAPIHandler.Conf<T>

co.arago.hiro.client.connection.AbstractClientAPIHandler.Conf<T>

co.arago.hiro.client.connection.AbstractVersionAPIHandler.Conf<T>

co.arago.hiro.client.connection.token.AbstractTokenAPIHandler.Conf<T>

co.arago.hiro.client.connection.token.PasswordAuthTokenAPIHandler.Conf<T>

All Implemented Interfaces:

AbstractAPIHandler.GetterConf

Direct Known Subclasses:

PasswordAuthTokenAPIHandler.Builder

Enclosing class:

PasswordAuthTokenAPIHandler

public abstract static class PasswordAuthTokenAPIHandler.Conf<T extends PasswordAuthTokenAPIHandler.Conf<T>>
extends AbstractTokenAPIHandler.Conf<T>

Field Summary

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

acceptAllCerts, connectTimeout, followRedirects, httpClient, maxBinaryLogLength, maxConnectionPool, proxy, sslContext, sslParameters

Constructor Summary

Constructors

Constructor	Description
Conf()

Method Summary

Modifier and Type	Method	Description
abstract PasswordAuthTokenAPIHandler	build()
java.lang.String	getApiPath()
java.lang.String	getClientId()
java.lang.String	getClientSecret()
boolean	getForceLogging()
java.lang.String	getPassword()
java.lang.Long	getRefreshOffset()
java.lang.Long	getRefreshPause()
java.lang.String	getUsername()
T	setApiPath(java.lang.String apiPath)
T	setClientId(java.lang.String clientId)
T	setClientSecret(java.lang.String clientSecret)
T	setCredentials(java.lang.String username, java.lang.String password, java.lang.String clientId, java.lang.String clientSecret)	Shorthand to set all credentials at once.
T	setForceLogging(boolean forceLogging)	Force logging of insecure request / response data.
T	setPassword(java.lang.String password)
T	setRefreshOffset(java.lang.Long refreshOffset)	Timespan that gets subtracted from the official expiration instant of a token so the token can be refreshed before it runs out.
T	setRefreshPause(java.lang.Long refreshPause)	Timespan where calls to refresh the token will be ignored and only the current token will be returned.
T	setUsername(java.lang.String username)

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

getAcceptAllCerts, getConnectTimeout, getHttpClient, getMaxBinaryLogLength, getMaxConnectionPool, getSslContext, getSslParameters, isFollowRedirects, setAcceptAllCerts, setConnectTimeout, setFollowRedirects, setHttpClient, setMaxBinaryLogLength, setMaxConnectionPool, setProxy, setSslContext, setSslParameters

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

getApiUrl, getHttpRequestTimeout, getMaxRetries, getUserAgent, getWebSocketUri, self, setApiUrl, setApiUrl, setHttpRequestTimeout, setMaxRetries, setUserAgent, setWebSocketUri, setWebSocketUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

Conf

public Conf()

Method Detail

getUsername

public java.lang.String getUsername()

setUsername

public T setUsername(java.lang.String username)

Parameters:

username - HIRO username for user account

Returns:

AbstractAPIHandler.Conf.self()

getPassword

public java.lang.String getPassword()

setPassword

public T setPassword(java.lang.String password)

Parameters:

password - HIRO password for user account

Returns:

AbstractAPIHandler.Conf.self()

getClientId

public java.lang.String getClientId()

setClientId

public T setClientId(java.lang.String clientId)

Parameters:

clientId - HIRO client_id of app

Returns:

AbstractAPIHandler.Conf.self()

getClientSecret

public java.lang.String getClientSecret()

setClientSecret

public T setClientSecret(java.lang.String clientSecret)

Parameters:

clientSecret - HIRO client_secret of app

Returns:

AbstractAPIHandler.Conf.self()

setCredentials

public T setCredentials(java.lang.String username,
                        java.lang.String password,
                        java.lang.String clientId,
                        java.lang.String clientSecret)

Shorthand to set all credentials at once.

Parameters:

username - HIRO username for user account

password - HIRO password for user account

clientId - HIRO client_id of app

clientSecret - HIRO client_secret of app

Returns:

AbstractAPIHandler.Conf.self()

getRefreshOffset

public java.lang.Long getRefreshOffset()

setRefreshOffset

public T setRefreshOffset(java.lang.Long refreshOffset)

Timespan that gets subtracted from the official expiration instant of a token so the token can be refreshed before it runs out. Default is 5000 (5s).

Parameters:

refreshOffset - Offset in ms

Returns:

AbstractAPIHandler.Conf.self()

getRefreshPause

public java.lang.Long getRefreshPause()

setRefreshPause

public T setRefreshPause(java.lang.Long refreshPause)

Timespan where calls to refresh the token will be ignored and only the current token will be returned. Avoids refresh floods that can happen with multiple threads using the same TokenAPIHandler. Default is 30000 (30s).

Parameters:

refreshPause - Buffer span in ms

Returns:

AbstractAPIHandler.Conf.self()

getForceLogging

public boolean getForceLogging()

setForceLogging

public T setForceLogging(boolean forceLogging)

Force logging of insecure request / response data. USE ONLY FOR DEBUGGING PURPOSES!!!

Parameters:

forceLogging - the flag to set.

Returns:

AbstractAPIHandler.Conf.self()

getApiPath

public java.lang.String getApiPath()

setApiPath

public T setApiPath(java.lang.String apiPath)

Parameters:

apiPath - The apiPath set externally. Overrides the fetching of the endpoint via /api/version.

Returns:

AbstractAPIHandler.Conf.self()

build

public abstract PasswordAuthTokenAPIHandler build()

Specified by:

build in class AbstractTokenAPIHandler.Conf<T extends PasswordAuthTokenAPIHandler.Conf<T>>