org.neo4j.driver.internal.cluster.RoutingTable 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.cluster;

import java.util.List;
import java.util.Set;
import org.neo4j.driver.AccessMode;
import org.neo4j.driver.internal.BoltServerAddress;
import org.neo4j.driver.internal.DatabaseName;

public interface RoutingTable {
    boolean isStaleFor(AccessMode mode);

    boolean hasBeenStaleFor(long staleRoutingTableTimeout);

    void update(ClusterComposition cluster);

    void forget(BoltServerAddress address);

    /**
     * Returns an immutable list of reader addresses.
     *
     * @return the immutable list of reader addresses.
     */
    List readers();

    /**
     * Returns an immutable list of writer addresses.
     *
     * @return the immutable list of write addresses.
     */
    List writers();

    /**
     * Returns an immutable list of router addresses.
     *
     * @return the immutable list of router addresses.
     */
    List routers();

    /**
     * Returns an immutable unordered set of all addresses known by this routing table. This includes all router, reader, writer and disused addresses.
     *
     * @return the immutable set of all addresses.
     */
    Set servers();

    DatabaseName database();

    void forgetWriter(BoltServerAddress toRemove);

    void replaceRouterIfPresent(BoltServerAddress oldRouter, BoltServerAddress newRouter);

    boolean preferInitialRouter();

    long expirationTimestamp();
}