Module org.neo4j.bolt.connection

Package org.neo4j.bolt.connection

Interface BoltConnectionSource<T extends BoltConnectionParameters>

Type Parameters:

T - the type of parameters supported

public interface BoltConnectionSource<T extends BoltConnectionParameters>

A source of Neo4j Bolt Protocol connections, typically to a specific Neo4j DBMS or Neo4j server.

There are two main types of implementations at the moment:

1. Pooling implementation - supplies BoltConnection instance that is pooled automatically.
2. Routing implementation - supplies BoltConnection instance that connects to a Neo4j DBMS cluster member that is selected based on automatically managed routing table information and the RoutedBoltConnectionParameters provided by the user.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	close()	Closes the BoltConnectionSource instance.
CompletionStage<BoltConnection>	getConnection()	Gets BoltConnection from the source.
CompletionStage<BoltConnection>	getConnection(T parameters)	Gets BoltConnection from the source using the provided BoltConnectionParameters.
CompletionStage<Boolean>	supportsMultiDb()	Checks if there is a BoltConnection that supports multi database feature.
CompletionStage<Boolean>	supportsSessionAuth()	Checks if there is a BoltConnection that supports re-auth feature.
CompletionStage<Void>	verifyConnectivity()	Verifies connectivity.

Method Details

getConnection

CompletionStage<BoltConnection> getConnection()

Gets BoltConnection from the source.

Returns:

the BoltConnection

getConnection

CompletionStage<BoltConnection> getConnection(T parameters)

Gets BoltConnection from the source using the provided BoltConnectionParameters.

Parameters:

parameters - the BoltConnectionParameters

Returns:

the BoltConnection

verifyConnectivity

CompletionStage<Void> verifyConnectivity()

Verifies connectivity.

Returns:

the CompletionStage that fails of there is an issue

supportsMultiDb

CompletionStage<Boolean> supportsMultiDb()

Checks if there is a BoltConnection that supports multi database feature.

Returns:

the CompletionStage

supportsSessionAuth

CompletionStage<Boolean> supportsSessionAuth()

Checks if there is a BoltConnection that supports re-auth feature.

Returns:

the CompletionStage

close

CompletionStage<Void> close()

Closes the BoltConnectionSource instance.

Returns:

the close CompletionStage