org.neo4j.bolt.transport

Class ProtocolChooser

java.lang.Object

org.neo4j.bolt.transport.ProtocolChooser

public class ProtocolChooser
extends Object

Manages the state for choosing the protocol version to use. The protocol opens with the client sending four bytes (0x6060 B017) followed by four suggested protocol versions in preference order. All bytes are expected to be big endian, and each of the suggested protocols are 4-byte unsigned integers. Since that message could get split up along the way, we first gather the 20 bytes of data we need, and then choose a protocol to use.

This class is stateful, one instance is expected per channel.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOLT_MAGIC_PREAMBLE

Constructor Summary

Constructors

Constructor and Description
ProtocolChooser(Map<Long,BiFunction<io.netty.channel.Channel,Boolean,BoltProtocol>> availableVersions, boolean encryptionRequired, boolean isEncrypted)

Method Summary

Modifier and Type	Method and Description
BoltProtocol	chosenProtocol()
HandshakeOutcome	handleVersionHandshakeChunk(io.netty.buffer.ByteBuf buffer, io.netty.channel.Channel ch)

Methods inherited from class java.lang.Object

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

Field Detail

BOLT_MAGIC_PREAMBLE

public static final int BOLT_MAGIC_PREAMBLE

See Also:

Constant Field Values

Constructor Detail

ProtocolChooser

public ProtocolChooser(Map<Long,BiFunction<io.netty.channel.Channel,Boolean,BoltProtocol>> availableVersions,
                       boolean encryptionRequired,
                       boolean isEncrypted)

Parameters:

availableVersions - version -> protocol mapping

encryptionRequired - whether or not the server allows only encrypted connections

isEncrypted - whether of not this connection is encrypted

Method Detail

handleVersionHandshakeChunk

public HandshakeOutcome handleVersionHandshakeChunk(io.netty.buffer.ByteBuf buffer,
                                                    io.netty.channel.Channel ch)

chosenProtocol

public BoltProtocol chosenProtocol()