Module org.neo4j.driver

Package org.neo4j.driver.internal.security

Class ExpirationBasedAuthTokenManager

java.lang.Object

org.neo4j.driver.internal.security.ExpirationBasedAuthTokenManager

All Implemented Interfaces:

AuthTokenManager

public class ExpirationBasedAuthTokenManager
extends Object
implements AuthTokenManager

Constructor Summary

Constructors

Constructor	Description
ExpirationBasedAuthTokenManager(Supplier<CompletionStage<AuthTokenAndExpiration>> freshTokenSupplier, Clock clock)

Method Summary

Modifier and Type	Method	Description
CompletionStage<AuthToken>	getToken()	Returns a CompletionStage for a valid AuthToken.
void	onExpired(AuthToken authToken)	Handles an error notification emitted by the server if the token is expired.

Methods inherited from class java.lang.Object

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

Constructor Details

ExpirationBasedAuthTokenManager

public ExpirationBasedAuthTokenManager(Supplier<CompletionStage<AuthTokenAndExpiration>> freshTokenSupplier,
 Clock clock)

Method Details

getToken

public CompletionStage<AuthToken> getToken()

Description copied from interface: AuthTokenManager

Returns a CompletionStage for a valid AuthToken.

Driver invokes this method often to check if token has changed.

Failures will surface via the driver API, like Session.beginTransaction() method and others.

Specified by:

getToken in interface AuthTokenManager

Returns:

a stage for a valid token, must not be null or complete with null

See Also:

• AuthTokenManagerExecutionException

onExpired

public void onExpired(AuthToken authToken)

Description copied from interface: AuthTokenManager

Handles an error notification emitted by the server if the token is expired.

This will be called when driver emits the TokenExpiredRetryableException.

Specified by:

onExpired in interface AuthTokenManager

Parameters:

authToken - the expired token