com.ibm.cloud.objectstorage.oauth

Class DefaultTokenManager

java.lang.Object

com.ibm.cloud.objectstorage.oauth.DefaultTokenManager

All Implemented Interfaces:

TokenManager

public class DefaultTokenManager
extends Object
implements TokenManager

Default implementation of Token Manager. This design will allow the class to be created with multiple constructors, yet only one instance can be created. The DefaultTokenProvider is used to retrieve the token from the IAM Service which uses the api key method. A client can also use their own implementation of TokenHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected static InternalLogApi	log

Constructor Summary

Constructors

Constructor and Description
DefaultTokenManager(String apiKey) Default constructor using the apiKey.
DefaultTokenManager(TokenProvider provider) Constructor which will allow a custom TokenHandler to retrieve the token from the IAM Service

Method Summary

Modifier and Type	Method and Description
static void	addProxyConfig(org.apache.http.impl.client.HttpClientBuilder builder, HttpClientSettings settings) Add a proxy to the http request if it has been set within settings
protected void	cacheToken(Token token) Add the Token object to in-memory cache
protected boolean	checkCache() Check if cache has a Token object stored
protected void	finalize()
protected Token	getCachedToken()
ClientConfiguration	getClientConfiguration() Client config to customise the IAM Client
TokenProvider	getProvider() Return the TokenProvider used by the TokenManager
String	getToken() Retrieve the access token String from the OAuth2 token object
protected boolean	hasTokenExpired(Token token) Check if the current cached token has expired.
protected boolean	isAsyncInProgress() boolean value to signal if the async refresh method is already in use
protected boolean	isTokenExpiring(Token token) Check if the current cached token is expiring in less than the given offset.
protected void	retrieveToken() retrieve token from provider.
protected Token	retrieveTokenFromCache() Retrieve the IAM token from cache storage
void	setClientConfiguration(ClientConfiguration clientConfiguration) Set the client config that is been used on the s3client
void	setIamEndpoint(String iamEndpoint) Overwrite the default IAM endpoint.
void	setIamMaxRetry(int count) Over write the default IAM max retry count.
void	setIamRefreshOffset(double offset) Over write the default IAM refresh offset.
protected void	setTokenCache(Token token)
protected void	submitRefreshTask() Submits a token refresh task

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final InternalLogApi log

Constructor Detail

DefaultTokenManager

public DefaultTokenManager(String apiKey)

Default constructor using the apiKey. This instance will use the DefaultTokenProvider to retrieve the access token.

Parameters:

apiKey - The IBM API Key

DefaultTokenManager

public DefaultTokenManager(TokenProvider provider)

Constructor which will allow a custom TokenHandler to retrieve the token from the IAM Service

Parameters:

provider - The Token Provider which will retrieve the Token Object from the IAM service

Method Detail

setIamEndpoint

public void setIamEndpoint(String iamEndpoint)

Overwrite the default IAM endpoint. This should only be done in a development or staging environment

Parameters:

iamEndpoint - The http endpoint to retrieve the token

setIamRefreshOffset

public void setIamRefreshOffset(double offset)

Over write the default IAM refresh offset. This should only be done in a development or staging environment

Parameters:

offset - The percentage of token life that token should be refreshed before expiration.

setIamMaxRetry

public void setIamMaxRetry(int count)

Over write the default IAM max retry count. This should only be done in a development or staging environment

Parameters:

offset - The max number of times to attempt IAM token retrieval.

getProvider

public TokenProvider getProvider()

Return the TokenProvider used by the TokenManager

getToken

public String getToken()

Retrieve the access token String from the OAuth2 token object

Specified by:

getToken in interface TokenManager

Returns:

String An access token String value

checkCache

protected boolean checkCache()

Check if cache has a Token object stored

Returns:

boolean Indicates if the Token has been cached

cacheToken

protected void cacheToken(Token token)

Add the Token object to in-memory cache

Parameters:

token - The IAM Token object

retrieveTokenFromCache

protected Token retrieveTokenFromCache()

Retrieve the IAM token from cache storage

Returns:

Token The IAM Token object

hasTokenExpired

protected boolean hasTokenExpired(Token token)

Check if the current cached token has expired. If it has a synchronous http call is made to the IAM service to retrieve & store a new token

Parameters:

token - The IAM Token object

Returns:

boolean Indicates if the currently cached token has expired

isTokenExpiring

protected boolean isTokenExpiring(Token token)

Check if the current cached token is expiring in less than the given offset. If it is, an asynchronous call is made to the IAM service to update the cache.

Parameters:

token - The IAM Token object

Returns:

boolean Indicates if the currently cached token is due refresh

getCachedToken

protected Token getCachedToken()

Returns:

boolean currently cached Token object

setTokenCache

protected void setTokenCache(Token token)

Parameters:

token - Sets the Token object in cache

retrieveToken

protected void retrieveToken()

retrieve token from provider. Ensures each thread checks the token is null prior to making the callout to IAM

submitRefreshTask

protected void submitRefreshTask()

Submits a token refresh task

isAsyncInProgress

protected boolean isAsyncInProgress()

boolean value to signal if the async refresh method is already in use

Returns:

boolean

getClientConfiguration

public ClientConfiguration getClientConfiguration()

Client config to customise the IAM Client

Returns:

setClientConfiguration

public void setClientConfiguration(ClientConfiguration clientConfiguration)

Set the client config that is been used on the s3client

Parameters:

clientConfiguration -

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

addProxyConfig

public static void addProxyConfig(org.apache.http.impl.client.HttpClientBuilder builder,
                                  HttpClientSettings settings)

Add a proxy to the http request if it has been set within settings

Parameters:

builder - Builder used to create the http client

settings - Settings which contain any proxy configuration details