org.neo4j.bolt.v1.messaging.BoltRequestMessage Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of neo4j-bolt Show documentation

The core of Neo4j Bolt Protocol, this contains the state machine for Bolt sessions.

There is a newer version: 5.23.0

/*
 * Copyright (c) 2002-2018 "Neo4j,"
 * Neo4j Sweden AB [http://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 .
 */
package org.neo4j.bolt.v1.messaging;

/**
 * Enumeration representing all defined Bolt request messages.
 * Also contains the signature byte with which the message is
 * encoded on the wire.
 */
public enum BoltRequestMessage
{
    INIT( 0x01 ),
    ACK_FAILURE( 0x0E ),
    RESET( 0x0F ),
    RUN( 0x10 ),
    DISCARD_ALL( 0x2F ),
    PULL_ALL( 0x3F );

    private static final BoltRequestMessage[] valuesBySignature = new BoltRequestMessage[0x40];
    static
    {
        for ( BoltRequestMessage value : values() )
        {
            valuesBySignature[value.signature()] = value;
        }
    }

    /**
     * Obtain a request message by signature.
     *
     * @param signature the signature byte to look up.
     * @return the appropriate message instance or {@code null} if no message with the given signature exists.
     */
    public static BoltRequestMessage withSignature( int signature )
    {
        if ( signature < 0 || signature > valuesBySignature.length - 1 )
        {
            return null;
        }
        return valuesBySignature[signature];
    }

    private final byte signature;

    BoltRequestMessage( int signature )
    {
        this.signature = (byte) signature;
    }

    public byte signature()
    {
        return signature;
    }

}