Uses of Class
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.config.metadata	Configuration metadata to support IDE auto completion and generation of documentation.
io.helidon.faulttolerance	Fault tolerance for Helidon SE reactive implementation.
io.helidon.integrations.oci.connect	Classes needed for OCI to connect to service API.
io.helidon.integrations.oci.metrics	Integrating with OCI Metrics.
io.helidon.integrations.oci.vault	Integration with OCI Vault REST API including the KMS encryption and digest support.
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.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.httpauth	Basic security provider, supporting "basic" and "digest" authentication schemes with role support.
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.webclient.context.propagation	Propagation of context values across network using HTTP Headers.
io.helidon.webserver	Reactive web server API.
io.helidon.webserver.context.propagation	Propagation of context data across HTTP for Helidon WebServer.

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.config.metadata

Methods in io.helidon.config.metadata that return ConfiguredOption

Modifier and Type	Method	Description
ConfiguredOption[]	value()	Group of options when used on a type.

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.integrations.oci.connect

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

Modifier and Type	Method	Description
OciConfigProfile.Builder	OciConfigProfile.Builder.keyFingerprint(String keyFingerprint)	Key fingerprint.
OciConfigProfile.Builder	OciConfigProfile.Builder.privateKey(String privateKey)	PEM encoded private key.
OciConfigProfile.Builder	OciConfigProfile.Builder.region(String region)	OCI region.
OciConfigProfile.Builder	OciConfigProfile.Builder.tenancyOcid(String tenancyOcid)	Tenancy OCID.
OciConfigProfile.Builder	OciConfigProfile.Builder.userOcid(String userOcid)	User OCID.

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.integrations.oci.vault

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

Modifier and Type	Method	Description
static OciVaultSecurityProvider	OciVaultSecurityProvider.create(Config config)	Create a new instance from configuration.
OciVaultRx.Builder	OciVaultRx.Builder.secretApiVersion(String apiVersion)
OciVaultSecurityProvider.OciVaultSecretConfig.Builder	OciVaultSecurityProvider.OciVaultSecretConfig.Builder.secretId(String secretId)	Secret OCID.
OciVaultSecurityProvider.OciVaultSecretConfig.Builder	OciVaultSecurityProvider.OciVaultSecretConfig.Builder.stage(SecretStage stage)	Secret stage.
OciVaultSecurityProvider.OciVaultSecretConfig.Builder	OciVaultSecurityProvider.OciVaultSecretConfig.Builder.versionName(String versionName)	Secret version name.
OciVaultSecurityProvider.OciVaultSecretConfig.Builder	OciVaultSecurityProvider.OciVaultSecretConfig.Builder.versionNumber(Integer versionNumber)	Secret version number.

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.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.
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
MetricsSupport.Builder<T>	MetricsSupport.Builder.restServiceSettings(RestServiceSettings.Builder restServiceSettingsBuilder)	Set the REST service settings.

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(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.
OutboundTarget.Builder	OutboundTarget.Builder.name(String name)	Configure the name of this outbound target.

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.httpauth

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

Modifier and Type	Method	Description
HttpBasicAuthProvider.Builder	HttpBasicAuthProvider.Builder.optional(boolean optional)	Whether authentication is required.
HttpBasicAuthProvider.Builder	HttpBasicAuthProvider.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).
HttpBasicAuthProvider.Builder	HttpBasicAuthProvider.Builder.userStore(SecureUserStore store)	Set user store to validate users.

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.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.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.
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(io.jaegertracing.Configuration.Propagation propagation)	Add propagation type to use.
JaegerTracerBuilder	JaegerTracerBuilder.logSpans(boolean logSpans)	Whether the reporter should also log the spans.
JaegerTracerBuilder	JaegerTracerBuilder.token(String token)	Authentication token sent as a "Bearer" to the endpoint.

Uses of ConfiguredOption in io.helidon.webclient.context.propagation

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

Modifier and Type	Method	Description
WebClientContextPropagation.Builder	WebClientContextPropagation.Builder.addRecord(PropagationRecord record)	Add a propagation record to the list of records.

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.
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.trust(KeyConfig trustConfig)	Set the trust key configuration to be used to validate certificates.
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.context.propagation

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

Modifier and Type	Method	Description
ContextPropagationFilter.Builder	ContextPropagationFilter.Builder.addRecord(PropagationRecord record)	Add a configuration records.
PropagationRecord.Builder	PropagationRecord.Builder.array(boolean isArray)	Whether this value is a String (false), or an array of Strings (true).
PropagationRecord.Builder	PropagationRecord.Builder.classifier(String classifier)	Classifier of the value to be used with Context.register(Object, Object).
PropagationRecord.Builder	PropagationRecord.Builder.defaultValue(String... defaultValue)	Default value to use, either a single string (any type), or an array of strings (only usable if this is an array).
PropagationRecord.Builder	PropagationRecord.Builder.header(String headerName)	Name of the header expected to contain value to be registered in context.