io.micronaut.discovery.vault.config.VaultConfigHttpClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-discovery-client Show documentation

Adds Service Discovery Features for Eureka and Consul

There is a newer version: 4.5.0

Show newest version

/*
 * Copyright 2017-2020 original 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 io.micronaut.discovery.vault.config;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.http.annotation.Header;
import org.reactivestreams.Publisher;

/**
 * A contract for an HTTP client to read configuration from Vault.
 *
 * @param  The body type
 * @author James Kleeh
 * @since 1.2.0
 */
public interface VaultConfigHttpClient> {

    /**
     * @return The client description
     */
    String getDescription();

    /**
     * Read configuration from Vault.
     *
     * @param token The vault token
     * @param backend The secret engine name
     * @param vaultKey The vault key
     * @return A publisher of the response body
     */
    Publisher readConfigurationValues(@NonNull @Header("X-Vault-Token") String token,
                                         @NonNull String backend,
                                         @NonNull String vaultKey);

}