doc-templates.extension-doc-page.adoc Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camel-quarkus-maven-plugin Show documentation

Maven plugin to help package Camel quarkus components and plugins

There is a newer version: 3.17.0

Show newest version

[[[=artifactIdBase]]]
= [=name]

[.badges]
[.badge-key]##Since Camel Quarkus##[.badge-version]##[=firstVersion]## [.badge-key]##JVM##[.badge-supported]##supported## [.badge-key]##Native##[.badge-[=nativeSupported?then('', 'un')]supported]##[=nativeSupported?then('', 'un')]supported##

[=intro]
[#if models?size > 0]

== What's inside

[#list models as model]
* https://camel.apache.org/components/latest/[#if model.kind != "component" ][=model.kind]s/[/#if][=model.name][#if model.kind != "other" ]-[=model.kind][/#if].html[[=model.title][#if model.kind != "other" ] [=humanReadableKind(model.kind)][/#if]][#if model.kind == "component" ], URI syntax: `[=model.syntax]`[/#if]
[/#list]

Please refer to the above link[#if models?size != 1]s[/#if] for usage and configuration details.
[/#if]

== Maven coordinates

[source,xml]
----

    org.apache.camel.quarkus
    camel-quarkus-[=artifactIdBase]

----

Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
[#if usage?? ]

== Usage

[=usage]
[/#if]
[#if limitations?? ]

== Camel Quarkus limitations

[=limitations]
[/#if]
[#if activatesNativeSsl ]

== SSL in native mode

This extension auto-enables SSL support in native mode. Hence you do not need to add
`quarkus.ssl.native=true` to your `application.properties` yourself. See also
https://quarkus.io/guides/native-and-ssl[Quarkus SSL guide].
[/#if]
[#if configuration?? || configOptions?size != 0 ]

== Additional Camel Quarkus configuration
[#if configuration??]

[=configuration]
[/#if]
[#if configOptions?size != 0 ]

[width="100%",cols="80,5,15",options="header"]
|===
| Configuration property | Type | Default

[#list configOptions as configDocItem][#assign anchor = toAnchor(configDocItem.configDocKey.key)]

|[=configDocItem.configDocKey.configPhase.illustration] [[[=anchor]]]`link:#[=anchor][[=configDocItem.configDocKey.key]]`

[=configDocItem.configDocKey.configDoc]
| `[=configDocItem.configDocKey.type]`
| [#if configDocItem.configDocKey.defaultValue?has_content]`[=configDocItem.configDocKey.defaultValue]`[#elseif ! configDocItem.configDocKey.optional]required icon:exclamation-circle[title=Configuration property is required][/#if]
[/#list]
|===

[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime.

[/#if]
[/#if]