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

Class PasswordAuthTokenAPIHandler

java.lang.Object

co.arago.hiro.client.connection.AbstractAPIHandler

co.arago.hiro.client.connection.AbstractVersionAPIHandler

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

co.arago.hiro.client.connection.token.AbstractRemoteAuthTokenAPIHandler

co.arago.hiro.client.connection.token.PasswordAuthTokenAPIHandler

All Implemented Interfaces:

TokenAPIHandler, java.lang.AutoCloseable

public class PasswordAuthTokenAPIHandler
extends AbstractRemoteAuthTokenAPIHandler

Nested Class Summary

Nested Classes

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

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

AbstractRemoteAuthTokenAPIHandler.TokenInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	password
protected java.lang.String	username

Fields inherited from class co.arago.hiro.client.connection.token.AbstractRemoteAuthTokenAPIHandler

apiName, apiPath, apiURI, clientId, clientSecret, organization, organizationId, tokenInfo

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

httpClientHandler, httpRequestTimeout, maxRetries, rootApiURI, title, userAgent, version, webSocketURI

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static PasswordAuthTokenAPIHandler.Conf<?>	newBuilder()
protected void	requestToken(java.lang.String organization, java.lang.String organizationId)	Obtain a new token from the auth API.

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

checkResponse, expiryInstant, getRefreshOffset, getRefreshToken, getToken, getURI, hasRefreshToken, hasToken, refreshToken, refreshToken, revokeToken, revokeToken, setRefreshOffset, tokenExpired

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

addToHeaders, close, decodeToken

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

getApiURIOf, getVersionMap, requestVersionMap

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

addQueryFragmentAndNormalize, buildApiURI, buildEndpointURI, buildURI, buildWebSocketURI, delete, executeAsyncWithStreamBody, executeAsyncWithStringBody, executeBinary, executeWithStreamBody, executeWithStringBody, get, getBinary, getConf, getHttpLogger, getHttpRequestTimeout, getMaxRetries, getOrBuildClient, getRequestBuilder, getRootApiURI, getUserAgent, getWebSocketURI, patch, patchBinary, post, postBinary, put, putBinary, send, sendAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.arago.hiro.client.connection.token.TokenAPIHandler

buildWebSocketURI, getApiURIOf, getConf, getOrBuildClient, getRootApiURI, getUserAgent, getVersionMap

Field Detail

username

protected final java.lang.String username

password

protected final java.lang.String password

Constructor Detail

PasswordAuthTokenAPIHandler

protected PasswordAuthTokenAPIHandler(PasswordAuthTokenAPIHandler.Conf<?> builder)

Method Detail

newBuilder

public static PasswordAuthTokenAPIHandler.Conf<?> newBuilder()

requestToken

protected void requestToken(java.lang.String organization,
                            java.lang.String organizationId)
                     throws java.io.IOException,
                            java.lang.InterruptedException,
                            HiroException

Obtain a new token from the auth API.

Specified by:

requestToken in class AbstractRemoteAuthTokenAPIHandler

Parameters:

organization - : Optional organization name. May be null.

organizationId - : Optional organization id. May be null.

Throws:

java.lang.InterruptedException - When call gets interrupted.

java.io.IOException - When call has IO errors.

HiroException - On Hiro protocol / handling errors.