ac.simons.neo4j.migrations.core.ConnectionDetails Maven / Gradle / Ivy

Go to download

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

The Core API of Neo4j-Migrations.

There is a newer version: 2.15.1

/*
 * Copyright 2020-2022 the original author or authors.
 *
 * 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
 *
 *      https://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 ac.simons.neo4j.migrations.core;

import java.util.Optional;

/**
 * Provides detailed information about the connection being used when invoking any method that talks to the database.
 *
 * @author Michael J. Simons
 * @soundtrack Snoop Dogg - Doggystyle
 * @since 1.4.0
 */
public interface ConnectionDetails {

	/**
	 * @return the address of the server used
	 */
	String getServerAddress();

	/**
	 * @return the Neo4j version the server is running
	 */
	String getServerVersion();

	/**
	 * @return the Neo4j edition the server is running
	 * @since 1.5.0
	 */
	String getServerEdition();

	/**
	 * @return the Neo4j user that ran the migrations
	 */
	String getUsername();

	/**
	 * @return the database if applicable (Neo4j 4.0 and up)
	 */
	Optional getOptionalDatabaseName();

	/**
	 * @return the database if applicable (Neo4j 4.0 and up)
	 */
	Optional getOptionalSchemaDatabaseName();
}