redis.clients.authentication.core

Class TokenManager

java.lang.Object

redis.clients.authentication.core.TokenManager

public class TokenManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TokenManager(IdentityProvider identityProvider, TokenManagerConfig tokenManagerConfig)

Method Summary

Modifier and Type	Method and Description
long	calculateRenewalDelay(long expireDate, long issueDate) This method calculates the duration we need to wait for requesting the next token.
TokenManagerConfig	getConfig()
Token	getCurrentToken()
protected Token	renewToken() This method is called by the renewal scheduler Dispatches a request to the identity provider asynchronously, with a timeout for execution, and returns the Token if successfully acquired.
void	start(TokenListener listener, boolean blockForInitialToken) Starts the token manager with given listener, blocks if blockForInitialToken is true
void	stop()
protected long	ttlForLowerRefresh(long expireDate) This method calculates TTL to renewal zone based on a minimum duration to token expiration.
protected long	ttlForRatioRefresh(long expireDate, long issueDate) This method calculates TTL to renewal zone based on a ratio.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenManager

public TokenManager(IdentityProvider identityProvider,
                    TokenManagerConfig tokenManagerConfig)

Method Detail

start

public void start(TokenListener listener,
                  boolean blockForInitialToken)

Starts the token manager with given listener, blocks if blockForInitialToken is true

Parameters:

listener -

blockForInitialToken -

renewToken

protected Token renewToken()

This method is called by the renewal scheduler Dispatches a request to the identity provider asynchronously, with a timeout for execution, and returns the Token if successfully acquired. If the request fails, it retries until the max number of retries is reached If the request fails after max number of retries, it throws an exception When a new Token is received, it schedules the next renewal with calculating the delay in respect to the new token. Scheduling cycle only ends under two conditions: 1. TokenManager is stopped 2. Token renewal fails for max number of retries

Returns:

getConfig

public TokenManagerConfig getConfig()

getCurrentToken

public Token getCurrentToken()

stop

public void stop()

calculateRenewalDelay

public long calculateRenewalDelay(long expireDate,
                                  long issueDate)

This method calculates the duration we need to wait for requesting the next token. Token acquisition and authentication with the new token should be completed before the current token expires. We define a time window between a point in time(T) and the token's expiration time. Let's call this the "renewal zone." The goal is to trigger a token renewal anytime soon within this renewal zone. This is necessary to avoid situations where connections are running on an AUTH where token has already expired. The method calculates the delay to the renewal zone based on two different strategies and returns the minimum of them. If the calculated delay is somehow negative, it returns 0 to trigger the renewal immediately.

Parameters:

expireDate -

issueDate -

Returns:

ttlForLowerRefresh

protected long ttlForLowerRefresh(long expireDate)

This method calculates TTL to renewal zone based on a minimum duration to token expiration. The suggested renewal zone here starts LowerRefreshBoundMillis(given in configuration) before the token expiration time. As example we have 1 hour left to token expiration and LowerRefreshBoundMillis is configured as 10 minutes, renewal zone will start in 50 minutes from now. This is the return value, 50 minutes TTL to renewal zone.

Parameters:

expireDate -

Returns:

ttlForRatioRefresh

protected long ttlForRatioRefresh(long expireDate,
                                  long issueDate)

This method calculates TTL to renewal zone based on a ratio. The ExpirationRefreshRatio value in config, indicates the ratio of intended usage of token's total lifetime between receive/issue time and expiration time. The suggested renewal zone here starts right after the token completes the given ratio of its total valid duration starting from issue time till expiration. As example we have a token with 1 hour total valid time and it already reach to half life, which lefts 30 minutes to token expiration. ExpirationRefreshRatio is configured as 0.8, means token will be in use for first 48 minutes of its valid duration. It needs to renew 12 minutes before the expiration. This makes it is 30 minutes left to expiration and 18 minutes left to renewal zone. Return value is 18 minutes TTL to renewal zone.

Parameters:

expireDate -

issueDate -

Returns: