io.micronaut.discovery.spring.config.client.SpringCloudConfigClient 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.spring.config.client;

import io.micronaut.context.annotation.BootstrapContextCompatible;
import io.micronaut.context.annotation.Requires;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.discovery.spring.config.SpringCloudClientConfiguration;
import io.micronaut.http.annotation.Get;
import io.micronaut.http.annotation.Header;
import io.micronaut.http.annotation.Produces;
import io.micronaut.http.client.annotation.Client;
import io.micronaut.retry.annotation.Retryable;
import org.reactivestreams.Publisher;

/**
 * A non-blocking HTTP client for Spring Cloud Config Client.
 *
 * @author Thiago Locatelli
 * @since 1.0
 */
@Client(value = SpringCloudClientConfiguration.SPRING_CLOUD_CONFIG_ENDPOINT, configuration = SpringCloudClientConfiguration.class)
@BootstrapContextCompatible
@Requires(beans = SpringCloudClientConfiguration.class)
public interface SpringCloudConfigClient {

    String CLIENT_DESCRIPTION = "spring-cloud-config-client";

    /**
     * Reads an application configuration from Spring Config Server.
     *
     * @param applicationName   The application name
     * @param profiles          The active profiles
     * @return A {@link Publisher} that emits a list of {@link ConfigServerResponse}
     */
    @Get("/{applicationName}{/profiles}")
    @Produces(single = true)
    @Retryable(
        attempts = "${" + SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration.PREFIX + ".retry-count:3}",
        delay = "${" + SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration.PREFIX + ".retry-delay:1s}"
    )
    Publisher readValues(
        @NonNull String applicationName,
        @Nullable String profiles);

    /**
     * Reads an application configuration from Spring Config Server with authorization parameter.
     *
     * @param applicationName   The application name
     * @param profiles          The active profiles
     * @param authorization     The Basic authorization header needed to authorize against the server
     * @return A {@link Publisher} that emits a list of {@link ConfigServerResponse}
     */
    @Get("/{applicationName}{/profiles}")
    @Produces(single = true)
    @Retryable(
            attempts = "${" + SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration.PREFIX + ".retry-count:3}",
            delay = "${" + SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration.PREFIX + ".retry-delay:1s}"
    )
    Publisher readValuesAuthorized(
            @NonNull String applicationName,
            @Nullable String profiles,
            @Header String authorization);

    /**
     * Reads a versioned (#label) application configuration from Spring Config Server.
     *
     * @param applicationName   The application name
     * @param profiles          The active profiles
     * @param label             The label
     * @return A {@link Publisher} that emits a list of {@link ConfigServerResponse}
     */
    @Get("/{applicationName}{/profiles}{/label}")
    @Produces(single = true)
    @Retryable(
        attempts = "${" + SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration.PREFIX + ".retry-count:3}",
        delay = "${" + SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration.PREFIX + ".retry-delay:1s}"
    )
    Publisher readValues(
        @NonNull String applicationName,
        @Nullable String profiles,
        @Nullable String label);

    /**
     * Reads a versioned (#label) application configuration from Spring Config Server with authorization parameter.
     *
     * @param applicationName   The application name
     * @param profiles          The active profiles
     * @param label             The label
     * @param authorization     The Basic authorization header needed to authorize against the server
     * @return A {@link Publisher} that emits a list of {@link ConfigServerResponse}
     */
    @Get("/{applicationName}{/profiles}{/label}")
    @Produces(single = true)
    @Retryable(
            attempts = "${" + SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration.PREFIX + ".retry-count:3}",
            delay = "${" + SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration.PREFIX + ".retry-delay:1s}"
    )
    Publisher readValuesAuthorized(
            @NonNull String applicationName,
            @Nullable String profiles,
            @Nullable String label,
            @Header String authorization);

}