Uses of Interface
io.helidon.config.Config
Package
Description
Provides interfaces and classes for loading and working with immutable, tree-structured
configuration data.
Support for encrypted properties.
Etcd configuration source.
Git configuration source.
HOCON config source for MicroProfile config.
Helidon implementation of microprofile config.
Helidon specific extension support for MicroProfile Config.
Mappers that can map
Config
to classes with factory methods, classes with Builders and
general "bean" classes with constructor and setters.Configuration SPI that defines the behavior developers can implement to extend the config system.
YAML config source for MicroProfile config.
Helidon Fault Tolerance Support.
Common classes for accessing JSON based REST APIs of third party systems.
Provides support for Microstream-Cache features integration.
Provides support for Microstream core features integration.
Integrating with OCI Metrics.
Integrating with OCI Metrics Using CDI.
Provides classes and interfaces for using the Oracle Cloud Infrastructure (OCI) Secrets
Retrieval and Vault APIs
as part of a ConfigSourceProvider implementation.
Provides classes and interfaces for using the Oracle Cloud Infrastructure (OCI) Secrets
Retrieval and Vault APIs
as part of a MpMetaConfigProvider implementation.
Mock LRA coordinator with Narayana like rest api for testing.
Helidon Reactive Messaging.
MicroProfile Reactive Messaging Oracle AQ connector.
Microprofile messaging JMS connector.
Microprofile messaging Kafka connector.
Microprofile messaging Weblogic JMS connector.
Client gRPC microprofile classes.
Microprofile gRPC server implementation.
Microprofile metrics specification implementation.
Microprofile 1.0 server implementation.
General-purpose reusable artifacts to help write CDI extensions, annotation processing, and interceptors for Helidon
services.
Integration with Open ID Connect providers.
Open Telemetry tracing support that plugs into the
TracerBuilder
SPI and provides
a Tracer
implementation.Helidon WebServer Access Log Support.
Helidon WebServer Context Support.
Helidon WebServer GraphQL Support.
Helidon WebServer Tracing Observability Support.
Helidon WebServer Services Common.
-
Uses of Config in io.helidon.config
Modifier and TypeFieldDescriptionstatic final GenericType
<Config> Config.GENERIC_TYPE
Generic type of configuration.Modifier and TypeMethodDescriptionConfig.Builder.build()
Builds new instance ofConfig
.static Config
MetaConfig.config()
Create configuration from meta configuration (files or classpath resources), or create a default config instance if meta configuration is not present.static Config
Create configuration from provided meta configuration.static Config
Config.create()
Returns a new defaultConfig
loaded using one of the configuration files available on the classpath and/or using the runtime environment.static Config
Config.create
(Supplier<? extends ConfigSource>... configSources) Creates a newConfig
loaded from environment variables, system properties, and the specifiedConfigSource
s.Config.detach()
Returns a copy of theConfig
node with no parent.static Config
Config.empty()
Returns empty instance ofConfig
.Config.get
(Config.Key key) Returns the single sub-node for the specified sub-key.default Config
Returns the single sub-node for the specified sub-key.static Config
Get a value from config, attempting to read both the keys.static Config
Config.global()
Either return the registered global config, or create a new config usingcreate()
and register it as global.static Config
Config.just
(Supplier<? extends ConfigSource>... configSources) Creates a newConfig
loaded from the specifiedConfigSource
s.Config.Context.last()
MetaConfig.metaConfiguration()
Meta configuration if provided, or empty config if not.Config.Context.reload()
Config.root()
Modifier and TypeMethodDescriptiondefault ConfigValue
<Config> Config.asNode()
Returns existing current config node asConfigValue
.Config.asNodeList()
ConfigFilters.ValueResolvingBuilder.build()
Creates a function of values reference resolving.ConfigFilters.ValueResolvingBuilder.get()
MetaConfig.metaConfig()
Find meta configuration (files or classpath resources) and create a meta configuration instance from it.Config.traverse()
Iterative deepening depth-first traversal of the node and its subtree as aStream<Config>
.Iterative deepening depth-first traversal of the node and its subtree as aStream<Config>
, qualified by the specified predicate.Modifier and TypeMethodDescriptionstatic ChangeWatcher
<?> MetaConfig.changeWatcher
(Config metaConfig) Load a change watcher based on its meta configuration.protected B
Configure builder from meta configuration.protected B
Configure builder from meta configuration.Configure builder from meta configuration.Update builder from meta configuration.Configure this config builder from meta configuration.Configure builder from meta configuration.Configure builder from meta configuration.Update this builder from meta configuration.static Config
Create configuration from provided meta configuration.Update this builder from meta configuration.Configure builder from meta configuration.static List
<ConfigSource> MetaConfig.configSource
(Config sourceMetaConfig) Load a config source (or config sources) based on its meta configuration.static ClasspathConfigSource
Initializes config source instance from configuration properties.static ClasspathOverrideSource
Create a new classpath override source from meta configuration, containingresource
key and other options.Initializes config filter instance from configuration properties.static ConfigSource
Returns aConfigSource
that contains the same configuration model as the providedconfig
.static DirectoryConfigSource
Initializes config source instance from configuration properties.static FileConfigSource
Initializes config source instance from configuration properties.static FileOverrideSource
Create a new file override source from meta configuration.Initializes polling strategy instance from configuration properties.static PrefixedConfigSource
Create a prefixed config source from meta configuration.static SimpleRetryPolicy
Initializes retry policy instance from configuration properties.static UrlConfigSource
Initializes config source instance from configuration properties.static UrlOverrideSource
Create a new URL override source from meta configuration.static List
<ConfigSource> Create config source for each resource on the classpath.static Config
Get a value from config, attempting to read both the keys.static void
Configure the provided configuration as the global configuration.void
static PollingStrategy
MetaConfig.pollingStrategy
(Config metaConfig) Load a polling strategy based on its meta configuration.static RetryPolicy
MetaConfig.retryPolicy
(Config metaConfig) Load a retry policy based on its meta configuration.Transform all leaf nodes (values) into Map instance.static Properties
ConfigMappers.toProperties
(Config config) Transform all leaf nodes (values) into Properties instance.Modifier and TypeMethodDescriptionConfig.Builder.addFilter
(Function<Config, ConfigFilter> configFilterProvider) Config.Builder.addFilter
(Supplier<Function<Config, ConfigFilter>> configFilterSupplier) <T> Config.Builder
Config.Builder.addMapper
(GenericType<T> type, Function<Config, T> mapper) Register a mapping function for specifiedGenericType
.<T> Config.Builder
Registers mapping function for specifiedtype
.<T> ConfigValue
<T> Typed value as aConfigValue
created from factory method.<T> ConfigValue
<List<T>> Returns this node as a list converting each list value using the provided mapper.default void
Performs the given action with the config node if nodeexists
, otherwise does nothing.default void
Register aConsumer
that is invoked each time a change occurs on whole Config or on a particular Config node.Iterative deepening depth-first traversal of the node and its subtree as aStream<Config>
, qualified by the specified predicate. -
Uses of Config in io.helidon.config.encryption
Modifier and TypeMethodDescriptionEncryptionFilter.Builder.buildProvider()
Create a newEncryptionFilter
provider based on this builder.static Function
<Config, ConfigFilter> EncryptionFilter.fromConfig()
Create a filter based on configuration (it takes its configuration from the configuration object it filters). -
Uses of Config in io.helidon.config.etcd
Modifier and TypeMethodDescriptionConfigure builder from meta configuration.static EtcdConfigSource
Create a new instance from configuration.static EtcdWatcher
Create a new instance from meta configuration. -
Uses of Config in io.helidon.config.git
Modifier and TypeMethodDescriptionConfigure builder from meta configuration.static GitConfigSource
Create an instance from meta configuration. -
Uses of Config in io.helidon.config.hocon.mp
-
Uses of Config in io.helidon.config.mp
Modifier and TypeMethodDescriptionstatic Config
MpConfig.toHelidonConfig
(Config mpConfig) This method allows use to use Helidon Config on top of an MP config.Modifier and TypeMethodDescriptionstatic ConfigSource
Config source base on a Helidon SE config instance.static List
<ConfigSource> MpMetaConfigUtils.sourceFromMeta
(Config config, String profile, Function<Path, ConfigSource> fromPath, Function<String, List<ConfigSource>> fromClasspath, BiFunction<String, String, List<ConfigSource>> fromClasspathWithProfile, Function<URL, ConfigSource> fromUrl) A utility for providing a list of configuration sources. -
Uses of Config in io.helidon.config.mp.spi
-
Uses of Config in io.helidon.config.objectmapping
-
Uses of Config in io.helidon.config.spi
Modifier and TypeMethodDescriptiondefault Map
<GenericType<?>, BiFunction<Config, ConfigMapper, ?>> ConfigMapperProvider.genericTypeMappers()
Returns a map of mapper functions associated with appropriate target type (GenericType<?>
.default <T> Optional
<BiFunction<Config, ConfigMapper, T>> ConfigMapperProvider.mapper
(GenericType<T> type) Mapper for a specific generic type.A simple mapping function from config node to a typed value based on the expected class.ConfigMapperProvider.mappers()
Returns a map of mapper functions associated with appropriate target type (Class<?>
.Modifier and TypeMethodDescriptiondefault List
<ConfigSource> ConfigSourceProvider.createMulti
(String type, Config metaConfig) Create a list of configuration sources from a single configuration.default void
Initializes the filter using theConfig
instance which the filter will affect onceConfig.Builder.build
completes.<T> T
ConfigMapper.map
(Config config, GenericType<T> type) Convert the specifiedConfig
node into the target type specified byGenericType
.<T> T
Converts the specifiedConfig
node to the target type. -
Uses of Config in io.helidon.config.yaml.mp
-
Uses of Config in io.helidon.faulttolerance
-
Uses of Config in io.helidon.integrations.common.rest
-
Uses of Config in io.helidon.integrations.microstream.cache
Modifier and TypeMethodDescriptionstatic MicrostreamCacheConfigurationBuilder
<?, ?> creates a new MicrostreamCacheConfigurationBuilder using the supplied helidon configuration.static <K,
V> MicrostreamCacheConfigurationBuilder <K, V> Create a CacheConfiguration builder initialized from the supplied helidon configuration node.static one.microstream.cache.types.Cache
<?, ?> Create a named cache using the provided helidon configuration. -
Uses of Config in io.helidon.integrations.microstream.core
Modifier and TypeMethodDescriptionUpdate builder from configuration.static one.microstream.storage.embedded.types.EmbeddedStorageManager
Create a EmbeddedStorageManager instance from Config. -
Uses of Config in io.helidon.integrations.oci.metrics
Modifier and TypeMethodDescriptionprotected Config
OciMetricsSupportFactory.ociMetricsConfig()
Returns the OCI metrics config node used to set up theOciMetricsSupport
instance.Modifier and TypeMethodDescriptionprotected abstract void
OciMetricsSupportFactory.activateOciMetricsSupport
(Config rootConfig, Config ociMetricsConfig, OciMetricsSupport.Builder builder) Activates OCI metrics support.Updates the builder using the specified OCI metricsConfig
node.protected OciMetricsSupport.Builder
OciMetricsSupportFactory.ociMetricsSupportBuilder
(Config rootConfig, Config ociMetricsConfig, com.oracle.bmc.monitoring.Monitoring monitoring) Returns the builder for constructing a newOciMetricsSupport
instance, initialized using the config retrieved using theOciMetricsSupportFactory.configKey()
return value and the providedMonitoring
instance.protected void
OciMetricsSupportFactory.registerOciMetrics
(Config rootConfig, com.oracle.bmc.monitoring.Monitoring monitoringClient) Registers OCI metrics using the configuration and the provided monitoring client by preparing anOciMetricsSupport
instance and then calling back to the subclass to activate that instance with, for example, routing. -
Uses of Config in io.helidon.integrations.oci.metrics.cdi
Modifier and TypeMethodDescriptionprotected void
OciMetricsBean.activateOciMetricsSupport
(Config rootConfig, Config ociMetricsConfig, OciMetricsSupport.Builder builder) -
Uses of Config in io.helidon.integrations.oci.secrets.configsource
Modifier and TypeMethodDescriptionConfigures thisSecretBundleLazyConfigSource.Builder
from the supplied meta-configuration.Configures thisSecretBundleNodeConfigSource.Builder
from the supplied meta-configuration.Deprecated.For use by the Helidon Config subsystem only. -
Uses of Config in io.helidon.integrations.oci.secrets.mp.configsource
Modifier and TypeMethodDescriptionList
<? extends ConfigSource> Returns an immutableList
whose sole element is aConfigSource
implementation backed by the Oracle Cloud Infrastructure (OCI) Secrets Retrieval and Vault APIs. -
Uses of Config in io.helidon.lra.coordinator
Modifier and TypeMethodDescriptionConfiguration needed for configuring coordinator. -
Uses of Config in io.helidon.messaging
Modifier and TypeMethodDescriptionConfiguration needed for configuring connector and their routing.Channel.Builder.publisherConfig
(Config config) Config available to publisher connector.Channel.Builder.subscriberConfig
(Config config) Config available to subscriber connector. -
Uses of Config in io.helidon.messaging.connectors.aq
Modifier and TypeMethodDescriptionprotected BiConsumer
<Message<?>, jakarta.jms.JMSException> AqConnectorImpl.sendingErrorHandler
(Config config) -
Uses of Config in io.helidon.messaging.connectors.jms
Modifier and TypeMethodDescriptionCustom configuration for connector.protected CompletionStage
<?> JmsConnector.consumeAsync
(Message<?> m, jakarta.jms.Session session, AtomicReference<MessageMapper> mapper, jakarta.jms.MessageProducer producer, Config config) protected jakarta.jms.MessageConsumer
JmsConnector.createConsumer
(Config config, jakarta.jms.Destination destination, SessionMetadata sessionEntry) protected SessionMetadata
JmsConnector.prepareSession
(Config config, jakarta.jms.ConnectionFactory factory) protected BiConsumer
<Message<?>, jakarta.jms.JMSException> JmsConnector.sendingErrorHandler
(Config config) Customizable handler for errors during sending.ModifierConstructorDescriptionprotected
JmsConnector
(Config config, Instance<jakarta.jms.ConnectionFactory> jakartaConnectionFactories) Create new JmsConnector. -
Uses of Config in io.helidon.messaging.connectors.kafka
Modifier and TypeMethodDescriptionLoad this builder from a configuration.Load this builder from a configuration.static KafkaConnector
Creates a new instance of KafkaConnector with the required configuration.static <K,
V> KafkaPublisher <K, V> Load this builder from a configuration.static <K,
V> KafkaSubscriber <K, V> Load this builder from a configuration. -
Uses of Config in io.helidon.messaging.connectors.wls
Modifier and TypeMethodDescriptionprotected CompletionStage
<?> WeblogicConnector.consumeAsync
(Message<?> m, jakarta.jms.Session session, AtomicReference<MessageMapper> mapper, jakarta.jms.MessageProducer producer, Config config) protected jakarta.jms.MessageConsumer
WeblogicConnector.createConsumer
(Config config, jakarta.jms.Destination destination, SessionMetadata sessionEntry) protected SessionMetadata
WeblogicConnector.prepareSession
(Config config, jakarta.jms.ConnectionFactory factory) ModifierConstructorDescriptionprotected
WeblogicConnector
(Config config, Instance<jakarta.jms.ConnectionFactory> connectionFactories) -
Uses of Config in io.helidon.microprofile.grpc.client
Modifier and TypeMethodDescriptionstatic GrpcChannelsProvider.Builder
Create a newGrpcChannelsProvider.Builder
.static GrpcChannelsProvider
Creates aGrpcChannelsProvider
using the specified configuration. -
Uses of Config in io.helidon.microprofile.grpc.server.spi
-
Uses of Config in io.helidon.microprofile.metrics
-
Uses of Config in io.helidon.microprofile.server
Modifier and TypeMethodDescriptionConfiguration instance to use to configure this server (Helidon config).static RoutingBuilders
Prepares the default and actualHttpRouting.Builder
instances based on the "routing" configuration for the specific component configuration. -
Uses of Config in io.helidon.microprofile.servicecommon
Modifier and TypeMethodDescriptionprotected Config
HelidonRestCdiExtension.componentConfig()
SE Configuration of the current compoennt.protected Config
HelidonRestCdiExtension.rootConfig()
SE Configuration, root.Modifier and TypeMethodDescriptionvoid
HelidonRestCdiExtension.prepareRuntime
(Config config) Configure with runtime config. -
Uses of Config in io.helidon.security.providers.oidc
Modifier and TypeMethodDescriptionConfig located at the provider's key to readOidcConfig
.Config located either at the configuration root, or at the provider node.static OidcFeature
Load OIDC support for webserver from config.static OidcFeature
Load OIDC support for webserver from config. -
Uses of Config in io.helidon.tracing.providers.opentelemetry
Modifier and TypeMethodDescriptionstatic boolean
HelidonOpenTelemetry.AgentDetector.isAgentPresent
(Config config) Check if the OTEL Agent is present.static boolean
HelidonOpenTelemetry.AgentDetector.useExistingGlobalOpenTelemetry
(Config config) Return whether the user has requested that Helidon use an existing global OpenTelemetry instance rather than creating one itself; specifying that the OpenTelemetry agent is present automatically implies using the agent's existing instance. -
Uses of Config in io.helidon.webserver.accesslog
Modifier and TypeMethodDescriptionUpdate this builder from configuration.static AccessLogFeature
Create Access log support configured fromConfig
.static AccessLogRoutingFeature
Create Access log support configured fromConfig
. -
Uses of Config in io.helidon.webserver.context
Modifier and TypeMethodDescriptionstatic ContextFeature
Create a new context feature with custom setup. -
Uses of Config in io.helidon.webserver.graphql
Modifier and TypeMethodDescriptionUpdate builder from configuration. -
Uses of Config in io.helidon.webserver.observe.tracing
Modifier and TypeMethodDescriptionstatic TracingObserver
Create a new tracing observer based onConfig
. -
Uses of Config in io.helidon.webserver.servicecommon
Modifier and TypeMethodDescriptionUpdates settings using the providedConfig
node for the service of interest.static RestServiceSettings
Creates a new instance using values from the provided config.