4.x: Config metadata docs (helidon-io#7581)

* Update to configuration metadata processor use in modules and update to documented types.

* Fix documentation issues
- remove references that no longer exist
- replace old configured types with new ones
- fix modules that did not generate config metadata

Author: tomas-langer

common/tls/pom.xml

@@ -90,6 +90,11 @@
                             <artifactId>helidon-common-processor-helidon-copyright</artifactId>
                             <version>${helidon.version}</version>
                         </path>
+                        <path>
+                            <groupId>io.helidon.config</groupId>
+                            <artifactId>helidon-config-metadata-processor</artifactId>
+                            <version>${helidon.version}</version>
+                        </path>
                     </annotationProcessorPaths>
                 </configuration>
                 <dependencies>
@@ -103,6 +108,11 @@
                         <artifactId>helidon-common-processor-helidon-copyright</artifactId>
                         <version>${helidon.version}</version>
                     </dependency>
+                    <dependency>
+                        <groupId>io.helidon.config</groupId>
+                        <artifactId>helidon-config-metadata-processor</artifactId>
+                        <version>${helidon.version}</version>
+                    </dependency>
                 </dependencies>
             </plugin>
         </plugins>

config/metadata-processor/src/main/java/io/helidon/config/metadata/processor/ConfiguredOptionData.java

@@ -20,12 +20,20 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Predicate;
+import java.util.stream.Collectors;
+
+import javax.annotation.processing.ProcessingEnvironment;
+import javax.lang.model.element.ElementKind;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.util.Elements;
 
 import io.helidon.common.types.Annotation;
 import io.helidon.common.types.TypeName;
+import io.helidon.common.types.TypeNames;
 import io.helidon.common.types.TypedElementInfo;
 
 import static io.helidon.config.metadata.processor.TypeHandlerBase.UNCONFIGURED_OPTION;
+import static io.helidon.config.metadata.processor.TypeHandlerBase.javadoc;
 import static io.helidon.config.metadata.processor.UsedTypes.DEPRECATED;
 import static io.helidon.config.metadata.processor.UsedTypes.DESCRIPTION;
 import static io.helidon.config.metadata.processor.UsedTypes.OPTION_ALLOWED_VALUE;
@@ -58,7 +66,7 @@ final class ConfiguredOptionData {
     private String kind = "VALUE";
 
     // create from @ConfiguredOption in config-metadata
-    static ConfiguredOptionData createMeta(Annotation option) {
+    static ConfiguredOptionData createMeta(ProcessingEnvironment aptEnv, Annotation option) {
         ConfiguredOptionData result = new ConfiguredOptionData();
 
         option.booleanValue("configured").ifPresent(result::configured);
@@ -79,9 +87,30 @@ static ConfiguredOptionData createMeta(Annotation option) {
                 .map(AllowedValue::create)
                 .forEach(result::addAllowedValue);
 
+        if (result.allowedValues.isEmpty()) {
+            // if enum, fill this in
+            Elements aptElements = aptEnv.getElementUtils();
+            TypeElement typeElement = aptElements
+                    .getTypeElement(option.typeValue("type").orElse(TypeNames.STRING).fqName());
+            if (typeElement != null && typeElement.getKind() == ElementKind.ENUM) {
+                result.allowedValues.addAll(allowedValues(aptElements, typeElement));
+            }
+        }
+
         return result;
     }
 
+    private static List<AllowedValue> allowedValues(Elements aptElements, TypeElement typeElement) {
+        if (typeElement != null && typeElement.getKind() == ElementKind.ENUM) {
+            return typeElement.getEnclosedElements()
+                    .stream()
+                    .filter(element -> element.getKind().equals(ElementKind.ENUM_CONSTANT))
+                    .map(element -> new AllowedValue(element.toString(), javadoc(aptElements.getDocComment(element))))
+                    .collect(Collectors.toList());
+        }
+        return List.of();
+    }
+
     // create from Option annotations in builder-api
     static ConfiguredOptionData createBuilder(TypedElementInfo element) {
         ConfiguredOptionData result = new ConfiguredOptionData();

config/metadata-processor/src/main/java/io/helidon/config/metadata/processor/TypeHandlerBase.java

@@ -94,6 +94,24 @@ static String toConfigKey(String methodName) {
         return result.toString();
     }
 
+    static String javadoc(String docComment) {
+        if (docComment == null) {
+            return "";
+        }
+
+        String javadoc = docComment;
+        int index = javadoc.indexOf("@param");
+        if (index > -1) {
+            javadoc = docComment.substring(0, index);
+        }
+        // replace all {@code xxx} with 'xxx'
+        javadoc = JAVADOC_CODE.matcher(javadoc).replaceAll(it -> '`' + it.group(1) + '`');
+        // replace all {@link ...} with just the name
+        javadoc = JAVADOC_LINK.matcher(javadoc).replaceAll(it -> it.group(1));
+
+        return javadoc.trim();
+    }
+
     String key(TypedElementInfo elementInfo, ConfiguredOptionData configuredOption) {
         String name = configuredOption.name();
         if (name == null || name.isBlank()) {
@@ -179,24 +197,6 @@ void addSuperClasses(ConfiguredType type, TypeInfo typeInfo, TypeName requiredAn
         }
     }
 
-    private static String javadoc(String docComment) {
-        if (docComment == null) {
-            return "";
-        }
-
-        String javadoc = docComment;
-        int index = javadoc.indexOf("@param");
-        if (index > -1) {
-            javadoc = docComment.substring(0, index);
-        }
-        // replace all {@code xxx} with 'xxx'
-        javadoc = JAVADOC_CODE.matcher(javadoc).replaceAll(it -> '`' + it.group(1) + '`');
-        // replace all {@link ...} with just the name
-        javadoc = JAVADOC_LINK.matcher(javadoc).replaceAll(it -> it.group(1));
-
-        return javadoc.trim();
-    }
-
     private List<ConfiguredOptionData.AllowedValue> allowedValues(TypeName type) {
         TypeElement typeElement = aptElements().getTypeElement(type.fqName());
         if (typeElement != null && typeElement.getKind() == ElementKind.ENUM) {

config/metadata-processor/src/main/java/io/helidon/config/metadata/processor/TypeHandlerMetaApiBase.java

@@ -40,13 +40,13 @@ List<ConfiguredOptionData> findConfiguredOptionAnnotations(TypedElementInfo elem
             return metaOptions.annotationValues()
                     .stream()
                     .flatMap(List::stream)
-                    .map(ConfiguredOptionData::createMeta)
+                    .map(it -> ConfiguredOptionData.createMeta(aptEnv(), it))
                     .toList();
         }
 
         if (elementInfo.hasAnnotation(META_OPTION)) {
             Annotation metaOption = elementInfo.annotation(META_OPTION);
-            return List.of(ConfiguredOptionData.createMeta(metaOption));
+            return List.of(ConfiguredOptionData.createMeta(aptEnv(), metaOption));
         }
 
         return List.of();

config/metadata-processor/src/main/java/io/helidon/config/metadata/processor/TypeHandlerMetaApiBlueprint.java

@@ -60,7 +60,7 @@ public TypeHandlerResult handle() {
         ConfiguredAnnotation configured = ConfiguredAnnotation.createMeta(blueprint.annotation(META_CONFIGURED));
 
         ConfiguredType type = new ConfiguredType(configured,
-                                                 builderType,
+                                                 prototype,
                                                  targetType,
                                                  true);
 

docs/config/config_reference.adoc

@@ -26,68 +26,76 @@ The following section lists all configurable types in Helidon.
 
 - xref:{rootdir}/config/io_helidon_security_providers_abac_AbacProvider.adoc[AbacProvider (security.providers.abac)]
 - xref:{rootdir}/config/io_helidon_common_configurable_AllowList.adoc[AllowList (common.configurable)]
-- xref:{rootdir}/config/io_helidon_metrics_api_BaseMetricsSettings.adoc[BaseMetricsSettings (metrics.api)]
-- xref:{rootdir}/config/io_helidon_reactive_faulttolerance_Bulkhead.adoc[Bulkhead (faulttolerance)]
-- xref:{rootdir}/config/io_helidon_reactive_faulttolerance_CircuitBreaker.adoc[CircuitBreaker (faulttolerance)]
+- 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_openapi_OpenApiUi_Builder.adoc[Builder (openapi.OpenApiUi)]
+- 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_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_security_providers_httpauth_ConfigUserStore_ConfigUser.adoc[ConfigUser (security.providers.httpauth.ConfigUserStore)]
-- xref:{rootdir}/config/io_helidon_reactive_webserver_cors_CrossOriginConfig.adoc[CrossOriginConfig (webserver.cors)]
-- xref:{rootdir}/config/io_helidon_reactive_faulttolerance_Retry_DelayingRetryPolicy.adoc[DelayingRetryPolicy (faulttolerance.Retry)]
+- xref:{rootdir}/config/io_helidon_http_encoding_ContentEncodingContext.adoc[ContentEncodingContext (http.encoding)]
+- xref:{rootdir}/config/io_helidon_cors_CrossOriginConfig.adoc[CrossOriginConfig (cors)]
 - xref:{rootdir}/config/io_helidon_security_providers_common_EvictableCache.adoc[EvictableCache (security.providers.common)]
 - xref:{rootdir}/config/io_helidon_security_providers_google_login_GoogleTokenProvider.adoc[GoogleTokenProvider (security.providers.google.login)]
-- xref:{rootdir}/config/io_helidon_grpc_client_GrpcChannelDescriptor.adoc[GrpcChannelDescriptor (grpc.client)]
-- xref:{rootdir}/config/io_helidon_grpc_server_GrpcServerConfiguration.adoc[GrpcServerConfiguration (grpc.server)]
-- xref:{rootdir}/config/io_helidon_grpc_core_GrpcTlsDescriptor.adoc[GrpcTlsDescriptor (grpc.core)]
 - 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_reactive_health_HealthSupport.adoc[HealthSupport (health)]
-- xref:{rootdir}/config/io_helidon_servicecommon_rest_HelidonRestServiceSupport.adoc[HelidonRestServiceSupport (servicecommon.rest)]
+- xref:{rootdir}/config/io_helidon_webserver_observe_health_HealthFeature.adoc[HealthFeature (webserver.observe.health)]
+- xref:{rootdir}/config/io_helidon_webclient_http1_Http1ClientProtocolConfig.adoc[Http1ClientProtocolConfig (webclient.http1)]
+- xref:{rootdir}/config/io_helidon_webserver_http1_Http1Config.adoc[Http1Config (webserver.http1)]
 - xref:{rootdir}/config/io_helidon_security_providers_httpauth_HttpBasicAuthProvider.adoc[HttpBasicAuthProvider (security.providers.httpauth)]
+- xref:{rootdir}/config/io_helidon_webclient_api_HttpClientConfig.adoc[HttpClientConfig (webclient.api)]
+- xref:{rootdir}/config/io_helidon_webclient_api_HttpConfigBase.adoc[HttpConfigBase (webclient.api)]
 - xref:{rootdir}/config/io_helidon_security_providers_httpauth_HttpDigestAuthProvider.adoc[HttpDigestAuthProvider (security.providers.httpauth)]
 - 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[IdcsMtRoleMapperRxProvider (security.providers.idcs.mapper)]
-- xref:{rootdir}/config/io_helidon_security_providers_idcs_mapper_IdcsRoleMapperProvider.adoc[IdcsRoleMapperRxProvider (security.providers.idcs.mapper)]
+- 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_security_providers_httpsign_InboundClientDefinition.adoc[InboundClientDefinition (security.providers.httpsign)]
-- xref:{rootdir}/config/io_helidon_tracing_jaeger_JaegerTracerBuilder.adoc[JaegerTracer (tracing.jaeger)]
-- xref:{rootdir}/config/io_helidon_reactive_faulttolerance_Retry_JitterRetryPolicy.adoc[JitterRetryPolicy (faulttolerance.Retry)]
+- xref:{rootdir}/config/io_helidon_tracing_providers_jaeger_JaegerTracerBuilder.adoc[JaegerTracerBuilder (tracing.providers.jaeger)]
 - xref:{rootdir}/config/io_helidon_security_providers_jwt_JwtProvider.adoc[JwtProvider (security.providers.jwt)]
-- xref:{rootdir}/config/io_helidon_common_pki_KeyConfig.adoc[KeyConfig (common.pki)]
-- xref:{rootdir}/config/io_helidon_metrics_api_KeyPerformanceIndicatorMetricsSettings.adoc[KeyPerformanceIndicatorMetricsSettings (metrics.api)]
-- xref:{rootdir}/config/io_helidon_common_pki_KeyConfig_KeystoreBuilder.adoc[KeystoreBuilder (common.pki.KeyConfig)]
+- xref:{rootdir}/config/io_helidon_metrics_api_KeyPerformanceIndicatorMetricsConfig.adoc[KeyPerformanceIndicatorMetricsConfig (metrics.api)]
+- xref:{rootdir}/config/io_helidon_common_pki_Keys.adoc[Keys (common.pki)]
+- xref:{rootdir}/config/io_helidon_common_pki_KeystoreKeys.adoc[KeystoreKeys (common.pki)]
+- xref:{rootdir}/config/io_helidon_webserver_ListenerConfig.adoc[ListenerConfig (webserver)]
 - xref:{rootdir}/config/io_helidon_common_configurable_LruCache.adoc[LruCache (common.configurable)]
-- xref:{rootdir}/config/io_helidon_reactive_media_common_MediaContext.adoc[MediaContext (media.common)]
-- xref:{rootdir}/config/io_helidon_metrics_api_MetricsSettings.adoc[MetricsSettings (metrics.api)]
-- xref:{rootdir}/config/io_helidon_metrics_serviceapi_MetricsSupport.adoc[MetricsSupport (metrics.serviceapi)]
-- xref:{rootdir}/config/io_helidon_integrations_micrometer_MicrometerSupport.adoc[MicrometerSupport (integrations.micrometer)]
+- xref:{rootdir}/config/io_helidon_http_media_MediaContext.adoc[MediaContext (http.media)]
+- xref:{rootdir}/config/io_helidon_metrics_api_MetricsConfig.adoc[MetricsConfig (metrics.api)]
+- xref:{rootdir}/config/io_helidon_webserver_observe_metrics_MetricsFeature.adoc[MetricsFeature (webserver.observe.metrics)]
+- xref:{rootdir}/config/io_helidon_integrations_micrometer_MicrometerFeature.adoc[MicrometerFeature (integrations.micrometer)]
 - xref:{rootdir}/config/io_helidon_config_mp_MpConfigBuilder.adoc[MpConfigBuilder (config.mp)]
 - xref:{rootdir}/config/io_helidon_security_providers_oidc_common_OidcConfig.adoc[OidcConfig (security.providers.oidc.common)]
 - xref:{rootdir}/config/io_helidon_security_providers_oidc_OidcProvider.adoc[OidcProvider (security.providers.oidc)]
-// - xref:{rootdir}/config/io_helidon_openapi_OpenAPISupport.adoc[OpenAPISupport (openapi)]
-// - xref:{rootdir}/config/io_helidon_openapi_OpenApiUi.adoc[OpenApiUi (openapi)]
+- xref:{rootdir}/config/io_helidon_tracing_providers_opentracing_OpenTracingTracerBuilder.adoc[OpenTracingTracerBuilder (tracing.providers.opentracing)]
 - xref:{rootdir}/config/io_helidon_security_providers_common_OutboundConfig.adoc[OutboundConfig (security.providers.common)]
 - xref:{rootdir}/config/io_helidon_security_providers_common_OutboundTarget.adoc[OutboundTarget (security.providers.common)]
-- xref:{rootdir}/config/io_helidon_common_pki_KeyConfig_PemBuilder.adoc[PemBuilder (common.pki.KeyConfig)]
-- xref:{rootdir}/config/io_helidon_reactive_webclient_Proxy.adoc[Proxy (webclient)]
-- xref:{rootdir}/config/io_helidon_metrics_api_RegistryFilterSettings.adoc[RegistryFilterSettings (metrics.api)]
-- xref:{rootdir}/config/io_helidon_metrics_api_RegistrySettings.adoc[RegistrySettings (metrics.api)]
-- xref:{rootdir}/config/io_helidon_common_http_RequestedUriDiscoveryContext.adoc[RequestedUriDiscoveryContext (common.http)]
+- xref:{rootdir}/config/io_helidon_common_pki_PemKeys.adoc[PemKeys (common.pki)]
+- 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_servicecommon_rest_RestServiceSettings.adoc[RestServiceSettings (servicecommon.rest)]
-- xref:{rootdir}/config/io_helidon_reactive_faulttolerance_Retry.adoc[Retry (faulttolerance)]
+- 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_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_openapi_SeOpenApiFeature.adoc[SeOpenApiFeature (openapi)]
 - xref:{rootdir}/config/io_helidon_security_Security.adoc[Security (security)]
 - xref:{rootdir}/config/io_helidon_security_SecurityTime.adoc[SecurityTime (security)]
-- xref:{rootdir}/config/io_helidon_reactive_webserver_SocketConfiguration.adoc[SocketConfiguration (webserver)]
-- xref:{rootdir}/config/io_helidon_reactive_webserver_SocketConfiguration_SocketConfigurationBuilder.adoc[SocketConfigurationBuilder (webserver.SocketConfiguration)]
-- xref:{rootdir}/config/io_helidon_common_configurable_ThreadPoolSupplier.adoc[ThreadPoolSupplier (common.configurable)]
-- xref:{rootdir}/config/io_helidon_reactive_faulttolerance_Timeout.adoc[Timeout (faulttolerance)]
+- xref:{rootdir}/config/io_helidon_microprofile_server_Server.adoc[Server (microprofile.server)]
+- xref:{rootdir}/config/io_helidon_common_socket_SocketOptions.adoc[SocketOptions (common.socket)]
+- xref:{rootdir}/config/io_helidon_metrics_api_Tag.adoc[Tag (metrics.api)]
 - xref:{rootdir}/config/io_helidon_security_providers_oidc_common_TenantConfig.adoc[TenantConfig (security.providers.oidc.common)]
+- xref:{rootdir}/config/io_helidon_common_configurable_ThreadPoolConfig.adoc[ThreadPoolConfig (common.configurable)]
+- xref:{rootdir}/config/io_helidon_common_configurable_ThreadPoolSupplier.adoc[ThreadPoolSupplier (common.configurable)]
+- xref:{rootdir}/config/io_helidon_faulttolerance_Timeout.adoc[Timeout (faulttolerance)]
+- xref:{rootdir}/config/io_helidon_common_tls_Tls.adoc[Tls (common.tls)]
 - xref:{rootdir}/config/io_helidon_security_util_TokenHandler.adoc[TokenHandler (security.util)]
+- xref:{rootdir}/config/io_helidon_tracing_Tracer.adoc[Tracer (tracing)]
 - xref:{rootdir}/config/io_helidon_tracing_TracerBuilder.adoc[TracerBuilder (tracing)]
-- xref:{rootdir}/config/io_helidon_reactive_webclient_WebClientConfiguration.adoc[WebClientConfiguration (webclient)]
-- xref:{rootdir}/config/io_helidon_reactive_webclient_WebClientTls.adoc[WebClientTls (webclient)]
-- xref:{rootdir}/config/io_helidon_reactive_webserver_WebServer.adoc[WebServer (webserver)]
-- xref:{rootdir}/config/io_helidon_reactive_webserver_WebServerTls.adoc[WebServerTls (webserver)]
-- xref:{rootdir}/config/io_helidon_tracing_zipkin_ZipkinTracerBuilder.adoc[ZipkinTracer (tracing.zipkin)]
-- xref:{rootdir}/config/io_smallrye_openapi_api_OpenApiConfig.adoc[io_smallrye_openapi_api_OpenApiConfig]
-- xref:{rootdir}/config/io_helidon_microprofile_server_Server.adoc[Server (microprofile.server)]
+- xref:{rootdir}/config/io_helidon_webclient_api_WebClient.adoc[WebClient (webclient.api)]
+- xref:{rootdir}/config/io_helidon_webclient_api_WebClientCookieManager.adoc[WebClientCookieManager (webclient.api)]
+- xref:{rootdir}/config/io_helidon_webserver_WebServer.adoc[WebServer (webserver)]
+- xref:{rootdir}/config/io_helidon_tracing_providers_zipkin_ZipkinTracerBuilder.adoc[ZipkinTracerBuilder (tracing.providers.zipkin)]
+- xref:{rootdir}/config/io_opentracing_Tracer.adoc[io_opentracing_Tracer]
+- xref:{rootdir}/config/org_eclipse_microprofile_config_Config.adoc[org_eclipse_microprofile_config_Config]