Package io.quarkus.spring.cloud.config.client.runtime

Interface SpringCloudConfigClientConfig

  • @ConfigMapping(prefix="quarkus.spring-cloud-config")
@ConfigRoot(phase=RUN_TIME)
public interface SpringCloudConfigClientConfig

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration connectionTimeout()
      The amount of time to wait when initially establishing a connection before giving up and timing out.
      boolean enabled()
      If enabled, will try to read the configuration from a Spring Cloud Config Server
      boolean failFast()
      If set to true, the application will not stand up if it cannot obtain configuration from the Config Server
      Map<String,​String> headers()
      Custom headers to pass the Spring Cloud Config Server when performing the HTTP request
      Optional<String> keyPassword()
      Password to recover key from KeyStore for SSL client authentication with the Config server If no value is provided, the key-store-password will be used
      @WithConverter(io.quarkus.runtime.configuration.PathConverter.class) Optional<Path> keyStore()
      KeyStore to be used containing the SSL certificate for authentication with the Config server Can be either a classpath resource or a file system path
      Optional<String> keyStorePassword()
      Password of KeyStore to be used containing the SSL certificate for authentication with the Config server
      Optional<String> label()
      The label to be used to pull remote configuration properties.
      Optional<String> password()
      The password to be used if the Config Server has BASIC Auth enabled
      Optional<List<String>> profiles()
      The profiles to use for lookup
      @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration readTimeout()
      The amount of time to wait for a read on a socket before an exception is thrown.
      boolean trustCerts()
      When using HTTPS and no keyStore has been specified, whether to trust all certificates
      @WithConverter(io.quarkus.runtime.configuration.PathConverter.class) Optional<Path> trustStore()
      TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path
      Optional<String> trustStorePassword()
      Password of TrustStore to be used containing the SSL certificate used by the Config server
      String url()
      The Base URI where the Spring Cloud Config Server is available
      Optional<String> username()
      The username to be used if the Config Server has BASIC Auth enabled
      default boolean usernameAndPasswordSet()  

    • Method Detail

      • enabled

        @WithDefault("false")
boolean enabled()
        If enabled, will try to read the configuration from a Spring Cloud Config Server

      • failFast

        @WithDefault("false")
boolean failFast()
        If set to true, the application will not stand up if it cannot obtain configuration from the Config Server

      • url

        @WithDefault("http://localhost:8888")
String url()
        The Base URI where the Spring Cloud Config Server is available

      • label

        Optional<String> label()
        The label to be used to pull remote configuration properties. The default is set on the Spring Cloud Config Server (generally "master" when the server uses a Git backend).

      • connectionTimeout

        @WithDefault("10S")
@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class)
@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration connectionTimeout()
        The amount of time to wait when initially establishing a connection before giving up and timing out.

        Specify `0` to wait indefinitely.

      • readTimeout

        @WithDefault("60S")
@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class)
@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration readTimeout()
        The amount of time to wait for a read on a socket before an exception is thrown.

        Specify `0` to wait indefinitely.

      • username

        Optional<String> username()
        The username to be used if the Config Server has BASIC Auth enabled

      • password

        Optional<String> password()
        The password to be used if the Config Server has BASIC Auth enabled

      • trustStore

        @WithConverter(io.quarkus.runtime.configuration.PathConverter.class)
@WithConverter(io.quarkus.runtime.configuration.PathConverter.class) Optional<Path> trustStore()
        TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path

      • trustStorePassword

        Optional<String> trustStorePassword()
        Password of TrustStore to be used containing the SSL certificate used by the Config server

      • keyStore

        @WithConverter(io.quarkus.runtime.configuration.PathConverter.class)
@WithConverter(io.quarkus.runtime.configuration.PathConverter.class) Optional<Path> keyStore()
        KeyStore to be used containing the SSL certificate for authentication with the Config server Can be either a classpath resource or a file system path

      • keyStorePassword

        Optional<String> keyStorePassword()
        Password of KeyStore to be used containing the SSL certificate for authentication with the Config server

      • keyPassword

        Optional<String> keyPassword()
        Password to recover key from KeyStore for SSL client authentication with the Config server If no value is provided, the key-store-password will be used

      • trustCerts

        @WithDefault("${quarkus.tls.trust-all:false}")
boolean trustCerts()
        When using HTTPS and no keyStore has been specified, whether to trust all certificates

      • headers

        Map<String,​String> headers()
        Custom headers to pass the Spring Cloud Config Server when performing the HTTP request

      • usernameAndPasswordSet

        default boolean usernameAndPasswordSet()