Module org.neo4j.bolt.connection

Package org.neo4j.bolt.connection

Interface BoltConnectionParameters

All Known Subinterfaces:

RoutedBoltConnectionParameters

public interface BoltConnectionParameters

A set of parameters used by BoltConnectionSource when getting BoltConnection.

Since:

4.0.0

See Also:

• BoltConnectionSource
• RoutedBoltConnectionParameters

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BoltConnectionParameters.Builder	A builder for creating BoltConnectionParameters.

Method Summary

Modifier and Type	Method	Description
AuthToken	authToken()	An optional AuthToken that the given connection must use.
static BoltConnectionParameters.Builder	builder()	Returns a new BoltConnectionParameters.Builder instance.
static BoltConnectionParameters	defaultParameters()	Returns default BoltConnectionParameters.
BoltProtocolVersion	minVersion()	An optional minimum BoltProtocolVersion that the connection must support.

Method Details

authToken

AuthToken authToken()

An optional 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.

BoltConnectionSource might pipeline Messages.logoff() and Messages.logon(AuthToken) when it already has a suitable BoltConnection, the ResponseHandler must handle response errors in such cases.

Returns:

an optional AuthToken or null if BoltConnectionSource default should be used

minVersion

BoltProtocolVersion minVersion()

An optional minimum BoltProtocolVersion that the connection must support.

Returns:

an Optional of BoltProtocolVersion

defaultParameters

static BoltConnectionParameters defaultParameters()

Returns default BoltConnectionParameters.

Returns:

the default BoltConnectionParameters

builder

static BoltConnectionParameters.Builder builder()

Returns a new BoltConnectionParameters.Builder instance.

Returns:

a new builder