Package io.smallrye.config

Class SmallRyeConfigBuilder

java.lang.Object
io.smallrye.config.SmallRyeConfigBuilder
All Implemented Interfaces:
org.eclipse.microprofile.config.spi.ConfigBuilder
public class SmallRyeConfigBuilder extends Object implements org.eclipse.microprofile.config.spi.ConfigBuilder
Author:
Jeff Mesnil (c) 2017 Red Hat inc.

  • Constructor Details

    • SmallRyeConfigBuilder

      public SmallRyeConfigBuilder()

  • Method Details

    • addDiscoveredCustomizers

      public SmallRyeConfigBuilder addDiscoveredCustomizers()

    • addDiscoveredSources

      public SmallRyeConfigBuilder addDiscoveredSources()
      Specified by:
      addDiscoveredSources in interface org.eclipse.microprofile.config.spi.ConfigBuilder

    • addDiscoveredConverters

      public SmallRyeConfigBuilder addDiscoveredConverters()
      Specified by:
      addDiscoveredConverters in interface org.eclipse.microprofile.config.spi.ConfigBuilder

    • addDiscoveredInterceptors

      public SmallRyeConfigBuilder addDiscoveredInterceptors()

    • addDiscoveredSecretKeysHandlers

      public SmallRyeConfigBuilder addDiscoveredSecretKeysHandlers()

    • addDiscoveredValidator

      public SmallRyeConfigBuilder addDiscoveredValidator()

    • addDefaultSources

      public SmallRyeConfigBuilder addDefaultSources()
      Specified by:
      addDefaultSources in interface org.eclipse.microprofile.config.spi.ConfigBuilder

    • addSystemSources

      public SmallRyeConfigBuilder addSystemSources()

    • addPropertiesSources

      public SmallRyeConfigBuilder addPropertiesSources()

    • getDefaultSources

      protected List<org.eclipse.microprofile.config.spi.ConfigSource> getDefaultSources()

    • getSystemSources

      protected List<org.eclipse.microprofile.config.spi.ConfigSource> getSystemSources()

    • getPropertiesSources

      protected List<org.eclipse.microprofile.config.spi.ConfigSource> getPropertiesSources()

    • addDefaultInterceptors

      public SmallRyeConfigBuilder addDefaultInterceptors()

    • forClassLoader

      public SmallRyeConfigBuilder forClassLoader(ClassLoader classLoader)
      Specified by:
      forClassLoader in interface org.eclipse.microprofile.config.spi.ConfigBuilder

    • withCustomizers

      public SmallRyeConfigBuilder withCustomizers(SmallRyeConfigBuilderCustomizer... customizers)

    • withSources

      public SmallRyeConfigBuilder withSources(org.eclipse.microprofile.config.spi.ConfigSource... configSources)
      Specified by:
      withSources in interface org.eclipse.microprofile.config.spi.ConfigBuilder

    • withSources

      public SmallRyeConfigBuilder withSources(Collection<org.eclipse.microprofile.config.spi.ConfigSource> configSources)

    • withSources

      public SmallRyeConfigBuilder withSources(org.eclipse.microprofile.config.spi.ConfigSourceProvider provider)

    • withSources

      public SmallRyeConfigBuilder withSources(ConfigSourceFactory... configSourceFactories)

    • withInterceptors

      public SmallRyeConfigBuilder withInterceptors(ConfigSourceInterceptor... interceptors)

    • withInterceptorFactories

      public SmallRyeConfigBuilder withInterceptorFactories(ConfigSourceInterceptorFactory... interceptorFactories)

    • withSecretKeysHandlers

      public SmallRyeConfigBuilder withSecretKeysHandlers(SecretKeysHandler... secretKeysHandlers)

    • withSecretKeyHandlerFactories

      public SmallRyeConfigBuilder withSecretKeyHandlerFactories(SecretKeysHandlerFactory... secretKeyHandlerFactories)

    • withProfile

      public SmallRyeConfigBuilder withProfile(String profile)

    • withProfiles

      public SmallRyeConfigBuilder withProfiles(List<String> profiles)

    • withSecretKeys

      public SmallRyeConfigBuilder withSecretKeys(String... keys)

    • withDefaultValue

      public SmallRyeConfigBuilder withDefaultValue(String name, String value)

    • withDefaultValues

      public SmallRyeConfigBuilder withDefaultValues(Map<String,String> defaultValues)

    • withMapping

      public SmallRyeConfigBuilder withMapping(Class<?> klass)

    • withMapping

      public SmallRyeConfigBuilder withMapping(Class<?> klass, String prefix)

    • withMapping

      public SmallRyeConfigBuilder withMapping(ConfigMappings.ConfigClass configClass)

    • withMappingIgnore

      public SmallRyeConfigBuilder withMappingIgnore(String path)
      Ignores a specified path segment when performing a Config Mapping.

      By default, a Config Mapping must match every configuration path available in the Config system. However, such conditions may not always be possible, and in that case, the specified path is ignored.

      Examples of paths and ignores:

      • foo.bar - ignores the configuration name foo.bar
      • foo.* - ignores the single configurations names under foo
      • foo.** - ignores all the configurations names under foo
      Parameters:
      path - the configuration path to ignore
      Returns:
      this SmallRyeConfigBuilder
      See Also:

    • withValidateUnknown

      public SmallRyeConfigBuilder withValidateUnknown(boolean validateUnknown)
      Enable or disable the Config Mapping requirement to match every configuration path available in the Config system. By default, the validation is enabled.
      Parameters:
      validateUnknown - a boolean true to enable the validation, or false to disable it.
      Returns:
      this SmallRyeConfigBuilder
      See Also:

    • withValidator

      public SmallRyeConfigBuilder withValidator(ConfigValidator validator)

    • withConverters

      public SmallRyeConfigBuilder withConverters(org.eclipse.microprofile.config.spi.Converter<?>[] converters)
      Specified by:
      withConverters in interface org.eclipse.microprofile.config.spi.ConfigBuilder

    • withConverter

      public <T> SmallRyeConfigBuilder withConverter(Class<T> type, int priority, org.eclipse.microprofile.config.spi.Converter<T> converter)
      Specified by:
      withConverter in interface org.eclipse.microprofile.config.spi.ConfigBuilder

    • getSources

      public List<org.eclipse.microprofile.config.spi.ConfigSource> getSources()

    • getSourceProviders

      public List<org.eclipse.microprofile.config.spi.ConfigSourceProvider> getSourceProviders()

    • getConverters

      public Map<Type,io.smallrye.config.SmallRyeConfigBuilder.ConverterWithPriority> getConverters()

    • getInterceptors

      public List<io.smallrye.config.SmallRyeConfigBuilder.InterceptorWithPriority> getInterceptors()

    • getProfiles

      public List<String> getProfiles()

    • getValidator

      public ConfigValidator getValidator()

    • getDefaultValues

      public Map<String,String> getDefaultValues()

    • getSecretKeys

      public Set<PropertyName> getSecretKeys()

    • getMappingsBuilder

      public SmallRyeConfigBuilder.MappingBuilder getMappingsBuilder()

    • getClassLoader

      public ClassLoader getClassLoader()

    • isAddDiscoveredCustomizers

      public boolean isAddDiscoveredCustomizers()

    • isAddDefaultSources

      public boolean isAddDefaultSources()

    • isAddSystemSources

      public boolean isAddSystemSources()

    • isAddPropertiesSources

      public boolean isAddPropertiesSources()

    • isAddDefaultInterceptors

      public boolean isAddDefaultInterceptors()

    • isAddDiscoveredSources

      public boolean isAddDiscoveredSources()

    • isAddDiscoveredConverters

      public boolean isAddDiscoveredConverters()

    • isAddDiscoveredInterceptors

      public boolean isAddDiscoveredInterceptors()

    • isAddDiscoveredSecretKeysHandlers

      public boolean isAddDiscoveredSecretKeysHandlers()

    • isAddDiscoveredValidator

      public boolean isAddDiscoveredValidator()

    • isCachePropertyNames

      public boolean isCachePropertyNames()

    • setAddDefaultSources

      public SmallRyeConfigBuilder setAddDefaultSources(boolean addDefaultSources)

    • setAddSystemSources

      public SmallRyeConfigBuilder setAddSystemSources(boolean addSystemSources)

    • setAddPropertiesSources

      public SmallRyeConfigBuilder setAddPropertiesSources(boolean addPropertiesSources)

    • setAddDefaultInterceptors

      public SmallRyeConfigBuilder setAddDefaultInterceptors(boolean addDefaultInterceptors)

    • setAddDiscoveredSources

      public SmallRyeConfigBuilder setAddDiscoveredSources(boolean addDiscoveredSources)

    • setAddDiscoveredConverters

      public SmallRyeConfigBuilder setAddDiscoveredConverters(boolean addDiscoveredConverters)

    • setAddDiscoveredInterceptors

      public SmallRyeConfigBuilder setAddDiscoveredInterceptors(boolean addDiscoveredInterceptors)

    • setAddDiscoveredSecretKeysHandlers

      public SmallRyeConfigBuilder setAddDiscoveredSecretKeysHandlers(boolean addDiscoveredSecretKeysHandlers)

    • setAddDiscoveredValidator

      public SmallRyeConfigBuilder setAddDiscoveredValidator(boolean addDiscoveredValidator)

    • setCachePropertyNames

      public SmallRyeConfigBuilder setCachePropertyNames(boolean cachePropertyNames)

    • build

      public SmallRyeConfig build()
      Specified by:
      build in interface org.eclipse.microprofile.config.spi.ConfigBuilder