org.neo4j.driver.summary.ServerInfo 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.summary;

/**
 * Provides some basic information of the server where the result is obtained from.
 */
public interface ServerInfo {

    /**
     * Returns a string telling the address of the server the query was executed.
     * @return The address of the server the query was executed.
     */
    String address();

    /**
     * Returns Bolt protocol version with which the remote server communicates. This is returned as a string in format X.Y where X is the major version and Y is
     * the minor version.
     *
     * @return The Bolt protocol version.
     */
    String protocolVersion();

    /**
     * Returns server agent string by which the remote server identifies itself.
     *
     * @return The agent string.
     */
    String agent();
}