Interface ConfigurationClient

  • All Superinterfaces:
    io.micronaut.core.naming.Described
    All Known Implementing Classes:
    DefaultCompositeConfigurationClient

    public interface ConfigurationClient
    extends io.micronaut.core.naming.Described
    A Configuration client is responsible for reading configuration for configuration servers.
    Since:
    1.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CONFIGURATION_PREFIX
      The prefix used to configure the config client.
      static java.lang.String ENABLED
      Whether the configuration client, responsible for reading configuration for configuration servers, is enabled.
      static java.lang.String READ_TIMEOUT
      The read timeout used when reading distributed configuration.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.reactivestreams.Publisher<io.micronaut.context.env.PropertySource> getPropertySources​(io.micronaut.context.env.Environment environment)
      Retrieves all of the PropertySource registrations for the given environment.
      • Methods inherited from interface io.micronaut.core.naming.Described

        getDescription, getDescription
    • Field Detail

      • CONFIGURATION_PREFIX

        static final java.lang.String CONFIGURATION_PREFIX
        The prefix used to configure the config client.
        See Also:
        Constant Field Values
      • ENABLED

        static final java.lang.String ENABLED
        Whether the configuration client, responsible for reading configuration for configuration servers, is enabled.
        See Also:
        Constant Field Values
      • READ_TIMEOUT

        static final java.lang.String READ_TIMEOUT
        The read timeout used when reading distributed configuration.
        See Also:
        Constant Field Values
    • Method Detail

      • getPropertySources

        org.reactivestreams.Publisher<io.micronaut.context.env.PropertySource> getPropertySources​(io.micronaut.context.env.Environment environment)
        Retrieves all of the PropertySource registrations for the given environment.
        Parameters:
        environment - The environment
        Returns:
        A Publisher that emits zero or many PropertySource instances discovered for the given environment