Module org.neo4j.bolt.connection

Package org.neo4j.bolt.connection

Interface BoltConnectionParameters.Builder

All Known Subinterfaces:

RoutedBoltConnectionParameters.Builder

Enclosing interface:

BoltConnectionParameters

public static interface BoltConnectionParameters.Builder

A builder for creating BoltConnectionParameters.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
BoltConnectionParameters	build()	Builds a new BoltConnectionParameters.
BoltConnectionParameters.Builder	withAuthToken(AuthToken authToken)	Sets an AuthToken that the given connection must use.
BoltConnectionParameters.Builder	withMinVersion(BoltProtocolVersion minVersion)	Sets an optional minimum BoltProtocolVersion that the connection must support.

Method Details

withAuthToken

BoltConnectionParameters.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.

Parameters:

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

Returns:

this builder

withMinVersion

BoltConnectionParameters.Builder withMinVersion(BoltProtocolVersion minVersion)

Sets an optional minimum BoltProtocolVersion that the connection must support.

The default is null.

Parameters:

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

Returns:

this builder

build

BoltConnectionParameters build()

Builds a new BoltConnectionParameters.

Returns:

the new BoltConnectionParameters