Module org.neo4j.driver

Package org.neo4j.driver.internal.bolt.basicimpl.messaging.v3

Class BoltProtocolV3

java.lang.Object

org.neo4j.driver.internal.bolt.basicimpl.messaging.v3.BoltProtocolV3

All Implemented Interfaces:

BoltProtocol

Direct Known Subclasses:

BoltProtocolV4

public class BoltProtocolV3
extends Object
implements BoltProtocol

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	BoltProtocolV3.Query

Field Summary

Fields

Modifier and Type	Field	Description
static final BoltProtocol	INSTANCE
static final MetadataExtractor	METADATA_EXTRACTOR
static final BoltProtocolVersion	VERSION

Constructor Summary

Constructors

Constructor	Description
BoltProtocolV3()

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	beginTransaction(Connection connection, DatabaseName databaseName, AccessMode accessMode, String impersonatedUser, Set<String> bookmarks, Duration txTimeout, Map<String,Value> txMetadata, String txType, NotificationConfig notificationConfig, MessageHandler<Void> handler, LoggingProvider logging)
CompletionStage<Void>	commitTransaction(Connection connection, MessageHandler<String> handler)
MessageFormat	createMessageFormat()
CompletionStage<Void>	discard(Connection connection, long qid, long number, MessageHandler<DiscardSummary> handler)
protected boolean	includeDateTimeUtcPatchInHello()
CompletionStage<io.netty.channel.Channel>	initializeChannel(io.netty.channel.Channel channel, String userAgent, BoltAgent boltAgent, Map<String,Value> authMap, RoutingContext routingContext, NotificationConfig notificationConfig, Clock clock, CompletableFuture<Long> latestAuthMillisFuture)
CompletionStage<Void>	pull(Connection connection, long qid, long request, PullMessageHandler handler)
CompletionStage<Void>	reset(Connection connection, MessageHandler<Void> handler)
CompletionStage<Void>	rollbackTransaction(Connection connection, MessageHandler<Void> handler)
CompletionStage<Void>	route(Connection connection, Map<String,Value> routingContext, Set<String> bookmarks, String databaseName, String impersonatedUser, MessageHandler<RouteSummary> handler, Clock clock, LoggingProvider logging)
CompletionStage<Void>	run(Connection connection, String query, Map<String,Value> parameters, MessageHandler<RunSummary> handler)
CompletionStage<Void>	runAuto(Connection connection, DatabaseName databaseName, AccessMode accessMode, String impersonatedUser, String query, Map<String,Value> parameters, Set<String> bookmarks, Duration txTimeout, Map<String,Value> txMetadata, NotificationConfig notificationConfig, MessageHandler<RunSummary> handler, LoggingProvider logging)
CompletionStage<Void>	telemetry(Connection connection, Integer api, MessageHandler<Void> handler)
protected boolean	useLegacyNotifications()
protected void	verifyDatabaseNameBeforeTransaction(DatabaseName databaseName)
protected Neo4jException	verifyNotificationConfigSupported(NotificationConfig notificationConfig)
BoltProtocolVersion	version()	Returns the protocol version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.neo4j.driver.internal.bolt.basicimpl.messaging.BoltProtocol

logoff, logon

Field Details

VERSION

public static final BoltProtocolVersion VERSION

INSTANCE

public static final BoltProtocol INSTANCE

METADATA_EXTRACTOR

public static final MetadataExtractor METADATA_EXTRACTOR

Constructor Details

BoltProtocolV3

public BoltProtocolV3()

Method Details

createMessageFormat

public MessageFormat createMessageFormat()

Specified by:

createMessageFormat in interface BoltProtocol

initializeChannel

public CompletionStage<io.netty.channel.Channel> initializeChannel(io.netty.channel.Channel channel,
 String userAgent,
 BoltAgent boltAgent,
 Map<String,Value> authMap,
 RoutingContext routingContext,
 NotificationConfig notificationConfig,
 Clock clock,
 CompletableFuture<Long> latestAuthMillisFuture)

Specified by:

initializeChannel in interface BoltProtocol

route

public CompletionStage<Void> route(Connection connection,
 Map<String,Value> routingContext,
 Set<String> bookmarks,
 String databaseName,
 String impersonatedUser,
 MessageHandler<RouteSummary> handler,
 Clock clock,
 LoggingProvider logging)

Specified by:

route in interface BoltProtocol

beginTransaction

public CompletionStage<Void> beginTransaction(Connection connection,
 DatabaseName databaseName,
 AccessMode accessMode,
 String impersonatedUser,
 Set<String> bookmarks,
 Duration txTimeout,
 Map<String,Value> txMetadata,
 String txType,
 NotificationConfig notificationConfig,
 MessageHandler<Void> handler,
 LoggingProvider logging)

Specified by:

beginTransaction in interface BoltProtocol

commitTransaction

public CompletionStage<Void> commitTransaction(Connection connection,
 MessageHandler<String> handler)

Specified by:

commitTransaction in interface BoltProtocol

rollbackTransaction

public CompletionStage<Void> rollbackTransaction(Connection connection,
 MessageHandler<Void> handler)

Specified by:

rollbackTransaction in interface BoltProtocol

reset

public CompletionStage<Void> reset(Connection connection,
 MessageHandler<Void> handler)

Specified by:

reset in interface BoltProtocol

telemetry

public CompletionStage<Void> telemetry(Connection connection,
 Integer api,
 MessageHandler<Void> handler)

Specified by:

telemetry in interface BoltProtocol

runAuto

public CompletionStage<Void> runAuto(Connection connection,
 DatabaseName databaseName,
 AccessMode accessMode,
 String impersonatedUser,
 String query,
 Map<String,Value> parameters,
 Set<String> bookmarks,
 Duration txTimeout,
 Map<String,Value> txMetadata,
 NotificationConfig notificationConfig,
 MessageHandler<RunSummary> handler,
 LoggingProvider logging)

Specified by:

runAuto in interface BoltProtocol

run

public CompletionStage<Void> run(Connection connection,
 String query,
 Map<String,Value> parameters,
 MessageHandler<RunSummary> handler)

Specified by:

run in interface BoltProtocol

pull

public CompletionStage<Void> pull(Connection connection,
 long qid,
 long request,
 PullMessageHandler handler)

Specified by:

pull in interface BoltProtocol

discard

public CompletionStage<Void> discard(Connection connection,
 long qid,
 long number,
 MessageHandler<DiscardSummary> handler)

Specified by:

discard in interface BoltProtocol

verifyDatabaseNameBeforeTransaction

protected void verifyDatabaseNameBeforeTransaction(DatabaseName databaseName)

version

public BoltProtocolVersion version()

Description copied from interface: BoltProtocol

Returns the protocol version. It can be used for version specific error messages.

Specified by:

version in interface BoltProtocol

Returns:

the protocol version.

includeDateTimeUtcPatchInHello

protected boolean includeDateTimeUtcPatchInHello()

verifyNotificationConfigSupported

protected Neo4jException verifyNotificationConfigSupported(NotificationConfig notificationConfig)

useLegacyNotifications

protected boolean useLegacyNotifications()