org.neo4j.driver.ClientCertificateManager 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

The newest version!

/*
 * 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;

import java.util.concurrent.CompletionStage;
import org.neo4j.driver.util.Preview;

/**
 * A manager of {@link ClientCertificate} instances used by the driver for mTLS.
 * 
 * The driver uses the {@link ClientCertificate} supplied by the manager for setting up new connections. Therefore,
 * a change of the certificate affects subsequent new connections only.
 * 

 * The manager must never return {@literal null}. Exceptions must be emitted via the {@link CompletionStage} only.
 * 

 * All implementations of this interface must be thread-safe and non-blocking for caller threads. For instance, IO
 * operations must not done on the calling thread.
 * @since 5.19
 */
@Preview(name = "mTLS")
public interface ClientCertificateManager {
    /**
     * Returns a {@link CompletionStage} of a new {@link ClientCertificate}.
     * 

     * The first {@link CompletionStage} supplied to the driver must not complete with {@literal null} to ensure the
     * driver has the initial {@link ClientCertificate}.
     * 
     * Afterwards, the {@link CompletionStage} may complete with {@literal null} to indicate no update. If the
     * {@link CompletionStage} completes with {@link ClientCertificate}, the driver loads the supplied
     * {@link ClientCertificate}.
     * @return the certificate stage, must not be {@literal null}
     */
    CompletionStage getClientCertificate();
}