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

Packages that use ConfiguredOption

Package	Description
io.helidon.cors	Common cross origin configuration and types used by all Helidon flavors.
io.helidon.http	HTTP APIs and implementations usable by both server and client side of the HTTP story.
io.helidon.integrations.neo4j	Neo4j integrations for Helidon.
io.helidon.integrations.oci.metrics	Integrating with OCI Metrics.
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.microprofile.jwt.auth	Implementation of Microprofile JWT Auth specification.
io.helidon.microprofile.server	Microprofile 1.0 server implementation.
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.tracing	Distributed tracing support for Helidon.
io.helidon.tracing.providers.jaeger	Helidon integration with Jaeger tracer.
io.helidon.tracing.providers.opentracing	Open Tracing support that plugs into the TracerBuilder SPI and provides a Tracer implementation.
io.helidon.tracing.providers.zipkin	Brave based Open Tracing implementation for an integration with Zipkin.
io.helidon.webclient.api	Helidon WebClient APIs shared by all types of clients.
io.helidon.webserver.servicecommon	Helidon WebServer Services Common.

Uses of ConfiguredOption in io.helidon.cors

Methods in io.helidon.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.

Uses of ConfiguredOption in io.helidon.http

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

Modifier and Type	Method	Description
RequestedUriDiscoveryContext.Builder	RequestedUriDiscoveryContext.Builder.enabled(boolean value)	Sets whether requested URI discovery is enabled for requestes arriving on the socket.
RequestedUriDiscoveryContext.Builder	RequestedUriDiscoveryContext.Builder.trustedProxies(AllowList trustedProxies)	Sets the trusted proxies for requested URI discovery for requests arriving on the socket.
RequestedUriDiscoveryContext.Builder	RequestedUriDiscoveryContext.Builder.types(List<RequestedUriDiscoveryContext.RequestedUriDiscoveryType> discoveryTypes)	Sets the discovery types for requested URI discovery for requests arriving on the socket.

Uses of ConfiguredOption in io.helidon.integrations.neo4j

Methods in io.helidon.integrations.neo4j with annotations of type ConfiguredOption

Modifier and Type	Method	Description
Neo4j.Builder	Neo4j.Builder.authenticationEnabled(boolean authenticationEnabled)	Enable authentication.
Neo4j.Builder	Neo4j.Builder.certificate(Path certFile)	Set certificate path.
Neo4j.Builder	Neo4j.Builder.connectionAcquisitionTimeout(Duration connectionAcquisitionTimeout)	Set connection acquisition timeout.
Neo4j.Builder	Neo4j.Builder.encrypted(boolean encrypted)	Enable encrypted field.
Neo4j.Builder	Neo4j.Builder.hostnameVerificationEnabled(boolean hostnameVerificationEnabled)	Enable hostname verification.
Neo4j.Builder	Neo4j.Builder.idleTimeBeforeConnectionTest(Duration idleTimeBeforeConnectionTest)	Set idle time.
Neo4j.Builder	Neo4j.Builder.logLeakedSessions(boolean logLeakedSessions)	Enable log leaked sessions.
Neo4j.Builder	Neo4j.Builder.maxConnectionLifetime(Duration maxConnectionLifetime)	Set max life time.
Neo4j.Builder	Neo4j.Builder.maxConnectionPoolSize(int maxConnectionPoolSize)	Set pool size.
Neo4j.Builder	Neo4j.Builder.metricsEnabled(boolean metricsEnabled)	Enable metrics.
Neo4j.Builder	Neo4j.Builder.password(String password)	Create password.
Neo4j.Builder	Neo4j.Builder.trustStrategy(Neo4j.Builder.TrustStrategy strategy)	Set trust strategy.
Neo4j.Builder	Neo4j.Builder.uri(String uri)	Create uri.
Neo4j.Builder	Neo4j.Builder.username(String username)	Create username.

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.metrics.api

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

Modifier and Type	Method	Description
ComponentMetricsSettings.Builder	ComponentMetricsSettings.Builder.enabled(boolean value)	Sets whether metrics should be enabled for the component.
String	Tag.key()	Returns the tag's key.
String	Tag.value()	Returns the tag's value.

Uses of ConfiguredOption in io.helidon.microprofile.jwt.auth

Methods in io.helidon.microprofile.jwt.auth with annotations of type ConfiguredOption

Modifier and Type	Method	Description
JwtAuthProvider.Builder	JwtAuthProvider.Builder.allowImpersonation(boolean allowImpersonation)	Whether to allow impersonation by explicitly overriding username from outbound requests using EndpointConfig.PROPERTY_OUTBOUND_ID property.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.atnTokenHandler(TokenHandler tokenHandler)	Token handler to extract username from request.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.authenticate(boolean authenticate)	Whether to authenticate requests.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.clockSkew(int clockSkew)	Clock skew to be accounted for in token expiration and max age validations in seconds.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.config(Config config)	Load this builder from a configuration.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.cookieProperty(String cookieProperty)	Specific cookie property name where we should search for JWT property.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.decryptKeyAlgorithm(String decryptionKeyAlgorithm)	Expected key management algorithm supported by the MP JWT endpoint.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.decryptKeyLocation(String decryptKeyLocation)	Private key for decryption of encrypted claims.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.defaultKeyId(String defaultKeyId)	Default JWT key ID which should be used.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.expectedAudience(String audience)	Deprecated, for removal: This API element is subject to removal in a future version. use JwtAuthProvider.Builder.addExpectedAudience(String) instead
JwtAuthProvider.Builder	JwtAuthProvider.Builder.expectedAudiences(Collection<String> audiences)	Expected audiences of incoming tokens.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.expectedIssuer(String issuer)	Expected issuer in incoming requests.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.expectedMaxTokenAge(int expectedMaxTokenAge)	Maximal expected token age in seconds.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.jwtHeader(String header)	Name of the header expected to contain the token.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.loadOnStartup(boolean loadOnStartup)	Whether to load JWK verification keys on server startup Default value is false.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.optional(boolean optional)	Whether authentication is required.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.outboundConfig(OutboundConfig config)	Configuration of outbound rules.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.propagate(boolean propagate)	Whether to propagate identity.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.publicKey(String publicKey)	String representation of the public key.
JwtAuthProvider.Builder	JwtAuthProvider.Builder.subjectType(SubjectType subjectType)	Principal type this provider extracts (and also propagates).

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.host(String host)	Configure listen host.
Server.Builder	Server.Builder.port(int port)	Configure listen port.

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.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(Keys 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	IdcsRoleMapperProviderBase.Builder.addSubjectType(SubjectType type)	Add a supported subject type.
B	IdcsMtRoleMapperProvider.Builder.cache(EvictableCache<IdcsMtRoleMapperProvider.MtCacheKey,List<Grant>> roleCache)	Use explicit EvictableCache for role caching.
B	IdcsRoleMapperProviderBase.Builder.defaultIdcsSubjectType(String subjectType)	Configure subject type to use when requesting roles from IDCS.
B	IdcsMtRoleMapperProvider.Builder.idcsAppNameTokenHandler(TokenHandler idcsAppNameTokenHandler)	Configure token handler for IDCS Application name.
B	IdcsMtRoleMapperProvider.Builder.idcsTenantTokenHandler(TokenHandler idcsTenantTokenHandler)	Configure token handler for IDCS Tenant ID.
B	IdcsRoleMapperProviderBase.Builder.oidcConfig(OidcConfig config)	Use explicit OidcConfig instance, e.g.
B	IdcsRoleMapperProvider.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.accessTokenIpCheck(boolean enabled)	Whether to check if current IP address matches the one access token was issued for.
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.cookieEncryptionEnabled(boolean cookieEncryptionEnabled)	Whether to encrypt token cookie created by this microservice.
OidcConfig.Builder	OidcConfig.Builder.cookieEncryptionEnabledIdToken(boolean cookieEncryptionEnabled)	Whether to encrypt id token cookie created by this microservice.
OidcConfig.Builder	OidcConfig.Builder.cookieEncryptionEnabledRefreshToken(boolean cookieEncryptionEnabled)	Whether to encrypt refresh token cookie created by this microservice.
OidcConfig.Builder	OidcConfig.Builder.cookieEncryptionEnabledState(boolean cookieEncryptionEnabled)	Whether to encrypt state cookie created by this microservice.
OidcConfig.Builder	OidcConfig.Builder.cookieEncryptionEnabledTenantName(boolean cookieEncryptionEnabled)	Whether to encrypt tenant name cookie created by this microservice.
OidcConfig.Builder	OidcConfig.Builder.cookieEncryptionName(String cookieEncryptionName)	Name of the encryption configuration available through Security.encrypt(String, byte[]) and Security.decrypt(String, String).
OidcConfig.Builder	OidcConfig.Builder.cookieEncryptionPassword(char[] cookieEncryptionPassword)	Master password for encryption/decryption of cookies.
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.cookieNameIdToken(String cookieName)	Name of the cookie to use for id token.
OidcConfig.Builder	OidcConfig.Builder.cookieNameRefreshToken(String cookieName)	The name of the cookie to use for the refresh token.
OidcConfig.Builder	OidcConfig.Builder.cookieNameState(String cookieName)	The name of the cookie to use for the state storage.
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)	The name of the cookie to use for the 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.idTokenParamName(String idTokenParamName)	Name of a query parameter that contains the JWT id token when parameter is used.
OidcConfig.Builder	OidcConfig.Builder.idTokenSignatureValidation(boolean enabled)	Whether id token signature check should be enabled.
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 access token when parameter is used.
OidcConfig.Builder	OidcConfig.Builder.paramTenantName(String paramName)	Name of a query parameter that contains the tenant name when the 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.tokenSignatureValidation(boolean enabled)	Whether access token signature check should be enabled.
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.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.providers.jaeger

Methods in io.helidon.tracing.providers.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.providers.opentracing

Methods in io.helidon.tracing.providers.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.providers.zipkin

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

Modifier and Type	Method	Description
ZipkinTracerBuilder	ZipkinTracerBuilder.version(ZipkinTracerBuilder.Version version)	Version of Zipkin API to use.

Uses of ConfiguredOption in io.helidon.webclient.api

Methods in io.helidon.webclient.api 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.
Proxy.Builder	Proxy.Builder.forceHttpConnect(boolean forceHttpConnect)	Forces HTTP CONNECT with the proxy server.
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.
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.

Uses of ConfiguredOption in io.helidon.webserver.servicecommon

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

Modifier and Type	Method	Description
B	HelidonFeatureSupport.Builder.crossOriginConfig(CrossOriginConfig crossOriginConfig)	Set the CORS config from the specified CrossOriginConfig object.
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.enabled(boolean enabled)	Is this service enabled or not.
RestServiceSettings.Builder	RestServiceSettings.Builder.routing(String routing)	Sets the routing name to use for setting up the service's endpoint.
B	HelidonFeatureSupport.Builder.webContext(String path)	Set the root context for the REST API of the service.
RestServiceSettings.Builder	RestServiceSettings.Builder.webContext(String webContext)	Sets the web context to use for the service's endpoint.