Module org.neo4j.bolt.connection

Package org.neo4j.bolt.connection

Interface RoutedBoltConnectionParameters.Builder

All Superinterfaces:

BoltConnectionParameters.Builder

Enclosing interface:

RoutedBoltConnectionParameters

public static interface RoutedBoltConnectionParameters.Builder
extends BoltConnectionParameters.Builder

A builder for creating RoutedBoltConnectionParameters.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
RoutedBoltConnectionParameters	build()	Builds a new RoutedBoltConnectionParameters.
RoutedBoltConnectionParameters.Builder	withAccessMode(AccessMode accessMode)	Sets an AccessMode that the connection must support.
RoutedBoltConnectionParameters.Builder	withAuthToken(AuthToken authToken)	Sets an AuthToken that the given connection must use.
RoutedBoltConnectionParameters.Builder	withBookmarks(Set<String> bookmarks)	Sets routing bookmarks.
RoutedBoltConnectionParameters.Builder	withDatabaseName(DatabaseName databaseName)	Sets a database that the connection must lead to.
RoutedBoltConnectionParameters.Builder	withDatabaseNameListener(Consumer<DatabaseName> databaseNameListener)	Sets a database name consumer that will be notified with the database name used for the given connection.
RoutedBoltConnectionParameters.Builder	withHomeDatabaseHint(String homeDatabaseHint)	Sets a home database name hint.
RoutedBoltConnectionParameters.Builder	withImpersonatedUser(String impersonatedUser)	Sets impersonated user.
RoutedBoltConnectionParameters.Builder	withMinVersion(BoltProtocolVersion minVersion)	Sets an optional minimum BoltProtocolVersion that the connection must support.

Method Details

withAuthToken

RoutedBoltConnectionParameters.Builder withAuthToken(AuthToken authToken)

Sets an AuthToken that the given connection must use.

It is intended for cases when a specific AuthToken must be used that may differ from the BoltConnectionSource default one.

The default is null.

Specified by:

withAuthToken in interface BoltConnectionParameters.Builder

Parameters:

authToken - the AuthToken or null to use the BoltConnectionSource default one

Returns:

this builder

withMinVersion

RoutedBoltConnectionParameters.Builder withMinVersion(BoltProtocolVersion minVersion)

Sets an optional minimum BoltProtocolVersion that the connection must support.

The default is null.

Specified by:

withMinVersion in interface BoltConnectionParameters.Builder

Parameters:

minVersion - the minimum BoltProtocolVersion or null if there is no minimum

Returns:

this builder

withAccessMode

RoutedBoltConnectionParameters.Builder withAccessMode(AccessMode accessMode)

Sets an AccessMode that the connection must support.

The default is AccessMode.WRITE.

Parameters:

accessMode - the access mode

Returns:

this builder

withDatabaseName

RoutedBoltConnectionParameters.Builder withDatabaseName(DatabaseName databaseName)

Sets a database that the connection must lead to.

The default is null.

Parameters:

databaseName - the database name or null for home database

Returns:

this builder

withDatabaseNameListener

RoutedBoltConnectionParameters.Builder withDatabaseNameListener(Consumer<DatabaseName> databaseNameListener)

Sets a database name consumer that will be notified with the database name used for the given connection.

The default is a noop consumer.

Parameters:

databaseNameListener - the database name consumer

Returns:

this builder

withHomeDatabaseHint

RoutedBoltConnectionParameters.Builder withHomeDatabaseHint(String homeDatabaseHint)

Sets a home database name hint.

The default is null.

Parameters:

homeDatabaseHint - the home database hint or null

Returns:

this builder

withBookmarks

RoutedBoltConnectionParameters.Builder withBookmarks(Set<String> bookmarks)

Sets routing bookmarks.

The default is an empty set.

Parameters:

bookmarks - the bookmarks

Returns:

this builder

withImpersonatedUser

RoutedBoltConnectionParameters.Builder withImpersonatedUser(String impersonatedUser)

Sets impersonated user.

The default is null.

Parameters:

impersonatedUser - the impersonated user or null

Returns:

this builder

build

RoutedBoltConnectionParameters build()

Builds a new RoutedBoltConnectionParameters.

Specified by:

build in interface BoltConnectionParameters.Builder

Returns:

the new RoutedBoltConnectionParameters