org.neo4j.driver.internal.async.connection.ChannelAttributes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-java-driver Show documentation
Access to the Neo4j graph database through Java
There is a newer version: 5.27.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.neo4j.driver.internal.async.connection;

import io.netty.channel.Channel;
import io.netty.util.AttributeKey;

import java.util.Optional;

import org.neo4j.driver.internal.BoltServerAddress;
import org.neo4j.driver.internal.async.inbound.InboundMessageDispatcher;
import org.neo4j.driver.internal.messaging.BoltProtocolVersion;
import org.neo4j.driver.internal.util.ServerVersion;

import static io.netty.util.AttributeKey.newInstance;

public final class ChannelAttributes
{
    private static final AttributeKey CONNECTION_ID = newInstance( "connectionId" );
    private static final AttributeKey POOL_ID = newInstance( "poolId" );
    private static final AttributeKey PROTOCOL_VERSION = newInstance( "protocolVersion" );
    private static final AttributeKey SERVER_AGENT = newInstance( "serverAgent" );
    private static final AttributeKey ADDRESS = newInstance( "serverAddress" );
    private static final AttributeKey SERVER_VERSION = newInstance( "serverVersion" );
    private static final AttributeKey CREATION_TIMESTAMP = newInstance( "creationTimestamp" );
    private static final AttributeKey LAST_USED_TIMESTAMP = newInstance( "lastUsedTimestamp" );
    private static final AttributeKey MESSAGE_DISPATCHER = newInstance( "messageDispatcher" );
    private static final AttributeKey TERMINATION_REASON = newInstance( "terminationReason" );
    private static final AttributeKey AUTHORIZATION_STATE_LISTENER = newInstance( "authorizationStateListener" );

    // configuration hints provided by the server
    private static final AttributeKey CONNECTION_READ_TIMEOUT = newInstance( "connectionReadTimeout" );

    private ChannelAttributes()
    {
    }

    public static String connectionId( Channel channel )
    {
        return get( channel, CONNECTION_ID );
    }

    public static void setConnectionId( Channel channel, String id )
    {
        setOnce( channel, CONNECTION_ID, id );
    }

    public static String poolId( Channel channel )
    {
        return get( channel, POOL_ID );
    }

    public static void setPoolId( Channel channel, String id )
    {
        setOnce( channel, POOL_ID, id );
    }

    public static BoltProtocolVersion protocolVersion( Channel channel )
    {
        return get( channel, PROTOCOL_VERSION );
    }

    public static void setProtocolVersion( Channel channel, BoltProtocolVersion version )
    {
        setOnce( channel, PROTOCOL_VERSION, version );
    }

    public static void setServerAgent( Channel channel, String serverAgent )
    {
        setOnce( channel, SERVER_AGENT, serverAgent );
    }

    public static String serverAgent( Channel channel )
    {
        return get( channel, SERVER_AGENT );
    }

    public static BoltServerAddress serverAddress( Channel channel )
    {
        return get( channel, ADDRESS );
    }

    public static void setServerAddress( Channel channel, BoltServerAddress address )
    {
        setOnce( channel, ADDRESS, address );
    }

    public static ServerVersion serverVersion( Channel channel )
    {
        return get( channel, SERVER_VERSION );
    }

    public static void setServerVersion( Channel channel, ServerVersion version )
    {
        setOnce( channel, SERVER_VERSION, version );
    }

    public static long creationTimestamp( Channel channel )
    {
        return get( channel, CREATION_TIMESTAMP );
    }

    public static void setCreationTimestamp( Channel channel, long creationTimestamp )
    {
        setOnce( channel, CREATION_TIMESTAMP, creationTimestamp );
    }

    public static Long lastUsedTimestamp( Channel channel )
    {
        return get( channel, LAST_USED_TIMESTAMP );
    }

    public static void setLastUsedTimestamp( Channel channel, long lastUsedTimestamp )
    {
        set( channel, LAST_USED_TIMESTAMP, lastUsedTimestamp );
    }

    public static InboundMessageDispatcher messageDispatcher( Channel channel )
    {
        return get( channel, MESSAGE_DISPATCHER );
    }

    public static void setMessageDispatcher( Channel channel, InboundMessageDispatcher messageDispatcher )
    {
        setOnce( channel, MESSAGE_DISPATCHER, messageDispatcher );
    }

    public static String terminationReason( Channel channel )
    {
        return get( channel, TERMINATION_REASON );
    }

    public static void setTerminationReason( Channel channel, String reason )
    {
        setOnce( channel, TERMINATION_REASON, reason );
    }

    public static AuthorizationStateListener authorizationStateListener( Channel channel )
    {
        return get( channel, AUTHORIZATION_STATE_LISTENER );
    }

    public static void setAuthorizationStateListener( Channel channel, AuthorizationStateListener authorizationStateListener )
    {
        set( channel, AUTHORIZATION_STATE_LISTENER, authorizationStateListener );
    }

    public static Optional connectionReadTimeout( Channel channel )
    {
        return Optional.ofNullable( get( channel, CONNECTION_READ_TIMEOUT ) );
    }

    public static void setConnectionReadTimeout( Channel channel, Long connectionReadTimeout )
    {
        setOnce( channel, CONNECTION_READ_TIMEOUT, connectionReadTimeout );
    }

    private static  T get( Channel channel, AttributeKey key )
    {
        return channel.attr( key ).get();
    }

    private static  void set( Channel channel, AttributeKey key, T value )
    {
        channel.attr( key ).set( value );
    }

    private static  void setOnce( Channel channel, AttributeKey key, T value )
    {
        T existingValue = channel.attr( key ).setIfAbsent( value );
        if ( existingValue != null )
        {
            throw new IllegalStateException(
                    "Unable to set " + key.name() + " because it is already set to " + existingValue );
        }
    }
}