Repository: camel Updated Branches: refs/heads/master 80a51ed08 -> fd8e2cb78
CAMEL-11147: Regen docs Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/fd8e2cb7 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/fd8e2cb7 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/fd8e2cb7 Branch: refs/heads/master Commit: fd8e2cb78c50ecc842f257df7af3eeb7f39c3e03 Parents: 80a51ed Author: Claus Ibsen <davscl...@apache.org> Authored: Tue Sep 19 09:28:50 2017 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Sep 19 09:28:56 2017 +0200 ---------------------------------------------------------------------- .../src/main/docs/amqp-component.adoc | 11 ++- .../springboot/AMQPComponentConfiguration.java | 74 +++++++++++++++----- 2 files changed, 64 insertions(+), 21 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/fd8e2cb7/components/camel-amqp/src/main/docs/amqp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-amqp/src/main/docs/amqp-component.adoc b/components/camel-amqp/src/main/docs/amqp-component.adoc index 9af5ce5..24f34ee 100644 --- a/components/camel-amqp/src/main/docs/amqp-component.adoc +++ b/components/camel-amqp/src/main/docs/amqp-component.adoc @@ -38,7 +38,7 @@ link:../../../../camel-jms/src/main/docs/readme.html[JMS] component after the de // component options: START -The AMQP component supports 76 options which are listed below. +The AMQP component supports 78 options which are listed below. @@ -86,7 +86,6 @@ The AMQP component supports 76 options which are listed below. | **pubSubNoLocal** (advanced) | Specifies whether to inhibit the delivery of messages published by its own connection. | false | boolean | **receiveTimeout** (advanced) | The timeout for receiving messages (in milliseconds). | 1000 | long | **recoveryInterval** (advanced) | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. | 5000 | long -| **subscriptionDurable** (common) | *Deprecated* Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId. | false | boolean | **taskExecutor** (consumer) | Allows you to specify a custom task executor for consuming messages. | | TaskExecutor | **timeToLive** (producer) | When sending messages specifies the time-to-live of the message (in milliseconds). | -1 | long | **transacted** (transaction) | Specifies whether to use transacted mode | false | boolean @@ -119,6 +118,9 @@ The AMQP component supports 76 options which are listed below. | **waitForProvision CorrelationToBeUpdated Counter** (advanced) | Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled. | 50 | int | **waitForProvision CorrelationToBeUpdated ThreadSleepingTime** (advanced) | Interval in millis to sleep each time while waiting for provisional correlation id to be updated. | 100 | long | **correlationProperty** (producer) | Use this JMS property to correlate messages in InOut exchange pattern (request-reply) instead of JMSCorrelationID property. This allows you to exchange messages with systems that do not correlate messages using JMSCorrelationID JMS property. If used JMSCorrelationID will not be used or set by Camel. The value of here named property will be generated if not supplied in the header of the message under the same name. | | String +| **subscriptionDurable** (consumer) | Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain) therefore this method switches the pubSubDomain flag as well. | false | boolean +| **subscriptionShared** (consumer) | Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain) therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. | false | boolean +| **subscriptionName** (consumer) | Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription except for a shared subscription (which requires JMS 2.0). | | String | **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy | **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= @@ -146,7 +148,7 @@ with the following path and query parameters: | **destinationName** | *Required* Name of the queue or topic to use as destination | | String |======================================================================= -#### Query Parameters (86 parameters): +#### Query Parameters (89 parameters): [width="100%",cols="2,5,^1,2",options="header"] |======================================================================= @@ -168,6 +170,9 @@ with the following path and query parameters: | **replyTo** (consumer) | Provides an explicit ReplyTo destination which overrides any incoming value of Message.getJMSReplyTo(). | | String | **replyToDeliveryPersistent** (consumer) | Specifies whether to use persistent delivery by default for replies. | true | boolean | **selector** (consumer) | Sets the JMS selector to use | | String +| **subscriptionDurable** (consumer) | Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain) therefore this method switches the pubSubDomain flag as well. | false | boolean +| **subscriptionName** (consumer) | Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription except for a shared subscription (which requires JMS 2.0). | | String +| **subscriptionShared** (consumer) | Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain) therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. | false | boolean | **acceptMessagesWhileStopping** (consumer) | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. | false | boolean | **allowReplyManagerQuickStop** (consumer) | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. | false | boolean | **consumerType** (consumer) | The consumer type to use which can be one of: Simple Default or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use. | Default | ConsumerType http://git-wip-us.apache.org/repos/asf/camel/blob/fd8e2cb7/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java ---------------------------------------------------------------------- diff --git a/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java index 412f83a..5c85fc1 100644 --- a/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java +++ b/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java @@ -30,7 +30,6 @@ import org.apache.camel.component.jms.ReplyToType; import org.apache.camel.spi.HeaderFilterStrategy; import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.boot.context.properties.DeprecatedConfigurationProperty; import org.springframework.boot.context.properties.NestedConfigurationProperty; import org.springframework.core.task.TaskExecutor; import org.springframework.jms.core.JmsOperations; @@ -313,12 +312,6 @@ public class AMQPComponentConfiguration */ private Long recoveryInterval = 5000L; /** - * Deprecated: Enabled by default if you specify a durableSubscriptionName - * and a clientId. - */ - @Deprecated - private Boolean subscriptionDurable = false; - /** * Allows you to specify a custom task executor for consuming messages. */ @NestedConfigurationProperty @@ -572,6 +565,38 @@ public class AMQPComponentConfiguration */ private String correlationProperty; /** + * Set whether to make the subscription durable. The durable subscription + * name to be used can be specified through the subscriptionName property. + * Default is false. Set this to true to register a durable subscription + * typically in combination with a subscriptionName value (unless your + * message listener class name is good enough as subscription name). Only + * makes sense when listening to a topic (pub-sub domain) therefore this + * method switches the pubSubDomain flag as well. + */ + private Boolean subscriptionDurable = false; + /** + * Set whether to make the subscription shared. The shared subscription name + * to be used can be specified through the subscriptionName property. + * Default is false. Set this to true to register a shared subscription + * typically in combination with a subscriptionName value (unless your + * message listener class name is good enough as subscription name). Note + * that shared subscriptions may also be durable so this flag can (and often + * will) be combined with subscriptionDurable as well. Only makes sense when + * listening to a topic (pub-sub domain) therefore this method switches the + * pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. + */ + private Boolean subscriptionShared = false; + /** + * Set the name of a subscription to create. To be applied in case of a + * topic (pub-sub domain) with a shared or durable subscription. The + * subscription name needs to be unique within this client's JMS client id. + * Default is the class name of the specified message listener. Note: Only 1 + * concurrent consumer (which is the default of this message listener + * container) is allowed for each subscription except for a shared + * subscription (which requires JMS 2.0). + */ + private String subscriptionName; + /** * To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter * header to and from Camel message. */ @@ -917,17 +942,6 @@ public class AMQPComponentConfiguration this.recoveryInterval = recoveryInterval; } - @Deprecated - @DeprecatedConfigurationProperty - public Boolean getSubscriptionDurable() { - return subscriptionDurable; - } - - @Deprecated - public void setSubscriptionDurable(Boolean subscriptionDurable) { - this.subscriptionDurable = subscriptionDurable; - } - public TaskExecutor getTaskExecutor() { return taskExecutor; } @@ -1192,6 +1206,30 @@ public class AMQPComponentConfiguration this.correlationProperty = correlationProperty; } + public Boolean getSubscriptionDurable() { + return subscriptionDurable; + } + + public void setSubscriptionDurable(Boolean subscriptionDurable) { + this.subscriptionDurable = subscriptionDurable; + } + + public Boolean getSubscriptionShared() { + return subscriptionShared; + } + + public void setSubscriptionShared(Boolean subscriptionShared) { + this.subscriptionShared = subscriptionShared; + } + + public String getSubscriptionName() { + return subscriptionName; + } + + public void setSubscriptionName(String subscriptionName) { + this.subscriptionName = subscriptionName; + } + public HeaderFilterStrategy getHeaderFilterStrategy() { return headerFilterStrategy; }
