org.neo4j.kernel.database.DatabaseReferenceRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation
Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.
There is a newer version: 5.25.1
Show newest version
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://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.kernel.database;

import java.util.Optional;
import java.util.Set;
import org.neo4j.kernel.database.DatabaseReferenceImpl.Composite;
import org.neo4j.kernel.database.DatabaseReferenceImpl.External;
import org.neo4j.kernel.database.DatabaseReferenceImpl.Internal;
import org.neo4j.kernel.database.DatabaseReferenceImpl.SPD;

/**
 * Implementations of this interface allow for the retrieval of {@link DatabaseReference}s for databases which have not yet been dropped.
 */
public interface DatabaseReferenceRepository {
    /**
     * Given a database alias, return the corresponding {@link DatabaseReference} from the system database, if one exists.
     */
    Optional getByAlias(NormalizedDatabaseName databaseAlias);

    /**
     * Given a database alias, return the corresponding {@link DatabaseReferenceImpl.Internal} from the system database, if one exists.
     *
     * Note that this reference must point to a database hosted on this DBMS.
     */
    default Optional getInternalByAlias(NormalizedDatabaseName databaseAlias) {
        return getByAlias(databaseAlias)
                .filter(DatabaseReferenceImpl.Internal.class::isInstance)
                .map(DatabaseReferenceImpl.Internal.class::cast);
    }

    /**
     * Given a database alias, return the corresponding {@link DatabaseReferenceImpl.External} from the system database, if one exists.
     *
     * Note that this reference must not point to a database hosted on this DBMS.
     */
    default Optional getExternalByAlias(NormalizedDatabaseName databaseAlias) {
        return getByAlias(databaseAlias)
                .filter(DatabaseReferenceImpl.External.class::isInstance)
                .map(DatabaseReferenceImpl.External.class::cast);
    }

    /**
     * Given a string representation of a database name, return the corresponding {@link DatabaseReference} from the system database, if one exists.
     */
    default Optional getByAlias(String databaseName) {
        return getByAlias(new NormalizedDatabaseName(databaseName));
    }

    /**
     * Given a database name, return the corresponding {@link DatabaseReferenceImpl.Internal} from the system database, if one exists.
     *
     * Note that this reference must point to a database hosted on this DBMS.
     */
    default Optional getInternalByAlias(String databaseName) {
        return getInternalByAlias(new NormalizedDatabaseName(databaseName));
    }

    /**
     * Given a database name, return the corresponding {@link DatabaseReferenceImpl.External} from the system database, if one exists.
     *
     * Note that this reference must not point to a database hosted on this DBMS.
     */
    default Optional getExternalByAlias(String databaseName) {
        return getExternalByAlias(new NormalizedDatabaseName(databaseName));
    }

    /**
     *  Fetch all known {@link DatabaseReference}es.
     */
    Set getAllDatabaseReferences();

    /**
     * Fetch all known {@link Internal} references
     */
    Set getInternalDatabaseReferences();

    /**
     * Fetch all known {@link  External} references
     */
    Set getExternalDatabaseReferences();

    /**
     * Fetch all known {@link  Composite} references
     */
    Set getCompositeDatabaseReferences();

    /**
     * Get an SPD database reference if there is one.
     * Only one SPD database can be present in a DBMS.
     */
    Optional getSpdDatabaseReference();

    interface Caching extends DatabaseReferenceRepository {
        void invalidateAll();
    }
}