Module io.helidon.webserver.observe.config
Package io.helidon.webserver.observe.config

Interface ConfigObserverConfig

All Superinterfaces:
ObserverConfigBase, Prototype.Api, Prototype.Factory<ConfigObserver>
All Known Implementing Classes:
ConfigObserverConfig.BuilderBase.ConfigObserverConfigImpl
public interface ConfigObserverConfig extends Prototype.Api, ObserverConfigBase
Configuration of Config Observer.
See Also:

  • Method Details

    • builder

      static ConfigObserverConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static ConfigObserverConfig.Builder builder(ConfigObserverConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static ConfigObserverConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      @Deprecated static ConfigObserverConfig create(Config config)
      Deprecated.
      use create(io.helidon.config.Config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static ConfigObserverConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • endpoint

      String endpoint()
      Endpoint this observer is available on.
      Returns:
      the observer endpoint

    • permitAll

      boolean permitAll()
      Permit all access, even when not authorized.
      Returns:
      whether to permit access for anybody

    • secrets

      Set<String> secrets()
      Secret patterns (regular expressions) to exclude from output. Any pattern that matches a key will cause the output to be obfuscated and not contain the value. Patterns are matched case-insensitively.

      Patterns always added:

      • .*password
      • .*passphrase
      • .*secret
      Returns:
      set of regular expression patterns for keys, where values should be excluded from output

    • safeKeys

      default Set<String> safeKeys()
      Safe key patterns (regular expressions) to include in output. Any pattern that matches a key will cause the output to contain the value, unless it also matches a secrets() pattern. Patterns are matched case-insensitively.
      Returns:
      set of regular expression patterns for keys, where values can be included in output

    • unsafeValues

      default boolean unsafeValues()
      Whether to include values that do not match configured safe-keys patterns; values whose keys match configured secrets patterns are still obfuscated. If enabled, the observer uses the previous behavior and only obfuscates values whose keys match secrets().
      Returns:
      whether to include unsafe values in output

    • name

      String name()
      Description copied from interface: ObserverConfigBase
      Name of this observer. Each observer should provide its own default for this property.
      Specified by:
      name in interface ObserverConfigBase
      Returns:
      observer name