You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by pp...@apache.org on 2024/10/23 19:27:23 UTC
(camel-quarkus) branch main updated: Transform the configuration options documentation from vanila JavaDoc to @asciidoclet
This is an automated email from the ASF dual-hosted git repository.
ppalaga pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
The following commit(s) were added to refs/heads/main by this push:
new 75e2fc09a7 Transform the configuration options documentation from vanila JavaDoc to @asciidoclet
75e2fc09a7 is described below
commit 75e2fc09a7eb2887bc79788ce8176d07aeb0a134
Author: Peter Palaga <pp...@redhat.com>
AuthorDate: Wed Oct 23 16:14:00 2024 +0200
Transform the configuration options documentation from vanila JavaDoc to @asciidoclet
---
docs/modules/ROOT/examples/dataformats/beanio.yml | 6 +-
.../ROOT/pages/reference/extensions/beanio.adoc | 52 ++-
.../ROOT/pages/reference/extensions/core.adoc | 145 +++++---
.../ROOT/pages/reference/extensions/cxf-soap.adoc | 7 +-
.../ROOT/pages/reference/extensions/debug.adoc | 3 +-
.../reference/extensions/file-cluster-service.adoc | 3 +-
.../ROOT/pages/reference/extensions/graphql.adoc | 5 +-
.../ROOT/pages/reference/extensions/grpc.adoc | 22 +-
.../ROOT/pages/reference/extensions/jasypt.adoc | 13 +-
.../ROOT/pages/reference/extensions/jfr.adoc | 14 +-
.../ROOT/pages/reference/extensions/kafka.adoc | 5 +-
.../ROOT/pages/reference/extensions/kamelet.adoc | 4 +-
.../extensions/kubernetes-cluster-service.adoc | 15 +-
.../pages/reference/extensions/micrometer.adoc | 14 +-
.../pages/reference/extensions/opentelemetry.adoc | 16 +-
.../pages/reference/extensions/rest-openapi.adoc | 8 +-
.../ROOT/pages/reference/extensions/servlet.adoc | 38 +-
.../org/apache/camel/quarkus/core/CamelConfig.java | 397 +++++++++++++--------
.../apache/camel/quarkus/main/CamelMainConfig.java | 21 +-
.../cli/connector/CamelCliConnectorConfig.java | 3 +
.../cxf/soap/deployment/CxfBuildTimeConfig.java | 23 +-
.../camel/quarkus/component/debug/DebugConfig.java | 9 +-
.../camel/quarkus/component/fhir/FhirConfig.java | 12 +
.../file/cluster/FileLockClusterServiceConfig.java | 22 +-
.../component/graphql/CamelGraphQLConfig.java | 10 +-
.../quarkus/grpc/runtime/GrpcBuildTimeConfig.java | 47 +--
.../jasypt/CamelJasyptBuildTimeConfig.java | 9 +-
.../component/jasypt/CamelJasyptConfig.java | 45 +--
.../component/jfr/RuntimeCamelJfrConfig.java | 17 +-
.../joor/runtime/JoorExpressionConfig.java | 18 +-
.../component/kafka/CamelKafkaRuntimeConfig.java | 11 +-
.../KubernetesClusterServiceBuildTimeConfig.java | 16 +-
.../KubernetesClusterServiceRuntimeConfig.java | 37 +-
.../micrometer/CamelMicrometerConfig.java | 52 +--
.../runtime/CamelMicroProfileHealthConfig.java | 2 +
.../deployment/OpenApiJavaBuildTimeConfig.java | 2 +-
.../opentelemetry/CamelOpenTelemetryConfig.java | 34 +-
.../runtime/RestOpenApiBuildTimeConfig.java | 23 +-
.../servlet/runtime/CamelServletConfig.java | 91 +++--
.../quarkus/component/xslt/CamelXsltConfig.java | 7 +
.../quarkus/maven/UpdateExtensionDocPageMojo.java | 6 +-
41 files changed, 849 insertions(+), 435 deletions(-)
diff --git a/docs/modules/ROOT/examples/dataformats/beanio.yml b/docs/modules/ROOT/examples/dataformats/beanio.yml
index db2e6f7c43..634fc84d99 100644
--- a/docs/modules/ROOT/examples/dataformats/beanio.yml
+++ b/docs/modules/ROOT/examples/dataformats/beanio.yml
@@ -2,11 +2,11 @@
# This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
cqArtifactId: camel-quarkus-beanio
cqArtifactIdBase: beanio
-cqNativeSupported: false
-cqStatus: Preview
+cqNativeSupported: true
+cqStatus: Stable
cqDeprecated: false
cqJvmSince: 3.8.0
-cqNativeSince: n/a
+cqNativeSince: 3.16.0
cqCamelPartName: beanio
cqCamelPartTitle: BeanIO
cqCamelPartDescription: Marshal and unmarshal Java beans to and from flat files (such as CSV, delimited, or fixed length formats).
diff --git a/docs/modules/ROOT/pages/reference/extensions/beanio.adoc b/docs/modules/ROOT/pages/reference/extensions/beanio.adoc
index 6b78085800..7ba04e03e9 100644
--- a/docs/modules/ROOT/pages/reference/extensions/beanio.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/beanio.adoc
@@ -4,17 +4,17 @@
= BeanIO
:linkattrs:
:cq-artifact-id: camel-quarkus-beanio
-:cq-native-supported: false
-:cq-status: Preview
-:cq-status-deprecation: Preview
+:cq-native-supported: true
+:cq-status: Stable
+:cq-status-deprecation: Stable
:cq-description: Marshal and unmarshal Java beans to and from flat files (such as CSV, delimited, or fixed length formats).
:cq-deprecated: false
:cq-jvm-since: 3.8.0
-:cq-native-since: n/a
+:cq-native-since: 3.16.0
ifeval::[{doc-show-badges} == true]
[.badges]
-[.badge-key]##JVM since##[.badge-supported]##3.8.0## [.badge-key]##Native##[.badge-unsupported]##unsupported##
+[.badge-key]##JVM since##[.badge-supported]##3.8.0## [.badge-key]##Native since##[.badge-supported]##3.16.0##
endif::[]
Marshal and unmarshal Java beans to and from flat files (such as CSV, delimited, or fixed length formats).
@@ -29,6 +29,10 @@ Please refer to the above link for usage and configuration details.
[id="extensions-beanio-maven-coordinates"]
== Maven coordinates
+https://{link-quarkus-code-generator}/?extension-search=camel-quarkus-beanio[Create a new project with this extension on {link-quarkus-code-generator}, window="_blank"]
+
+Or add the coordinates to your existing project:
+
[source,xml]
----
<dependency>
@@ -39,3 +43,41 @@ Please refer to the above link for usage and configuration details.
ifeval::[{doc-show-user-guide-link} == true]
Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
endif::[]
+
+[id="extensions-beanio-usage"]
+== Usage
+[id="extensions-beanio-usage-beanio-in-native-mode"]
+=== BeanIO in native mode
+
+[id="extensions-beanio-usage-xml-mapping-files"]
+==== XML mapping files
+
+When BeanIO configuration is defined in XML files that are read from the classpath.
+You must ensure each file is added to the native application image.
+To do this, add the `quarkus.native.resources.includes` configuration property to `application.properties`. For example.
+
+[source,properties]
+----
+quarkus.native.resources.includes=mapping.xml,model/other-mapping.xml
+----
+
+More information about selecting resources for inclusion in the native executable can be found at xref:user-guide/native-mode.adoc#embedding-resource-in-native-executable[Embedding resources in native executable].
+
+[id="extensions-beanio-usage-beanio-record-classes"]
+==== BeanIO Record classes
+
+All classes that participate in BeanIO marshal / unmarshal operations must be registered for reflection.
+
+This can be achieved with the `@RegisterForReflection`
+annotation or with configuration property `quarkus.camel.native.reflection.include-patterns`. For example:
+
+[source,java]
+----
+@RegisterForReflection
+public class Employee {
+ ...
+}
+----
+
+Refer to the xref:user-guide/native-mode.adoc#reflection[Native mode] user guide for more information.
+
diff --git a/docs/modules/ROOT/pages/reference/extensions/core.adoc b/docs/modules/ROOT/pages/reference/extensions/core.adoc
index aaf1fcdd5b..b09867f1b8 100644
--- a/docs/modules/ROOT/pages/reference/extensions/core.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/core.adoc
@@ -138,9 +138,12 @@ When set to true, the `CamelRuntime` will be started automatically.
|icon:lock[title=Fixed at build time] [[quarkus.camel.service.discovery.exclude-patterns]]`link:#quarkus.camel.service.discovery.exclude-patterns[quarkus.camel.service.discovery.exclude-patterns]`
-A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will *not* be discoverable via the **`org.apache.camel.spi.FactoryFinder` mechanism.
+A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The
+services defined in the matching files will *not* be discoverable via the **`org.apache.camel.spi.FactoryFinder`
+mechanism.
-The excludes have higher precedence than includes. The excludes defined here can also be used to veto the discoverability of services included by Camel Quarkus extensions.
+The excludes have higher precedence than includes. The excludes defined here can also be used to veto the
+discoverability of services included by Camel Quarkus extensions.
Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`
| List of `string`
@@ -148,9 +151,12 @@ Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/
|icon:lock[title=Fixed at build time] [[quarkus.camel.service.discovery.include-patterns]]`link:#quarkus.camel.service.discovery.include-patterns[quarkus.camel.service.discovery.include-patterns]`
-A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will be discoverable via the `org.apache.camel.spi.FactoryFinder` mechanism unless the given file is excluded via `exclude-patterns`.
+A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The
+services defined in the matching files will be discoverable via the `org.apache.camel.spi.FactoryFinder` mechanism
+unless the given file is excluded via `exclude-patterns`.
-Note that Camel Quarkus extensions may include some services by default. The services selected here added to those services and the exclusions defined in `exclude-patterns` are applied to the union set.
+Note that Camel Quarkus extensions may include some services by default. The services selected here added to those
+services and the exclusions defined in `exclude-patterns` are applied to the union set.
Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`
| List of `string`
@@ -158,9 +164,12 @@ Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/
|icon:lock[title=Fixed at build time] [[quarkus.camel.service.registry.exclude-patterns]]`link:#quarkus.camel.service.registry.exclude-patterns[quarkus.camel.service.registry.exclude-patterns]`
-A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will *not* be added to Camel registry during application's static initialization.
+A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The
+services defined in the matching files will *not* be added to Camel registry during application's static
+initialization.
-The excludes have higher precedence than includes. The excludes defined here can also be used to veto the registration of services included by Camel Quarkus extensions.
+The excludes have higher precedence than includes. The excludes defined here can also be used to veto the
+registration of services included by Camel Quarkus extensions.
Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`**
| List of `string`
@@ -168,9 +177,12 @@ Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/
|icon:lock[title=Fixed at build time] [[quarkus.camel.service.registry.include-patterns]]`link:#quarkus.camel.service.registry.include-patterns[quarkus.camel.service.registry.include-patterns]`
-A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will be added to Camel registry during application's static initialization unless the given file is excluded via `exclude-patterns`.
+A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The
+services defined in the matching files will be added to Camel registry during application's static initialization
+unless the given file is excluded via `exclude-patterns`.
-Note that Camel Quarkus extensions may include some services by default. The services selected here added to those services and the exclusions defined in `exclude-patterns` are applied to the union set.
+Note that Camel Quarkus extensions may include some services by default. The services selected here added to those
+services and the exclusions defined in `exclude-patterns` are applied to the union set.
Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`
| List of `string`
@@ -178,49 +190,67 @@ Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/
|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.components]]`link:#quarkus.camel.runtime-catalog.components[quarkus.camel.runtime-catalog.components]`
-If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel components available in the application; otherwise component JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
+If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel components
+available in the application; otherwise component JSON schemas will not be available in the Runtime Camel Catalog and
+any attempt to access those will result in a RuntimeException.
-Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
+Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`
|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.languages]]`link:#quarkus.camel.runtime-catalog.languages[quarkus.camel.runtime-catalog.languages]`
-If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel languages available in the application; otherwise language JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
+If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel languages
+available in the application; otherwise language JSON schemas will not be available in the Runtime Camel Catalog and
+any attempt to access those will result in a RuntimeException.
-Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
+Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`
|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.dataformats]]`link:#quarkus.camel.runtime-catalog.dataformats[quarkus.camel.runtime-catalog.dataformats]`
-If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel data formats available in the application; otherwise data format JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
+If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel data formats
+available in the application; otherwise data format JSON schemas will not be available in the Runtime Camel Catalog
+and any attempt to access those will result in a RuntimeException.
-Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
+Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`
|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.devconsoles]]`link:#quarkus.camel.runtime-catalog.devconsoles[quarkus.camel.runtime-catalog.devconsoles]`
-If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel dev consoles available in the application; otherwise dev console JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
+If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel dev consoles
+available in the application; otherwise dev console JSON schemas will not be available in the Runtime Camel Catalog
+and any attempt to access those will result in a RuntimeException.
-Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
+Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`
|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.models]]`link:#quarkus.camel.runtime-catalog.models[quarkus.camel.runtime-catalog.models]`
-If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel EIP models available in the application; otherwise EIP model JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
+If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel EIP models
+available in the application; otherwise EIP model JSON schemas will not be available in the Runtime Camel Catalog and
+any attempt to access those will result in a RuntimeException.
-Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
+Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`
|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.transformers]]`link:#quarkus.camel.runtime-catalog.transformers[quarkus.camel.runtime-catalog.transformers]`
-If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel transformers available in the application; otherwise transformer JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
+If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel transformers
+available in the application; otherwise transformer JSON schemas will not be available in the Runtime Camel Catalog
+and any attempt to access those will result in a RuntimeException.
-Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
+Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`
@@ -232,19 +262,31 @@ Enable automatic discovery of routes during static initialization.
|icon:lock[title=Fixed at build time] [[quarkus.camel.routes-discovery.exclude-patterns]]`link:#quarkus.camel.routes-discovery.exclude-patterns[quarkus.camel.routes-discovery.exclude-patterns]`
-Used for exclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. For example to exclude all classes starting with Bar use: ++**++/Bar++*++ To exclude all routes form a specific package use: com/mycompany/bar/++*++ To exclude all routes form a specific package and its sub-packages use double wildcards: com/mycompany/bar/++**++ [...]
+Used for exclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over
+inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by
+comma. For example to exclude all classes starting with Bar use: ++**++/Bar++*++ To exclude all routes form a
+specific package use: com/mycompany/bar/++*++ To exclude all routes form a specific package and its sub-packages use
+double wildcards: com/mycompany/bar/++**++ And to exclude all routes from two specific packages use:
+com/mycompany/bar/++*++,com/mycompany/stuff/++*++
| List of `string`
|
|icon:lock[title=Fixed at build time] [[quarkus.camel.routes-discovery.include-patterns]]`link:#quarkus.camel.routes-discovery.include-patterns[quarkus.camel.routes-discovery.include-patterns]`
-Used for inclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. For example to include all classes starting with Foo use: ++**++/Foo++*++ To include all routes form a specific package use: com/mycompany/foo/++*++ To include all routes form a specific package and its sub-packages use double wildcards: com/mycompany/foo/++**++ [...]
+Used for inclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over
+inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by
+comma. For example to include all classes starting with Foo use: ++**++/Foo++*++ To include all routes form a
+specific package use: com/mycompany/foo/++*++ To include all routes form a specific package and its sub-packages use
+double wildcards: com/mycompany/foo/++**++ And to include all routes from two specific packages use:
+com/mycompany/foo/++*++,com/mycompany/stuff/++*++
| List of `string`
|
|icon:lock[title=Fixed at build time] [[quarkus.camel.native.reflection.exclude-patterns]]`link:#quarkus.camel.native.reflection.exclude-patterns[quarkus.camel.native.reflection.exclude-patterns]`
-A comma separated list of Ant-path style patterns to match class names that should be *excluded* from registering for reflection. Use the class name format as returned by the `java.lang.Class.getName()` method: package segments delimited by period `.` and inner classes by dollar sign `$`.
+A comma separated list of Ant-path style patterns to match class names that should be *excluded* from registering for
+reflection. Use the class name format as returned by the `java.lang.Class.getName()` method: package segments
+delimited by period `.` and inner classes by dollar sign `$`.
This option narrows down the set selected by `include-patterns`. By default, no classes are excluded.
@@ -254,24 +296,30 @@ This option cannot be used to unregister classes which have been registered inte
|icon:lock[title=Fixed at build time] [[quarkus.camel.native.reflection.include-patterns]]`link:#quarkus.camel.native.reflection.include-patterns[quarkus.camel.native.reflection.include-patterns]`
-A comma separated list of Ant-path style patterns to match class names that should be registered for reflection. Use the class name format as returned by the `java.lang.Class.getName()` method: package segments delimited by period `.` and inner classes by dollar sign `$`.
+A comma separated list of Ant-path style patterns to match class names that should be registered for reflection. Use
+the class name format as returned by the `java.lang.Class.getName()` method: package segments delimited by period `.`
+and inner classes by dollar sign `$`.
By default, no classes are included. The set selected by this option can be narrowed down by `exclude-patterns`.
-Note that Quarkus extensions typically register the required classes for reflection by themselves. This option is useful in situations when the built in functionality is not sufficient.
+Note that Quarkus extensions typically register the required classes for reflection by themselves. This option is
+useful in situations when the built in functionality is not sufficient.
-Note that this option enables the full reflective access for constructors, fields and methods. If you need a finer grained control, consider using `io.quarkus.runtime.annotations.RegisterForReflection` annotation in your Java code.
+Note that this option enables the full reflective access for constructors, fields and methods. If you need a finer
+grained control, consider using `io.quarkus.runtime.annotations.RegisterForReflection` annotation in your Java code.
For this option to work properly, at least one of the following conditions must be satisfied:
- - There are no wildcards (`++*++` or `/`) in the patterns
- - The artifacts containing the selected classes contain a Jandex index (`META-INF/jandex.idx`)
- - The artifacts containing the selected classes are registered for indexing using the `quarkus.index-dependency.++*++` family of options in `application.properties` - e.g.
+- There are no wildcards (`++*++` or `/`) in the patterns
+- The artifacts containing the selected classes contain a Jandex index (`META-INF/jandex.idx`)
+- The artifacts containing the selected classes are registered for indexing using the
+`quarkus.index-dependency.++*++` family of options in `application.properties` - e.g.
-```
+[source,properties]
+----
quarkus.index-dependency.my-dep.group-id = org.my-group
quarkus.index-dependency.my-dep.artifact-id = my-artifact
-```
+----
where `my-dep` is a label of your choice to tell Quarkus that `org.my-group` and with `my-artifact` belong together.
| List of `string`
@@ -279,7 +327,11 @@ where `my-dep` is a label of your choice to tell Quarkus that `org.my-group` and
|icon:lock[title=Fixed at build time] [[quarkus.camel.native.reflection.serialization-enabled]]`link:#quarkus.camel.native.reflection.serialization-enabled[quarkus.camel.native.reflection.serialization-enabled]`
-If `true`, basic classes are registered for serialization; otherwise basic classes won't be registered automatically for serialization in native mode. The list of classes automatically registered for serialization can be found in link:https://github.com/apache/camel-quarkus/blob/main/extensions-core/core/deployment/src/main/java/org/apache/camel/quarkus/core/deployment/CamelSerializationProcessor.java[CamelSerializationProcessor.BASE_SERIALIZATION_CLASSES]. Setting this to `false` helps [...]
+If `true`, basic classes are registered for serialization; otherwise basic classes won't be registered automatically
+for serialization in native mode. The list of classes automatically registered for serialization can be found in
+link:https://github.com/apache/camel-quarkus/blob/main/extensions-core/core/deployment/src/main/java/org/apache/camel/quarkus/core/deployment/CamelSerializationProcessor.java[CamelSerializationProcessor.BASE_SERIALIZATION_CLASSES].
+Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+setting this flag to `true` except for making the behavior consistent with native mode.
| `boolean`
| `false`
@@ -297,7 +349,8 @@ What to do if it is not possible to extract expressions from a route definition
|icon:lock[title=Fixed at build time] [[quarkus.camel.expression.extraction-enabled]]`link:#quarkus.camel.expression.extraction-enabled[quarkus.camel.expression.extraction-enabled]`
-Indicates whether the expression extraction from the route definitions at build time must be done. If disabled, the expressions are compiled at runtime.
+Indicates whether the expression extraction from the route definitions at build time must be done. If disabled, the
+expressions are compiled at runtime.
| `boolean`
| `true`
@@ -305,9 +358,12 @@ Indicates whether the expression extraction from the route definitions at build
Whether to enable the bridging of Camel events to CDI events.
-This allows CDI observers to be configured for Camel events. E.g. those belonging to the `org.apache.camel.quarkus.core.events`, `org.apache.camel.quarkus.main.events` & `org.apache.camel.impl.event` packages.
+This allows CDI observers to be configured for Camel events. E.g. those belonging to the
+`org.apache.camel.quarkus.core.events`, `org.apache.camel.quarkus.main.events` & `org.apache.camel.impl.event`
+packages.
-Note that this configuration item only has any effect when observers configured for Camel events are present in the application.
+Note that this configuration item only has any effect when observers configured for Camel events are present in the
+application.
| `boolean`
| `true`
@@ -325,7 +381,8 @@ Enables tracer in your Camel application.
|icon:lock[title=Fixed at build time] [[quarkus.camel.trace.standby]]`link:#quarkus.camel.trace.standby[quarkus.camel.trace.standby]`
-To set the tracer in standby mode, where the tracer will be installed, but not automatically enabled. The tracer can then be enabled explicitly later from Java, JMX or tooling.
+To set the tracer in standby mode, where the tracer will be installed, but not automatically enabled. The tracer can
+then be enabled explicitly later from Java, JMX or tooling.
| `boolean`
| `false`
@@ -337,7 +394,8 @@ Defines how many of the last messages to keep in the tracer.
|icon:lock[title=Fixed at build time] [[quarkus.camel.trace.remove-on-dump]]`link:#quarkus.camel.trace.remove-on-dump[quarkus.camel.trace.remove-on-dump]`
-Whether all traced messages should be removed when the tracer is dumping. By default, the messages are removed, which means that dumping will not contain previous dumped messages.
+Whether all traced messages should be removed when the tracer is dumping. By default, the messages are removed, which
+means that dumping will not contain previous dumped messages.
| `boolean`
| `true`
@@ -349,13 +407,15 @@ To limit the message body to a maximum size in the traced message. Use 0 or nega
|icon:lock[title=Fixed at build time] [[quarkus.camel.trace.body-include-streams]]`link:#quarkus.camel.trace.body-include-streams[quarkus.camel.trace.body-include-streams]`
-Whether to include the message body of stream based messages. If enabled then beware the stream may not be re-readable later. See more about Stream Caching.
+Whether to include the message body of stream based messages. If enabled then beware the stream may not be
+re-readable later. See more about Stream Caching.
| `boolean`
| `false`
|icon:lock[title=Fixed at build time] [[quarkus.camel.trace.body-include-files]]`link:#quarkus.camel.trace.body-include-files[quarkus.camel.trace.body-include-files]`
-Whether to include the message body of file based messages. The overhead is that the file content has to be read from the file.
+Whether to include the message body of file based messages. The overhead is that the file content has to be read from
+the file.
| `boolean`
| `true`
@@ -403,7 +463,8 @@ Filter for tracing messages.
|icon:lock[title=Fixed at build time] [[quarkus.camel.type-converter.statistics-enabled]]`link:#quarkus.camel.type-converter.statistics-enabled[quarkus.camel.type-converter.statistics-enabled]`
-Whether type converter statistics are enabled. By default, type converter utilization statistics are disabled. Note that enabling statistics incurs a minor performance impact under very heavy load.
+Whether type converter statistics are enabled. By default, type converter utilization statistics are disabled. Note
+that enabling statistics incurs a minor performance impact under very heavy load.
| `boolean`
| `false`
@@ -415,7 +476,9 @@ A timeout (with millisecond precision) to wait for `CamelMain++#++stop()` to fin
|icon:lock[title=Fixed at build time] [[quarkus.camel.main.arguments.on-unknown]]`link:#quarkus.camel.main.arguments.on-unknown[quarkus.camel.main.arguments.on-unknown]`
-The action to take when `CamelMain` encounters an unknown argument. fail - Prints the `CamelMain` usage statement and throws a `RuntimeException` ignore - Suppresses any warnings and the application startup proceeds as normal warn - Prints the `CamelMain` usage statement but allows the application startup to proceed as normal
+The action to take when `CamelMain` encounters an unknown argument. fail - Prints the `CamelMain` usage statement and
+throws a `RuntimeException` ignore - Suppresses any warnings and the application startup proceeds as normal warn -
+Prints the `CamelMain` usage statement but allows the application startup to proceed as normal
| `fail`, `warn`, `ignore`
| `warn`
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/cxf-soap.adoc b/docs/modules/ROOT/pages/reference/extensions/cxf-soap.adoc
index 5c42f3ac9f..a6f244250f 100644
--- a/docs/modules/ROOT/pages/reference/extensions/cxf-soap.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/cxf-soap.adoc
@@ -320,9 +320,12 @@ quarkus.cxf.codegen.wsdl2java.additional-params = -validate
|icon:lock[title=Fixed at build time] [[quarkus.camel.cxf.class-generation.exclude-patterns]]`link:#quarkus.camel.cxf.class-generation.exclude-patterns[quarkus.camel.cxf.class-generation.exclude-patterns]`
-For CXF service interfaces to work properly, some ancillary classes (such as request and response wrappers) need to be generated at build time. Camel Quarkus lets the `quarkus-cxf` extension to do this for all service interfaces found in the class path except the ones matching the patterns in this property.
+For CXF service interfaces to work properly, some ancillary classes (such as request and response wrappers) need to
+be generated at build time. Camel Quarkus lets the `quarkus-cxf` extension to do this for all service interfaces
+found in the class path except the ones matching the patterns in this property.
-`org.apache.cxf.ws.security.sts.provider.SecurityTokenService` is excluded by default due to link:https://issues.apache.org/jira/browse/CXF-8834[https://issues.apache.org/jira/browse/CXF-8834]
+`org.apache.cxf.ws.security.sts.provider.SecurityTokenService` is excluded by default due to
+link:https://issues.apache.org/jira/browse/CXF-8834[https://issues.apache.org/jira/browse/CXF-8834]
| List of `string`
| `org.apache.cxf.ws.security.sts.provider.SecurityTokenService`
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/debug.adoc b/docs/modules/ROOT/pages/reference/extensions/debug.adoc
index 12a48f5774..c74f6a1480 100644
--- a/docs/modules/ROOT/pages/reference/extensions/debug.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/debug.adoc
@@ -85,7 +85,8 @@ Set whether to enable Camel debugging support.
|icon:lock[title=Fixed at build time] [[quarkus.camel.debug.suspend]]`link:#quarkus.camel.debug.suspend[quarkus.camel.debug.suspend]`
-Indicates whether the _suspend mode_ is enabled or not. If `true` the message processing is immediately suspended until the method `attach()` is called.
+Indicates whether the _suspend mode_ is enabled or not. If `true` the message processing is immediately suspended
+until the method `attach()` is called.
| `boolean`
| `false`
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/file-cluster-service.adoc b/docs/modules/ROOT/pages/reference/extensions/file-cluster-service.adoc
index 8b7951989a..7fd5e6a2db 100644
--- a/docs/modules/ROOT/pages/reference/extensions/file-cluster-service.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/file-cluster-service.adoc
@@ -73,7 +73,8 @@ The file cluster service could further be tuned by tweaking `quarkus.camel.clust
|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.file.enabled]]`link:#quarkus.camel.cluster.file.enabled[quarkus.camel.cluster.file.enabled]`
-Whether a File Lock Cluster Service should be automatically configured according to 'quarkus.camel.cluster.file.++*++' configurations.
+Whether a File Lock Cluster Service should be automatically configured according to
+'quarkus.camel.cluster.file.++*++' configurations.
| `boolean`
| `true`
diff --git a/docs/modules/ROOT/pages/reference/extensions/graphql.adoc b/docs/modules/ROOT/pages/reference/extensions/graphql.adoc
index bfc5f97c24..dfa46cf531 100644
--- a/docs/modules/ROOT/pages/reference/extensions/graphql.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/graphql.adoc
@@ -62,7 +62,10 @@ https://quarkus.io/guides/native-and-ssl[Quarkus SSL guide].
|icon:lock[title=Fixed at build time] [[quarkus.camel.graphql.query-files]]`link:#quarkus.camel.graphql.query-files[quarkus.camel.graphql.query-files]`
-A comma separated list of paths to files containing GraphQL queries for use by GraphQL endpoints. Query files that only need to be accessible from the classpath should be specified on this property. Paths can either be schemeless (E.g graphql/my-query.graphql) or be prefixed with the classpath: URI scheme (E.g classpath:graphql/my-query.graphql). Other URI schemes are not supported.
+A comma separated list of paths to files containing GraphQL queries for use by GraphQL endpoints. Query files that
+only need to be accessible from the classpath should be specified on this property. Paths can either be schemeless
+(E.g graphql/my-query.graphql) or be prefixed with the classpath: URI scheme (E.g
+classpath:graphql/my-query.graphql). Other URI schemes are not supported.
| List of `string`
|
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/grpc.adoc b/docs/modules/ROOT/pages/reference/extensions/grpc.adoc
index b51897b24b..e7ef9d4729 100644
--- a/docs/modules/ROOT/pages/reference/extensions/grpc.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/grpc.adoc
@@ -162,27 +162,31 @@ At present there is no support for integrating Camel Quarkus gRPC with Quarkus g
|icon:lock[title=Fixed at build time] [[quarkus.camel.grpc.codegen.enabled]]`link:#quarkus.camel.grpc.codegen.enabled[quarkus.camel.grpc.codegen.enabled]`
-If `true`, Camel Quarkus gRPC code generation is run for .proto files discovered from the `proto` directory, or from dependencies specified in the `scan-for-proto` or `scan-for-imports` options. When `false`, code generation for .proto files is disabled.
+If `true`, Camel Quarkus gRPC code generation is run for .proto files discovered from the `proto` directory, or from
+dependencies specified in the `scan-for-proto` or `scan-for-imports` options. When `false`, code generation for
+.proto files is disabled.
| `boolean`
| `true`
|icon:lock[title=Fixed at build time] [[quarkus.camel.grpc.codegen.scan-for-proto]]`link:#quarkus.camel.grpc.codegen.scan-for-proto[quarkus.camel.grpc.codegen.scan-for-proto]`
-Camel Quarkus gRPC code generation can scan application dependencies for .proto files to generate Java stubs from them. This property sets the scope of the dependencies to scan. Applicable values:
+Camel Quarkus gRPC code generation can scan application dependencies for .proto files to generate Java stubs from
+them. This property sets the scope of the dependencies to scan. Applicable values:
- - _none_ - default - don't scan dependencies
- - a comma separated list of _groupId:artifactId_ coordinates to scan
- - _all_ - scan all dependencies
+- _none_ - default - don't scan dependencies
+- a comma separated list of _groupId:artifactId_ coordinates to scan
+- _all_ - scan all dependencies
| `string`
| `none`
|icon:lock[title=Fixed at build time] [[quarkus.camel.grpc.codegen.scan-for-imports]]`link:#quarkus.camel.grpc.codegen.scan-for-imports[quarkus.camel.grpc.codegen.scan-for-imports]`
-Camel Quarkus gRPC code generation can scan dependencies for .proto files that can be imported by protos in this applications. Applicable values:
+Camel Quarkus gRPC code generation can scan dependencies for .proto files that can be imported by protos in this
+applications. Applicable values:
- - _none_ - default - don't scan dependencies
- - a comma separated list of _groupId:artifactId_ coordinates to scan
- - _all_ - scan all dependencies The default is _com.google.protobuf:protobuf-java_.
+- _none_ - default - don't scan dependencies
+- a comma separated list of _groupId:artifactId_ coordinates to scan
+- _all_ - scan all dependencies The default is _com.google.protobuf:protobuf-java_.
| `string`
| `com.google.protobuf:protobuf-java`
diff --git a/docs/modules/ROOT/pages/reference/extensions/jasypt.adoc b/docs/modules/ROOT/pages/reference/extensions/jasypt.adoc
index 4d4b25d461..97e39d0cca 100644
--- a/docs/modules/ROOT/pages/reference/extensions/jasypt.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/jasypt.adoc
@@ -201,7 +201,9 @@ you must add the file to `quarkus.native.resources.includes` so that it can be l
|icon:lock[title=Fixed at build time] [[quarkus.camel.jasypt.enabled]]`link:#quarkus.camel.jasypt.enabled[quarkus.camel.jasypt.enabled]`
-Setting this option to false will disable Jasypt integration with Quarkus SmallRye configuration. You can however, manually configure Jasypt with Camel in the 'classic' way of manually configuring JasyptPropertiesParser and PropertiesComponent. Refer to the usage section for more details.
+Setting this option to false will disable Jasypt integration with Quarkus SmallRye configuration. You can however,
+manually configure Jasypt with Camel in the 'classic' way of manually configuring JasyptPropertiesParser and
+PropertiesComponent. Refer to the usage section for more details.
| `boolean`
| `true`
@@ -213,9 +215,11 @@ The algorithm to be used for decryption.
| [[quarkus.camel.jasypt.password]]`link:#quarkus.camel.jasypt.password[quarkus.camel.jasypt.password]`
-The master password used by Jasypt for decrypting configuration values. This option supports prefixes which influence the master password lookup behaviour.
+The master password used by Jasypt for decrypting configuration values. This option supports prefixes which influence
+the master password lookup behaviour.
-`sys:` will to look up the value from a JVM system property. `sysenv:` will look up the value from the OS system environment with the given key.
+`sys:` will to look up the value from a JVM system property. `sysenv:` will look up the value from the OS system
+environment with the given key.
| `string`
|
@@ -233,7 +237,8 @@ Configures the Jasypt StandardPBEStringEncryptor with a RandomSaltGenerator usin
| [[quarkus.camel.jasypt.configuration-customizer-class-name]]`link:#quarkus.camel.jasypt.configuration-customizer-class-name[quarkus.camel.jasypt.configuration-customizer-class-name]`
-The fully qualified class name of an org.apache.camel.quarkus.component.jasypt.JasyptConfigurationCustomizer implementation. This provides the optional capability of having full control over the Jasypt configuration.
+The fully qualified class name of an org.apache.camel.quarkus.component.jasypt.JasyptConfigurationCustomizer
+implementation. This provides the optional capability of having full control over the Jasypt configuration.
| `string`
|
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/jfr.adoc b/docs/modules/ROOT/pages/reference/extensions/jfr.adoc
index 4d760ec6c4..d02c6f7fb9 100644
--- a/docs/modules/ROOT/pages/reference/extensions/jfr.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/jfr.adoc
@@ -93,19 +93,24 @@ quarkus.native.monitoring=jfr
| [[quarkus.camel.jfr.startup-recorder-dir]]`link:#quarkus.camel.jfr.startup-recorder-dir[quarkus.camel.jfr.startup-recorder-dir]`
-Directory to store the recording. By default the current directory will be used. Use false to turn off saving the recording to disk.
+Directory to store the recording. By default the current directory will be used. Use false to turn off saving the
+recording to disk.
| `string`
|
| [[quarkus.camel.jfr.startup-recorder-duration]]`link:#quarkus.camel.jfr.startup-recorder-duration[quarkus.camel.jfr.startup-recorder-duration]`
-How long time to run the startup recorder. Use 0 (default) to keep the recorder running until the JVM is exited. Use -1 to stop the recorder right after Camel has been started (to only focus on potential Camel startup performance bottlenecks) Use a positive value to keep recording for N seconds. When the recorder is stopped then the recording is auto saved to disk (note: save to disk can be disabled by setting startupRecorderDir to false).
+How long time to run the startup recorder. Use 0 (default) to keep the recorder running until the JVM is exited. Use
+-1 to stop the recorder right after Camel has been started (to only focus on potential Camel startup performance
+bottlenecks) Use a positive value to keep recording for N seconds. When the recorder is stopped then the recording is
+auto saved to disk (note: save to disk can be disabled by setting startupRecorderDir to false).
| `long`
|
| [[quarkus.camel.jfr.startup-recorder-max-depth]]`link:#quarkus.camel.jfr.startup-recorder-max-depth[quarkus.camel.jfr.startup-recorder-max-depth]`
-To filter our sub steps at a maximum depth. Use -1 for no maximum. Use 0 for no sub steps. Use 1 for max 1 sub step, and so forth. The default is -1.
+To filter our sub steps at a maximum depth. Use -1 for no maximum. Use 0 for no sub steps. Use 1 for max 1 sub step,
+and so forth. The default is -1.
| `int`
|
@@ -117,7 +122,8 @@ To use a specific Java Flight Recorder profile configuration, such as default or
| [[quarkus.camel.jfr.startup-recorder-recording]]`link:#quarkus.camel.jfr.startup-recorder-recording[quarkus.camel.jfr.startup-recorder-recording]`
-To enable Java Flight Recorder to start a recording and automatic dump the recording to disk after startup is complete. This requires that camel-jfr is on the classpath. The default is false.
+To enable Java Flight Recorder to start a recording and automatic dump the recording to disk after startup is
+complete. This requires that camel-jfr is on the classpath. The default is false.
| `boolean`
|
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/kafka.adoc b/docs/modules/ROOT/pages/reference/extensions/kafka.adoc
index 70f0031186..f0fe753ded 100644
--- a/docs/modules/ROOT/pages/reference/extensions/kafka.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/kafka.adoc
@@ -69,7 +69,10 @@ This functionality can be disabled with the configuration property `quarkus.kafk
| [[quarkus.camel.kafka.kubernetes-service-binding.merge-configuration]]`link:#quarkus.camel.kafka.kubernetes-service-binding.merge-configuration[quarkus.camel.kafka.kubernetes-service-binding.merge-configuration]`
-If `true` then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding extension (if configured) will be merged with those set via Camel Kafka component or endpoint options. If `false` then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding extension are ignored, and all of the Kafka component configuration is driven by Camel.
+If `true` then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding extension (if
+configured) will be merged with those set via Camel Kafka component or endpoint options. If `false` then any Kafka
+configuration properties discovered by the Quarkus Kubernetes Service Binding extension are ignored, and all of the
+Kafka component configuration is driven by Camel.
| `boolean`
| `true`
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/kamelet.adoc b/docs/modules/ROOT/pages/reference/extensions/kamelet.adoc
index dc7d3358d4..9a5927e2b0 100644
--- a/docs/modules/ROOT/pages/reference/extensions/kamelet.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/kamelet.adoc
@@ -81,8 +81,8 @@ You can select which Kamelets from the catalog you want to use by referencing th
|icon:lock[title=Fixed at build time] [[quarkus.camel.kamelet.identifiers]]`link:#quarkus.camel.kamelet.identifiers[quarkus.camel.kamelet.identifiers]`
List of kamelets identifiers to pre-load at build time.
-
-Each individual identifier is used to set the related `org.apache.camel.model.RouteTemplateDefinition` id.
+<p>
+Each individual identifier is used to set the related {@link org.apache.camel.model.RouteTemplateDefinition} id.
| List of `string`
|
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/kubernetes-cluster-service.adoc b/docs/modules/ROOT/pages/reference/extensions/kubernetes-cluster-service.adoc
index 740d3f70ed..d479c560e7 100644
--- a/docs/modules/ROOT/pages/reference/extensions/kubernetes-cluster-service.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/kubernetes-cluster-service.adoc
@@ -70,7 +70,8 @@ The kubernetes cluster service could further be tuned by tweaking `quarkus.camel
|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.kubernetes.enabled]]`link:#quarkus.camel.cluster.kubernetes.enabled[quarkus.camel.cluster.kubernetes.enabled]`
-Whether a Kubernetes Cluster Service should be automatically configured according to 'quarkus.camel.cluster.kubernetes.++*++' configurations.
+Whether a Kubernetes Cluster Service should be automatically configured according to
+'quarkus.camel.cluster.kubernetes.++*++' configurations.
| `boolean`
| `true`
@@ -112,7 +113,8 @@ The name of the current pod (autodetected from container host name by default).
| [[quarkus.camel.cluster.kubernetes.jitter-factor]]`link:#quarkus.camel.cluster.kubernetes.jitter-factor[quarkus.camel.cluster.kubernetes.jitter-factor]`
-The jitter factor to apply in order to prevent all pods to call Kubernetes APIs in the same instant (defaults to 1.2).
+The jitter factor to apply in order to prevent all pods to call Kubernetes APIs in the same instant (defaults to
+1.2).
| `double`
|
@@ -124,13 +126,15 @@ The default duration of the lease for the current leader (defaults to 15000).
| [[quarkus.camel.cluster.kubernetes.renew-deadline-millis]]`link:#quarkus.camel.cluster.kubernetes.renew-deadline-millis[quarkus.camel.cluster.kubernetes.renew-deadline-millis]`
-The deadline after which the leader must stop its services because it may have lost the leadership (defaults to 10000).
+The deadline after which the leader must stop its services because it may have lost the leadership (defaults to
+10000).
| `long`
|
| [[quarkus.camel.cluster.kubernetes.retry-period-millis]]`link:#quarkus.camel.cluster.kubernetes.retry-period-millis[quarkus.camel.cluster.kubernetes.retry-period-millis]`
-The time between two subsequent attempts to check and acquire the leadership. It is randomized using the jitter factor (defaults to 2000).
+The time between two subsequent attempts to check and acquire the leadership. It is randomized using the jitter
+factor (defaults to 2000).
| `long`
|
@@ -142,7 +146,8 @@ Service lookup order/priority (defaults to 2147482647).
| [[quarkus.camel.cluster.kubernetes.resource-name]]`link:#quarkus.camel.cluster.kubernetes.resource-name[quarkus.camel.cluster.kubernetes.resource-name]`
-The name of the lease resource used to do optimistic locking (defaults to 'leaders'). The resource name is used as prefix when the underlying Kubernetes resource can manage a single lock.
+The name of the lease resource used to do optimistic locking (defaults to 'leaders'). The resource name is used as
+prefix when the underlying Kubernetes resource can manage a single lock.
| `string`
|
diff --git a/docs/modules/ROOT/pages/reference/extensions/micrometer.adoc b/docs/modules/ROOT/pages/reference/extensions/micrometer.adoc
index 281d90df30..c1dd8a886c 100644
--- a/docs/modules/ROOT/pages/reference/extensions/micrometer.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/micrometer.adoc
@@ -99,7 +99,9 @@ Set whether to enable the MicrometerRoutePolicyFactory for capturing metrics on
|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-message-history]]`link:#quarkus.camel.metrics.enable-message-history[quarkus.camel.metrics.enable-message-history]`
-Set whether to enable the MicrometerMessageHistoryFactory for capturing metrics on individual route node processing times. Depending on the number of configured route nodes, there is the potential to create a large volume of metrics. Therefore, this option is disabled by default.
+Set whether to enable the MicrometerMessageHistoryFactory for capturing metrics on individual route node processing
+times. Depending on the number of configured route nodes, there is the potential to create a large volume of metrics.
+Therefore, this option is disabled by default.
| `boolean`
| `false`
@@ -111,7 +113,8 @@ Set whether to enable the MicrometerExchangeEventNotifier for capturing metrics
|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-route-event-notifier]]`link:#quarkus.camel.metrics.enable-route-event-notifier[quarkus.camel.metrics.enable-route-event-notifier]`
-Set whether to enable the MicrometerRouteEventNotifier for capturing metrics on the total number of routes and total number of routes running.
+Set whether to enable the MicrometerRouteEventNotifier for capturing metrics on the total number of routes and total
+number of routes running.
| `boolean`
| `true`
@@ -123,13 +126,16 @@ Set whether to gather performance information about Camel Thread Pools by inject
|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.naming-strategy]]`link:#quarkus.camel.metrics.naming-strategy[quarkus.camel.metrics.naming-strategy]`
-Controls the naming style to use for metrics. The available values are `default` and `legacy`. `default` uses the default Micrometer naming convention. `legacy` uses the legacy camel-case naming style.
+Controls the naming style to use for metrics. The available values are `default` and `legacy`. `default` uses the
+default Micrometer naming convention. `legacy` uses the legacy camel-case naming style.
| `default`, `legacy`
| `default`
|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.route-policy-level]]`link:#quarkus.camel.metrics.route-policy-level[quarkus.camel.metrics.route-policy-level]`
-Sets the level of metrics to capture. The available values are `all` ,`context` and `route`. `all` captures metrics for both the camel context and routes. `route` captures metrics for routes only. `context` captures metrics for the camel context only.
+Sets the level of metrics to capture. The available values are `all` ,`context` and `route`. `all` captures metrics
+for both the camel context and routes. `route` captures metrics for routes only. `context` captures metrics for the
+camel context only.
| `all`, `context`, `route`
| `all`
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/opentelemetry.adoc b/docs/modules/ROOT/pages/reference/extensions/opentelemetry.adoc
index 7fd7861c8b..02c895fcc3 100644
--- a/docs/modules/ROOT/pages/reference/extensions/opentelemetry.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/opentelemetry.adoc
@@ -122,31 +122,29 @@ There is more information about CDI instrumentation in the https://quarkus.io/gu
| [[quarkus.camel.opentelemetry.encoding]]`link:#quarkus.camel.opentelemetry.encoding[quarkus.camel.opentelemetry.encoding]`
-Sets whether header names need to be encoded. Can be useful in situations where OpenTelemetry propagators potentially set header name values in formats that are not compatible with the target system. E.g for JMS where the specification mandates header names are valid Java identifiers.
+Sets whether header names need to be encoded. Can be useful in situations where OpenTelemetry propagators potentially
+set header name values in formats that are not compatible with the target system. E.g for JMS where the specification
+mandates header names are valid Java identifiers.
| `boolean`
| `false`
| [[quarkus.camel.opentelemetry.exclude-patterns]]`link:#quarkus.camel.opentelemetry.exclude-patterns[quarkus.camel.opentelemetry.exclude-patterns]`
-Sets whether to disable tracing for endpoint URIs or Processor ids that match the given comma separated patterns. The pattern can take the following forms:
-
-
+Sets whether to disable tracing for endpoint URIs or Processor ids that match the given comma separated patterns. The
+pattern can take the following forms:
1. An exact match on the endpoint URI. E.g platform-http:/some/path
-
-
2. A wildcard match. E.g platform-http:++*++
-
-
3. A regular expression matching the endpoint URI. E.g platform-http:/prefix/.++*++
| `string`
|
| [[quarkus.camel.opentelemetry.trace-processors]]`link:#quarkus.camel.opentelemetry.trace-processors[quarkus.camel.opentelemetry.trace-processors]`
-Sets whether to create new OpenTelemetry spans for each Camel Processor. Use the excludePatterns property to filter out Processors.
+Sets whether to create new OpenTelemetry spans for each Camel Processor. Use the excludePatterns property to filter
+out Processors.
| `boolean`
| `false`
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/rest-openapi.adoc b/docs/modules/ROOT/pages/reference/extensions/rest-openapi.adoc
index 253c6ccfaf..7a81c4f58d 100644
--- a/docs/modules/ROOT/pages/reference/extensions/rest-openapi.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/rest-openapi.adoc
@@ -138,8 +138,8 @@ quarkus.native.resources.includes=contract.json
|icon:lock[title=Fixed at build time] [[quarkus.camel.openapi.codegen.enabled]]`link:#quarkus.camel.openapi.codegen.enabled[quarkus.camel.openapi.codegen.enabled]`
-If {@code true}, Camel Quarkus OpenAPI code generation is run for .json files discovered from the {@code openapi}
-directory. When {@code false}, code generation for .json files is disabled.
+If `true`, Camel Quarkus OpenAPI code generation is run for .json files discovered from the `openapi` directory. When
+`false`, code generation for .json files is disabled.
| `boolean`
| `true`
@@ -157,13 +157,13 @@ A comma separated list of models to generate. All models is the default.
|icon:lock[title=Fixed at build time] [[quarkus.camel.openapi.codegen.use-bean-validation]]`link:#quarkus.camel.openapi.codegen.use-bean-validation[quarkus.camel.openapi.codegen.use-bean-validation]`
-If {@code true}, use bean validation annotations in the generated model classes.
+If `true`, use bean validation annotations in the generated model classes.
| `boolean`
| `false`
|icon:lock[title=Fixed at build time] [[quarkus.camel.openapi.codegen.not-null-jackson]]`link:#quarkus.camel.openapi.codegen.not-null-jackson[quarkus.camel.openapi.codegen.not-null-jackson]`
-If {@code true}, use NON_NULL Jackson annotation in the generated model classes.
+If `true`, use NON_NULL Jackson annotation in the generated model classes.
| `boolean`
| `false`
|===
diff --git a/docs/modules/ROOT/pages/reference/extensions/servlet.adoc b/docs/modules/ROOT/pages/reference/extensions/servlet.adoc
index 2e534fc8a6..7e41b6190e 100644
--- a/docs/modules/ROOT/pages/reference/extensions/servlet.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/servlet.adoc
@@ -177,7 +177,8 @@ You will also need to enable serialization for the exception classes that you in
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.url-patterns]]`link:#quarkus.camel.servlet.url-patterns[quarkus.camel.servlet.url-patterns]`
-A comma separated list of path patterns under which the CamelServlet should be accessible. Example path patterns: `/++*++`, `/services/++*++`
+A comma separated list of path patterns under which the CamelServlet should be accessible. Example path patterns:
+`/++*++`, `/services/++*++`
| List of `string`
|
@@ -189,13 +190,16 @@ A fully qualified name of a servlet class to serve paths that match `url-pattern
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.servlet-name]]`link:#quarkus.camel.servlet.servlet-name[quarkus.camel.servlet.servlet-name]`
-A servletName as it would be defined in a `web.xml` file or in the `jakarta.servlet.annotation.WebServlet++#++name()` annotation.
+A servletName as it would be defined in a `web.xml` file or in the `jakarta.servlet.annotation.WebServlet++#++name()`
+annotation.
| `string`
| `CamelServlet`
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.load-on-startup]]`link:#quarkus.camel.servlet.load-on-startup[quarkus.camel.servlet.load-on-startup]`
-Sets the loadOnStartup priority on the Servlet. A loadOnStartup is a value greater than or equal to zero, indicates to the container the initialization priority of the Servlet. If loadOnStartup is a negative integer, the Servlet is initialized lazily.
+Sets the loadOnStartup priority on the Servlet. A loadOnStartup is a value greater than or equal to zero, indicates
+to the container the initialization priority of the Servlet. If loadOnStartup is a negative integer, the Servlet is
+initialized lazily.
| `int`
| `-1`
@@ -207,7 +211,8 @@ Enables Camel to benefit from asynchronous Servlet support.
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.force-await]]`link:#quarkus.camel.servlet.force-await[quarkus.camel.servlet.force-await]`
-When set to `true` used in conjunction with `quarkus.camel.servlet.async = true`, this will force route processing to run synchronously.
+When set to `true` used in conjunction with `quarkus.camel.servlet.async = true`, this will force route processing to
+run synchronously.
| `boolean`
| `false`
@@ -219,7 +224,8 @@ The name of a bean to configure an optional custom thread pool for handling Came
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.multipart.location]]`link:#quarkus.camel.servlet.multipart.location[quarkus.camel.servlet.multipart.location]`
-An absolute path to a directory on the file system to store files temporarily while the parts are processed or when the size of the file exceeds the specified file-size-threshold configuration value.
+An absolute path to a directory on the file system to store files temporarily while the parts are processed or
+when the size of the file exceeds the specified file-size-threshold configuration value.
| `string`
| `${java.io.tmpdir}`
@@ -231,7 +237,8 @@ The maximum size allowed in bytes for uploaded files. The default size (-1) allo
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.multipart.max-request-size]]`link:#quarkus.camel.servlet.multipart.max-request-size[quarkus.camel.servlet.multipart.max-request-size]`
-The maximum size allowed in bytes for a multipart/form-data request. The default size (-1) allows an unlimited size.
+The maximum size allowed in bytes for a multipart/form-data request. The default size (-1) allows an unlimited
+size.
| `long`
| `-1`
@@ -243,7 +250,8 @@ The file size in bytes after which the file will be temporarily stored on disk.
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.-named-servlets-.url-patterns]]`link:#quarkus.camel.servlet.-named-servlets-.url-patterns[quarkus.camel.servlet."named-servlets".url-patterns]`
-A comma separated list of path patterns under which the CamelServlet should be accessible. Example path patterns: `/++*++`, `/services/++*++`
+A comma separated list of path patterns under which the CamelServlet should be accessible. Example path patterns:
+`/++*++`, `/services/++*++`
| List of `string`
|
@@ -255,13 +263,16 @@ A fully qualified name of a servlet class to serve paths that match `url-pattern
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.-named-servlets-.servlet-name]]`link:#quarkus.camel.servlet.-named-servlets-.servlet-name[quarkus.camel.servlet."named-servlets".servlet-name]`
-A servletName as it would be defined in a `web.xml` file or in the `jakarta.servlet.annotation.WebServlet++#++name()` annotation.
+A servletName as it would be defined in a `web.xml` file or in the `jakarta.servlet.annotation.WebServlet++#++name()`
+annotation.
| `string`
| `CamelServlet`
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.-named-servlets-.load-on-startup]]`link:#quarkus.camel.servlet.-named-servlets-.load-on-startup[quarkus.camel.servlet."named-servlets".load-on-startup]`
-Sets the loadOnStartup priority on the Servlet. A loadOnStartup is a value greater than or equal to zero, indicates to the container the initialization priority of the Servlet. If loadOnStartup is a negative integer, the Servlet is initialized lazily.
+Sets the loadOnStartup priority on the Servlet. A loadOnStartup is a value greater than or equal to zero, indicates
+to the container the initialization priority of the Servlet. If loadOnStartup is a negative integer, the Servlet is
+initialized lazily.
| `int`
| `-1`
@@ -273,7 +284,8 @@ Enables Camel to benefit from asynchronous Servlet support.
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.-named-servlets-.force-await]]`link:#quarkus.camel.servlet.-named-servlets-.force-await[quarkus.camel.servlet."named-servlets".force-await]`
-When set to `true` used in conjunction with `quarkus.camel.servlet.async = true`, this will force route processing to run synchronously.
+When set to `true` used in conjunction with `quarkus.camel.servlet.async = true`, this will force route processing to
+run synchronously.
| `boolean`
| `false`
@@ -285,7 +297,8 @@ The name of a bean to configure an optional custom thread pool for handling Came
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.-named-servlets-.multipart.location]]`link:#quarkus.camel.servlet.-named-servlets-.multipart.location[quarkus.camel.servlet."named-servlets".multipart.location]`
-An absolute path to a directory on the file system to store files temporarily while the parts are processed or when the size of the file exceeds the specified file-size-threshold configuration value.
+An absolute path to a directory on the file system to store files temporarily while the parts are processed or
+when the size of the file exceeds the specified file-size-threshold configuration value.
| `string`
| `${java.io.tmpdir}`
@@ -297,7 +310,8 @@ The maximum size allowed in bytes for uploaded files. The default size (-1) allo
|icon:lock[title=Fixed at build time] [[quarkus.camel.servlet.-named-servlets-.multipart.max-request-size]]`link:#quarkus.camel.servlet.-named-servlets-.multipart.max-request-size[quarkus.camel.servlet."named-servlets".multipart.max-request-size]`
-The maximum size allowed in bytes for a multipart/form-data request. The default size (-1) allows an unlimited size.
+The maximum size allowed in bytes for a multipart/form-data request. The default size (-1) allows an unlimited
+size.
| `long`
| `-1`
diff --git a/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/core/CamelConfig.java b/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/core/CamelConfig.java
index 9207de66cc..49e54ffe0c 100644
--- a/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/core/CamelConfig.java
+++ b/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/core/CamelConfig.java
@@ -26,42 +26,56 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
public class CamelConfig {
+
public enum FailureRemedy {
+
fail, warn, ignore
}
/**
- * Build time configuration options for {@link CamelRuntime} bootstrap.
+ * Build time configuration options for `CamelRuntime` bootstrap.
+ *
+ * @asciidoclet
*/
@ConfigItem
public BootstrapConfig bootstrap;
/**
* Build time configuration options for Camel services.
+ *
+ * @asciidoclet
*/
@ConfigItem
public ServiceConfig service;
/**
- * Build time configuration options for {@link org.apache.camel.catalog.RuntimeCamelCatalog}.
+ * Build time configuration options for `org.apache.camel.catalog.RuntimeCamelCatalog`.
+ *
+ * @asciidoclet
*/
@ConfigItem
public RuntimeCatalogConfig runtimeCatalog;
/**
* Build time configuration options for routes discovery.
+ *
+ * @asciidoclet
*/
@ConfigItem
public RoutesDiscoveryConfig routesDiscovery;
/**
* Build time configuration options related to the building of native executable.
+ *
+ * @asciidoclet
*/
@ConfigItem(name = "native")
public NativeConfig native_;
/**
* Build time configuration options for the Camel CSimple language.
+ *
+ * @asciidoclet
*/
@Deprecated(forRemoval = true)
@ConfigItem
@@ -69,38 +83,51 @@ public class CamelConfig {
/**
* Build time configuration options for the extraction of Camel expressions.
+ *
+ * @asciidoclet
*/
@ConfigItem
public ExpressionConfig expression;
/**
* Build time configuration options for the Camel CDI event bridge.
+ *
+ * @asciidoclet
*/
@ConfigItem
public EventBridgeConfig eventBridge;
/**
* Build time configuration options for enable/disable camel source location.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean sourceLocationEnabled;
/**
* Build time configuration options for the Camel tracing.
+ *
+ * @asciidoclet
*/
@ConfigItem
public TraceConfig trace;
/**
* Build time configuration options for Camel type converters.
+ *
+ * @asciidoclet
*/
@ConfigItem
public TypeConverterConfig typeConverter;
@ConfigGroup
public static class BootstrapConfig {
+
/**
- * When set to true, the {@link CamelRuntime} will be started automatically.
+ * When set to true, the `CamelRuntime` will be started automatically.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enabled;
@@ -108,36 +135,37 @@ public class CamelConfig {
@ConfigGroup
public static class RoutesDiscoveryConfig {
+
/**
* Enable automatic discovery of routes during static initialization.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enabled;
/**
- * Used for exclusive filtering scanning of RouteBuilder classes.
- * The exclusive filtering takes precedence over inclusive filtering.
- * The pattern is using Ant-path style pattern.
- * Multiple patterns can be specified separated by comma.
+ * Used for exclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over
+ * inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by
+ * comma. For example to exclude all classes starting with Bar use: ++**++/Bar++*++ To exclude all routes form a
+ * specific package use: com/mycompany/bar/++*++ To exclude all routes form a specific package and its sub-packages use
+ * double wildcards: com/mycompany/bar/++**++ And to exclude all routes from two specific packages use:
+ * com/mycompany/bar/++*++,com/mycompany/stuff/++*++
*
- * For example to exclude all classes starting with Bar use: **/Bar*
- * To exclude all routes form a specific package use: com/mycompany/bar/*
- * To exclude all routes form a specific package and its sub-packages use double wildcards: com/mycompany/bar/**
- * And to exclude all routes from two specific packages use: com/mycompany/bar/*,com/mycompany/stuff/*
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> excludePatterns;
/**
- * Used for inclusive filtering scanning of RouteBuilder classes.
- * The exclusive filtering takes precedence over inclusive filtering.
- * The pattern is using Ant-path style pattern.
+ * Used for inclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over
+ * inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by
+ * comma. For example to include all classes starting with Foo use: ++**++/Foo++*++ To include all routes form a
+ * specific package use: com/mycompany/foo/++*++ To include all routes form a specific package and its sub-packages use
+ * double wildcards: com/mycompany/foo/++**++ And to include all routes from two specific packages use:
+ * com/mycompany/foo/++*++,com/mycompany/stuff/++*++
*
- * Multiple patterns can be specified separated by comma.
- * For example to include all classes starting with Foo use: **/Foo*
- * To include all routes form a specific package use: com/mycompany/foo/*
- * To include all routes form a specific package and its sub-packages use double wildcards: com/mycompany/foo/**
- * And to include all routes from two specific packages use: com/mycompany/foo/*,com/mycompany/stuff/*
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> includePatterns;
@@ -147,13 +175,19 @@ public class CamelConfig {
public static class ServiceConfig {
/**
- * Build time configuration related to discoverability of Camel services via the
- * {@code org.apache.camel.spi.FactoryFinder} mechanism
+ * Build time configuration related to discoverability of Camel services via the `org.apache.camel.spi.FactoryFinder`
+ * mechanism
+ *
+ * @asciidoclet
*/
@ConfigItem
public ServiceDiscoveryConfig discovery;
- /** Build time configuration related to registering of Camel services to the Camel registry */
+ /**
+ * Build time configuration related to registering of Camel services to the Camel registry
+ *
+ * @asciidoclet
+ */
@ConfigItem
public ServiceRegistryConfig registry;
}
@@ -162,30 +196,31 @@ public class CamelConfig {
public static class ServiceDiscoveryConfig {
/**
- * A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath.
- * The services defined in the matching files will <strong>not<strong> be discoverable via the
- * {@code org.apache.camel.spi.FactoryFinder} mechanism.
- * <p>
+ * A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The
+ * services defined in the matching files will *not* be discoverable via the **`org.apache.camel.spi.FactoryFinder`
+ * mechanism.
+ *
* The excludes have higher precedence than includes. The excludes defined here can also be used to veto the
* discoverability of services included by Camel Quarkus extensions.
- * <p>
- * Example values:
- * <code>META-INF/services/org/apache/camel/foo/*,META-INF/services/org/apache/camel/foo/**/bar</code>
+ *
+ * Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> excludePatterns;
/**
- * A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath.
- * The services defined in the matching files will be discoverable via the
- * {@code org.apache.camel.spi.FactoryFinder} mechanism unless the given file is excluded via
- * {@code exclude-patterns}.
- * <p>
- * Note that Camel Quarkus extensions may include some services by default. The services selected here added
- * to those services and the exclusions defined in {@code exclude-patterns} are applied to the union set.
- * <p>
- * Example values:
- * <code>META-INF/services/org/apache/camel/foo/*,META-INF/services/org/apache/camel/foo/**/bar</code>
+ * A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The
+ * services defined in the matching files will be discoverable via the `org.apache.camel.spi.FactoryFinder` mechanism
+ * unless the given file is excluded via `exclude-patterns`.
+ *
+ * Note that Camel Quarkus extensions may include some services by default. The services selected here added to those
+ * services and the exclusions defined in `exclude-patterns` are applied to the union set.
+ *
+ * Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> includePatterns;
@@ -195,29 +230,31 @@ public class CamelConfig {
public static class ServiceRegistryConfig {
/**
- * A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath.
- * The services defined in the matching files will <strong>not<strong> be added to Camel registry during
- * application's static initialization.
- * <p>
+ * A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The
+ * services defined in the matching files will *not* be added to Camel registry during application's static
+ * initialization.
+ *
* The excludes have higher precedence than includes. The excludes defined here can also be used to veto the
* registration of services included by Camel Quarkus extensions.
- * <p>
- * Example values:
- * <code>META-INF/services/org/apache/camel/foo/*,META-INF/services/org/apache/camel/foo/**/bar</code>
+ *
+ * Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`**
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> excludePatterns;
/**
- * A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath.
- * The services defined in the matching files will be added to Camel registry during application's static
- * initialization unless the given file is excluded via {@code exclude-patterns}.
- * <p>
- * Note that Camel Quarkus extensions may include some services by default. The services selected here added
- * to those services and the exclusions defined in {@code exclude-patterns} are applied to the union set.
- * <p>
- * Example values:
- * <code>META-INF/services/org/apache/camel/foo/*,META-INF/services/org/apache/camel/foo/**/bar</code>
+ * A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The
+ * services defined in the matching files will be added to Camel registry during application's static initialization
+ * unless the given file is excluded via `exclude-patterns`.
+ *
+ * Note that Camel Quarkus extensions may include some services by default. The services selected here added to those
+ * services and the exclusions defined in `exclude-patterns` are applied to the union set.
+ *
+ * Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> includePatterns;
@@ -228,79 +265,71 @@ public class CamelConfig {
/**
* Register classes for reflection.
+ *
+ * @asciidoclet
*/
@ConfigItem
public ReflectionConfig reflection;
-
}
@ConfigGroup
public static class ReflectionConfig {
/**
- * A comma separated list of Ant-path style patterns to match class names
- * that should be <strong>excluded</strong> from registering for reflection.
- * Use the class name format as returned by the {@code java.lang.Class.getName()}
- * method: package segments delimited by period {@code .} and inner classes
- * by dollar sign {@code $}.
- * <p>
- * This option narrows down the set selected by {@link #includePatterns}.
- * By default, no classes are excluded.
- * <p>
- * This option cannot be used to unregister classes which have been registered
- * internally by Quarkus extensions.
+ * A comma separated list of Ant-path style patterns to match class names that should be *excluded* from registering for
+ * reflection. Use the class name format as returned by the `java.lang.Class.getName()` method: package segments
+ * delimited by period `.` and inner classes by dollar sign `$`.
+ *
+ * This option narrows down the set selected by `include-patterns`. By default, no classes are excluded.
+ *
+ * This option cannot be used to unregister classes which have been registered internally by Quarkus extensions.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> excludePatterns;
/**
- * A comma separated list of Ant-path style patterns to match class names
- * that should be registered for reflection.
- * Use the class name format as returned by the {@code java.lang.Class.getName()}
- * method: package segments delimited by period {@code .} and inner classes
- * by dollar sign {@code $}.
- * <p>
- * By default, no classes are included. The set selected by this option can be
- * narrowed down by {@link #excludePatterns}.
- * <p>
- * Note that Quarkus extensions typically register the required classes for
- * reflection by themselves. This option is useful in situations when the
- * built in functionality is not sufficient.
- * <p>
- * Note that this option enables the full reflective access for constructors,
- * fields and methods. If you need a finer grained control, consider using
- * <code>io.quarkus.runtime.annotations.RegisterForReflection</code> annotation
- * in your Java code.
- * <p>
+ * A comma separated list of Ant-path style patterns to match class names that should be registered for reflection. Use
+ * the class name format as returned by the `java.lang.Class.getName()` method: package segments delimited by period `.`
+ * and inner classes by dollar sign `$`.
+ *
+ * By default, no classes are included. The set selected by this option can be narrowed down by `exclude-patterns`.
+ *
+ * Note that Quarkus extensions typically register the required classes for reflection by themselves. This option is
+ * useful in situations when the built in functionality is not sufficient.
+ *
+ * Note that this option enables the full reflective access for constructors, fields and methods. If you need a finer
+ * grained control, consider using `io.quarkus.runtime.annotations.RegisterForReflection` annotation in your Java code.
+ *
* For this option to work properly, at least one of the following conditions must be satisfied:
- * <ul>
- * <li>There are no wildcards (<code>*</code> or <code>/</code>) in the patterns</li>
- * <li>The artifacts containing the selected classes contain a Jandex index ({@code META-INF/jandex.idx})</li>
- * <li>The artifacts containing the selected classes are registered for indexing using the
- * {@code quarkus.index-dependency.*} family
- * of options in {@code application.properties} - e.g.
- *
- * <pre>
+ *
+ * - There are no wildcards (`++*++` or `/`) in the patterns
+ * - The artifacts containing the selected classes contain a Jandex index (`META-INF/jandex.idx`)
+ * - The artifacts containing the selected classes are registered for indexing using the
+ * `quarkus.index-dependency.++*++` family of options in `application.properties` - e.g.
+ *
+ * [source,properties]
+ * ----
* quarkus.index-dependency.my-dep.group-id = org.my-group
* quarkus.index-dependency.my-dep.artifact-id = my-artifact
- * </pre>
+ * ----
*
- * where {@code my-dep} is a label of your choice to tell Quarkus that
- * {@code org.my-group} and with {@code my-artifact} belong together.</li>
- * </ul>
+ * where `my-dep` is a label of your choice to tell Quarkus that `org.my-group` and with `my-artifact` belong together.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> includePatterns;
/**
- * If {@code true}, basic classes are registered for serialization; otherwise basic classes won't be registered
- * automatically for serialization in native mode.
- *
- * The list of classes automatically registered for serialization can be found in <a href=
- * "https://github.com/apache/camel-quarkus/blob/main/extensions-core/core/deployment/src/main/java/org/apache/camel/quarkus/core/deployment/CamelSerializationProcessor.java">CamelSerializationProcessor.BASE_SERIALIZATION_CLASSES</a>.
+ * If `true`, basic classes are registered for serialization; otherwise basic classes won't be registered automatically
+ * for serialization in native mode. The list of classes automatically registered for serialization can be found in
+ * link:https://github.com/apache/camel-quarkus/blob/main/extensions-core/core/deployment/src/main/java/org/apache/camel/quarkus/core/deployment/CamelSerializationProcessor.java[CamelSerializationProcessor.BASE_SERIALIZATION_CLASSES].
+ * Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+ * setting this flag to `true` except for making the behavior consistent with native mode.
*
- * Setting this to {@code false} helps to reduce the size of the native image. In JVM mode, there is no real
- * benefit of setting this flag to {@code true} except for making the behavior consistent with native mode.
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean serializationEnabled;
@@ -308,68 +337,81 @@ public class CamelConfig {
@ConfigGroup
public static class RuntimeCatalogConfig {
+
/**
- * If {@code true} the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel
- * components available in the application; otherwise component JSON schemas will not be available in the
- * Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
- * <p>
- * Setting this to {@code false} helps to reduce the size of the native image. In JVM mode, there is no real
- * benefit of setting this flag to {@code false} except for making the behavior consistent with native mode.
+ * If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel components
+ * available in the application; otherwise component JSON schemas will not be available in the Runtime Camel Catalog and
+ * any attempt to access those will result in a RuntimeException.
+ *
+ * Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+ * setting this flag to `false` except for making the behavior consistent with native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean components;
/**
- * If {@code true} the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel
- * languages available in the application; otherwise language JSON schemas will not be available in the
- * Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
- * <p>
- * Setting this to {@code false} helps to reduce the size of the native image. In JVM mode, there is no real
- * benefit of setting this flag to {@code false} except for making the behavior consistent with native mode.
+ * If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel languages
+ * available in the application; otherwise language JSON schemas will not be available in the Runtime Camel Catalog and
+ * any attempt to access those will result in a RuntimeException.
+ *
+ * Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+ * setting this flag to `false` except for making the behavior consistent with native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean languages;
/**
- * If {@code true} the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel
- * data formats available in the application; otherwise data format JSON schemas will not be available in the
- * Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
- * <p>
- * Setting this to {@code false} helps to reduce the size of the native image. In JVM mode, there is no real
- * benefit of setting this flag to {@code false} except for making the behavior consistent with native mode.
+ * If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel data formats
+ * available in the application; otherwise data format JSON schemas will not be available in the Runtime Camel Catalog
+ * and any attempt to access those will result in a RuntimeException.
+ *
+ * Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+ * setting this flag to `false` except for making the behavior consistent with native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean dataformats;
/**
- * If {@code true} the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel
- * dev consoles available in the application; otherwise dev console JSON schemas will not be available in the
- * Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
- * <p>
- * Setting this to {@code false} helps to reduce the size of the native image. In JVM mode, there is no real
- * benefit of setting this flag to {@code false} except for making the behavior consistent with native mode.
+ * If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel dev consoles
+ * available in the application; otherwise dev console JSON schemas will not be available in the Runtime Camel Catalog
+ * and any attempt to access those will result in a RuntimeException.
+ *
+ * Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+ * setting this flag to `false` except for making the behavior consistent with native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean devconsoles;
/**
- * If {@code true} the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel
- * EIP models available in the application; otherwise EIP model JSON schemas will not be available in the
- * Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
- * <p>
- * Setting this to {@code false} helps to reduce the size of the native image. In JVM mode, there is no real
- * benefit of setting this flag to {@code false} except for making the behavior consistent with native mode.
+ * If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel EIP models
+ * available in the application; otherwise EIP model JSON schemas will not be available in the Runtime Camel Catalog and
+ * any attempt to access those will result in a RuntimeException.
+ *
+ * Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+ * setting this flag to `false` except for making the behavior consistent with native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean models;
/**
- * If {@code true} the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel
- * transformers available in the application; otherwise transformer JSON schemas will not be available in the
- * Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
- * <p>
- * Setting this to {@code false} helps to reduce the size of the native image. In JVM mode, there is no real
- * benefit of setting this flag to {@code false} except for making the behavior consistent with native mode.
+ * If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel transformers
+ * available in the application; otherwise transformer JSON schemas will not be available in the Runtime Camel Catalog
+ * and any attempt to access those will result in a RuntimeException.
+ *
+ * Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of
+ * setting this flag to `false` except for making the behavior consistent with native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean transformers;
@@ -382,7 +424,11 @@ public class CamelConfig {
@ConfigGroup
public static class CSimpleConfig {
- /** What to do if it is not possible to extract CSimple expressions from a route definition at build time. */
+ /**
+ * What to do if it is not possible to extract CSimple expressions from a route definition at build time.
+ *
+ * @asciidoclet
+ */
@ConfigItem(defaultValue = "warn")
public FailureRemedy onBuildTimeAnalysisFailure;
}
@@ -390,13 +436,19 @@ public class CamelConfig {
@ConfigGroup
public static class ExpressionConfig {
- /** What to do if it is not possible to extract expressions from a route definition at build time. */
+ /**
+ * What to do if it is not possible to extract expressions from a route definition at build time.
+ *
+ * @asciidoclet
+ */
@ConfigItem(defaultValue = "warn")
public FailureRemedy onBuildTimeAnalysisFailure;
/**
- * Indicates whether the expression extraction from the route definitions at build time must be done. If
- * disabled, the expressions are compiled at runtime.
+ * Indicates whether the expression extraction from the route definitions at build time must be done. If disabled, the
+ * expressions are compiled at runtime.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean extractionEnabled;
@@ -407,13 +459,15 @@ public class CamelConfig {
/**
* Whether to enable the bridging of Camel events to CDI events.
- * <p>
+ *
* This allows CDI observers to be configured for Camel events. E.g. those belonging to the
- * {@code org.apache.camel.quarkus.core.events}, {@code org.apache.camel.quarkus.main.events} &
- * {@code org.apache.camel.impl.event} packages.
- * <p>
- * Note that this configuration item only has any effect when observers configured for Camel events
- * are present in the application.
+ * `org.apache.camel.quarkus.core.events`, `org.apache.camel.quarkus.main.events` & `org.apache.camel.impl.event`
+ * packages.
+ *
+ * Note that this configuration item only has any effect when observers configured for Camel events are present in the
+ * application.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enabled;
@@ -424,6 +478,8 @@ public class CamelConfig {
/**
* Enables tracer in your Camel application.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean enabled;
@@ -431,25 +487,33 @@ public class CamelConfig {
/**
* To set the tracer in standby mode, where the tracer will be installed, but not automatically enabled. The tracer can
* then be enabled explicitly later from Java, JMX or tooling.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean standby;
/**
* Defines how many of the last messages to keep in the tracer.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "1000")
public int backlogSize;
/**
- * Whether all traced messages should be removed when the tracer is dumping. By default, the messages are removed,
- * which means that dumping will not contain previous dumped messages.
+ * Whether all traced messages should be removed when the tracer is dumping. By default, the messages are removed, which
+ * means that dumping will not contain previous dumped messages.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean removeOnDump;
/**
* To limit the message body to a maximum size in the traced message. Use 0 or negative value to use unlimited size.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "131072")
public int bodyMaxChars;
@@ -457,55 +521,73 @@ public class CamelConfig {
/**
* Whether to include the message body of stream based messages. If enabled then beware the stream may not be
* re-readable later. See more about Stream Caching.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean bodyIncludeStreams;
/**
- * Whether to include the message body of file based messages. The overhead is that the file content has to be read
- * from the file.
+ * Whether to include the message body of file based messages. The overhead is that the file content has to be read from
+ * the file.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean bodyIncludeFiles;
/**
* Whether to include the exchange properties in the traced message.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean includeExchangeProperties;
/**
* Whether to include the exchange variables in the traced message.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean includeExchangeVariables;
/**
* Whether to include the exception in the traced message in case of failed exchange.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean includeException;
/**
* Whether to trace routes that is created from Rest DSL.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean traceRests;
/**
* Whether to trace routes that is created from route templates or kamelets.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean traceTemplates;
/**
* Filter for tracing by route or node id.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> tracePattern;
/**
* Filter for tracing messages.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> traceFilter;
@@ -513,9 +595,12 @@ public class CamelConfig {
@ConfigGroup
public static class TypeConverterConfig {
+
/**
- * Whether type converter statistics are enabled. By default, type converter utilization statistics are disabled.
- * Note that enabling statistics incurs a minor performance impact under very heavy load.
+ * Whether type converter statistics are enabled. By default, type converter utilization statistics are disabled. Note
+ * that enabling statistics incurs a minor performance impact under very heavy load.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean statisticsEnabled;
diff --git a/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/main/CamelMainConfig.java b/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/main/CamelMainConfig.java
index e249b93c86..87ab786b27 100644
--- a/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/main/CamelMainConfig.java
+++ b/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/main/CamelMainConfig.java
@@ -28,21 +28,28 @@ import org.apache.camel.quarkus.core.CamelConfig.FailureRemedy;
public class CamelMainConfig {
/**
- * Build time configuration options for {@link CamelMain} shutdown.
+ * Build time configuration options for `CamelMain` shutdown.
+ *
+ * @asciidoclet
*/
@ConfigItem
public ShutdownConfig shutdown;
/**
- * Build time configuration options for {@link CamelMain} arguments
+ * Build time configuration options for `CamelMain` arguments
+ *
+ * @asciidoclet
*/
@ConfigItem
public ArgumentConfig arguments;
@ConfigGroup
public static class ShutdownConfig {
+
/**
- * A timeout (with millisecond precision) to wait for {@link CamelMain#stop()} to finish
+ * A timeout (with millisecond precision) to wait for `CamelMain++#++stop()` to finish
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "PT3S")
public Duration timeout;
@@ -52,11 +59,11 @@ public class CamelMainConfig {
public static class ArgumentConfig {
/**
- * The action to take when {@link CamelMain} encounters an unknown argument.
+ * The action to take when `CamelMain` encounters an unknown argument. fail - Prints the `CamelMain` usage statement and
+ * throws a `RuntimeException` ignore - Suppresses any warnings and the application startup proceeds as normal warn -
+ * Prints the `CamelMain` usage statement but allows the application startup to proceed as normal
*
- * fail - Prints the {@link CamelMain} usage statement and throws a {@link RuntimeException}
- * ignore - Suppresses any warnings and the application startup proceeds as normal
- * warn - Prints the {@link CamelMain} usage statement but allows the application startup to proceed as normal
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "warn")
public FailureRemedy onUnknown;
diff --git a/extensions-jvm/cli-connector/runtime/src/main/java/org/apache/camel/quarkus/component/cli/connector/CamelCliConnectorConfig.java b/extensions-jvm/cli-connector/runtime/src/main/java/org/apache/camel/quarkus/component/cli/connector/CamelCliConnectorConfig.java
index 78ca502e79..141d2d2690 100644
--- a/extensions-jvm/cli-connector/runtime/src/main/java/org/apache/camel/quarkus/component/cli/connector/CamelCliConnectorConfig.java
+++ b/extensions-jvm/cli-connector/runtime/src/main/java/org/apache/camel/quarkus/component/cli/connector/CamelCliConnectorConfig.java
@@ -22,8 +22,11 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.cli", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
public class CamelCliConnectorConfig {
+
/**
* Sets whether to enable Camel CLI Connector support.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enabled;
diff --git a/extensions/cxf-soap/deployment/src/main/java/org/apache/camel/quarkus/component/cxf/soap/deployment/CxfBuildTimeConfig.java b/extensions/cxf-soap/deployment/src/main/java/org/apache/camel/quarkus/component/cxf/soap/deployment/CxfBuildTimeConfig.java
index 64ff7ff4ce..c795ac0f12 100644
--- a/extensions/cxf-soap/deployment/src/main/java/org/apache/camel/quarkus/component/cxf/soap/deployment/CxfBuildTimeConfig.java
+++ b/extensions/cxf-soap/deployment/src/main/java/org/apache/camel/quarkus/component/cxf/soap/deployment/CxfBuildTimeConfig.java
@@ -26,23 +26,28 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.cxf", phase = ConfigPhase.BUILD_TIME)
public class CxfBuildTimeConfig {
- /** Configuration options related to build time class generation */
+ /**
+ * Configuration options related to build time class generation
+ *
+ * @asciidoclet
+ */
@ConfigItem
public ClassGeneration classGeneration;
@ConfigGroup
public static class ClassGeneration {
+
/**
- * For CXF service interfaces to work properly, some ancillary classes (such as request and response
- * wrappers) need to be generated at build time. Camel Quarkus lets the {@code quarkus-cxf} extension to do this
- * for all service interfaces found in the class path except the ones matching the patterns in this property.
- * <p>
- * {@code org.apache.cxf.ws.security.sts.provider.SecurityTokenService} is excluded by default due to
- * <a href="https://issues.apache.org/jira/browse/CXF-8834">https://issues.apache.org/jira/browse/CXF-8834</a>
+ * For CXF service interfaces to work properly, some ancillary classes (such as request and response wrappers) need to
+ * be generated at build time. Camel Quarkus lets the `quarkus-cxf` extension to do this for all service interfaces
+ * found in the class path except the ones matching the patterns in this property.
+ *
+ * `org.apache.cxf.ws.security.sts.provider.SecurityTokenService` is excluded by default due to
+ * link:https://issues.apache.org/jira/browse/CXF-8834[https://issues.apache.org/jira/browse/CXF-8834]
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "org.apache.cxf.ws.security.sts.provider.SecurityTokenService")
List<String> excludePatterns;
-
}
-
}
diff --git a/extensions/debug/runtime/src/main/java/org/apache/camel/quarkus/component/debug/DebugConfig.java b/extensions/debug/runtime/src/main/java/org/apache/camel/quarkus/component/debug/DebugConfig.java
index 3bbcb581a8..659ed57b67 100644
--- a/extensions/debug/runtime/src/main/java/org/apache/camel/quarkus/component/debug/DebugConfig.java
+++ b/extensions/debug/runtime/src/main/java/org/apache/camel/quarkus/component/debug/DebugConfig.java
@@ -21,14 +21,19 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.debug", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
public class DebugConfig {
+
/**
* Set whether to enable Camel debugging support.
+ *
+ * @asciidoclet
*/
public boolean enabled;
/**
- * Indicates whether the <i>suspend mode</i> is enabled or not. If {@code true} the message processing is
- * immediately suspended until the method {@code attach()} is called.
+ * Indicates whether the _suspend mode_ is enabled or not. If `true` the message processing is immediately suspended
+ * until the method `attach()` is called.
+ *
+ * @asciidoclet
*/
public boolean suspend;
}
diff --git a/extensions/fhir/runtime/src/main/java/org/apache/camel/quarkus/component/fhir/FhirConfig.java b/extensions/fhir/runtime/src/main/java/org/apache/camel/quarkus/component/fhir/FhirConfig.java
index da852823d2..b94f1e74af 100644
--- a/extensions/fhir/runtime/src/main/java/org/apache/camel/quarkus/component/fhir/FhirConfig.java
+++ b/extensions/fhir/runtime/src/main/java/org/apache/camel/quarkus/component/fhir/FhirConfig.java
@@ -25,36 +25,48 @@ public final class FhirConfig {
/**
* Enable FHIR DSTU2 Specs in native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(name = "enable-dstu2", defaultValue = "false")
public boolean enableDstu2;
/**
* Enable FHIR DSTU2_HL7ORG Specs in native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(name = "enable-dstu2_hl7org", defaultValue = "false")
public boolean enableDstu2Hl7Org;
/**
* Enable FHIR DSTU2_1 Specs in native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(name = "enable-dstu2_1", defaultValue = "false")
public boolean enableDstu2_1;
/**
* Enable FHIR DSTU3 Specs in native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(name = "enable-dstu3", defaultValue = "false")
public boolean enableDstu3;
/**
* Enable FHIR R4 Specs in native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(name = "enable-r4", defaultValue = "true")
public boolean enableR4;
/**
* Enable FHIR R5 Specs in native mode.
+ *
+ * @asciidoclet
*/
@ConfigItem(name = "enable-r5", defaultValue = "false")
public boolean enableR5;
diff --git a/extensions/file-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/file/cluster/FileLockClusterServiceConfig.java b/extensions/file-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/file/cluster/FileLockClusterServiceConfig.java
index 5735703f9a..271450756a 100644
--- a/extensions/file-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/file/cluster/FileLockClusterServiceConfig.java
+++ b/extensions/file-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/file/cluster/FileLockClusterServiceConfig.java
@@ -27,11 +27,12 @@ import io.quarkus.runtime.annotations.ConfigRoot;
public class FileLockClusterServiceConfig {
/**
- * Whether a File Lock Cluster Service should be automatically configured
- * according to 'quarkus.camel.cluster.file.*' configurations.
+ * Whether a File Lock Cluster Service should be automatically configured according to
+ * 'quarkus.camel.cluster.file.++*++' configurations.
*
- * @deprecated this property is no longer needed as the FileLock implementation of the Camel CLuster Service API has
- * been moved to a dedicated extension.
+ * @deprecated this property is no longer needed as the FileLock implementation of the Camel CLuster Service API has
+ * been moved to a dedicated extension.
+ * @asciidoclet
*/
@Deprecated(since = "3.10.0", forRemoval = true)
@ConfigItem(defaultValue = "true")
@@ -39,41 +40,54 @@ public class FileLockClusterServiceConfig {
/**
* The cluster service ID (defaults to null).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> id;
/**
* The root path (defaults to null).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> root;
/**
* The service lookup order/priority (defaults to 2147482647).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<Integer> order;
/**
* The custom attributes associated to the service (defaults to empty map).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Map<String, String> attributes;
/**
* The time to wait before starting to try to acquire lock (defaults to 1000ms).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> acquireLockDelay;
/**
* The time to wait between attempts to try to acquire lock (defaults to 10000ms).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> acquireLockInterval;
public static final class Enabled implements BooleanSupplier {
+
FileLockClusterServiceConfig config;
@Override
diff --git a/extensions/graphql/runtime/src/main/java/org/apache/camel/quarkus/component/graphql/CamelGraphQLConfig.java b/extensions/graphql/runtime/src/main/java/org/apache/camel/quarkus/component/graphql/CamelGraphQLConfig.java
index 081a3f2a49..ee5134e197 100644
--- a/extensions/graphql/runtime/src/main/java/org/apache/camel/quarkus/component/graphql/CamelGraphQLConfig.java
+++ b/extensions/graphql/runtime/src/main/java/org/apache/camel/quarkus/component/graphql/CamelGraphQLConfig.java
@@ -27,12 +27,12 @@ import io.quarkus.runtime.annotations.ConfigRoot;
public class CamelGraphQLConfig {
/**
- * A comma separated list of paths to files containing GraphQL queries for use by GraphQL endpoints.
- *
- * Query files that only need to be accessible from the classpath should be specified on this property.
- *
- * Paths can either be schemeless (E.g graphql/my-query.graphql) or be prefixed with the classpath: URI scheme (E.g
+ * A comma separated list of paths to files containing GraphQL queries for use by GraphQL endpoints. Query files that
+ * only need to be accessible from the classpath should be specified on this property. Paths can either be schemeless
+ * (E.g graphql/my-query.graphql) or be prefixed with the classpath: URI scheme (E.g
* classpath:graphql/my-query.graphql). Other URI schemes are not supported.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> queryFiles;
diff --git a/extensions/grpc/runtime/src/main/java/org/apache/camel/quarkus/grpc/runtime/GrpcBuildTimeConfig.java b/extensions/grpc/runtime/src/main/java/org/apache/camel/quarkus/grpc/runtime/GrpcBuildTimeConfig.java
index 0f7a3eda56..0f6ec948cd 100644
--- a/extensions/grpc/runtime/src/main/java/org/apache/camel/quarkus/grpc/runtime/GrpcBuildTimeConfig.java
+++ b/extensions/grpc/runtime/src/main/java/org/apache/camel/quarkus/grpc/runtime/GrpcBuildTimeConfig.java
@@ -26,59 +26,66 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.grpc", phase = ConfigPhase.BUILD_TIME)
public class GrpcBuildTimeConfig {
+
/**
* Build time configuration options for Camel Quarkus gRPC code generator.
+ *
+ * @asciidoclet
*/
@ConfigItem
public CodeGenConfig codegen;
@ConfigGroup
public static class CodeGenConfig {
+
/**
- * If {@code true}, Camel Quarkus gRPC code generation is run for .proto files discovered from the {@code proto}
- * directory, or from dependencies specified in the {@code scan-for-proto} or {@code scan-for-imports} options. When
- * {@code false}, code generation for .proto files is disabled.
+ * If `true`, Camel Quarkus gRPC code generation is run for .proto files discovered from the `proto` directory, or from
+ * dependencies specified in the `scan-for-proto` or `scan-for-imports` options. When `false`, code generation for
+ * .proto files is disabled.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enabled;
/**
- * Camel Quarkus gRPC code generation can scan application dependencies for .proto files to generate Java stubs
- * from them.
- * This property sets the scope of the dependencies to scan.
- * Applicable values:
- * <ul>
- * <li><i>none</i> - default - don't scan dependencies</li>
- * <li>a comma separated list of <i>groupId:artifactId</i> coordinates to scan</li>
- * <li><i>all</i> - scan all dependencies</li>
- * </ul>
+ * Camel Quarkus gRPC code generation can scan application dependencies for .proto files to generate Java stubs from
+ * them. This property sets the scope of the dependencies to scan. Applicable values:
+ *
+ * - _none_ - default - don't scan dependencies
+ * - a comma separated list of _groupId:artifactId_ coordinates to scan
+ * - _all_ - scan all dependencies
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "none")
public String scanForProto;
/**
* Camel Quarkus gRPC code generation can scan dependencies for .proto files that can be imported by protos in this
- * applications.
- * Applicable values:
- * <ul>
- * <li><i>none</i> - default - don't scan dependencies</li>
- * <li>a comma separated list of <i>groupId:artifactId</i> coordinates to scan</li>
- * <li><i>all</i> - scan all dependencies</li>
- * </ul>
+ * applications. Applicable values:
+ *
+ * - _none_ - default - don't scan dependencies
+ * - a comma separated list of _groupId:artifactId_ coordinates to scan
+ * - _all_ - scan all dependencies The default is _com.google.protobuf:protobuf-java_.
*
- * The default is <i>com.google.protobuf:protobuf-java</i>.
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "com.google.protobuf:protobuf-java")
public String scanForImports;
/**
* Package path or file glob pattern includes per dependency containing .proto files to be considered for inclusion.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Map<String, List<String>> scanForProtoIncludes;
/**
* Package path or file glob pattern includes per dependency containing .proto files to be considered for exclusion.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Map<String, List<String>> scanForProtoExcludes;
diff --git a/extensions/jasypt/runtime/src/main/java/org/apache/camel/quarkus/component/jasypt/CamelJasyptBuildTimeConfig.java b/extensions/jasypt/runtime/src/main/java/org/apache/camel/quarkus/component/jasypt/CamelJasyptBuildTimeConfig.java
index f0325ee5d4..3ae8717599 100644
--- a/extensions/jasypt/runtime/src/main/java/org/apache/camel/quarkus/component/jasypt/CamelJasyptBuildTimeConfig.java
+++ b/extensions/jasypt/runtime/src/main/java/org/apache/camel/quarkus/component/jasypt/CamelJasyptBuildTimeConfig.java
@@ -24,10 +24,13 @@ import io.smallrye.config.WithDefault;
@ConfigMapping(prefix = "quarkus.camel.jasypt")
@ConfigRoot(phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
public interface CamelJasyptBuildTimeConfig {
+
/**
- * Setting this option to false will disable Jasypt integration with Quarkus SmallRye configuration.
- * You can however, manually configure Jasypt with Camel in the 'classic' way of manually configuring
- * JasyptPropertiesParser and PropertiesComponent. Refer to the usage section for more details.
+ * Setting this option to false will disable Jasypt integration with Quarkus SmallRye configuration. You can however,
+ * manually configure Jasypt with Camel in the 'classic' way of manually configuring JasyptPropertiesParser and
+ * PropertiesComponent. Refer to the usage section for more details.
+ *
+ * @asciidoclet
*/
@WithDefault("true")
boolean enabled();
diff --git a/extensions/jasypt/runtime/src/main/java/org/apache/camel/quarkus/component/jasypt/CamelJasyptConfig.java b/extensions/jasypt/runtime/src/main/java/org/apache/camel/quarkus/component/jasypt/CamelJasyptConfig.java
index 20a9085ace..22e3d9adf7 100644
--- a/extensions/jasypt/runtime/src/main/java/org/apache/camel/quarkus/component/jasypt/CamelJasyptConfig.java
+++ b/extensions/jasypt/runtime/src/main/java/org/apache/camel/quarkus/component/jasypt/CamelJasyptConfig.java
@@ -36,33 +36,42 @@ import org.jasypt.salt.RandomSaltGenerator;
@ConfigMapping(prefix = "quarkus.camel.jasypt")
@ConfigRoot(phase = ConfigPhase.RUN_TIME)
public interface CamelJasyptConfig {
+
String NAME = "camel-jasypt";
+
String DEFAULT_ALGORITHM = StandardPBEByteEncryptor.DEFAULT_ALGORITHM;
/**
* The algorithm to be used for decryption.
+ *
+ * @asciidoclet
*/
@WithDefault(DEFAULT_ALGORITHM)
String algorithm();
/**
- * The master password used by Jasypt for decrypting configuration values.
- * This option supports prefixes which influence the master password lookup behaviour.
- * <p>
- * <code>sys:</code> will to look up the value from a JVM system property.
- * <code>sysenv:</code> will look up the value from the OS system environment with the given key.
- * <p>
+ * The master password used by Jasypt for decrypting configuration values. This option supports prefixes which influence
+ * the master password lookup behaviour.
+ *
+ * `sys:` will to look up the value from a JVM system property. `sysenv:` will look up the value from the OS system
+ * environment with the given key.
+ *
+ * @asciidoclet
*/
Optional<String> password();
/**
* Configures the Jasypt StandardPBEStringEncryptor with a RandomIvGenerator using the given algorithm.
+ *
+ * @asciidoclet
*/
@WithDefault(RandomIvGenerator.DEFAULT_SECURE_RANDOM_ALGORITHM)
String randomIvGeneratorAlgorithm();
/**
* Configures the Jasypt StandardPBEStringEncryptor with a RandomSaltGenerator using the given algorithm.
+ *
+ * @asciidoclet
*/
@WithDefault(RandomSaltGenerator.DEFAULT_SECURE_RANDOM_ALGORITHM)
String randomSaltGeneratorAlgorithm();
@@ -70,26 +79,22 @@ public interface CamelJasyptConfig {
/**
* The fully qualified class name of an org.apache.camel.quarkus.component.jasypt.JasyptConfigurationCustomizer
* implementation. This provides the optional capability of having full control over the Jasypt configuration.
+ *
+ * @asciidoclet
*/
Optional<String> configurationCustomizerClassName();
String SYS_CONFIG_PREFIX = "sys:";
+
String SYS_ENV_CONFIG_PREFIX = "sysenv:";
- Set<String> ALGORITHMS_THAT_REQUIRE_IV = Set.of(
- "PBEWITHHMACSHA1ANDAES_128",
- "PBEWITHHMACSHA1ANDAES_256",
- "PBEWITHHMACSHA224ANDAES_128",
- "PBEWITHHMACSHA224ANDAES_256",
- "PBEWITHHMACSHA256ANDAES_128",
- "PBEWITHHMACSHA256ANDAES_256",
- "PBEWITHHMACSHA384ANDAES_128",
- "PBEWITHHMACSHA384ANDAES_256",
- "PBEWITHHMACSHA512ANDAES_128",
- "PBEWITHHMACSHA512ANDAES_256");
+
+ Set<String> ALGORITHMS_THAT_REQUIRE_IV = Set.of("PBEWITHHMACSHA1ANDAES_128", "PBEWITHHMACSHA1ANDAES_256",
+ "PBEWITHHMACSHA224ANDAES_128", "PBEWITHHMACSHA224ANDAES_256", "PBEWITHHMACSHA256ANDAES_128",
+ "PBEWITHHMACSHA256ANDAES_256", "PBEWITHHMACSHA384ANDAES_128", "PBEWITHHMACSHA384ANDAES_256",
+ "PBEWITHHMACSHA512ANDAES_128", "PBEWITHHMACSHA512ANDAES_256");
default PBEConfig pbeConfig() {
EnvironmentStringPBEConfig config = new EnvironmentStringPBEConfig();
-
String password = null;
if (password().isPresent()) {
password = password().get();
@@ -102,13 +107,11 @@ public interface CamelJasyptConfig {
}
}
}
-
config.setPassword(password);
config.setAlgorithm(algorithm());
config.setIvGenerator(ALGORITHMS_THAT_REQUIRE_IV.contains(algorithm().toUpperCase())
? new RandomIvGenerator(randomIvGeneratorAlgorithm()) : new NoIvGenerator());
config.setSaltGenerator(new RandomSaltGenerator(randomSaltGeneratorAlgorithm()));
-
if (configurationCustomizerClassName().isPresent()) {
try {
Class<?> encryptorClass = Thread.currentThread().getContextClassLoader()
@@ -121,14 +124,12 @@ public interface CamelJasyptConfig {
throw new RuntimeException(e);
}
}
-
// Avoid potentially confusing runtime NPEs and fail fast if no password has been configured
try {
config.getPassword();
} catch (NullPointerException e) {
throw new IllegalStateException("The jasypt password has not been configured.");
}
-
return config;
}
}
diff --git a/extensions/jfr/runtime/src/main/java/org/apache/camel/quarkus/component/jfr/RuntimeCamelJfrConfig.java b/extensions/jfr/runtime/src/main/java/org/apache/camel/quarkus/component/jfr/RuntimeCamelJfrConfig.java
index 625b553903..e0a97e6560 100644
--- a/extensions/jfr/runtime/src/main/java/org/apache/camel/quarkus/component/jfr/RuntimeCamelJfrConfig.java
+++ b/extensions/jfr/runtime/src/main/java/org/apache/camel/quarkus/component/jfr/RuntimeCamelJfrConfig.java
@@ -28,18 +28,19 @@ public class RuntimeCamelJfrConfig {
/**
* Directory to store the recording. By default the current directory will be used. Use false to turn off saving the
* recording to disk.
+ *
+ * @asciidoclet
*/
@ConfigItem
Optional<String> startupRecorderDir;
/**
- *
* How long time to run the startup recorder. Use 0 (default) to keep the recorder running until the JVM is exited. Use
* -1 to stop the recorder right after Camel has been started (to only focus on potential Camel startup performance
- * bottlenecks) Use a positive
- * value to keep recording for N seconds. When the recorder is stopped then the recording is auto saved to disk (note:
- * save to disk can be disabled by setting
- * startupRecorderDir to false).
+ * bottlenecks) Use a positive value to keep recording for N seconds. When the recorder is stopped then the recording is
+ * auto saved to disk (note: save to disk can be disabled by setting startupRecorderDir to false).
+ *
+ * @asciidoclet
*/
@ConfigItem
Optional<Long> startupRecorderDuration;
@@ -47,12 +48,16 @@ public class RuntimeCamelJfrConfig {
/**
* To filter our sub steps at a maximum depth. Use -1 for no maximum. Use 0 for no sub steps. Use 1 for max 1 sub step,
* and so forth. The default is -1.
+ *
+ * @asciidoclet
*/
@ConfigItem
Optional<Integer> startupRecorderMaxDepth;
/**
* To use a specific Java Flight Recorder profile configuration, such as default or profile. The default is default.
+ *
+ * @asciidoclet
*/
@ConfigItem
Optional<String> startupRecorderProfile;
@@ -60,6 +65,8 @@ public class RuntimeCamelJfrConfig {
/**
* To enable Java Flight Recorder to start a recording and automatic dump the recording to disk after startup is
* complete. This requires that camel-jfr is on the classpath. The default is false.
+ *
+ * @asciidoclet
*/
@ConfigItem
Optional<Boolean> startupRecorderRecording;
diff --git a/extensions/joor/runtime/src/main/java/org/apache/camel/quarkus/component/joor/runtime/JoorExpressionConfig.java b/extensions/joor/runtime/src/main/java/org/apache/camel/quarkus/component/joor/runtime/JoorExpressionConfig.java
index 4efe81b13f..53d6f93f40 100644
--- a/extensions/joor/runtime/src/main/java/org/apache/camel/quarkus/component/joor/runtime/JoorExpressionConfig.java
+++ b/extensions/joor/runtime/src/main/java/org/apache/camel/quarkus/component/joor/runtime/JoorExpressionConfig.java
@@ -28,15 +28,27 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.joor", phase = ConfigPhase.BUILD_TIME)
public class JoorExpressionConfig {
- /** Indicates whether a jOOR expression can use single quotes instead of double quotes. */
+ /**
+ * Indicates whether a jOOR expression can use single quotes instead of double quotes.
+ *
+ * @asciidoclet
+ */
@ConfigItem(defaultValue = "true")
public boolean singleQuotes;
- /** The specific location of the configuration of the jOOR language. */
+ /**
+ * The specific location of the configuration of the jOOR language.
+ *
+ * @asciidoclet
+ */
@ConfigItem
public Optional<String> configResource;
- /** In JVM mode, indicates whether the expressions must be compiled at build time. */
+ /**
+ * In JVM mode, indicates whether the expressions must be compiled at build time.
+ *
+ * @asciidoclet
+ */
@ConfigItem(defaultValue = "false")
public boolean compileAtBuildTime;
}
diff --git a/extensions/kafka/runtime/src/main/java/org/apache/camel/quarkus/component/kafka/CamelKafkaRuntimeConfig.java b/extensions/kafka/runtime/src/main/java/org/apache/camel/quarkus/component/kafka/CamelKafkaRuntimeConfig.java
index 6d119301e9..62ae704de1 100644
--- a/extensions/kafka/runtime/src/main/java/org/apache/camel/quarkus/component/kafka/CamelKafkaRuntimeConfig.java
+++ b/extensions/kafka/runtime/src/main/java/org/apache/camel/quarkus/component/kafka/CamelKafkaRuntimeConfig.java
@@ -26,6 +26,8 @@ public final class CamelKafkaRuntimeConfig {
/**
* Kafka Kubernetes Service Binding configuration options
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public KafkaServiceBindingConfig kubernetesServiceBinding;
@@ -34,11 +36,12 @@ public final class CamelKafkaRuntimeConfig {
public static final class KafkaServiceBindingConfig {
/**
- * If {@code true} then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding
- * extension (if configured) will be merged with those set via Camel Kafka component or endpoint options.
+ * If `true` then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding extension (if
+ * configured) will be merged with those set via Camel Kafka component or endpoint options. If `false` then any Kafka
+ * configuration properties discovered by the Quarkus Kubernetes Service Binding extension are ignored, and all of the
+ * Kafka component configuration is driven by Camel.
*
- * If {@code false} then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding
- * extension are ignored, and all of the Kafka component configuration is driven by Camel.
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean mergeConfiguration;
diff --git a/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java b/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java
index 024f282cdf..f69a401c94 100644
--- a/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java
+++ b/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceBuildTimeConfig.java
@@ -24,25 +24,29 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.cluster.kubernetes", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
public class KubernetesClusterServiceBuildTimeConfig {
+
/**
- * Whether a Kubernetes Cluster Service should be automatically configured
- * according to 'quarkus.camel.cluster.kubernetes.*' configurations.
+ * Whether a Kubernetes Cluster Service should be automatically configured according to
+ * 'quarkus.camel.cluster.kubernetes.++*++' configurations.
*
- * @deprecated this property is no longer needed as the Kubernetes implementation of the Camel CLuster Service API has
- * been moved to a dedicated extension.
+ * @deprecated this property is no longer needed as the Kubernetes implementation of the Camel CLuster Service API has
+ * been moved to a dedicated extension.
+ * @asciidoclet
*/
@Deprecated(since = "3.10.0", forRemoval = true)
@ConfigItem(defaultValue = "true")
public boolean enabled;
/**
- * Whether the camel master namespace leaders should be distributed evenly
- * across all the camel contexts in the cluster.
+ * Whether the camel master namespace leaders should be distributed evenly across all the camel contexts in the cluster.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean rebalancing;
public static final class Enabled implements BooleanSupplier {
+
KubernetesClusterServiceBuildTimeConfig config;
@Override
diff --git a/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRuntimeConfig.java b/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRuntimeConfig.java
index 26a3c8d2ef..b627523b40 100644
--- a/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRuntimeConfig.java
+++ b/extensions/kubernetes-cluster-service/runtime/src/main/java/org/apache/camel/quarkus/component/kubernetes/cluster/KubernetesClusterServiceRuntimeConfig.java
@@ -29,30 +29,40 @@ public class KubernetesClusterServiceRuntimeConfig {
/**
* The cluster service ID (defaults to null).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> id;
/**
* The URL of the Kubernetes master (read from Kubernetes client properties by default).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> masterUrl;
/**
* The connection timeout in milliseconds to use when making requests to the Kubernetes API server.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<Integer> connectionTimeoutMillis;
/**
* The name of the Kubernetes namespace containing the pods and the configmap (autodetected by default).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> namespace;
/**
* The name of the current pod (autodetected from container host name by default).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> podName;
@@ -60,12 +70,16 @@ public class KubernetesClusterServiceRuntimeConfig {
/**
* The jitter factor to apply in order to prevent all pods to call Kubernetes APIs in the same instant (defaults to
* 1.2).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<Double> jitterFactor;
/**
* The default duration of the lease for the current leader (defaults to 15000).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<Long> leaseDurationMillis;
@@ -73,6 +87,8 @@ public class KubernetesClusterServiceRuntimeConfig {
/**
* The deadline after which the leader must stop its services because it may have lost the leadership (defaults to
* 10000).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<Long> renewDeadlineMillis;
@@ -80,34 +96,41 @@ public class KubernetesClusterServiceRuntimeConfig {
/**
* The time between two subsequent attempts to check and acquire the leadership. It is randomized using the jitter
* factor (defaults to 2000).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<Long> retryPeriodMillis;
/**
* Service lookup order/priority (defaults to 2147482647).
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<Integer> order;
/**
- * The name of the lease resource used to do optimistic locking (defaults to
- * 'leaders'). The resource name is used as prefix when the underlying
- * Kubernetes resource can manage a single lock.
+ * The name of the lease resource used to do optimistic locking (defaults to 'leaders'). The resource name is used as
+ * prefix when the underlying Kubernetes resource can manage a single lock.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> resourceName;
/**
- * The lease resource type used in Kubernetes, either 'config-map' or
- * 'lease' (defaults to 'lease').
+ * The lease resource type used in Kubernetes, either 'config-map' or 'lease' (defaults to 'lease').
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<LeaseResourceType> leaseResourceType;
/**
- * The labels key/value used to identify the pods composing the cluster,
- * defaults to empty map.
+ * The labels key/value used to identify the pods composing the cluster, defaults to empty map.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Map<String, String> labels;
diff --git a/extensions/micrometer/runtime/src/main/java/org/apache/camel/quarkus/component/micrometer/CamelMicrometerConfig.java b/extensions/micrometer/runtime/src/main/java/org/apache/camel/quarkus/component/micrometer/CamelMicrometerConfig.java
index ede0c1f8de..c6bedf87dc 100644
--- a/extensions/micrometer/runtime/src/main/java/org/apache/camel/quarkus/component/micrometer/CamelMicrometerConfig.java
+++ b/extensions/micrometer/runtime/src/main/java/org/apache/camel/quarkus/component/micrometer/CamelMicrometerConfig.java
@@ -22,68 +22,76 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.metrics", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
public class CamelMicrometerConfig {
+
/**
- * Set whether to enable the MicrometerRoutePolicyFactory for capturing metrics
- * on route processing times.
+ * Set whether to enable the MicrometerRoutePolicyFactory for capturing metrics on route processing times.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enableRoutePolicy;
/**
- * Set whether to enable the MicrometerMessageHistoryFactory for capturing metrics
- * on individual route node processing times.
+ * Set whether to enable the MicrometerMessageHistoryFactory for capturing metrics on individual route node processing
+ * times. Depending on the number of configured route nodes, there is the potential to create a large volume of metrics.
+ * Therefore, this option is disabled by default.
*
- * Depending on the number of configured route nodes, there is the potential to create a large
- * volume of metrics. Therefore, this option is disabled by default.
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean enableMessageHistory;
/**
- * Set whether to enable the MicrometerExchangeEventNotifier for capturing metrics
- * on exchange processing times.
+ * Set whether to enable the MicrometerExchangeEventNotifier for capturing metrics on exchange processing times.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enableExchangeEventNotifier;
/**
- * Set whether to enable the MicrometerRouteEventNotifier for capturing metrics
- * on the total number of routes and total number of routes running.
+ * Set whether to enable the MicrometerRouteEventNotifier for capturing metrics on the total number of routes and total
+ * number of routes running.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enableRouteEventNotifier;
/**
* Set whether to gather performance information about Camel Thread Pools by injecting an InstrumentedThreadPoolFactory.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean enableInstrumentedThreadPoolFactory;
/**
- * Controls the naming style to use for metrics. The available values are {@code default} and {@code legacy}.
- * {@code default} uses the default Micrometer naming convention.
- * {@code legacy} uses the legacy camel-case naming style.
+ * Controls the naming style to use for metrics. The available values are `default` and `legacy`. `default` uses the
+ * default Micrometer naming convention. `legacy` uses the legacy camel-case naming style.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "default")
public MetricsNamingStrategy namingStrategy;
/**
- * Sets the level of metrics to capture. The available values are {@code all} ,{@code context} and {@code route}.
- * {@code all} captures metrics for both the camel context and routes.
- * {@code route} captures metrics for routes only.
- * {@code context} captures metrics for the camel context only.
+ * Sets the level of metrics to capture. The available values are `all` ,`context` and `route`. `all` captures metrics
+ * for both the camel context and routes. `route` captures metrics for routes only. `context` captures metrics for the
+ * camel context only.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "all")
public RoutePolicyLevel routePolicyLevel;
public enum MetricsNamingStrategy {
- DEFAULT,
- LEGACY
+
+ DEFAULT, LEGACY
}
public enum RoutePolicyLevel {
- ALL,
- CONTEXT,
- ROUTE
+
+ ALL, CONTEXT, ROUTE
}
}
diff --git a/extensions/microprofile-health/runtime/src/main/java/org/apache/camel/quarkus/component/microprofile/health/runtime/CamelMicroProfileHealthConfig.java b/extensions/microprofile-health/runtime/src/main/java/org/apache/camel/quarkus/component/microprofile/health/runtime/CamelMicroProfileHealthConfig.java
index ed0aefe768..92e023b1f7 100644
--- a/extensions/microprofile-health/runtime/src/main/java/org/apache/camel/quarkus/component/microprofile/health/runtime/CamelMicroProfileHealthConfig.java
+++ b/extensions/microprofile-health/runtime/src/main/java/org/apache/camel/quarkus/component/microprofile/health/runtime/CamelMicroProfileHealthConfig.java
@@ -25,6 +25,8 @@ public final class CamelMicroProfileHealthConfig {
/**
* Set whether to enable Camel health checks
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enabled;
diff --git a/extensions/openapi-java/deployment/src/main/java/org/apache/camel/quarkus/component/openapi/java/deployment/OpenApiJavaBuildTimeConfig.java b/extensions/openapi-java/deployment/src/main/java/org/apache/camel/quarkus/component/openapi/java/deployment/OpenApiJavaBuildTimeConfig.java
index 0ad245cc1d..765dbb7679 100644
--- a/extensions/openapi-java/deployment/src/main/java/org/apache/camel/quarkus/component/openapi/java/deployment/OpenApiJavaBuildTimeConfig.java
+++ b/extensions/openapi-java/deployment/src/main/java/org/apache/camel/quarkus/component/openapi/java/deployment/OpenApiJavaBuildTimeConfig.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.quarkus.component.openapi.java.deployment;
import io.quarkus.runtime.annotations.ConfigItem;
@@ -26,6 +25,7 @@ public class OpenApiJavaBuildTimeConfig {
/**
* Expose the Camel REST DSL services to quarkus openapi at build time if 'quarkus.smallrye-openapi' is available.
*
+ * @asciidoclet
*/
@ConfigItem(name = "expose.enabled", defaultValue = "false")
public boolean enabled = false;
diff --git a/extensions/opentelemetry/runtime/src/main/java/org/apache/camel/quarkus/component/opentelemetry/CamelOpenTelemetryConfig.java b/extensions/opentelemetry/runtime/src/main/java/org/apache/camel/quarkus/component/opentelemetry/CamelOpenTelemetryConfig.java
index 7ea9cb3759..9dcde80212 100644
--- a/extensions/opentelemetry/runtime/src/main/java/org/apache/camel/quarkus/component/opentelemetry/CamelOpenTelemetryConfig.java
+++ b/extensions/opentelemetry/runtime/src/main/java/org/apache/camel/quarkus/component/opentelemetry/CamelOpenTelemetryConfig.java
@@ -26,33 +26,35 @@ import io.quarkus.runtime.annotations.ConfigRoot;
public final class CamelOpenTelemetryConfig {
/**
- * Sets whether header names need to be encoded. Can be useful in situations where OpenTelemetry propagators
- * potentially set header name values in formats that are not compatible with the target system. E.g for JMS where the
- * specification mandates header names are valid Java identifiers.
+ * Sets whether header names need to be encoded. Can be useful in situations where OpenTelemetry propagators potentially
+ * set header name values in formats that are not compatible with the target system. E.g for JMS where the specification
+ * mandates header names are valid Java identifiers.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean encoding;
/**
- * Sets whether to disable tracing for endpoint URIs or Processor ids that match the given
- * comma separated patterns. The pattern can take the following
- * forms:
- * <p>
- * <p>
+ * Sets whether to disable tracing for endpoint URIs or Processor ids that match the given comma separated patterns. The
+ * pattern can take the following forms:
+ *
* 1. An exact match on the endpoint URI. E.g platform-http:/some/path
- * <p>
- * <p>
- * 2. A wildcard match. E.g platform-http:*
- * <p>
- * <p>
- * 3. A regular expression matching the endpoint URI. E.g platform-http:/prefix/.*
+ *
+ * 2. A wildcard match. E.g platform-http:++*++
+ *
+ * 3. A regular expression matching the endpoint URI. E.g platform-http:/prefix/.++*++
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> excludePatterns;
/**
- * Sets whether to create new OpenTelemetry spans for each Camel Processor. Use the excludePatterns
- * property to filter out Processors.
+ * Sets whether to create new OpenTelemetry spans for each Camel Processor. Use the excludePatterns property to filter
+ * out Processors.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean traceProcessors;
diff --git a/extensions/rest-openapi/runtime/src/main/java/org/apache/camel/quarkus/rest/openapi/runtime/RestOpenApiBuildTimeConfig.java b/extensions/rest-openapi/runtime/src/main/java/org/apache/camel/quarkus/rest/openapi/runtime/RestOpenApiBuildTimeConfig.java
index 0e0dbfb340..fbd83bbcab 100644
--- a/extensions/rest-openapi/runtime/src/main/java/org/apache/camel/quarkus/rest/openapi/runtime/RestOpenApiBuildTimeConfig.java
+++ b/extensions/rest-openapi/runtime/src/main/java/org/apache/camel/quarkus/rest/openapi/runtime/RestOpenApiBuildTimeConfig.java
@@ -25,44 +25,57 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.openapi", phase = ConfigPhase.BUILD_TIME)
public class RestOpenApiBuildTimeConfig {
+
/**
* Build time configuration options for Camel Quarkus REST OpenAPI code generator.
+ *
+ * @asciidoclet
*/
@ConfigItem
public CodeGenConfig codegen;
@ConfigGroup
public static class CodeGenConfig {
+
/**
- * If {@code true}, Camel Quarkus OpenAPI code generation is run for .json files discovered from the {@code openapi}
- * directory. When {@code false}, code generation for .json files is disabled.
+ * If `true`, Camel Quarkus OpenAPI code generation is run for .json files discovered from the `openapi` directory. When
+ * `false`, code generation for .json files is disabled.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "true")
public boolean enabled;
/**
* The package to use for generated model classes.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "org.apache.camel.quarkus")
public String modelPackage;
/**
* A comma separated list of models to generate. All models is the default.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> models;
/**
- * If {@code true}, use bean validation annotations in the generated model classes.
+ * If `true`, use bean validation annotations in the generated model classes.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean useBeanValidation;
/**
- * If {@code true}, use NON_NULL Jackson annotation in the generated model classes.
+ * If `true`, use NON_NULL Jackson annotation in the generated model classes.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean notNullJackson;
}
-
}
diff --git a/extensions/servlet/runtime/src/main/java/org/apache/camel/quarkus/servlet/runtime/CamelServletConfig.java b/extensions/servlet/runtime/src/main/java/org/apache/camel/quarkus/servlet/runtime/CamelServletConfig.java
index ff20269995..83cf30ca24 100644
--- a/extensions/servlet/runtime/src/main/java/org/apache/camel/quarkus/servlet/runtime/CamelServletConfig.java
+++ b/extensions/servlet/runtime/src/main/java/org/apache/camel/quarkus/servlet/runtime/CamelServletConfig.java
@@ -31,89 +31,120 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.servlet", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
public final class CamelServletConfig {
- /** The default servlet with implicit name {@value ServletConfig.DEFAULT_SERVLET_NAME} */
+ /**
+ * The default servlet with implicit name `ServletConfig.DEFAULT_SERVLET_NAME`
+ *
+ * @asciidoclet
+ */
@ConfigItem(name = ConfigItem.PARENT)
public ServletConfig defaultServlet;
- /** A collection of named servlets */
+ /**
+ * A collection of named servlets
+ *
+ * @asciidoclet
+ */
@ConfigItem(name = ConfigItem.PARENT)
public Map<String, ServletConfig> namedServlets;
- /** {@code camel-servlet} component configuration */
+ /**
+ * {@code camel-servlet} component configuration
+ */
@ConfigGroup
public static class ServletConfig {
public static final String DEFAULT_SERVLET_NAME = "CamelServlet";
+
public static final String DEFAULT_SERVLET_CLASS = "org.apache.camel.component.servlet.CamelHttpTransportServlet";
/**
- * A comma separated list of path patterns under which the CamelServlet should be accessible. Example path
- * patterns: {@code /*}, {@code /services/*}
+ * A comma separated list of path patterns under which the CamelServlet should be accessible. Example path patterns:
+ * `/++*++`, `/services/++*++`
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> urlPatterns;
- /** A fully qualified name of a servlet class to serve paths that match {@link #urlPatterns} */
+ /**
+ * A fully qualified name of a servlet class to serve paths that match `url-patterns`
+ *
+ * @asciidoclet
+ */
@ConfigItem(defaultValue = DEFAULT_SERVLET_CLASS)
public String servletClass;
/**
- * A servletName as it would be defined in a `web.xml` file or in the
- * {@link jakarta.servlet.annotation.WebServlet#name()} annotation.
+ * A servletName as it would be defined in a `web.xml` file or in the `jakarta.servlet.annotation.WebServlet++#++name()`
+ * annotation.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = DEFAULT_SERVLET_NAME)
public String servletName;
/**
- * Sets the loadOnStartup priority on the Servlet. A loadOnStartup is a value greater than or equal to zero,
- * indicates to the container the initialization priority of the Servlet. If loadOnStartup is a negative
- * integer, the Servlet is initialized lazily.
+ * Sets the loadOnStartup priority on the Servlet. A loadOnStartup is a value greater than or equal to zero, indicates
+ * to the container the initialization priority of the Servlet. If loadOnStartup is a negative integer, the Servlet is
+ * initialized lazily.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "-1")
public Integer loadOnStartup;
/**
* Enables Camel to benefit from asynchronous Servlet support.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean async;
/**
- * When set to {@code true} used in conjunction with {@code quarkus.camel.servlet.async = true}, this will force
- * route processing to run synchronously.
+ * When set to `true` used in conjunction with `quarkus.camel.servlet.async = true`, this will force route processing to
+ * run synchronously.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "false")
public boolean forceAwait;
/**
* The name of a bean to configure an optional custom thread pool for handling Camel Servlet processing.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<String> executorRef;
/**
* Servlet multipart request configuration.
+ *
+ * @asciidoclet
*/
public MultipartConfig multipart;
/**
- * @return {@code true} if this {@link ServletConfig} is valid as a whole. This currently translates to
- * {@link #urlPatterns} being non-empty because {@link #servletClass} and {@link #servletName} have
- * default values. Otherwise returns {@code false}.
+ * @return {@code true} if this {@link ServletConfig} is valid as a whole. This currently translates to
+ * {@link #urlPatterns} being non-empty because {@link #servletClass} and {@link #servletName} have
+ * default values. Otherwise returns {@code false}.
+ * @asciidoclet
*/
public boolean isValid() {
return urlPatterns.isPresent() && !urlPatterns.get().isEmpty();
}
/**
- * Setting the servlet name is possible both via {@link #servletName} and the key in the
- * {@link org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletsConfig#namedServlets} map. This method
- * sets the precedence: the {@link #servletName} gets effective only if it has a non-default value; otherwise
- * the {@code key} is returned as the servlet name.
+ * Setting the servlet name is possible both via `servlet-name` and the key in the
+ * `org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletsConfig++#++namedServlets` map. This method sets
+ * the precedence: the `servlet-name` gets effective only if it has a non-default value; otherwise the `key` is returned
+ * as the servlet name.
*
- * @param key the key used in
- * {@link org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletsConfig#namedServlets}
- * @return the effective servlet name to use
+ * @param key the key used in
+ * {@link org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletsConfig#namedServlets}
+ * @return the effective servlet name to use
+ * @asciidoclet
*/
public String getEffectiveServletName(final String key) {
return DEFAULT_SERVLET_NAME.equals(servletName) ? key : servletName;
@@ -124,15 +155,20 @@ public final class CamelServletConfig {
*/
@ConfigGroup
public static class MultipartConfig {
+
/**
- * An absolute path to a directory on the file system to store files temporarily while the parts are
- * processed or when the size of the file exceeds the specified file-size-threshold configuration value.
+ * An absolute path to a directory on the file system to store files temporarily while the parts are processed or
+ * when the size of the file exceeds the specified file-size-threshold configuration value.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "${java.io.tmpdir}")
public String location;
/**
* The maximum size allowed in bytes for uploaded files. The default size (-1) allows an unlimited size.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "-1")
public long maxFileSize;
@@ -140,16 +176,19 @@ public final class CamelServletConfig {
/**
* The maximum size allowed in bytes for a multipart/form-data request. The default size (-1) allows an unlimited
* size.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "-1")
public long maxRequestSize;
/**
* The file size in bytes after which the file will be temporarily stored on disk.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "0")
public int fileSizeThreshold;
}
}
-
}
diff --git a/extensions/xslt/runtime/src/main/java/org/apache/camel/quarkus/component/xslt/CamelXsltConfig.java b/extensions/xslt/runtime/src/main/java/org/apache/camel/quarkus/component/xslt/CamelXsltConfig.java
index 00479f6972..dcfc5fe4a1 100644
--- a/extensions/xslt/runtime/src/main/java/org/apache/camel/quarkus/component/xslt/CamelXsltConfig.java
+++ b/extensions/xslt/runtime/src/main/java/org/apache/camel/quarkus/component/xslt/CamelXsltConfig.java
@@ -26,20 +26,27 @@ import io.quarkus.runtime.annotations.ConfigRoot;
@ConfigRoot(name = "camel.xslt", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
public class CamelXsltConfig {
+
/**
* A comma separated list of templates to compile.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Optional<List<String>> sources;
/**
* The package name for the generated classes.
+ *
+ * @asciidoclet
*/
@ConfigItem(defaultValue = "org.apache.camel.quarkus.component.xslt.generated")
public String packageName;
/**
* TransformerFactory features.
+ *
+ * @asciidoclet
*/
@ConfigItem
public Map<String, Boolean> features;
diff --git a/tooling/maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateExtensionDocPageMojo.java b/tooling/maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateExtensionDocPageMojo.java
index 294576f9cc..dd69313293 100644
--- a/tooling/maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateExtensionDocPageMojo.java
+++ b/tooling/maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateExtensionDocPageMojo.java
@@ -87,10 +87,8 @@ public class UpdateExtensionDocPageMojo extends AbstractDocGeneratorMojo {
private static final String TOOLTIP_MACRO = "tooltip:%s[%s]";
private static final String MORE_INFO_ABOUT_TYPE_FORMAT = "link:#%s[icon:question-circle[title=More information about the %s format]]";
- // TODO: Revert the default back to false
- // https://github.com/apache/camel-quarkus/issues/6418
- @Parameter(defaultValue = "true", property = "camel-quarkus.update-extension-doc-page.skip")
- boolean skip = true;
+ @Parameter(defaultValue = "false", property = "camel-quarkus.update-extension-doc-page.skip")
+ boolean skip;
@Parameter(defaultValue = "${project}", readonly = true)
MavenProject project;