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, Set<Class<? extends SecurityException>> retryableExceptionClasses, Clock clock)

Method Summary

Modifier and Type	Method	Description
CompletionStage<AuthToken>	getToken()	Returns a CompletionStage for a valid AuthToken.
boolean	handleSecurityException(AuthToken authToken, SecurityException exception)	Handles SecurityException that is created based on the server's security error response by determining if the given error may be resolved upon next AuthTokenManager.getToken() invokation.

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,
 Set<Class<? extends SecurityException>> retryableExceptionClasses,
 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

handleSecurityException

public boolean handleSecurityException(AuthToken authToken,
 SecurityException exception)

Description copied from interface: AuthTokenManager

Handles SecurityException that is created based on the server's security error response by determining if the given error may be resolved upon next AuthTokenManager.getToken() invokation.

If this method returns true, the driver wraps the original SecurityException in SecurityRetryableException. The managed transaction API (like Session.executeRead(TransactionCallback), etc.) automatically retries its unit of work if no other condition is violated, while the other query execution APIs surface this error for external handling.

If this method returns false, the original error remains unchanged.

This method must not throw exceptions.

Specified by:

handleSecurityException in interface AuthTokenManager

Parameters:

authToken - the current token

exception - the security exception

Returns:

true if the exception should be marked as retryable or false if it should remain unchanged