io.kroxylicious.kms.service.TestKmsFacade Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kroxylicious-kms-test-support Show documentation

Test support for modules testing KMS implementations.

The newest version!

/*
 * Copyright Kroxylicious Authors.
 *
 * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 */

package io.kroxylicious.kms.service;

/**
 * Represents the Kms itself, exposed for test purpose.
 * @param  The config type
 * @param  The key reference
 * @param  The type of encrypted DEK
 */
public interface TestKmsFacade extends AutoCloseable {

    /**
     * Returns true of this facade is available, or false otherwise.
     * @return true if available, false otherwise.
     */
    default boolean isAvailable() {
        return true;
    }

    /**
     * Starts the underlying KMS.
     */
    void start();

    /**
     * Stops the underlying KMS.
     */
    void stop();

    /**
     * Gets a manager capable of managing the KEKs on the underlying KMS.
     * @return kek manager
     */
    TestKekManager getTestKekManager();

    /**
     * Gets the service class of used by Kroxylicious with the underlying KMS.
     *
     * @return service class
     */
    Class> getKmsServiceClass();

    /**
     * Gets the configuration Kroxylicious will need to use to connect to the underlying KMS.
     * @return service configuration.
     */
    C getKmsServiceConfig();

    /**
     * Returns the actual {@link Kms} in-use by Kroxylicious.  This is an optional method.
     * It is expected most implementations will throw an {@link UnsupportedOperationException}.
     *
     * @return service instance
     * @throws UnsupportedOperationException operation is not supported.
     */
    default Kms getKms() {
        throw new UnsupportedOperationException();
    }

    default void close() {
        stop();
    }
}