Module org.neo4j.driver

Package org.neo4j.driver

Class AuthTokenManagers

java.lang.Object

org.neo4j.driver.AuthTokenManagers

@Preview(name="AuthToken rotation and session auth support")
public final class AuthTokenManagers
extends Object

Implementations of AuthTokenManager.

Since:

5.8

Method Summary

Modifier and Type	Method	Description
static AuthTokenManager	expirationBased(Supplier<AuthTokenAndExpiration> newTokenSupplier)	Returns an AuthTokenManager that manages AuthToken instances with UTC expiration timestamp.
static AuthTokenManager	expirationBasedAsync(Supplier<CompletionStage<AuthTokenAndExpiration>> newTokenStageSupplier)	Returns an AuthTokenManager that manages 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

expirationBased

public static AuthTokenManager expirationBased(Supplier<AuthTokenAndExpiration> newTokenSupplier)

Returns an AuthTokenManager that manages 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 (see AuthTokenManager.onExpired(AuthToken))

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

expirationBasedAsync

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

Returns an AuthTokenManager that manages 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 (see AuthTokenManager.onExpired(AuthToken))

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