org.neo4j.driver.internal.spi.Connection 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 [https://neo4j.com]
 *
 * 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.spi;

import static java.lang.String.format;

import java.util.concurrent.CompletionStage;
import org.neo4j.driver.AccessMode;
import org.neo4j.driver.internal.BoltServerAddress;
import org.neo4j.driver.internal.DatabaseName;
import org.neo4j.driver.internal.async.TerminationAwareStateLockingExecutor;
import org.neo4j.driver.internal.messaging.BoltProtocol;
import org.neo4j.driver.internal.messaging.Message;

public interface Connection {
    boolean isOpen();

    void enableAutoRead();

    void disableAutoRead();

    void write(Message message, ResponseHandler handler);

    void writeAndFlush(Message message, ResponseHandler handler);

    boolean isTelemetryEnabled();

    CompletionStage reset(Throwable throwable);

    CompletionStage release();

    void terminateAndRelease(String reason);

    String serverAgent();

    BoltServerAddress serverAddress();

    BoltProtocol protocol();

    void bindTerminationAwareStateLockingExecutor(TerminationAwareStateLockingExecutor executor);

    default AccessMode mode() {
        throw new UnsupportedOperationException(format("%s does not support access mode.", getClass()));
    }

    default DatabaseName databaseName() {
        throw new UnsupportedOperationException(format("%s does not support database name.", getClass()));
    }

    default String impersonatedUser() {
        throw new UnsupportedOperationException(format("%s does not support impersonated user.", getClass()));
    }
}