Skip to content

Commit

Permalink
Regenerated configuration metadata, and a reference fix.
Browse files Browse the repository at this point in the history
  • Loading branch information
tomas-langer committed Jul 29, 2024
1 parent f034842 commit a254689
Show file tree
Hide file tree
Showing 102 changed files with 2,010 additions and 1,544 deletions.
9 changes: 7 additions & 2 deletions docs/src/main/asciidoc/config/config_reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ The following section lists all configurable types in Helidon.
- xref:{rootdir}/config/io_helidon_common_configurable_AllowList.adoc[AllowList (common.configurable)]
- xref:{rootdir}/config/io_helidon_faulttolerance_Async.adoc[Async (faulttolerance)]
- xref:{rootdir}/config/io_helidon_security_providers_oidc_common_BaseBuilder.adoc[BaseBuilder (security.providers.oidc.common)]
- xref:{rootdir}/config/io_helidon_metrics_api_ComponentMetricsSettings_Builder.adoc[Builder (metrics.api.ComponentMetricsSettings)]
- xref:{rootdir}/config/io_helidon_security_providers_idcs_mapper_IdcsRoleMapperProviderBase_Builder.adoc[Builder (security.providers.idcs.mapper.IdcsRoleMapperProviderBase)]
- xref:{rootdir}/config/io_helidon_webserver_servicecommon_HelidonFeatureSupport_Builder.adoc[Builder (webserver.servicecommon.HelidonFeatureSupport)]
- xref:{rootdir}/config/io_helidon_webserver_servicecommon_RestServiceSettings_Builder.adoc[Builder (webserver.servicecommon.RestServiceSettings)]
- xref:{rootdir}/config/io_helidon_faulttolerance_Bulkhead.adoc[Bulkhead (faulttolerance)]
- xref:{rootdir}/config/io_helidon_faulttolerance_CircuitBreaker.adoc[CircuitBreaker (faulttolerance)]
- xref:{rootdir}/config/io_helidon_metrics_api_ComponentMetricsSettings.adoc[ComponentMetricsSettings (metrics.api)]
- xref:{rootdir}/config/io_helidon_integrations_oci_ConfigFileMethodConfig.adoc[ConfigFileMethodConfig (integrations.oci)]
- xref:{rootdir}/config/io_helidon_integrations_oci_ConfigMethodConfig.adoc[ConfigMethodConfig (integrations.oci)]
- xref:{rootdir}/config/io_helidon_webserver_observe_config_ConfigObserver.adoc[ConfigObserver (webserver.observe.config)]
- xref:{rootdir}/config/io_helidon_security_providers_httpauth_ConfigUserStore_ConfigUser.adoc[ConfigUser (security.providers.httpauth.ConfigUserStore)]
- xref:{rootdir}/config/io_helidon_security_providers_config_vault_ConfigVaultProvider.adoc[ConfigVaultProvider (security.providers.config.vault)]
- xref:{rootdir}/config/io_helidon_webserver_ConnectionConfig.adoc[ConnectionConfig (webserver)]
- xref:{rootdir}/config/io_helidon_http_encoding_ContentEncodingContext.adoc[ContentEncodingContext (http.encoding)]
- xref:{rootdir}/config/io_helidon_webserver_context_ContextFeature.adoc[ContextFeature (webserver.context)]
Expand All @@ -53,6 +53,7 @@ The following section lists all configurable types in Helidon.
- xref:{rootdir}/config/io_helidon_webclient_grpc_GrpcClient.adoc[GrpcClient (webclient.grpc)]
- xref:{rootdir}/config/io_helidon_webclient_grpc_GrpcClientProtocolConfig.adoc[GrpcClientProtocolConfig (webclient.grpc)]
- xref:{rootdir}/config/io_helidon_webserver_grpc_GrpcConfig.adoc[GrpcConfig (webserver.grpc)]
- xref:{rootdir}/config/io_helidon_webserver_grpc_GrpcTracingConfig.adoc[GrpcTracingConfig (webserver.grpc)]
- xref:{rootdir}/config/io_helidon_security_providers_header_HeaderAtnProvider.adoc[HeaderAtnProvider (security.providers.header)]
- xref:{rootdir}/config/io_helidon_security_providers_httpsign_SignedHeadersConfig_HeadersConfig.adoc[HeadersConfig (security.providers.httpsign.SignedHeadersConfig)]
- xref:{rootdir}/config/io_helidon_webserver_observe_health_HealthObserver.adoc[HealthObserver (webserver.observe.health)]
Expand All @@ -67,10 +68,12 @@ The following section lists all configurable types in Helidon.
- xref:{rootdir}/config/io_helidon_security_providers_httpsign_HttpSignProvider.adoc[HttpSignProvider (security.providers.httpsign)]
- xref:{rootdir}/config/io_helidon_security_providers_idcs_mapper_IdcsMtRoleMapperProvider.adoc[IdcsMtRoleMapperProvider (security.providers.idcs.mapper)]
- xref:{rootdir}/config/io_helidon_security_providers_idcs_mapper_IdcsRoleMapperProvider.adoc[IdcsRoleMapperProvider (security.providers.idcs.mapper)]
- xref:{rootdir}/config/io_helidon_integrations_oci_ImdsInstanceInfo.adoc[ImdsInstanceInfo (integrations.oci)]
- xref:{rootdir}/config/io_helidon_security_providers_httpsign_InboundClientDefinition.adoc[InboundClientDefinition (security.providers.httpsign)]
- xref:{rootdir}/config/io_helidon_webserver_observe_info_InfoObserver.adoc[InfoObserver (webserver.observe.info)]
- xref:{rootdir}/config/io_helidon_tracing_providers_jaeger_JaegerTracerBuilder.adoc[JaegerTracerBuilder (tracing.providers.jaeger)]
- xref:{rootdir}/config/io_helidon_dbclient_jdbc_JdbcParametersConfig.adoc[JdbcParametersConfig (dbclient.jdbc)]
- xref:{rootdir}/config/io_helidon_microprofile_jwt_auth_JwtAuthProvider.adoc[JwtAuthProvider (microprofile.jwt.auth)]
- xref:{rootdir}/config/io_helidon_security_providers_jwt_JwtProvider.adoc[JwtProvider (security.providers.jwt)]
- xref:{rootdir}/config/io_helidon_metrics_api_KeyPerformanceIndicatorMetricsConfig.adoc[KeyPerformanceIndicatorMetricsConfig (metrics.api)]
- xref:{rootdir}/config/io_helidon_common_pki_Keys.adoc[Keys (common.pki)]
Expand Down Expand Up @@ -104,12 +107,14 @@ The following section lists all configurable types in Helidon.
- xref:{rootdir}/config/io_helidon_webclient_api_Proxy.adoc[Proxy (webclient.api)]
- xref:{rootdir}/config/io_helidon_http_RequestedUriDiscoveryContext.adoc[RequestedUriDiscoveryContext (http)]
- xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource (common.configurable)]
- xref:{rootdir}/config/io_helidon_webserver_servicecommon_RestServiceSettings.adoc[RestServiceSettings (webserver.servicecommon)]
- xref:{rootdir}/config/io_helidon_faulttolerance_Retry.adoc[Retry (faulttolerance)]
- xref:{rootdir}/config/io_helidon_common_tls_RevocationConfig.adoc[RevocationConfig (common.tls)]
- xref:{rootdir}/config/io_helidon_common_configurable_ScheduledThreadPoolConfig.adoc[ScheduledThreadPoolConfig (common.configurable)]
- xref:{rootdir}/config/io_helidon_common_configurable_ScheduledThreadPoolSupplier.adoc[ScheduledThreadPoolSupplier (common.configurable)]
- xref:{rootdir}/config/io_helidon_metrics_api_ScopeConfig.adoc[ScopeConfig (metrics.api)]
- xref:{rootdir}/config/io_helidon_metrics_api_ScopingConfig.adoc[ScopingConfig (metrics.api)]
- xref:{rootdir}/config/io_helidon_security_providers_config_vault_ConfigVaultProvider_SecretConfig.adoc[SecretConfig (security.providers.config.vault.ConfigVaultProvider)]
- xref:{rootdir}/config/io_helidon_security_Security.adoc[Security (security)]
- xref:{rootdir}/config/io_helidon_webserver_security_SecurityFeature.adoc[SecurityFeature (webserver.security)]
- xref:{rootdir}/config/io_helidon_webserver_security_SecurityHandler.adoc[SecurityHandler (webserver.security)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,34 +43,34 @@ Type: link:{javadoc-base-url}/io.helidon.common.configurable/io/helidon/common/c
|key |type |default value |description
|`allow.all` |boolean |`false` |Allows all strings to match (subject to "deny" conditions). An `allow.all` setting of `false` does
not deny all strings but rather represents the absence of a universal match, meaning that other allow and deny settings
determine the matching outcomes.
not deny all strings but rather represents the absence of a universal match, meaning that other allow and deny settings
determine the matching outcomes.
Whether to allow all strings to match (subject to "deny" conditions)
Whether to allow all strings to match (subject to "deny" conditions)
|`allow.exact` |string[] |{nbsp} |Exact strings to allow.
Exact strings to allow
Exact strings to allow
|`allow.pattern` |Pattern[] |{nbsp} |Patterns specifying strings to allow.
Patterns which allow matching
Patterns which allow matching
|`allow.prefix` |string[] |{nbsp} |Prefixes specifying strings to allow.
Prefixes which allow matching
Prefixes which allow matching
|`allow.suffix` |string[] |{nbsp} |Suffixes specifying strings to allow.
Suffixes which allow matching
Suffixes which allow matching
|`deny.exact` |string[] |{nbsp} |Exact strings to deny.
Exact strings to allow
Exact strings to deny
|`deny.pattern` |Pattern[] |{nbsp} |Patterns specifying strings to deny.
Patterns which deny matching
Patterns which deny matching
|`deny.prefix` |string[] |{nbsp} |Prefixes specifying strings to deny.
Prefixes which deny matching
Prefixes which deny matching
|`deny.suffix` |string[] |{nbsp} |Suffixes specifying strings to deny.
Suffixes which deny matching
Suffixes which deny matching
|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Type: link:{javadoc-base-url}/io.helidon.common.configurable/io/helidon/common/c
|`capacity` |int |`10000` |Configure capacity of the cache. Defaults to LruCache.DEFAULT_CAPACITY.
Maximal number of records in the cache before the oldest one is removed
Maximal number of records in the cache before the oldest one is removed
|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,34 +44,34 @@ Type: link:{javadoc-base-url}/io.helidon.common.configurable/io/helidon/common/c
|`content` |string |{nbsp} |Binary content of the resource (base64 encoded).
Binary content
Binary content
|`content-plain` |string |{nbsp} |Plain content of the resource (text).
Plain content
Plain content
|`description` |string |{nbsp} |Description of this resource when configured through plain text or binary.
Description
Description
|`path` |Path |{nbsp} |Resource is located on filesystem.
Path of the resource
Path of the resource
|`proxy-host` |string |{nbsp} |Host of the proxy when using URI.
Proxy host
Proxy host
|`proxy-port` |int |`80` |Port of the proxy when using URI.
Proxy port
Proxy port
|`resource-path` |string |{nbsp} |Resource is located on classpath.
Classpath location of the resource
Classpath location of the resource
|`uri` |URI |{nbsp} |Resource is available on a java.net.URI.
Of the resource
See proxy()
See useProxy()
Of the resource
See proxy()
See useProxy()
|`use-proxy` |boolean |`true` |Whether to use proxy. If set to `false`, proxy will not be used even if configured.
When set to `true` (default), proxy will be used if configured.
When set to `true` (default), proxy will be used if configured.
Whether to use proxy if configured
Whether to use proxy if configured
|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,26 +43,26 @@ Type: link:{javadoc-base-url}/io.helidon.common.configurable/io/helidon/common/c
|key |type |default value |description
|`core-pool-size` |int |`16` |Core pool size of the thread pool executor.
Defaults to DEFAULT_CORE_POOL_SIZE.
Defaults to DEFAULT_CORE_POOL_SIZE.
CorePoolSize see java.util.concurrent.ThreadPoolExecutor.getCorePoolSize()
CorePoolSize see java.util.concurrent.ThreadPoolExecutor.getCorePoolSize()
|`is-daemon` |boolean |`true` |Is daemon of the thread pool executor.
Defaults to DEFAULT_IS_DAEMON.
Defaults to DEFAULT_IS_DAEMON.
Whether the threads are daemon threads
Whether the threads are daemon threads
|`prestart` |boolean |`false` |Whether to prestart core threads in this thread pool executor.
Defaults to DEFAULT_PRESTART.
Defaults to DEFAULT_PRESTART.
Whether to prestart the threads
Whether to prestart the threads
|`thread-name-prefix` |string |`helidon-` |Name prefix for threads in this thread pool executor.
Defaults to DEFAULT_THREAD_NAME_PREFIX.
Defaults to DEFAULT_THREAD_NAME_PREFIX.
Prefix of a thread name
Prefix of a thread name
|`virtual-threads` |boolean |{nbsp} |When configured to `true`, an unbounded virtual executor service (project Loom) will be used.
If enabled, all other configuration options of this executor service are ignored!
If enabled, all other configuration options of this executor service are ignored!
Whether to use virtual threads or not, defaults to `false`
Whether to use virtual threads or not, defaults to `false`
|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,26 +43,26 @@ Type: link:{javadoc-base-url}/io.helidon.common.configurable/io/helidon/common/c
|key |type |default value |description
|`core-pool-size` |int |`16` |Core pool size of the thread pool executor.
Defaults to DEFAULT_CORE_POOL_SIZE.
Defaults to DEFAULT_CORE_POOL_SIZE.
CorePoolSize see java.util.concurrent.ThreadPoolExecutor.getCorePoolSize()
CorePoolSize see java.util.concurrent.ThreadPoolExecutor.getCorePoolSize()
|`is-daemon` |boolean |`true` |Is daemon of the thread pool executor.
Defaults to DEFAULT_IS_DAEMON.
Defaults to DEFAULT_IS_DAEMON.
Whether the threads are daemon threads
Whether the threads are daemon threads
|`prestart` |boolean |`false` |Whether to prestart core threads in this thread pool executor.
Defaults to DEFAULT_PRESTART.
Defaults to DEFAULT_PRESTART.
Whether to prestart the threads
Whether to prestart the threads
|`thread-name-prefix` |string |`helidon-` |Name prefix for threads in this thread pool executor.
Defaults to DEFAULT_THREAD_NAME_PREFIX.
Defaults to DEFAULT_THREAD_NAME_PREFIX.
Prefix of a thread name
Prefix of a thread name
|`virtual-threads` |boolean |{nbsp} |When configured to `true`, an unbounded virtual executor service (project Loom) will be used.
If enabled, all other configuration options of this executor service are ignored!
If enabled, all other configuration options of this executor service are ignored!
Whether to use virtual threads or not, defaults to `false`
Whether to use virtual threads or not, defaults to `false`
|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,58 +43,58 @@ Type: link:{javadoc-base-url}/io.helidon.common.configurable/io/helidon/common/c
|key |type |default value |description
|`core-pool-size` |int |`10` |Core pool size of the thread pool executor.
Defaults to DEFAULT_CORE_POOL_SIZE.
Defaults to DEFAULT_CORE_POOL_SIZE.
CorePoolSize see java.util.concurrent.ThreadPoolExecutor.getCorePoolSize()
CorePoolSize see java.util.concurrent.ThreadPoolExecutor.getCorePoolSize()
|`growth-rate` |int |`0` |The percentage of task submissions that should result in adding threads, expressed as a value from 1 to 100. The
rate applies only when all of the following are true:
rate applies only when all of the following are true:
- the pool size is below the maximum, and
- there are no idle threads, and
- the number of tasks in the queue exceeds the `growthThreshold`
For example, a rate of 20 means that while these conditions are met one thread will be added for every 5 submitted
tasks.
tasks.
Defaults to DEFAULT_GROWTH_RATE
Defaults to DEFAULT_GROWTH_RATE
The growth rate
The growth rate
|`growth-threshold` |int |`1000` |The queue size above which pool growth will be considered if the pool is not fixed size.
Defaults to DEFAULT_GROWTH_THRESHOLD.
Defaults to DEFAULT_GROWTH_THRESHOLD.
The growth threshold
The growth threshold
|`is-daemon` |boolean |`true` |Is daemon of the thread pool executor.
Defaults to DEFAULT_IS_DAEMON.
Defaults to DEFAULT_IS_DAEMON.
Whether the threads are daemon threads
Whether the threads are daemon threads
|`keep-alive` |Duration |`PT3M` |Keep alive of the thread pool executor.
Defaults to DEFAULT_KEEP_ALIVE.
Defaults to DEFAULT_KEEP_ALIVE.
Keep alive see java.util.concurrent.ThreadPoolExecutor.getKeepAliveTime(java.util.concurrent.TimeUnit)
Keep alive see java.util.concurrent.ThreadPoolExecutor.getKeepAliveTime(java.util.concurrent.TimeUnit)
|`max-pool-size` |int |`50` |Max pool size of the thread pool executor.
Defaults to DEFAULT_MAX_POOL_SIZE.
Defaults to DEFAULT_MAX_POOL_SIZE.
MaxPoolSize see java.util.concurrent.ThreadPoolExecutor.getMaximumPoolSize()
MaxPoolSize see java.util.concurrent.ThreadPoolExecutor.getMaximumPoolSize()
|`name` |string |{nbsp} |Name of this thread pool executor.
The pool name
The pool name
|`queue-capacity` |int |`10000` |Queue capacity of the thread pool executor.
Defaults to DEFAULT_QUEUE_CAPACITY.
Defaults to DEFAULT_QUEUE_CAPACITY.
Capacity of the queue backing the executor
Capacity of the queue backing the executor
|`should-prestart` |boolean |`true` |Whether to prestart core threads in this thread pool executor.
Defaults to DEFAULT_PRESTART.
Defaults to DEFAULT_PRESTART.
Whether to prestart the threads
Whether to prestart the threads
|`thread-name-prefix` |string |{nbsp} |Name prefix for threads in this thread pool executor.
Defaults to DEFAULT_THREAD_NAME_PREFIX.
Defaults to DEFAULT_THREAD_NAME_PREFIX.
Prefix of a thread name
Prefix of a thread name
|`virtual-threads` |boolean |{nbsp} |When configured to `true`, an unbounded virtual executor service (project Loom) will be used.
If enabled, all other configuration options of this executor service are ignored!
If enabled, all other configuration options of this executor service are ignored!
Whether to use virtual threads or not, defaults to `false`
Whether to use virtual threads or not, defaults to `false`
|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,58 +43,58 @@ Type: link:{javadoc-base-url}/io.helidon.common.configurable/io/helidon/common/c
|key |type |default value |description
|`core-pool-size` |int |`10` |Core pool size of the thread pool executor.
Defaults to DEFAULT_CORE_POOL_SIZE.
Defaults to DEFAULT_CORE_POOL_SIZE.
CorePoolSize see java.util.concurrent.ThreadPoolExecutor.getCorePoolSize()
CorePoolSize see java.util.concurrent.ThreadPoolExecutor.getCorePoolSize()
|`growth-rate` |int |`0` |The percentage of task submissions that should result in adding threads, expressed as a value from 1 to 100. The
rate applies only when all of the following are true:
rate applies only when all of the following are true:
- the pool size is below the maximum, and
- there are no idle threads, and
- the number of tasks in the queue exceeds the `growthThreshold`
For example, a rate of 20 means that while these conditions are met one thread will be added for every 5 submitted
tasks.
tasks.
Defaults to DEFAULT_GROWTH_RATE
Defaults to DEFAULT_GROWTH_RATE
The growth rate
The growth rate
|`growth-threshold` |int |`1000` |The queue size above which pool growth will be considered if the pool is not fixed size.
Defaults to DEFAULT_GROWTH_THRESHOLD.
Defaults to DEFAULT_GROWTH_THRESHOLD.
The growth threshold
The growth threshold
|`is-daemon` |boolean |`true` |Is daemon of the thread pool executor.
Defaults to DEFAULT_IS_DAEMON.
Defaults to DEFAULT_IS_DAEMON.
Whether the threads are daemon threads
Whether the threads are daemon threads
|`keep-alive` |Duration |`PT3M` |Keep alive of the thread pool executor.
Defaults to DEFAULT_KEEP_ALIVE.
Defaults to DEFAULT_KEEP_ALIVE.
Keep alive see java.util.concurrent.ThreadPoolExecutor.getKeepAliveTime(java.util.concurrent.TimeUnit)
Keep alive see java.util.concurrent.ThreadPoolExecutor.getKeepAliveTime(java.util.concurrent.TimeUnit)
|`max-pool-size` |int |`50` |Max pool size of the thread pool executor.
Defaults to DEFAULT_MAX_POOL_SIZE.
Defaults to DEFAULT_MAX_POOL_SIZE.
MaxPoolSize see java.util.concurrent.ThreadPoolExecutor.getMaximumPoolSize()
MaxPoolSize see java.util.concurrent.ThreadPoolExecutor.getMaximumPoolSize()
|`name` |string |{nbsp} |Name of this thread pool executor.
The pool name
The pool name
|`queue-capacity` |int |`10000` |Queue capacity of the thread pool executor.
Defaults to DEFAULT_QUEUE_CAPACITY.
Defaults to DEFAULT_QUEUE_CAPACITY.
Capacity of the queue backing the executor
Capacity of the queue backing the executor
|`should-prestart` |boolean |`true` |Whether to prestart core threads in this thread pool executor.
Defaults to DEFAULT_PRESTART.
Defaults to DEFAULT_PRESTART.
Whether to prestart the threads
Whether to prestart the threads
|`thread-name-prefix` |string |{nbsp} |Name prefix for threads in this thread pool executor.
Defaults to DEFAULT_THREAD_NAME_PREFIX.
Defaults to DEFAULT_THREAD_NAME_PREFIX.
Prefix of a thread name
Prefix of a thread name
|`virtual-threads` |boolean |{nbsp} |When configured to `true`, an unbounded virtual executor service (project Loom) will be used.
If enabled, all other configuration options of this executor service are ignored!
If enabled, all other configuration options of this executor service are ignored!
Whether to use virtual threads or not, defaults to `false`
Whether to use virtual threads or not, defaults to `false`
|===
Expand Down
Loading

0 comments on commit a254689

Please sign in to comment.