Uses of Annotation Interface
io.helidon.config.metadata.ConfiguredOption

Packages that use ConfiguredOption

Package	Description
io.helidon.common.configurable	General utilities that use Config.
io.helidon.common.pki	Utilities for PKI configuration and loading of certificates and keys.
io.helidon.faulttolerance	Fault tolerance for Helidon SE reactive implementation.
io.helidon.grpc.client	gRPC client API.
io.helidon.grpc.core	Core classes used by both the reactive gRPC server API and gRPC client API.
io.helidon.grpc.server	Reactive gRPC server API.
io.helidon.health	Health check support for helidon SE.
io.helidon.integrations.oci.metrics	Integrating with OCI Metrics.
io.helidon.media.common	Common classes for processing content with a specific MediaType.
io.helidon.metrics.api	Defines the Helidon metrics API so Helidon metrics-capable components can implement metrics simply and without regard for whether metrics is actually on the runtime path or not or is enabled or not.
io.helidon.metrics.serviceapi	API and minimal implementation for metrics support service.
io.helidon.microprofile.server	Microprofile 1.0 server implementation.
io.helidon.openapi	Helidon SE OpenAPI Support.
io.helidon.security	Security
io.helidon.security.providers.abac	Attribute based access control (ABAC) security provider.
io.helidon.security.providers.common	Common classes for provider implementation.
io.helidon.security.providers.config.vault	Vault operation backed by configuration.
io.helidon.security.providers.google.login	Integration with Google login button.
io.helidon.security.providers.header	Provider that can extract username from a (any) header.
io.helidon.security.providers.httpauth	Basic security provider, supporting "basic" and "digest" authentication schemes with role support.
io.helidon.security.providers.httpsign	Provider supporting validation of incoming signatures and signing of outbound requests.
io.helidon.security.providers.idcs.mapper	Mapper that retrieves roles from IDCS server and maps them to user subject.
io.helidon.security.providers.jwt	Provider that can process incoming JWTs and assert users based on them and can propagate JWTs (or create new ones) for outbound calls.
io.helidon.security.providers.oidc	Integration with Open ID Connect providers.
io.helidon.security.providers.oidc.common	Open ID Connect (OIDC) classes usable from all OIDC related components.
io.helidon.security.util	General utilities for security modules.
io.helidon.servicecommon.rest	Support types for REST services.
io.helidon.tracing	Distributed tracing support for Helidon.
io.helidon.tracing.jaeger	Helidon integration with Jaeger tracer.
io.helidon.tracing.opentracing	Open Tracing tracing support that plugs into the TracerBuilder SPI and provides a Tracer implementation.
io.helidon.tracing.zipkin	Brave based Open Tracing implementation for an integration with Zipkin.
io.helidon.webclient	A reactive client for rest calls.
io.helidon.webserver	Reactive web server API.
io.helidon.webserver.cors	Helidon SE CORS Support

Uses of ConfiguredOption in io.helidon.common.configurable

Methods in io.helidon.common.configurable with annotations of type ConfiguredOption

Modifier and Type	Method	Description
AllowList.Builder	AllowList.Builder.allowAll(boolean value)	Allows all strings to match (subject to "deny" conditions).
AllowList.Builder	AllowList.Builder.allowed(List<String> exacts)	Adds a list of exact strings any of which, if matched, allows matching for a candidate string.
AllowList.Builder	AllowList.Builder.allowedPatterns(List<Pattern> patterns)	Adds a list of Pattern any of which, if matched, allows matching for a candidate string.
AllowList.Builder	AllowList.Builder.allowedPrefixes(List<String> prefixes)	Adds a list of prefixes any of which, if matched, allows matching for a candidate string.
AllowList.Builder	AllowList.Builder.allowedSuffixes(List<String> suffixes)	Adds a list of suffixes any of which, if matched, allows matching for a candidate string.
LruCache.Builder<K,V>	LruCache.Builder.capacity(int capacity)	Configure capacity of the cache.
ScheduledThreadPoolSupplier.Builder	ScheduledThreadPoolSupplier.Builder.corePoolSize(int corePoolSize)	Core pool size of the thread pool executor.
ThreadPoolSupplier.Builder	ThreadPoolSupplier.Builder.corePoolSize(int corePoolSize)	Core pool size of the thread pool executor.
static Resource	Resource.create(String description, byte[] bytes)	Load resource from binary content.
ScheduledThreadPoolSupplier.Builder	ScheduledThreadPoolSupplier.Builder.daemon(boolean daemon)	Is daemon of the thread pool executor.
ThreadPoolSupplier.Builder	ThreadPoolSupplier.Builder.daemon(boolean daemon)	Is daemon of the thread pool executor.
AllowList.Builder	AllowList.Builder.denied(List<String> exacts)	Adds exact strings a match by any of which denies matching for a candidate string.
AllowList.Builder	AllowList.Builder.deniedPatterns(List<Pattern> patterns)	Adds patterns a match by any of which denies matching for a candidate string.
AllowList.Builder	AllowList.Builder.deniedPrefixes(List<String> prefixes)	Adds prefixes a match by any of which denies matching for a candidate string.
AllowList.Builder	AllowList.Builder.deniedSuffixes(List<String> suffixes)	Adds suffixes a match by any of which denies matching for a candidate string.
ThreadPoolSupplier.Builder	ThreadPoolSupplier.Builder.keepAliveMinutes(int keepAliveMinutes)	Keep alive minutes of the thread pool executor.
ThreadPoolSupplier.Builder	ThreadPoolSupplier.Builder.maxPoolSize(int maxPoolSize)	Max pool size of the thread pool executor.
ScheduledThreadPoolSupplier.Builder	ScheduledThreadPoolSupplier.Builder.prestart(boolean prestart)	Whether to prestart core threads in this thread pool executor.
ThreadPoolSupplier.Builder	ThreadPoolSupplier.Builder.prestart(boolean prestart)	Whether to prestart core threads in this thread pool executor.
ThreadPoolSupplier.Builder	ThreadPoolSupplier.Builder.queueCapacity(int queueCapacity)	Queue capacity of the thread pool executor.
ScheduledThreadPoolSupplier.Builder	ScheduledThreadPoolSupplier.Builder.threadNamePrefix(String threadNamePrefix)	Name prefix for threads in this thread pool executor.
ThreadPoolSupplier.Builder	ThreadPoolSupplier.Builder.threadNamePrefix(String threadNamePrefix)	Name prefix for threads in this thread pool executor.
ThreadPoolSupplier.Builder	ThreadPoolSupplier.Builder.virtualEnforced(boolean enforceVirtualThreads)	When configured to true, virtual thread executor service must be available, otherwise the built executor would fail to start.
ThreadPoolSupplier.Builder	ThreadPoolSupplier.Builder.virtualIfAvailable(boolean useVirtualThreads)	When configured to true, an unbounded virtual executor service (project Loom) will be used if available.

Uses of ConfiguredOption in io.helidon.common.pki

Methods in io.helidon.common.pki with annotations of type ConfiguredOption

Modifier and Type	Method	Description
KeyConfig.KeystoreBuilder	KeyConfig.KeystoreBuilder.certAlias(String alias)	Alias of X.509 certificate of public key.
KeyConfig.PemBuilder	KeyConfig.PemBuilder.certChain(Resource resource)	Load certificate chain from PEM resource.
KeyConfig.KeystoreBuilder	KeyConfig.KeystoreBuilder.certChainAlias(String alias)	Alias of an X.509 chain.
KeyConfig.PemBuilder	KeyConfig.PemBuilder.key(Resource resource)	Read a private key from PEM format from a resource definition.
KeyConfig.KeystoreBuilder	KeyConfig.KeystoreBuilder.keyAlias(String keyAlias)	Alias of the private key in the keystore.
KeyConfig.KeystoreBuilder	KeyConfig.KeystoreBuilder.keyPassphrase(String privateKeyPassphrase)	Pass-phrase of the key in the keystore (used for private keys).
KeyConfig.PemBuilder	KeyConfig.PemBuilder.keyPassphrase(String passphrase)	Passphrase for private key.
KeyConfig.KeystoreBuilder	KeyConfig.KeystoreBuilder.keystore(Resource keystore)	Keystore resource definition.
KeyConfig.KeystoreBuilder	KeyConfig.KeystoreBuilder.keystorePassphrase(String keystorePassword)	Pass-phrase of the keystore (supported with JKS and PKCS12 keystores).
KeyConfig.KeystoreBuilder	KeyConfig.KeystoreBuilder.keystoreType(String keystoreType)	Set type of keystore.
KeyConfig.KeystoreBuilder	KeyConfig.KeystoreBuilder.trustStore()	If you want to build a trust store, call this method to add all certificates present in the keystore to certificate list.
KeyConfig.Builder	KeyConfig.Builder.updateWith(KeyConfig.KeystoreBuilder builder)	Update this builder with information from a keystore builder.
KeyConfig.Builder	KeyConfig.Builder.updateWith(KeyConfig.PemBuilder builder)	Update this builder with information from a pem builder.

Uses of ConfiguredOption in io.helidon.faulttolerance

Methods in io.helidon.faulttolerance with annotations of type ConfiguredOption

Modifier and Type	Method	Description
Retry.DelayingRetryPolicy.Builder	Retry.DelayingRetryPolicy.Builder.calls(int calls)	Total number of calls (first + retries).
Retry.ExponentialRetryPolicy.Builder	Retry.ExponentialRetryPolicy.Builder.calls(int calls)	Total number of calls (first + retries).
Retry.FibonacciRetryPolicy.Builder	Retry.FibonacciRetryPolicy.Builder.calls(int calls)	Total number of calls (first + retries).
Retry.JitterRetryPolicy.Builder	Retry.JitterRetryPolicy.Builder.calls(int calls)	Total number of calls (first + retries).
Bulkhead.Builder	Bulkhead.Builder.cancelSource(boolean cancelSource)	Policy to cancel any source stage if the value return by FtHandler.invoke(java.util.function.Supplier<? extends java.util.concurrent.CompletionStage<T>>) is cancelled.
CircuitBreaker.Builder	CircuitBreaker.Builder.cancelSource(boolean cancelSource)	Policy to cancel any source stage if the value return by FtHandler.invoke(java.util.function.Supplier<? extends java.util.concurrent.CompletionStage<T>>) is cancelled.
Retry.Builder	Retry.Builder.cancelSource(boolean cancelSource)	Policy to cancel any source stage if the value return by FtHandler.invoke(java.util.function.Supplier<? extends java.util.concurrent.CompletionStage<T>>) is cancelled.
Timeout.Builder	Timeout.Builder.cancelSource(boolean cancelSource)	Cancel source if destination stage is cancelled.
Timeout.Builder	Timeout.Builder.currentThread(boolean currentThread)	Flag to indicate that code must be executed in current thread instead of in an executor's thread.
CircuitBreaker.Builder	CircuitBreaker.Builder.delay(Duration delay)	How long to wait before transitioning from open to half-open state.
Retry.DelayingRetryPolicy.Builder	Retry.DelayingRetryPolicy.Builder.delay(Duration delay)	Base delay between the invocations.
Retry.JitterRetryPolicy.Builder	Retry.JitterRetryPolicy.Builder.delay(Duration delay)	Base delay between the invocations.
Retry.DelayingRetryPolicy.Builder	Retry.DelayingRetryPolicy.Builder.delayFactor(double delayFactor)	A delay multiplication factor.
CircuitBreaker.Builder	CircuitBreaker.Builder.errorRatio(int ratio)	How many failures out of 100 will trigger the circuit to open.
Retry.ExponentialRetryPolicy.Builder	Retry.ExponentialRetryPolicy.Builder.factor(int factor)	Multiplication factor.
Retry.ExponentialRetryPolicy.Builder	Retry.ExponentialRetryPolicy.Builder.initialDelay(Duration initialDelay)	Initial Delay.
Retry.FibonacciRetryPolicy.Builder	Retry.FibonacciRetryPolicy.Builder.initialDelay(Duration initialDelay)	Initial Delay in Milliseconds.
Retry.ExponentialRetryPolicy.Builder	Retry.ExponentialRetryPolicy.Builder.jitter(long jitter)	Random part of the delay.
Retry.FibonacciRetryPolicy.Builder	Retry.FibonacciRetryPolicy.Builder.jitter(long jitter)	Random part of the delay.
Retry.JitterRetryPolicy.Builder	Retry.JitterRetryPolicy.Builder.jitter(Duration jitter)	Random part of the delay.
Bulkhead.Builder	Bulkhead.Builder.limit(int limit)	Maximal number of parallel requests going through this bulkhead.
Retry.ExponentialRetryPolicy.Builder	Retry.ExponentialRetryPolicy.Builder.maxDelay(Duration maxDelay)	Max Delay in Milliseconds.
Retry.FibonacciRetryPolicy.Builder	Retry.FibonacciRetryPolicy.Builder.maxDelay(Duration maxDelay)	Max Delay in Milliseconds.
Bulkhead.Builder	Bulkhead.Builder.name(String name)	A name assigned for debugging, error reporting or configuration purposes.
CircuitBreaker.Builder	CircuitBreaker.Builder.name(String name)	A name assigned for debugging, error reporting or configuration purposes.
Retry.Builder	Retry.Builder.name(String name)	A name assigned for debugging, error reporting or configuration purposes.
Timeout.Builder	Timeout.Builder.name(String name)	A name assigned for debugging, error reporting or configuration purposes.
Retry.Builder	Retry.Builder.overallTimeout(Duration overallTimeout)	Overall timeout.
Bulkhead.Builder	Bulkhead.Builder.queueLength(int queueLength)	Maximal number of enqueued requests waiting for processing.
Retry.Builder	Retry.Builder.retryPolicy(Retry.RetryPolicy policy)	Configure a retry policy to use to calculate delays between retries.
CircuitBreaker.Builder	CircuitBreaker.Builder.successThreshold(int successThreshold)	How many successful calls will close a half-open circuit.
Timeout.Builder	Timeout.Builder.timeout(Duration timeout)	Timeout duration.
CircuitBreaker.Builder	CircuitBreaker.Builder.volume(int volume)	Rolling window size used to calculate ratio of failed requests.

Uses of ConfiguredOption in io.helidon.grpc.client

Methods in io.helidon.grpc.client with annotations of type ConfiguredOption

Modifier and Type	Method	Description
GrpcChannelDescriptor.Builder	GrpcChannelDescriptor.Builder.host(String host)	Set the host name to connect.
GrpcChannelDescriptor.Builder	GrpcChannelDescriptor.Builder.port(int port)	Set the port that will be used to connect to the server.
GrpcChannelDescriptor.Builder	GrpcChannelDescriptor.Builder.sslDescriptor(GrpcTlsDescriptor tlsDescriptor)	Set the GrpcTlsDescriptor.
GrpcChannelDescriptor.Builder	GrpcChannelDescriptor.Builder.target(String target)	Set the target string, which can be either a valid NameResolver compliant URI, or an authority string.

Uses of ConfiguredOption in io.helidon.grpc.core

Methods in io.helidon.grpc.core with annotations of type ConfiguredOption

Modifier and Type	Method	Description
GrpcTlsDescriptor.Builder	GrpcTlsDescriptor.Builder.enabled(boolean enabled)	Enable or disable TLS.
GrpcTlsDescriptor.Builder	GrpcTlsDescriptor.Builder.jdkSSL(boolean jdkSSL)	Sets the type of SSL implementation to be used.
GrpcTlsDescriptor.Builder	GrpcTlsDescriptor.Builder.tlsCaCert(Resource caCert)	Set the CA (certificate authority) certificate path.
GrpcTlsDescriptor.Builder	GrpcTlsDescriptor.Builder.tlsCert(Resource tlsCert)	Set the client tlsCert path.
GrpcTlsDescriptor.Builder	GrpcTlsDescriptor.Builder.tlsKey(Resource tlsKey)	Set the client private key path.

Uses of ConfiguredOption in io.helidon.grpc.server

Methods in io.helidon.grpc.server with annotations of type ConfiguredOption

Modifier and Type	Method	Description
GrpcServerConfiguration.Builder	GrpcServerConfiguration.Builder.config(Config config)	Update the builder from configuration.
GrpcServerConfiguration.Builder	GrpcServerConfiguration.Builder.maxRapidResets(int maxRapidResets)	Maximum number of rapid resets(stream RST sent by client before any data have been sent by server).
GrpcServerConfiguration.Builder	GrpcServerConfiguration.Builder.name(String name)	Set the name of the gRPC server.
GrpcServerConfiguration.Builder	GrpcServerConfiguration.Builder.port(int port)	Sets server port.
GrpcServerConfiguration.Builder	GrpcServerConfiguration.Builder.rapidResetCheckPeriod(Duration rapidResetCheckPeriod)	Period for counting rapid resets(stream RST sent by client before any data have been sent by server).
GrpcServerConfiguration.Builder	GrpcServerConfiguration.Builder.workersCount(int workers)	Sets a count of threads in pool used to process HTTP requests.

Uses of ConfiguredOption in io.helidon.health

Methods in io.helidon.health with annotations of type ConfiguredOption

Modifier and Type	Method	Description
HealthSupport.Builder	HealthSupport.Builder.addExcluded(Collection<String> names)	Add health checks to a black list.
HealthSupport.Builder	HealthSupport.Builder.addExcludedClass(Class<?> aClass)	A class may be excluded from invoking health checks on it.
HealthSupport.Builder	HealthSupport.Builder.addIncluded(Collection<String> names)	Add health checks to a white list (in case HealthSupport.includeAll is set to false.
HealthSupport.Builder	HealthSupport.Builder.enabled(boolean enabled)	HealthSupport can be disabled by invoking this method.
HealthSupport.Builder	HealthSupport.Builder.timeout(long timeout, TimeUnit unit)	Configure overall timeout of health check call.

Uses of ConfiguredOption in io.helidon.integrations.oci.metrics

Methods in io.helidon.integrations.oci.metrics with annotations of type ConfiguredOption

Modifier and Type	Method	Description
OciMetricsSupport.Builder	OciMetricsSupport.Builder.batchDelay(long value)	Sets the delay interval if metrics are posted in batches (defaults to 1L).
OciMetricsSupport.Builder	OciMetricsSupport.Builder.batchSize(int value)	Sets the maximum no.
OciMetricsSupport.Builder	OciMetricsSupport.Builder.compartmentId(String value)	Sets the compartment ID.
OciMetricsSupport.Builder	OciMetricsSupport.Builder.delay(long value)	Sets the delay interval between metric posting (defaults to 60L).
OciMetricsSupport.Builder	OciMetricsSupport.Builder.descriptionEnabled(boolean value)	Sets whether the description should be enabled or not.
OciMetricsSupport.Builder	OciMetricsSupport.Builder.enabled(boolean value)	Sets whether metrics transmission to OCI is enabled.
OciMetricsSupport.Builder	OciMetricsSupport.Builder.initialDelay(long value)	Sets the initial delay before metrics are sent to OCI (defaults to 1L).
OciMetricsSupport.Builder	OciMetricsSupport.Builder.namespace(String value)	Sets the namespace.
OciMetricsSupport.Builder	OciMetricsSupport.Builder.resourceGroup(String value)	Sets the resource group.
OciMetricsSupport.Builder	OciMetricsSupport.Builder.schedulingTimeUnit(TimeUnit timeUnit)	Sets the time unit applied to the initial delay and delay values (defaults to TimeUnit.SECONDS).
OciMetricsSupport.Builder	OciMetricsSupport.Builder.scopes(String[] value)	Sets which metrics scopes (e.g., base, vendor, application) should be sent to OCI.

Uses of ConfiguredOption in io.helidon.media.common

Methods in io.helidon.media.common with annotations of type ConfiguredOption

Modifier and Type	Method	Description
MediaContext.Builder	MediaContext.Builder.config(Config config)	Configures this MediaContext.Builder from the supplied Config.
MediaContext.Builder	MediaContext.Builder.discoverServices(boolean discoverServices)	Whether Java Service Loader should be used to load MediaSupportProvider.
MediaContext.Builder	MediaContext.Builder.filterServices(boolean filterServices)	Whether services loaded by Java Service Loader should be filtered.
MediaContext.Builder	MediaContext.Builder.registerDefaults(boolean registerDefaults)	Whether default readers and writers should be registered.

Uses of ConfiguredOption in io.helidon.metrics.api

Methods in io.helidon.metrics.api with annotations of type ConfiguredOption

Modifier and Type	Method	Description
MetricsSettings.Builder	MetricsSettings.Builder.appTagValue(String appTag)	Sets the value for the _app tag to be applied to all metrics.
MetricsSettings.Builder	MetricsSettings.Builder.baseMetricsSettings(BaseMetricsSettings.Builder baseMetricsSettingsBuilder)	Set the base metrics settings.
BaseMetricsSettings.Builder	BaseMetricsSettings.Builder.enableBaseMetric(String dottedName, boolean value)	Sets whether a specific base metric should be enabled.
BaseMetricsSettings.Builder	BaseMetricsSettings.Builder.enabled(boolean value)	Sets whether base metrics should be enabled.
ComponentMetricsSettings.Builder	ComponentMetricsSettings.Builder.enabled(boolean value)	Sets whether metrics should be enabled for the component.
MetricsSettings.Builder	MetricsSettings.Builder.enabled(boolean value)	Sets whether metrics should be enabled.
RegistrySettings.Builder	RegistrySettings.Builder.enabled(boolean value)	Sets whether the metric type should be enabled.
RegistryFilterSettings.Builder	RegistryFilterSettings.Builder.exclude(String excludeFilter)	Sets the regex for names to exclude.
KeyPerformanceIndicatorMetricsSettings.Builder	KeyPerformanceIndicatorMetricsSettings.Builder.extended(boolean value)	Sets whether exntended KPI metrics should be enabled in the settings.
RegistrySettings.Builder	RegistrySettings.Builder.filterSettings(RegistryFilterSettings.Builder registryFilterSettingsBuilder)	Sets the filter to use for identifying specific metrics to enable.
MetricsSettings.Builder	MetricsSettings.Builder.globalTags(Map<String,String> globalTags)	Sets the global tags to be applied to all metrics.
RegistryFilterSettings.Builder	RegistryFilterSettings.Builder.include(String includeFilter)	Sets the refex for names to include.
MetricsSettings.Builder	MetricsSettings.Builder.keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder kpiSettings)	Set the KPI metrics settings.
KeyPerformanceIndicatorMetricsSettings.Builder	KeyPerformanceIndicatorMetricsSettings.Builder.longRunningRequestThresholdMs(long value)	Sets the long-running request threshold (in ms).
MetricsSettings.Builder	MetricsSettings.Builder.registrySettings(MetricRegistry.Type registryType, RegistrySettings registrySettings)	Sets the registry settings for the specified registry type.
RegistrySettings.Builder	RegistrySettings.Builder.strictExemplars(boolean value)	Whether to add exemplars (if exemplar providers are present) only to counter totals and buckets.

Uses of ConfiguredOption in io.helidon.metrics.serviceapi

Methods in io.helidon.metrics.serviceapi with annotations of type ConfiguredOption

Modifier and Type	Method	Description
B	MetricsSupport.Builder.metricsSettings(MetricsSettings.Builder metricsSettingsBuilder)	Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.
B	MetricsSupport.Builder.restServiceSettings(RestServiceSettings.Builder restServiceSettingsBuilder)	Set the REST service settings.

Uses of ConfiguredOption in io.helidon.microprofile.server

Methods in io.helidon.microprofile.server with annotations of type ConfiguredOption

Modifier and Type	Method	Description
Server.Builder	Server.Builder.defaultExecutorServiceSupplier(Supplier<? extends ExecutorService> supplier)	Set a supplier of an executor service to use for tasks connected with application processing (JAX-RS).
Server.Builder	Server.Builder.host(String host)	Configure listen host.
Server.Builder	Server.Builder.port(int port)	Configure listen port.

Uses of ConfiguredOption in io.helidon.openapi

Methods in io.helidon.openapi with annotations of type ConfiguredOption

Modifier and Type	Method	Description
SEOpenAPISupportBuilder	SEOpenAPISupportBuilder.config(Config config)	Assigns various OpenAPI settings from the specified openapi Config object.
B	OpenAPISupport.Builder.crossOriginConfig(CrossOriginConfig crossOriginConfig)	Assigns the CORS settings for the OpenAPI endpoint.
B	OpenApiUi.Builder.isEnabled(boolean isEnabled)	Sets whether the UI should be enabled.
B	OpenApiUi.Builder.options(Map<String,String> options)	Merges implementation-specific UI options.
B	OpenAPISupport.Builder.staticFile(String path)	Sets the file system path of the static OpenAPI document file.
B	OpenAPISupport.Builder.ui(OpenApiUi.Builder<?,?> uiBuilder)	Assigns the OpenAPI UI builder the OpenAPISupport service should use in preparing the UI.
B	OpenAPISupport.Builder.webContext(String path)	Sets the web context path for the OpenAPI endpoint.
B	OpenApiUi.Builder.webContext(String webContext)	Sets the entire web context (not just the suffix) where the UI response.

Uses of ConfiguredOption in io.helidon.security

Methods in io.helidon.security with annotations of type ConfiguredOption

Modifier and Type	Method	Description
Security.Builder	Security.Builder.addProvider(SecurityProvider provider)	Add a provider, works as Security.Builder.addProvider(io.helidon.security.spi.SecurityProvider, String), where the name is set to Class.getSimpleName().
Security.Builder	Security.Builder.authenticationProvider(AuthenticationProvider provider)	Set the default authentication provider.
Security.Builder	Security.Builder.authorizationProvider(AuthorizationProvider provider)	Set the default authorization provider.
Security.Builder	Security.Builder.enabled(boolean enabled)	Security can be disabled using configuration, or explicitly.
Security.Builder	Security.Builder.executorService(Supplier<ExecutorService> supplier)	Configure executor service to be used for blocking operations within security.
Security.Builder	Security.Builder.serverTime(SecurityTime time)	Server time to use when evaluating security policies that depend on time.
SecurityTime.Builder	SecurityTime.Builder.shiftBySeconds(long seconds)	Configure a time-shift in seconds, to move the current time to past or future.
SecurityTime.Builder	SecurityTime.Builder.timeZone(ZoneId zoneId)	Override current time zone.
Security.Builder	Security.Builder.tracingEnabled(boolean tracingEnabled)	Whether or not tracing should be enabled.

Uses of ConfiguredOption in io.helidon.security.providers.abac

Methods in io.helidon.security.providers.abac with annotations of type ConfiguredOption

Modifier and Type	Method	Description
AbacProvider.Builder	AbacProvider.Builder.failIfNoneValidated(boolean failIfNoneValidated)	Whether to fail if NONE of the attributes is validated.
AbacProvider.Builder	AbacProvider.Builder.failOnUnvalidated(boolean failOnUnvalidated)	Whether to fail if any attribute is left unvalidated.

Uses of ConfiguredOption in io.helidon.security.providers.common

Methods in io.helidon.security.providers.common with annotations of type ConfiguredOption

Modifier and Type	Method	Description
OutboundTarget.Builder	OutboundTarget.Builder.addHost(String host)	Add supported host for this target.
OutboundTarget.Builder	OutboundTarget.Builder.addMethod(String method)	Add supported method for this target.
OutboundTarget.Builder	OutboundTarget.Builder.addPath(String path)	Add supported paths for this target.
OutboundConfig.Builder	OutboundConfig.Builder.addTarget(OutboundTarget config)	Add a new target configuration.
OutboundTarget.Builder	OutboundTarget.Builder.addTransport(String transport)	Add supported transports for this target.
EvictableCache.Builder<K,V>	EvictableCache.Builder.cacheEnabled(boolean cacheEnabled)	If the cacheEnabled is set to false, no caching will be done.
EvictableCache.Builder<K,V>	EvictableCache.Builder.evictor(BiFunction<K,V,Boolean> evictor)	Configure evictor to check if a record is still valid.
EvictableCache.Builder<K,V>	EvictableCache.Builder.maxSize(long cacheMaxSize)	Configure maximal cache size.
OutboundTarget.Builder	OutboundTarget.Builder.name(String name)	Configure the name of this outbound target.
EvictableCache.Builder<K,V>	EvictableCache.Builder.overallTimeout(long timeout, TimeUnit timeoutUnit)	Configure record timeout since its creation.
EvictableCache.Builder<K,V>	EvictableCache.Builder.parallelismThreshold(long parallelismThreshold)	Configure parallelism threshold.
EvictableCache.Builder<K,V>	EvictableCache.Builder.timeout(long timeout, TimeUnit timeoutUnit)	Configure record timeout since last access.

Uses of ConfiguredOption in io.helidon.security.providers.config.vault

Methods in io.helidon.security.providers.config.vault with annotations of type ConfiguredOption

Modifier and Type	Method	Description
static ConfigVaultProvider.SecretConfig	ConfigVaultProvider.SecretConfig.create(String value)	Create a new secret from a value.
ConfigVaultProvider.Builder	ConfigVaultProvider.Builder.masterPassword(char[] masterPassword)	Configure master password used for encryption/decryption.

Uses of ConfiguredOption in io.helidon.security.providers.google.login

Methods in io.helidon.security.providers.google.login with annotations of type ConfiguredOption

Modifier and Type	Method	Description
GoogleTokenProvider.Builder	GoogleTokenProvider.Builder.clientId(String clientId)	Google application client id, to validate that the token was generated by Google for us.
GoogleTokenProvider.Builder	GoogleTokenProvider.Builder.optional(boolean optional)	If set to true, this provider will return SecurityResponse.SecurityStatus.ABSTAIN instead of failing in case of invalid request.
GoogleTokenProvider.Builder	GoogleTokenProvider.Builder.outboundConfig(OutboundConfig outboundConfig)	Outbound configuration - a set of outbound targets that will have the token propagated.
GoogleTokenProvider.Builder	GoogleTokenProvider.Builder.proxyHost(String host)	Set proxy host when talking to Google.
GoogleTokenProvider.Builder	GoogleTokenProvider.Builder.proxyPort(int port)	Set proxy port when talking to Google.
GoogleTokenProvider.Builder	GoogleTokenProvider.Builder.realm(String realm)	Set the authentication realm to build challenge, defaults to "helidon".
GoogleTokenProvider.Builder	GoogleTokenProvider.Builder.tokenProvider(TokenHandler provider)	Token provider to extract Google access token from request, defaults to "Authorization" header with a "bearer " prefix.

Uses of ConfiguredOption in io.helidon.security.providers.header

Methods in io.helidon.security.providers.header with annotations of type ConfiguredOption

Modifier and Type	Method	Description
HeaderAtnProvider.Builder	HeaderAtnProvider.Builder.addOutboundTarget(OutboundTarget target)	Configure outbound target for identity propagation.
HeaderAtnProvider.Builder	HeaderAtnProvider.Builder.atnTokenHandler(TokenHandler tokenHandler)	Token handler to extract username from request.
HeaderAtnProvider.Builder	HeaderAtnProvider.Builder.authenticate(boolean authenticate)	Whether to authenticate requests.
HeaderAtnProvider.Builder	HeaderAtnProvider.Builder.optional(boolean optional)	Whether authentication is required.
HeaderAtnProvider.Builder	HeaderAtnProvider.Builder.outboundTokenHandler(TokenHandler tokenHandler)	Token handler to create outbound headers to propagate identity.
HeaderAtnProvider.Builder	HeaderAtnProvider.Builder.propagate(boolean propagate)	Whether to propagate identity.
HeaderAtnProvider.Builder	HeaderAtnProvider.Builder.subjectType(SubjectType subjectType)	Principal type this provider extracts (and also propagates).

Uses of ConfiguredOption in io.helidon.security.providers.httpauth

Methods in io.helidon.security.providers.httpauth with annotations of type ConfiguredOption

Modifier and Type	Method	Description
HttpDigestAuthProvider.Builder	HttpDigestAuthProvider.Builder.addDigestQop(HttpDigest.Qop qop)	Digest QOP to support.
HttpBasicAuthProvider.Builder	HttpBasicAuthProvider.Builder.addOutboundTarget(OutboundTarget target)	Add a new outbound target to configure identity propagation or explicit username/password.
HttpDigestAuthProvider.Builder	HttpDigestAuthProvider.Builder.digestAlgorithm(HttpDigest.Algorithm algorithm)	Digest algorithm to use.
HttpDigestAuthProvider.Builder	HttpDigestAuthProvider.Builder.digestNonceTimeout(long duration, TimeUnit unit)	How long will the nonce value be valid.
HttpDigestAuthProvider.Builder	HttpDigestAuthProvider.Builder.digestServerSecret(char[] serverSecret)	The nonce is encrypted using this secret - to make sure the nonce we get back was generated by us and to make sure we can safely time-out nonce values.
HttpBasicAuthProvider.Builder	HttpBasicAuthProvider.Builder.optional(boolean optional)	Whether authentication is required.
HttpDigestAuthProvider.Builder	HttpDigestAuthProvider.Builder.optional(boolean optional)	Whether authentication is required.
HttpBasicAuthProvider.Builder	HttpBasicAuthProvider.Builder.realm(String realm)	Set the realm to use when challenging users.
HttpDigestAuthProvider.Builder	HttpDigestAuthProvider.Builder.realm(String realm)	Set the realm to use when challenging users.
HttpBasicAuthProvider.Builder	HttpBasicAuthProvider.Builder.subjectType(SubjectType subjectType)	Principal type this provider extracts (and also propagates).
HttpDigestAuthProvider.Builder	HttpDigestAuthProvider.Builder.subjectType(SubjectType subjectType)	Principal type this provider extracts (and also propagates).
HttpBasicAuthProvider.Builder	HttpBasicAuthProvider.Builder.userStore(SecureUserStore store)	Set user store to validate users.
HttpDigestAuthProvider.Builder	HttpDigestAuthProvider.Builder.userStore(SecureUserStore store)	Set user store to obtain passwords and roles based on logins.

Uses of ConfiguredOption in io.helidon.security.providers.httpsign

Methods in io.helidon.security.providers.httpsign with annotations of type ConfiguredOption

Modifier and Type	Method	Description
HttpSignProvider.Builder	HttpSignProvider.Builder.addAcceptHeader(HttpSignHeader header)	Add a header that is validated on inbound requests.
HttpSignProvider.Builder	HttpSignProvider.Builder.addInbound(InboundClientDefinition client)	Add inbound configuration.
InboundClientDefinition.Builder	InboundClientDefinition.Builder.algorithm(String algorithm)	Algorithm of signature used by this client.
HttpSignProvider.Builder	HttpSignProvider.Builder.backwardCompatibleEol(Boolean backwardCompatible)	Enable support for Helidon versions before 3.0.0 (exclusive).
InboundClientDefinition.Builder	InboundClientDefinition.Builder.hmacSecret(String secret)	Helper method to configure a password-like secret (instead of byte based InboundClientDefinition.Builder.hmacSecret(byte[]).
HttpSignProvider.Builder	HttpSignProvider.Builder.inboundRequiredHeaders(SignedHeadersConfig inboundRequiredHeaders)	Override the default inbound required headers (e.g.
InboundClientDefinition.Builder	InboundClientDefinition.Builder.keyId(String keyId)	The key id of this client to map to this signature validation configuration.
HttpSignProvider.Builder	HttpSignProvider.Builder.optional(boolean optional)	Set whether the signature is optional.
HttpSignProvider.Builder	HttpSignProvider.Builder.outbound(OutboundConfig targets)	Add outbound targets to this builder.
InboundClientDefinition.Builder	InboundClientDefinition.Builder.principalName(String name)	The principal name of the client, defaults to keyId if not configured.
InboundClientDefinition.Builder	InboundClientDefinition.Builder.publicKeyConfig(KeyConfig keyConfig)	For algorithms based on public/private key (such as rsa-sha256), this provides access to the public key of the client.
HttpSignProvider.Builder	HttpSignProvider.Builder.realm(String realm)	Realm to use for challenging inbound requests that do not have "Authorization" header in case header is HttpSignHeader.AUTHORIZATION and singatures are not optional.
InboundClientDefinition.Builder	InboundClientDefinition.Builder.subjectType(SubjectType type)	The type of principal we have authenticated (either user or service, defaults to service).

Uses of ConfiguredOption in io.helidon.security.providers.idcs.mapper

Methods in io.helidon.security.providers.idcs.mapper with annotations of type ConfiguredOption

Modifier and Type	Method	Description
B	IdcsRoleMapperRxProviderBase.Builder.addSubjectType(SubjectType type)	Add a supported subject type.
B	IdcsMtRoleMapperRxProvider.Builder.cache(EvictableCache<IdcsMtRoleMapperRxProvider.MtCacheKey,List<Grant>> roleCache)	Use explicit EvictableCache for role caching.
B	IdcsRoleMapperRxProviderBase.Builder.defaultIdcsSubjectType(String subjectType)	Configure subject type to use when requesting roles from IDCS.
B	IdcsMtRoleMapperRxProvider.Builder.idcsAppNameTokenHandler(TokenHandler idcsAppNameTokenHandler)	Configure token handler for IDCS Application name.
B	IdcsMtRoleMapperRxProvider.Builder.idcsTenantTokenHandler(TokenHandler idcsTenantTokenHandler)	Configure token handler for IDCS Tenant ID.
B	IdcsRoleMapperRxProviderBase.Builder.oidcConfig(OidcConfig config)	Use explicit OidcConfig instance, e.g.
B	IdcsRoleMapperRxProvider.Builder.roleCache(EvictableCache<String,List<Grant>> roleCache)	Use explicit EvictableCache for role caching.

Uses of ConfiguredOption in io.helidon.security.providers.jwt

Methods in io.helidon.security.providers.jwt with annotations of type ConfiguredOption

Modifier and Type	Method	Description
JwtProvider.Builder	JwtProvider.Builder.allowImpersonation(boolean allowImpersonation)	Whether to allow impersonation by explicitly overriding username from outbound requests using EndpointConfig.PROPERTY_OUTBOUND_ID property.
JwtProvider.Builder	JwtProvider.Builder.allowUnsigned(boolean allowUnsigned)	Configure support for unsigned JWT.
JwtProvider.Builder	JwtProvider.Builder.atnTokenHandler(TokenHandler tokenHandler)	Token handler to extract username from request.
JwtProvider.Builder	JwtProvider.Builder.authenticate(boolean authenticate)	Whether to authenticate requests.
void	JwtProvider.Builder.expectedAudience(String audience)	Audience expected in inbound JWTs.
JwtProvider.Builder	JwtProvider.Builder.issuer(String issuer)	Issuer used to create new JWTs.
JwtProvider.Builder	JwtProvider.Builder.optional(boolean optional)	Whether authentication is required.
JwtProvider.Builder	JwtProvider.Builder.outboundConfig(OutboundConfig config)	Configuration of outbound rules.
JwtProvider.Builder	JwtProvider.Builder.propagate(boolean propagate)	Whether to propagate identity.
JwtProvider.Builder	JwtProvider.Builder.signJwk(Resource signJwkResource)	JWK resource used to sign JWTs created by us.
JwtProvider.Builder	JwtProvider.Builder.subjectType(SubjectType subjectType)	Principal type this provider extracts (and also propagates).
JwtProvider.Builder	JwtProvider.Builder.useJwtGroups(boolean useJwtGroups)	Claim groups from JWT will be used to automatically add groups to current subject (may be used with RolesAllowed annotation).
JwtProvider.Builder	JwtProvider.Builder.verifyJwk(Resource verifyJwkResource)	JWK resource used to verify JWTs created by other parties.
JwtProvider.Builder	JwtProvider.Builder.verifySignature(boolean shouldValidate)	Configure whether to verify signatures.

Uses of ConfiguredOption in io.helidon.security.providers.oidc

Methods in io.helidon.security.providers.oidc with annotations of type ConfiguredOption

Modifier and Type	Method	Description
OidcProvider.Builder	OidcProvider.Builder.oidcConfig(OidcConfig config)	Configuration of OIDC (Open ID Connect).
OidcProvider.Builder	OidcProvider.Builder.optional(boolean optional)	Whether authentication is required.
OidcProvider.Builder	OidcProvider.Builder.outboundConfig(OutboundConfig config)	Configuration of outbound rules.
OidcProvider.Builder	OidcProvider.Builder.propagate(boolean propagate)	Whether to propagate identity.
OidcProvider.Builder	OidcProvider.Builder.useJwtGroups(boolean useJwtGroups)	Claim groups from JWT will be used to automatically add groups to current subject (may be used with RolesAllowed annotation).

Uses of ConfiguredOption in io.helidon.security.providers.oidc.common

Methods in io.helidon.security.providers.oidc.common with annotations of type ConfiguredOption

Modifier and Type	Method	Description
OidcConfig.Builder	OidcConfig.Builder.addTenantConfig(TenantConfig tenantConfig)	Add specific TenantConfig instance.
OidcConfig.Builder	OidcConfig.Builder.cookieDomain(String domain)	Domain the cookie is valid for.
OidcConfig.Builder	OidcConfig.Builder.cookieHttpOnly(Boolean httpOnly)	When using cookie, if set to true, the HttpOnly attribute will be configured.
OidcConfig.Builder	OidcConfig.Builder.cookieMaxAgeSeconds(long age)	When using cookie, used to set MaxAge attribute of the cookie, defining how long the cookie is valid.
OidcConfig.Builder	OidcConfig.Builder.cookieName(String cookieName)	Name of the cookie to use.
OidcConfig.Builder	OidcConfig.Builder.cookiePath(String path)	Path the cookie is valid for.
OidcConfig.Builder	OidcConfig.Builder.cookieSameSite(SetCookie.SameSite sameSite)	When using cookie, used to set the SameSite cookie value.
OidcConfig.Builder	OidcConfig.Builder.cookieSecure(Boolean secure)	When using cookie, if set to true, the Secure attribute will be configured.
OidcConfig.Builder	OidcConfig.Builder.cookieTenantName(String cookieName)	Name of the cookie to use for tenant name.
OidcConfig.Builder	OidcConfig.Builder.crossOriginConfig(CrossOriginConfig crossOriginConfig)	Assign cross-origin resource sharing settings.
OidcConfig.Builder	OidcConfig.Builder.forceHttpsRedirects(boolean forceHttpsRedirects)	Force HTTPS for redirects to identity provider.
OidcConfig.Builder	OidcConfig.Builder.frontendUri(String uri)	Full URI of this application that is visible from user browser.
OidcConfig.Builder	OidcConfig.Builder.headerTokenHandler(TokenHandler tokenHandler)	A TokenHandler to process header containing a JWT.
OidcConfig.Builder	OidcConfig.Builder.maxRedirects(int maxRedirects)	Configure maximal number of redirects when redirecting to an OIDC provider within a single authentication attempt.
TenantConfig.Builder	TenantConfig.Builder.name(String name)	Name of the tenant.
OidcConfig.Builder	OidcConfig.Builder.paramName(String paramName)	Name of a query parameter that contains the JWT token when parameter is used.
OidcConfig.Builder	OidcConfig.Builder.paramTenantName(String paramName)	Name of a query parameter that contains the tenant name when parameter is used.
OidcConfig.Builder	OidcConfig.Builder.proxyHost(String proxyHost)	Proxy host to use.
OidcConfig.Builder	OidcConfig.Builder.proxyPort(int proxyPort)	Proxy port.
OidcConfig.Builder	OidcConfig.Builder.proxyProtocol(String protocol)	Proxy protocol to use when proxy is used.
OidcConfig.Builder	OidcConfig.Builder.redirect(boolean redirect)	By default, the client should redirect to the identity server for the user to log in.
OidcConfig.Builder	OidcConfig.Builder.redirectAttemptParam(String paramName)	Configure the parameter used to store the number of attempts in redirect.
OidcConfig.Builder	OidcConfig.Builder.redirectUri(String redirectUri)	URI to register web server component on, used by the OIDC server to redirect authorization requests to after a user logs in or approves scopes.
OidcConfig.Builder	OidcConfig.Builder.relativeUris(boolean relativeUris)	Can be set to true to force the use of relative URIs in all requests, regardless of the presence or absence of proxies or no-proxy lists.
OidcConfig.Builder	OidcConfig.Builder.useCookie(Boolean useCookie)	Whether to use cookie to store JWT between requests.
OidcConfig.Builder	OidcConfig.Builder.useHeader(Boolean useHeader)	Whether to expect JWT in a header field.
OidcConfig.Builder	OidcConfig.Builder.useParam(Boolean useParam)	Whether to use a query parameter to send JWT token from application to this server.

Uses of ConfiguredOption in io.helidon.security.util

Methods in io.helidon.security.util with annotations of type ConfiguredOption

Modifier and Type	Method	Description
TokenHandler.Builder	TokenHandler.Builder.tokenFormat(String format)	Token format for creating outbound tokens.
TokenHandler.Builder	TokenHandler.Builder.tokenHeader(String header)	Set the name of header to look into to extract the token.
TokenHandler.Builder	TokenHandler.Builder.tokenPattern(Pattern pattern)	Set the token pattern (Regular expression) to extract the token.
TokenHandler.Builder	TokenHandler.Builder.tokenPrefix(String prefix)	Set the prefix of header value to extract the token.

Uses of ConfiguredOption in io.helidon.servicecommon.rest

Methods in io.helidon.servicecommon.rest with annotations of type ConfiguredOption

Modifier and Type	Method	Description
RestServiceSettings.Builder	RestServiceSettings.Builder.crossOriginConfig(CrossOriginConfig.Builder crossOriginConfigBuilder)	Sets the cross-origin config builder for use in establishing CORS support for the service endpoints.
B	HelidonRestServiceSupport.Builder.restServiceSettings(RestServiceSettings.Builder restServiceSettingsBuilder)	Sets the builder for the REST service settings.
RestServiceSettings.Builder	RestServiceSettings.Builder.routing(String routing)	Sets the routing name to use for setting up the service's endpoint.
RestServiceSettings.Builder	RestServiceSettings.Builder.webContext(String webContext)	Sets the web context to use for the service's endpoint.

Uses of ConfiguredOption in io.helidon.tracing

Methods in io.helidon.tracing with annotations of type ConfiguredOption

Modifier and Type	Method	Description
T	TracerBuilder.addTracerTag(String key, boolean value)	Tracer level tags that get added to all reported spans.
T	TracerBuilder.addTracerTag(String key, Number value)	Tracer level tags that get added to all reported spans.
T	TracerBuilder.addTracerTag(String key, String value)	Tracer level tags that get added to all reported spans.
T	TracerBuilder.collectorHost(String host)	Host to use to connect to tracing collector.
T	TracerBuilder.collectorPath(String path)	Path on the collector host to use when sending data to tracing collector.
T	TracerBuilder.collectorPort(int port)	Port to use to connect to tracing collector.
T	TracerBuilder.collectorProtocol(String protocol)	Protocol to use (such as http or https) to connect to tracing collector.
T	TracerBuilder.enabled(boolean enabled)	When enabled, tracing will be sent.
T	TracerBuilder.registerGlobal(boolean global)	When enabled, the created instance is also registered as a global tracer.
T	TracerBuilder.serviceName(String name)	Service name of the traced service.

Uses of ConfiguredOption in io.helidon.tracing.jaeger

Methods in io.helidon.tracing.jaeger with annotations of type ConfiguredOption

Modifier and Type	Method	Description
JaegerTracerBuilder	JaegerTracerBuilder.addPropagation(JaegerTracerBuilder.PropagationFormat propagationFormat)	Add propagation format to use.
JaegerTracerBuilder	JaegerTracerBuilder.clientCertificate(Resource resource)	Certificate of client in PEM format.
JaegerTracerBuilder	JaegerTracerBuilder.exporterTimeout(Duration exporterTimeout)	Timeout of exporter requests.
JaegerTracerBuilder	JaegerTracerBuilder.maxExportBatchSize(int maxExportBatchSize)	Maximum Export Batch Size of exporter requests.
JaegerTracerBuilder	JaegerTracerBuilder.maxQueueSize(int maxQueueSize)	Maximum Queue Size of exporter requests.
JaegerTracerBuilder	JaegerTracerBuilder.privateKey(Resource resource)	Private key in PEM format.
JaegerTracerBuilder	JaegerTracerBuilder.samplerParam(Number samplerParam)	The sampler parameter (number).
JaegerTracerBuilder	JaegerTracerBuilder.samplerType(JaegerTracerBuilder.SamplerType samplerType)	Sampler type.
JaegerTracerBuilder	JaegerTracerBuilder.scheduleDelay(Duration scheduleDelay)	Schedule Delay of exporter requests.
JaegerTracerBuilder	JaegerTracerBuilder.spanProcessorType(JaegerTracerBuilder.SpanProcessorType spanProcessorType)	Span Processor type used.
JaegerTracerBuilder	JaegerTracerBuilder.trustedCertificates(Resource resource)	Trusted certificates in PEM format.

Uses of ConfiguredOption in io.helidon.tracing.opentracing

Methods in io.helidon.tracing.opentracing with annotations of type ConfiguredOption

Modifier and Type	Method	Description
T	OpenTracingTracerBuilder.addTracerTag(String key, boolean value)	Tracer level tags that get added to all reported spans.
T	OpenTracingTracerBuilder.addTracerTag(String key, Number value)	Tracer level tags that get added to all reported spans.
T	OpenTracingTracerBuilder.addTracerTag(String key, String value)	Tracer level tags that get added to all reported spans.
T	OpenTracingTracerBuilder.collectorHost(String host)	Host to use to connect to tracing collector.
T	OpenTracingTracerBuilder.collectorPath(String path)	Path on the collector host to use when sending data to tracing collector.
T	OpenTracingTracerBuilder.collectorPort(int port)	Port to use to connect to tracing collector.
T	OpenTracingTracerBuilder.collectorProtocol(String protocol)	Protocol to use (such as http or https) to connect to tracing collector.
T	OpenTracingTracerBuilder.enabled(boolean enabled)	When enabled, tracing will be sent.
T	OpenTracingTracerBuilder.registerGlobal(boolean global)	When enabled, the created instance is also registered as a global tracer.
T	OpenTracingTracerBuilder.serviceName(String name)	Service name of the traced service.

Uses of ConfiguredOption in io.helidon.tracing.zipkin

Methods in io.helidon.tracing.zipkin with annotations of type ConfiguredOption

Modifier and Type	Method	Description
ZipkinTracerBuilder	ZipkinTracerBuilder.baggage(List<String> baggageKeys)	Baggage keys to be propagated.
ZipkinTracerBuilder	ZipkinTracerBuilder.version(ZipkinTracerBuilder.Version version)	Version of Zipkin API to use.

Uses of ConfiguredOption in io.helidon.webclient

Methods in io.helidon.webclient with annotations of type ConfiguredOption

Modifier and Type	Method	Description
Proxy.Builder	Proxy.Builder.addNoProxy(String noProxyHost)	Configure a host pattern that is not going through a proxy.
WebClientTls.Builder	WebClientTls.Builder.allowedCipherSuite(List<String> allowedCipherSuite)	Set allowed cipher suite for the client.
WebClientTls.Builder	WebClientTls.Builder.certificateTrustStore(KeyConfig keyStore)	Sets new certificate trust store.
WebClientTls.Builder	WebClientTls.Builder.clientKeyStore(KeyConfig keyConfig)	Sets new certificate key store.
WebClientTls.Builder	WebClientTls.Builder.disableHostnameVerification(boolean disableHostnameVerification)	Sets if hostname verification should be disabled.
Proxy.Builder	Proxy.Builder.host(String host)	Sets a new host value.
Proxy.Builder	Proxy.Builder.password(char[] password)	Sets a new password for the proxy.
Proxy.Builder	Proxy.Builder.port(int port)	Sets a port value.
WebClientTls.Builder	WebClientTls.Builder.trustAll(boolean trustAll)	Sets if all certificates should be trusted to.
Proxy.Builder	Proxy.Builder.type(Proxy.ProxyType type)	Sets a new proxy type.
Proxy.Builder	Proxy.Builder.username(String username)	Sets a new username for the proxy.
Proxy.Builder	Proxy.Builder.useSystemSelector(boolean useIt)	Configure proxy from environment variables and system properties.

Uses of ConfiguredOption in io.helidon.webserver

Methods in io.helidon.webserver with annotations of type ConfiguredOption

Modifier and Type	Method	Description
WebServer.Builder	WebServer.Builder.addSocket(SocketConfiguration config)	Adds an additional named server socket configuration.
WebServerTls.Builder	WebServerTls.Builder.allowedCipherSuite(List<String> cipherSuite)	Set allowed cipher suite.
B	SocketConfiguration.SocketConfigurationBuilder.backlog(int backlog)	Configures a maximum length of the queue of incoming connections on the server socket.
B	SocketConfiguration.SocketConfigurationBuilder.backpressureBufferSize(long size)	Maximum length of the response data sending buffer can keep without flushing.
B	SocketConfiguration.SocketConfigurationBuilder.backpressureStrategy(BackpressureStrategy backpressureStrategy)	Sets a backpressure strategy for the server to apply against user provided response upstream.
default B	SocketConfiguration.SocketConfigurationBuilder.bindAddress(String address)	Configures local address where the server listens on with the server socket.
WebServerTls.Builder	WebServerTls.Builder.clientAuth(ClientAuthentication clientAuth)	Configures whether client authentication will be required or not.
B	SocketConfiguration.SocketConfigurationBuilder.continueImmediately(boolean continueImmediately)	When true WebServer answers to expect continue with 100 continue immediately, not waiting for user to actually request the data.
B	SocketConfiguration.SocketConfigurationBuilder.enableCompression(boolean value)	Enable negotiation for gzip/deflate content encodings.
WebServerTls.Builder	WebServerTls.Builder.enabled(boolean enabled)	Whether the TLS config should be enabled or not.
default B	SocketConfiguration.SocketConfigurationBuilder.host(String address)	A helper method that just calls SocketConfiguration.SocketConfigurationBuilder.bindAddress(String).
B	SocketConfiguration.SocketConfigurationBuilder.maxHeaderSize(int size)	Maximal number of bytes of all header values combined.
B	SocketConfiguration.SocketConfigurationBuilder.maxInitialLineLength(int length)	Maximal number of characters in the initial HTTP line.
B	SocketConfiguration.SocketConfigurationBuilder.maxPayloadSize(long size)	Set a maximum payload size for a client request.
B	SocketConfiguration.SocketConfigurationBuilder.maxUpgradeContentLength(int size)	Set a maximum length of the content of an upgrade request.
SocketConfiguration.Builder	SocketConfiguration.Builder.name(String name)	Configure a socket name, to bind named routings to.
B	SocketConfiguration.SocketConfigurationBuilder.port(int port)	Configures a server port to listen on with the server socket.
WebServer.Builder	WebServer.Builder.printFeatureDetails(boolean shouldPrint)	Set to true to print detailed feature information on startup.
WebServerTls.Builder	WebServerTls.Builder.privateKey(KeyConfig privateKeyConfig)	Configure private key to use for SSL context.
B	SocketConfiguration.SocketConfigurationBuilder.receiveBufferSize(int receiveBufferSize)	Configures proposed value of the TCP receive window that is advertised to the remote peer on the server socket.
B	SocketConfiguration.SocketConfigurationBuilder.requestedUriDiscoveryEnabled(boolean enabled)	Sets whether requested URI discovery is enabled for the socket.
B	SocketConfiguration.SocketConfigurationBuilder.requestedUriDiscoveryTypes(List<SocketConfiguration.RequestedUriDiscoveryType> types)	Assigns the front-end URI discovery type(s) this socket should use.
WebServerTls.Builder	WebServerTls.Builder.sessionCacheSize(long sessionCacheSize)	Set the size of the cache used for storing SSL session objects.
WebServerTls.Builder	WebServerTls.Builder.sessionTimeoutSeconds(long sessionTimeout)	Set the timeout for the cached SSL session objects, in seconds.
B	SocketConfiguration.SocketConfigurationBuilder.timeout(long amount, TimeUnit unit)	Configures a server socket timeout.
B	SocketConfiguration.SocketConfigurationBuilder.tls(WebServerTls webServerTls)	Configures SSL for this socket.
WebServerTls.Builder	WebServerTls.Builder.tlsManager(TlsManager tlsManager)	The Tls manager.
WebServerTls.Builder	WebServerTls.Builder.trust(KeyConfig trustConfig)	Set the trust key configuration to be used to validate certificates.
WebServerTls.Builder	WebServerTls.Builder.trustAll(boolean trustAll)	Trust any certificate provided by the other side of communication.
B	SocketConfiguration.SocketConfigurationBuilder.trustedProxies(AllowList trustedProxies)	Assigns the settings governing the acceptance and rejection of forwarded headers from incoming requests to this socket.
WebServer.Builder	WebServer.Builder.workersCount(int workers)	Sets a count of threads in pool used to process HTTP requests.

Uses of ConfiguredOption in io.helidon.webserver.cors

Methods in io.helidon.webserver.cors with annotations of type ConfiguredOption

Modifier and Type	Method	Description
CrossOriginConfig.Builder	CrossOriginConfig.Builder.allowCredentials(boolean allowCredentials)
CrossOriginConfig.Builder	CrossOriginConfig.Builder.allowHeaders(String... allowHeaders)
CrossOriginConfig.Builder	CrossOriginConfig.Builder.allowMethods(String... allowMethods)
CrossOriginConfig.Builder	CrossOriginConfig.Builder.allowOrigins(String... origins)
CrossOriginConfig.Builder	CrossOriginConfig.Builder.enabled(boolean enabled)
CrossOriginConfig.Builder	CrossOriginConfig.Builder.exposeHeaders(String... exposeHeaders)
CrossOriginConfig.Builder	CrossOriginConfig.Builder.maxAgeSeconds(long maxAgeSeconds)
CrossOriginConfig.Builder	CrossOriginConfig.Builder.pathPattern(String pathPattern)	Updates the path prefix for this cross-origin config.