org.neo4j.bolt.protocol.common.BoltProtocol Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-bolt Show documentation
Show all versions of neo4j-bolt Show documentation
The core of Neo4j Bolt Protocol, this contains the state machine for Bolt sessions.
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [https://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see available() {
return List.of(
BoltProtocolV40.getInstance(),
BoltProtocolV41.getInstance(),
BoltProtocolV42.getInstance(),
BoltProtocolV43.getInstance(),
BoltProtocolV44.getInstance(),
BoltProtocolV50.getInstance(),
BoltProtocolV51.getInstance(),
BoltProtocolV52.getInstance(),
BoltProtocolV53.getInstance(),
BoltProtocolV54.getInstance(),
BoltProtocolV56.getInstance(),
BoltProtocolV57.getInstance(),
BoltProtocolV58.getInstance());
}
/**
* Identifies the version number via which this protocol implementation is identified during the negotiation process.
*
* @return a protocol version number.
*/
ProtocolVersion version();
/**
* Retrieves a set of features which are always enabled on this connection regardless of whether they have been
* negotiated or not.
*
* Note: Features listed within this set are effectively blacklisted (e.g. cannot be negotiated later) and should
* thus be provided through reader/writer pipeline configurators within the protocol implementations rather than
* relying on the configuration functions provided by {@link Feature}.
*
* @return a set of features.
*/
default Set features() {
return Set.of(Feature.UTC_DATETIME);
}
/**
* Retrieves a predicate which selects the frame signals supported by the protocol version.
*
* @return a signal predicate.
*/
default Predicate frameSignalFilter() {
// filter none of the passed signals (e.g. all features are supported)
return signal -> false;
}
StateMachineConfiguration stateMachine();
/**
* Retrieves the struct registry which provides read capabilities for request messages.
*
* @return a struct registry.
*/
StructRegistry requestMessageRegistry();
/**
* Retrieves the struct registry which provides write capabilities for response messages.
*
* @return a struct registry.
*/
StructRegistry responseMessageRegistry();
/**
* Registers protocol specific struct readers for decoding of values sent to the server by a client.
*
* @param builder a struct registry.
*/
default void registerStructReaders(StructRegistry.Builder builder) {
builder.register(DateReader.getInstance())
.register(DurationReader.getInstance())
.register(LocalDateTimeReader.getInstance())
.register(LocalTimeReader.getInstance())
.register(Point2dReader.getInstance())
.register(Point3dReader.getInstance())
.register(TimeReader.getInstance())
.register(DateTimeReader.getInstance())
.register(DateTimeZoneIdReader.getInstance());
}
/**
* Registers protocol specific struct writers for encoding of values through the result streaming APIs.
*
* @param pipeline a writer pipeline.
*/
default void registerStructWriters(WriterPipeline pipeline) {
pipeline.addLast(DefaultStructWriter.getInstance());
}
/**
* Retrieves a metadata handler which generates metadata entries within operation responses.
*
* @return a metadata handler implementation.
*/
default MetadataHandler metadataHandler() {
return DefaultMetadataHandler.getInstance();
}
default void onConnectionNegotiated(ConnectionHandle connection) {}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy