This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit e12ed74bf2322ef48e3be2b38f51bcda531dd97f Author: Nicolas Filotto <[email protected]> AuthorDate: Tue Mar 15 11:49:33 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-asterisk --- .../org/apache/camel/component/asterisk/asterisk.json | 6 ++++++ .../camel-asterisk/src/main/docs/asterisk-component.adoc | 3 +++ .../apache/camel/component/asterisk/AsteriskConstants.java | 11 +++++++++++ .../org/apache/camel/component/asterisk/AsteriskEndpoint.java | 2 +- 4 files changed, 21 insertions(+), 1 deletion(-) diff --git a/components/camel-asterisk/src/generated/resources/org/apache/camel/component/asterisk/asterisk.json b/components/camel-asterisk/src/generated/resources/org/apache/camel/component/asterisk/asterisk.json index 7bdc2ca..cc83ace 100644 --- a/components/camel-asterisk/src/generated/resources/org/apache/camel/component/asterisk/asterisk.json +++ b/components/camel-asterisk/src/generated/resources/org/apache/camel/component/asterisk/asterisk.json @@ -26,6 +26,12 @@ "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during star [...] "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which t [...] }, + "headers": { + "CamelAsteriskEventName": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "Simple name of the event", "description": "The name of the Asterisk event." }, + "CamelAsteriskExtension": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The extension to query in case of an `ExtensionStateAction`." }, + "CamelAsteriskContext": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The name of the context that contains the extension to query in case of an `ExtensionStateAction`." }, + "CamelAsteriskAction": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "org.apache.camel.component.asterisk.AsteriskAction", "enum": [ "QUEUE_STATUS", "SIP_PEERS", "EXTENSION_STATE" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Asterisk action to do." } + }, "properties": { "name": { "kind": "path", "displayName": "Name", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Name of component" }, "hostname": { "kind": "parameter", "displayName": "Hostname", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The hostname of the asterisk server" }, diff --git a/components/camel-asterisk/src/main/docs/asterisk-component.adoc b/components/camel-asterisk/src/main/docs/asterisk-component.adoc index 88c10c3..94a74e6 100644 --- a/components/camel-asterisk/src/main/docs/asterisk-component.adoc +++ b/components/camel-asterisk/src/main/docs/asterisk-component.adoc @@ -49,6 +49,9 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END == Action diff --git a/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskConstants.java b/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskConstants.java index b93d85c..6dd62d7 100644 --- a/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskConstants.java +++ b/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskConstants.java @@ -16,10 +16,21 @@ */ package org.apache.camel.component.asterisk; +import org.apache.camel.spi.Metadata; + public final class AsteriskConstants { + @Metadata(label = "consumer", description = "The name of the Asterisk event.", javaType = "java.lang.String", + defaultValue = "Simple name of the event") public static final String EVENT_NAME = "CamelAsteriskEventName"; + @Metadata(label = "producer", description = "The extension to query in case of an `ExtensionStateAction`.", + javaType = "java.lang.String") public static final String EXTENSION = "CamelAsteriskExtension"; + @Metadata(label = "producer", + description = "The name of the context that contains the extension to query in case of an `ExtensionStateAction`.", + javaType = "java.lang.String") public static final String CONTEXT = "CamelAsteriskContext"; + @Metadata(label = "producer", description = "The Asterisk action to do.", + javaType = "org.apache.camel.component.asterisk.AsteriskAction") public static final String ACTION = "CamelAsteriskAction"; private AsteriskConstants() { diff --git a/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskEndpoint.java b/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskEndpoint.java index 4f192b8..f8f689d 100644 --- a/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskEndpoint.java +++ b/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskEndpoint.java @@ -31,7 +31,7 @@ import org.apache.camel.util.ObjectHelper; * Interact with Asterisk PBX Server. */ @UriEndpoint(firstVersion = "2.18.0", scheme = "asterisk", title = "Asterisk", syntax = "asterisk:name", - category = { Category.VOIP }) + category = { Category.VOIP }, headersClass = AsteriskConstants.class) public class AsteriskEndpoint extends DefaultEndpoint { @UriPath(description = "Name of component") @Metadata(required = true)
