io.quarkus.tls.runtime.config.TrustStoreCredentialProviderConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-tls-registry Show documentation

An internal TLS certificate registry.

There is a newer version: 3.17.0

package io.quarkus.tls.runtime.config;

import java.util.Optional;

import io.quarkus.credentials.CredentialsProvider;
import io.quarkus.runtime.annotations.ConfigGroup;
import io.smallrye.config.WithDefault;

@ConfigGroup
public interface TrustStoreCredentialProviderConfig {

    /**
     * The name of the "credential" bucket (map key -> passwords) to retrieve from the
     * {@link io.quarkus.credentials.CredentialsProvider}. If not set, the credential provider will not be used.
     * 
     * A credential provider offers a way to retrieve the key store password as well as alias password.
     * Note that the credential provider is only used if the passwords are not set in the configuration.
     */
    Optional name();

    /**
     * The name of the bean providing the credential provider.
     * 

     * The name is used to select the credential provider to use.
     * The credential provider must be exposed as a CDI bean and with the {@code @Named} annotation set to the
     * configured name to be selected.
     * 

     * If not set, the default credential provider is used.
     */
    Optional beanName();

    /**
     * The key used to retrieve the trust store password.
     * 
     * If the selected credential provider does not contain the configured key, the password is not retrieved.
     * Otherwise, the retrieved value is used to open the trust store.
     */
    @WithDefault(CredentialsProvider.PASSWORD_PROPERTY_NAME)
    String passwordKey();

}