This is an automated email from the ASF dual-hosted git repository.
tsato pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new 8d6ae1a camel-amqp - Update docs
8d6ae1a is described below
commit 8d6ae1a0702cb72e4e2374f5fd7fde6e866d2aaf
Author: Tadayoshi Sato <sato.tadayo...@gmail.com>
AuthorDate: Wed Apr 15 15:25:12 2020 +0900
camel-amqp - Update docs
---
.../resources/org/apache/camel/component/amqp/amqp.json | 2 +-
components/camel-amqp/src/main/docs/amqp-component.adoc | 12 +++++++++++-
.../java/org/apache/camel/component/amqp/AMQPComponent.java | 2 +-
.../org/apache/camel/component/amqp/AMQPConfiguration.java | 4 ++--
.../builder/component/dsl/AmqpComponentBuilderFactory.java | 6 +++---
docs/components/modules/ROOT/pages/amqp-component.adoc | 12 +++++++++++-
6 files changed, 29 insertions(+), 9 deletions(-)
diff --git
a/components/camel-amqp/src/generated/resources/org/apache/camel/component/amqp/amqp.json
b/components/camel-amqp/src/generated/resources/org/apache/camel/component/amqp/amqp.json
index e742d3f..15bb3b7 100644
---
a/components/camel-amqp/src/generated/resources/org/apache/camel/component/amqp/amqp.json
+++
b/components/camel-amqp/src/generated/resources/org/apache/camel/component/amqp/amqp.json
@@ -25,7 +25,7 @@
"connectionFactory": { "kind": "property", "displayName": "Connection
Factory", "group": "common", "label": "", "required": false, "type": "object",
"javaType": "javax.jms.ConnectionFactory", "deprecated": false, "secret":
false, "configurationClass": "org.apache.camel.component.jms.JmsConfiguration",
"configurationField": "configuration", "description": "The connection factory
to be use. A connection factory must be configured either on the component or
endpoint." },
"disableReplyTo": { "kind": "property", "displayName": "Disable Reply To",
"group": "common", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "configurationClass": "org.apache.camel.component.jms.JmsConfiguration",
"configurationField": "configuration", "description": "Specifies whether Camel
ignores the JMSReplyTo header in messages. If true, Camel does not send a reply
back to the destination spe [...]
"durableSubscriptionName": { "kind": "property", "displayName": "Durable
Subscription Name", "group": "common", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "secret": false,
"configurationClass": "org.apache.camel.component.jms.JmsConfiguration",
"configurationField": "configuration", "description": "The durable subscriber
name for specifying durable topic subscriptions. The clientId option must be
configured as well." },
- "includeAmqpAnnotations": { "kind": "property", "displayName": "Include
Amqp Annotations", "group": "common", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "description": "Whether to include AMQP annotations when mapping from
AMQP to Camel Message. Setting this to true will map AMQP message annotations
to message headers. Due to limitations in Apache Qpid JMS API, currently
delivery annotations are ignored." },
+ "includeAmqpAnnotations": { "kind": "property", "displayName": "Include
Amqp Annotations", "group": "common", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "description": "Whether to include AMQP annotations when mapping from
AMQP to Camel Message. Setting this to true maps AMQP message annotations that
contain a JMS_AMQP_MA_ prefix to message headers. Due to limitations in Apache
Qpid JMS API, currently deli [...]
"jmsMessageType": { "kind": "property", "displayName": "Jms Message Type",
"group": "common", "label": "", "required": false, "type": "object",
"javaType": "org.apache.camel.component.jms.JmsMessageType", "enum": [ "Bytes",
"Map", "Object", "Stream", "Text" ], "deprecated": false, "secret": false,
"configurationClass": "org.apache.camel.component.jms.JmsConfiguration",
"configurationField": "configuration", "description": "Allows you to force the
use of a specific javax.jms.Message i [...]
"testConnectionOnStartup": { "kind": "property", "displayName": "Test
Connection On Startup", "group": "common", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.jms.JmsConfiguration", "configurationField":
"configuration", "description": "Specifies whether to test the connection on
startup. This ensures that when Camel starts that all the JMS consum [...]
"acknowledgementModeName": { "kind": "property", "displayName":
"Acknowledgement Mode Name", "group": "consumer", "label": "consumer",
"required": false, "type": "string", "javaType": "java.lang.String", "enum": [
"SESSION_TRANSACTED", "CLIENT_ACKNOWLEDGE", "AUTO_ACKNOWLEDGE",
"DUPS_OK_ACKNOWLEDGE" ], "deprecated": false, "secret": false, "defaultValue":
"AUTO_ACKNOWLEDGE", "configurationClass":
"org.apache.camel.component.jms.JmsConfiguration", "configurationField":
"configuration", [...]
diff --git a/components/camel-amqp/src/main/docs/amqp-component.adoc
b/components/camel-amqp/src/main/docs/amqp-component.adoc
index 8dd09c0..90e0383 100644
--- a/components/camel-amqp/src/main/docs/amqp-component.adoc
+++ b/components/camel-amqp/src/main/docs/amqp-component.adoc
@@ -7,6 +7,16 @@
:supportLevel: Stable
:component-header: Both producer and consumer are supported
+// HEADER START
+*Both producer and consumer is supported*
+// HEADER END
+
+:artifactId: camel-amqp
+:description: Messaging with AMQP protocol using Apache QPid Client.
+:since: 1.2
+:supportLevel: Stable
+:component-header: Both producer and consumer are supported
+
*Since Camel {since}*
*{component-header}*
@@ -55,7 +65,7 @@ The AMQP component supports 97 options, which are listed
below.
| *connectionFactory* (common) | The connection factory to be use. A
connection factory must be configured either on the component or endpoint. | |
ConnectionFactory
| *disableReplyTo* (common) | Specifies whether Camel ignores the JMSReplyTo
header in messages. If true, Camel does not send a reply back to the
destination specified in the JMSReplyTo header. You can use this option if you
want Camel to consume from a route and you do not want Camel to automatically
send back a reply message because another component in your code handles the
reply message. You can also use this option if you want to use Camel as a proxy
between different message broker [...]
| *durableSubscriptionName* (common) | The durable subscriber name for
specifying durable topic subscriptions. The clientId option must be configured
as well. | | String
-| *includeAmqpAnnotations* (common) | Whether to include AMQP annotations when
mapping from AMQP to Camel Message. Setting this to true will map AMQP message
annotations to message headers. Due to limitations in Apache Qpid JMS API,
currently delivery annotations are ignored. | false | boolean
+| *includeAmqpAnnotations* (common) | Whether to include AMQP annotations when
mapping from AMQP to Camel Message. Setting this to true maps AMQP message
annotations that contain a JMS_AMQP_MA_ prefix to message headers. Due to
limitations in Apache Qpid JMS API, currently delivery annotations are ignored.
| false | boolean
| *jmsMessageType* (common) | Allows you to force the use of a specific
javax.jms.Message implementation for sending JMS messages. Possible values are:
Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS
message type to use from the In body type. This option allows you to specify
it. The value can be one of: Bytes, Map, Object, Stream, Text | |
JmsMessageType
| *testConnectionOnStartup* (common) | Specifies whether to test the
connection on startup. This ensures that when Camel starts that all the JMS
consumers have a valid connection to the JMS broker. If a connection cannot be
granted then Camel throws an exception on startup. This ensures that Camel is
not started with failed connections. The JMS producers is tested as well. |
false | boolean
| *acknowledgementModeName* (consumer) | The JMS acknowledgement name, which
is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE,
DUPS_OK_ACKNOWLEDGE. The value can be one of: SESSION_TRANSACTED,
CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE | AUTO_ACKNOWLEDGE |
String
diff --git
a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPComponent.java
b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPComponent.java
index a7002e3..84613fc 100644
---
a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPComponent.java
+++
b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPComponent.java
@@ -106,7 +106,7 @@ public class AMQPComponent extends JmsComponent {
/**
* Whether to include AMQP annotations when mapping from AMQP to Camel
Message.
- * Setting this to true will map AMQP message annotations to message
headers.
+ * Setting this to true maps AMQP message annotations that contain a
JMS_AMQP_MA_ prefix to message headers.
* Due to limitations in Apache Qpid JMS API, currently delivery
annotations
* are ignored.
*/
diff --git
a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPConfiguration.java
b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPConfiguration.java
index a92c743..36e54e3 100644
---
a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPConfiguration.java
+++
b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPConfiguration.java
@@ -27,7 +27,7 @@ public class AMQPConfiguration extends JmsConfiguration {
@UriParam(label = "consumer,advanced",
description = "Whether to include AMQP annotations when mapping from
AMQP to Camel Message."
- + " Setting this to true will map AMQP message annotations to
message headers."
+ + " Setting this to true maps AMQP message annotations that
contain a JMS_AMQP_MA_ prefix to message headers."
+ " Due to limitations in Apache Qpid JMS API, currently delivery
annotations are ignored.")
private boolean includeAmqpAnnotations;
@@ -44,7 +44,7 @@ public class AMQPConfiguration extends JmsConfiguration {
/**
* Whether to include AMQP annotations when mapping from AMQP to Camel
Message.
- * Setting this to true will map AMQP message annotations to message
headers.
+ * Setting this to true maps AMQP message annotations that contain a
JMS_AMQP_MA_ prefix to message headers.
* Due to limitations in Apache Qpid JMS API, currently delivery
annotations
* are ignored.
*/
diff --git
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AmqpComponentBuilderFactory.java
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AmqpComponentBuilderFactory.java
index 05c151a..31a0eec 100644
---
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AmqpComponentBuilderFactory.java
+++
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AmqpComponentBuilderFactory.java
@@ -108,9 +108,9 @@ public interface AmqpComponentBuilderFactory {
}
/**
* Whether to include AMQP annotations when mapping from AMQP to Camel
- * Message. Setting this to true will map AMQP message annotations to
- * message headers. Due to limitations in Apache Qpid JMS API,
currently
- * delivery annotations are ignored.
+ * Message. Setting this to true maps AMQP message annotations that
+ * contain a JMS_AMQP_MA_ prefix to message headers. Due to limitations
+ * in Apache Qpid JMS API, currently delivery annotations are ignored.
*
* The option is a: <code>boolean</code> type.
*
diff --git a/docs/components/modules/ROOT/pages/amqp-component.adoc
b/docs/components/modules/ROOT/pages/amqp-component.adoc
index 2ee5ae8..cbd8314 100644
--- a/docs/components/modules/ROOT/pages/amqp-component.adoc
+++ b/docs/components/modules/ROOT/pages/amqp-component.adoc
@@ -8,6 +8,16 @@
:supportLevel: Stable
:component-header: Both producer and consumer are supported
+// HEADER START
+*Both producer and consumer is supported*
+// HEADER END
+
+:artifactId: camel-amqp
+:description: Messaging with AMQP protocol using Apache QPid Client.
+:since: 1.2
+:supportLevel: Stable
+:component-header: Both producer and consumer are supported
+
*Since Camel {since}*
*{component-header}*
@@ -56,7 +66,7 @@ The AMQP component supports 97 options, which are listed
below.
| *connectionFactory* (common) | The connection factory to be use. A
connection factory must be configured either on the component or endpoint. | |
ConnectionFactory
| *disableReplyTo* (common) | Specifies whether Camel ignores the JMSReplyTo
header in messages. If true, Camel does not send a reply back to the
destination specified in the JMSReplyTo header. You can use this option if you
want Camel to consume from a route and you do not want Camel to automatically
send back a reply message because another component in your code handles the
reply message. You can also use this option if you want to use Camel as a proxy
between different message broker [...]
| *durableSubscriptionName* (common) | The durable subscriber name for
specifying durable topic subscriptions. The clientId option must be configured
as well. | | String
-| *includeAmqpAnnotations* (common) | Whether to include AMQP annotations when
mapping from AMQP to Camel Message. Setting this to true will map AMQP message
annotations to message headers. Due to limitations in Apache Qpid JMS API,
currently delivery annotations are ignored. | false | boolean
+| *includeAmqpAnnotations* (common) | Whether to include AMQP annotations when
mapping from AMQP to Camel Message. Setting this to true maps AMQP message
annotations that contain a JMS_AMQP_MA_ prefix to message headers. Due to
limitations in Apache Qpid JMS API, currently delivery annotations are ignored.
| false | boolean
| *jmsMessageType* (common) | Allows you to force the use of a specific
javax.jms.Message implementation for sending JMS messages. Possible values are:
Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS
message type to use from the In body type. This option allows you to specify
it. The value can be one of: Bytes, Map, Object, Stream, Text | |
JmsMessageType
| *testConnectionOnStartup* (common) | Specifies whether to test the
connection on startup. This ensures that when Camel starts that all the JMS
consumers have a valid connection to the JMS broker. If a connection cannot be
granted then Camel throws an exception on startup. This ensures that Camel is
not started with failed connections. The JMS producers is tested as well. |
false | boolean
| *acknowledgementModeName* (consumer) | The JMS acknowledgement name, which
is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE,
DUPS_OK_ACKNOWLEDGE. The value can be one of: SESSION_TRANSACTED,
CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE | AUTO_ACKNOWLEDGE |
String
