Module io.helidon.pico.configdriven.runtime
Package io.helidon.pico.configdriven.runtime

Interface ConfigBeanRegistry

All Superinterfaces:
HelidonConfigBeanRegistry
All Known Subinterfaces:
BindableConfigBeanRegistry
public interface ConfigBeanRegistry extends HelidonConfigBeanRegistry
The highest ranked/weighted implementor of this contract is responsible for managing the set of ConfigBean's that are active, along with whether the application is configured to support dynamic aspects (i.e., dynamic in content, dynamic in lifecycle, etc.).

  • Method Details

    • ready

      boolean ready()
      The config bean registry is initialized as part of Pico's initialization, which happens when the service registry is initialized and bound.
      Returns:
      true if the config bean registry has been initialized

    • configurableServiceProviders

      Map<ConfiguredServiceProvider<?,?>,ConfigBeanInfo> configurableServiceProviders()
      These are the services that are configurable, mapping to the configuration beans each expects. Each entry in the returned map is the master/root for the config beans it manages. The result, therefore, is not associated with config beans. Use configuredServiceProviders() for configured service instances.
      Returns:
      the map of configurable services to the meta config beans each expects

    • configuredServiceProviders

      List<ConfiguredServiceProvider<?,?>> configuredServiceProviders()
      These are the managed/slave service providers that are associated with config bean instances.
      Returns:
      the list of configured services

    • configuredServiceProvidersConfiguredBy

      List<ConfiguredServiceProvider<?,?>> configuredServiceProvidersConfiguredBy(String key)
      These are the managed/slave service providers that are associated with config bean instances with the config key provided.
      Parameters:
      key - the config options key - note that this is a partial key - and not relative to the parent - the same key used by ConfigBean.value().
      Returns:
      the list of configured services

    • configBeansByConfigKey

      Set<?> configBeansByConfigKey(String key)
      Returns all the known config beans in order of rank given the key. Callers should understand that this list might be incomplete until ready state is reached (see ready()). Note also that callers should attempt to use configBeansByConfigKey(String) whenever possible since it will generate more precise matches.
      Parameters:
      key - the config options key - note that this is a partial key - and not relative to the parent - the same key used by ConfigBean.value().
      Returns:
      the set of known config keys

    • configBeansByConfigKey

      Set<?> configBeansByConfigKey(String key, String fullConfigKey)
      Returns all the known config beans in order of rank matching the key and fullConfigKey. Callers should understand that this list might be incomplete until ready state is reached (see ready()).
      Parameters:
      key - the config options key - note that this is a partial key - and not relative to the parent - the same key used by ConfigBean.value().
      fullConfigKey - the full config key
      Returns:
      the set of known config keys matching the provided criteria

    • configBeanMapByConfigKey

      Map<String,?> configBeanMapByConfigKey(String key, String fullConfigKey)
      Similar to configBeansByConfigKey(java.lang.String), but instead returns all the known config beans in a map where the key of the map is the config key.
      Parameters:
      key - the config options key - note that this is a partial key - and not relative to the parent - the same key used by ConfigBean.value().
      fullConfigKey - the full config key
      Returns:
      the map of known config keys to config beans