Module org.neo4j.driver

Package org.neo4j.driver

Class AuthTokenManagers

java.lang.Object

org.neo4j.driver.AuthTokenManagers

public final class AuthTokenManagers
extends Object

Implementations of AuthTokenManager.

Since:

5.8

Method Summary

Modifier and Type	Method	Description
static AuthTokenManager	basic(Supplier<AuthToken> newTokenSupplier)	Returns an AuthTokenManager that manages basic AuthToken instances.
static AuthTokenManager	basicAsync(Supplier<CompletionStage<AuthToken>> newTokenStageSupplier)	Returns an AuthTokenManager that manages basic AuthToken instances.
static AuthTokenManager	bearer(Supplier<AuthTokenAndExpiration> newTokenSupplier)	Returns an AuthTokenManager that manages bearer AuthToken instances with UTC expiration timestamp.
static AuthTokenManager	bearerAsync(Supplier<CompletionStage<AuthTokenAndExpiration>> newTokenStageSupplier)	Returns an AuthTokenManager that manages bearer AuthToken instances with UTC expiration timestamp.

Methods inherited from class java.lang.Object

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

Method Details

basic

public static AuthTokenManager basic(Supplier<AuthToken> newTokenSupplier)

Returns an AuthTokenManager that manages basic AuthToken instances.

The implementation will only use the token supplier when it needs a new token instance, which would happen if the server rejects the current token with AuthenticationException (see AuthTokenManager.handleSecurityException(AuthToken, SecurityException)). The provided supplier and its completion stages must be non-blocking as documented in the AuthTokenManager.

Parameters:

newTokenSupplier - a new token stage supplier

Returns:

a new token manager

Since:

5.12

basicAsync

public static AuthTokenManager basicAsync(Supplier<CompletionStage<AuthToken>> newTokenStageSupplier)

Returns an AuthTokenManager that manages basic AuthToken instances.

The implementation will only use the token supplier when it needs a new token instance, which would happen if the server rejects the current token with AuthenticationException (see AuthTokenManager.handleSecurityException(AuthToken, SecurityException)). The provided supplier and its completion stages must be non-blocking as documented in the AuthTokenManager.

Parameters:

newTokenStageSupplier - a new token stage supplier

Returns:

a new token manager

Since:

5.12

bearer

public static AuthTokenManager bearer(Supplier<AuthTokenAndExpiration> newTokenSupplier)

Returns an AuthTokenManager that manages bearer AuthToken instances with UTC expiration timestamp.

The implementation will only use the token supplier when it needs a new token instance. This includes the following conditions:

1. token's UTC timestamp is expired
2. server rejects the current token with either TokenExpiredException or AuthenticationException (see AuthTokenManager.handleSecurityException(AuthToken, SecurityException))

The supplier will be called by a task running in the ForkJoinPool.commonPool() as documented in the CompletableFuture.supplyAsync(Supplier).

Parameters:

newTokenSupplier - a new token supplier

Returns:

a new token manager

Since:

5.12

bearerAsync

public static AuthTokenManager bearerAsync(Supplier<CompletionStage<AuthTokenAndExpiration>> newTokenStageSupplier)

Returns an AuthTokenManager that manages bearer AuthToken instances with UTC expiration timestamp.

The implementation will only use the token supplier when it needs a new token instance. This includes the following conditions:

1. token's UTC timestamp is expired
2. server rejects the current token with either TokenExpiredException or AuthenticationException (see AuthTokenManager.handleSecurityException(AuthToken, SecurityException))

The provided supplier and its completion stages must be non-blocking as documented in the AuthTokenManager.

Parameters:

newTokenStageSupplier - a new token stage supplier

Returns:

a new token manager

Since:

5.12