Module org.neo4j.driver

Package org.neo4j.driver

Interface ClientCertificateManager

All Known Subinterfaces:

RotatingClientCertificateManager

public interface ClientCertificateManager

A manager of ClientCertificate instances used by the driver for mTLS.

The driver uses the ClientCertificate supplied by the manager for setting up new connections. Therefore, a change of the certificate affects subsequent new connections only.

The manager must never return null. Exceptions must be emitted via the CompletionStage only.

All implementations of this interface must be thread-safe and non-blocking for caller threads. For instance, IO operations must not done on the calling thread.

Since:

5.19

Method Summary

Modifier and Type	Method	Description
CompletionStage<ClientCertificate>	getClientCertificate()	Returns a CompletionStage of a new ClientCertificate.

Method Details

getClientCertificate

CompletionStage<ClientCertificate> getClientCertificate()

Returns a CompletionStage of a new ClientCertificate.

The first CompletionStage supplied to the driver must not complete with null to ensure the driver has the initial ClientCertificate.

Afterwards, the CompletionStage may complete with null to indicate no update. If the CompletionStage completes with ClientCertificate, the driver loads the supplied ClientCertificate.

Returns:

the certificate stage, must not be null