You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2016/12/21 19:54:24 UTC
[1/8] camel git commit: Lets reuse the header filter from the base
component instead
Repository: camel
Updated Branches:
refs/heads/master 5875067f0 -> 1fd504a12
Lets reuse the header filter from the base component instead
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/bf5d419d
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/bf5d419d
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/bf5d419d
Branch: refs/heads/master
Commit: bf5d419d60816c04651c5cf34bfb23ac4fbf6783
Parents: 5875067
Author: Claus Ibsen <da...@apache.org>
Authored: Wed Dec 21 18:57:51 2016 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Wed Dec 21 18:57:51 2016 +0100
----------------------------------------------------------------------
.../springboot/JmsComponentConfiguration.java | 30 ++++++++++----------
.../camel-jms/src/main/docs/jms-component.adoc | 2 +-
.../camel/component/jms/JmsComponent.java | 23 +++------------
3 files changed, 20 insertions(+), 35 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/bf5d419d/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java b/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
index bc77edf..99008ea 100644
--- a/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
+++ b/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
@@ -533,12 +533,6 @@ public class JmsComponentConfiguration {
@NestedConfigurationProperty
private QueueBrowseStrategy queueBrowseStrategy;
/**
- * To use a custom HeaderFilterStrategy to filter header to and from Camel
- * message.
- */
- @NestedConfigurationProperty
- private HeaderFilterStrategy headerFilterStrategy;
- /**
* To use the given MessageCreatedStrategy which are invoked when Camel
* creates new instances of javax.jms.Message objects when Camel is sending
* a JMS message.
@@ -556,6 +550,12 @@ public class JmsComponentConfiguration {
* correlation id to be updated.
*/
private Long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime;
+ /**
+ * To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter
+ * header to and from Camel message.
+ */
+ @NestedConfigurationProperty
+ private HeaderFilterStrategy headerFilterStrategy;
public JmsConfigurationNestedConfiguration getConfiguration() {
return configuration;
@@ -1131,15 +1131,6 @@ public class JmsComponentConfiguration {
this.queueBrowseStrategy = queueBrowseStrategy;
}
- public HeaderFilterStrategy getHeaderFilterStrategy() {
- return headerFilterStrategy;
- }
-
- public void setHeaderFilterStrategy(
- HeaderFilterStrategy headerFilterStrategy) {
- this.headerFilterStrategy = headerFilterStrategy;
- }
-
public MessageCreatedStrategy getMessageCreatedStrategy() {
return messageCreatedStrategy;
}
@@ -1167,6 +1158,15 @@ public class JmsComponentConfiguration {
this.waitForProvisionCorrelationToBeUpdatedThreadSleepingTime = waitForProvisionCorrelationToBeUpdatedThreadSleepingTime;
}
+ public HeaderFilterStrategy getHeaderFilterStrategy() {
+ return headerFilterStrategy;
+ }
+
+ public void setHeaderFilterStrategy(
+ HeaderFilterStrategy headerFilterStrategy) {
+ this.headerFilterStrategy = headerFilterStrategy;
+ }
+
public static class JmsConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.jms.JmsConfiguration.class;
/**
http://git-wip-us.apache.org/repos/asf/camel/blob/bf5d419d/components/camel-jms/src/main/docs/jms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc
index 0a17932..c010d54 100644
--- a/components/camel-jms/src/main/docs/jms-component.adoc
+++ b/components/camel-jms/src/main/docs/jms-component.adoc
@@ -292,10 +292,10 @@ The JMS component supports 74 options which are listed below.
| jmsKeyFormatStrategy | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
| applicationContext | ApplicationContext | Sets the Spring ApplicationContext to use
| queueBrowseStrategy | QueueBrowseStrategy | To use a custom QueueBrowseStrategy when browsing queues
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
| messageCreatedStrategy | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
| waitForProvisionCorrelationToBeUpdatedCounter | int | 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.
| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
+| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/bf5d419d/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
index b303b30..b1ee124 100644
--- a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
+++ b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
@@ -25,9 +25,7 @@ import javax.jms.Session;
import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.LoggingLevel;
-import org.apache.camel.impl.UriEndpointComponent;
-import org.apache.camel.spi.HeaderFilterStrategy;
-import org.apache.camel.spi.HeaderFilterStrategyAware;
+import org.apache.camel.impl.HeaderFilterStrategyComponent;
import org.apache.camel.spi.Metadata;
import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
@@ -51,7 +49,7 @@ import static org.apache.camel.util.ObjectHelper.removeStartingCharacters;
*
* @version
*/
-public class JmsComponent extends UriEndpointComponent implements ApplicationContextAware, HeaderFilterStrategyAware {
+public class JmsComponent extends HeaderFilterStrategyComponent implements ApplicationContextAware {
private static final Logger LOG = LoggerFactory.getLogger(JmsComponent.class);
@@ -64,8 +62,6 @@ public class JmsComponent extends UriEndpointComponent implements ApplicationCon
private JmsConfiguration configuration;
@Metadata(label = "advanced", description = "To use a custom QueueBrowseStrategy when browsing queues")
private QueueBrowseStrategy queueBrowseStrategy;
- @Metadata(label = "advanced", description = "To use a custom HeaderFilterStrategy to filter header to and from Camel message.")
- private HeaderFilterStrategy headerFilterStrategy;
@Metadata(label = "advanced", description = "To use the given MessageCreatedStrategy which are invoked when Camel creates new instances"
+ " of javax.jms.Message objects when Camel is sending a JMS message.")
private MessageCreatedStrategy messageCreatedStrategy;
@@ -834,17 +830,6 @@ public class JmsComponent extends UriEndpointComponent implements ApplicationCon
this.queueBrowseStrategy = queueBrowseStrategy;
}
- public HeaderFilterStrategy getHeaderFilterStrategy() {
- return headerFilterStrategy;
- }
-
- /**
- * To use a custom HeaderFilterStrategy to filter header to and from Camel message.
- */
- public void setHeaderFilterStrategy(HeaderFilterStrategy strategy) {
- this.headerFilterStrategy = strategy;
- }
-
public MessageCreatedStrategy getMessageCreatedStrategy() {
return messageCreatedStrategy;
}
@@ -885,8 +870,8 @@ public class JmsComponent extends UriEndpointComponent implements ApplicationCon
@Override
protected void doStart() throws Exception {
- if (headerFilterStrategy == null) {
- headerFilterStrategy = new JmsHeaderFilterStrategy(getConfiguration().isIncludeAllJMSXProperties());
+ if (getHeaderFilterStrategy() == null) {
+ setHeaderFilterStrategy(new JmsHeaderFilterStrategy(getConfiguration().isIncludeAllJMSXProperties()));
}
}
[2/8] camel git commit: CAMEL-10629: Add more details to component
level options
Posted by da...@apache.org.
CAMEL-10629: Add more details to component level options
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/8c0f3c3c
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/8c0f3c3c
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/8c0f3c3c
Branch: refs/heads/master
Commit: 8c0f3c3c41e9d5da709ffd4f176f821cee970936
Parents: bf5d419
Author: Claus Ibsen <da...@apache.org>
Authored: Wed Dec 21 19:37:07 2016 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Wed Dec 21 19:37:07 2016 +0100
----------------------------------------------------------------------
.../springboot/JmsComponentConfiguration.java | 68 ++---
.../camel-jms/src/main/docs/jms-component.adoc | 13 +-
.../camel/component/jms/JmsComponent.java | 256 ++++++++++++++++++-
.../camel/component/jms/JmsConfiguration.java | 11 +-
4 files changed, 301 insertions(+), 47 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/8c0f3c3c/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java b/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
index 99008ea..fad5811 100644
--- a/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
+++ b/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
@@ -57,7 +57,7 @@ public class JmsComponentConfiguration {
/**
* 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 enqued on the queue. If this
+ * 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
@@ -92,23 +92,23 @@ public class JmsComponentConfiguration {
* The JMS acknowledgement name which is one of: SESSION_TRANSACTED
* CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
*/
- private String acknowledgementModeName;
+ private String acknowledgementModeName = "AUTO_ACKNOWLEDGE";
/**
* Specifies whether the consumer container should auto-startup.
*/
- private Boolean autoStartup;
+ private Boolean autoStartup = true;
/**
* Sets the cache level by ID for the underlying JMS resources. See
* cacheLevelName option for more details.
*/
- private Integer cacheLevel;
+ private Integer cacheLevel = true;
/**
* Sets the cache level by name for the underlying JMS resources. Possible
* values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and
* CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring
* documentation and Transactions Cache Levels for more information.
*/
- private String cacheLevelName;
+ private String cacheLevelName = "CACHE_AUTO";
/**
* Sets the cache level by name for the reply consumer when doing
* request/reply over JMS. This option only applies when using fixed reply
@@ -134,15 +134,16 @@ public class JmsComponentConfiguration {
* request/reply over JMS then the option replyToConcurrentConsumers is used
* to control number of concurrent consumers on the reply message listener.
*/
- private Integer concurrentConsumers;
+ private Integer concurrentConsumers = 1;
/**
* Specifies the default number of concurrent consumers when doing
* request/reply over JMS. See also the maxMessagesPerTask option to control
* dynamic scaling up/down of threads.
*/
- private Integer replyToConcurrentConsumers;
+ private Integer replyToConcurrentConsumers = 1;
/**
- * Sets the default connection factory to be use
+ * The connection factory to be use. A connection factory must be configured
+ * either on the component or endpoint.
*/
private ConnectionFactory connectionFactory;
/**
@@ -158,7 +159,7 @@ public class JmsComponentConfiguration {
/**
* Specifies whether persistent delivery is used by default.
*/
- private Boolean deliveryPersistent;
+ private Boolean deliveryPersistent = true;
/**
* Specifies the delivery mode to be used. Possible values are Possibles
* values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1
@@ -190,12 +191,12 @@ public class JmsComponentConfiguration {
* Allows to configure the default errorHandler logging level for logging
* uncaught exceptions.
*/
- private LoggingLevel errorHandlerLoggingLevel;
+ private LoggingLevel errorHandlerLoggingLevel = LoggingLevel.WARN;
/**
* Allows to control whether stacktraces should be logged or not by the
* default errorHandler.
*/
- private Boolean errorHandlerLogStackTrace;
+ private Boolean errorHandlerLogStackTrace = true;
/**
* Set if the deliveryMode priority or timeToLive qualities of service
* should be used when sending messages. This option is based on Spring's
@@ -204,7 +205,7 @@ public class JmsComponentConfiguration {
* option which operates at message granularity reading QoS properties
* exclusively from the Camel In message headers.
*/
- private Boolean explicitQosEnabled;
+ private Boolean explicitQosEnabled = false;
/**
* Specifies whether the listener session should be exposed when consuming
* messages.
@@ -217,12 +218,12 @@ public class JmsComponentConfiguration {
* case of dynamic scheduling; see the maxConcurrentConsumers setting).
* There is additional doc available from Spring.
*/
- private Integer idleTaskExecutionLimit;
+ private Integer idleTaskExecutionLimit = 1;
/**
* Specify the limit for the number of consumers that are allowed to be idle
* at any given time.
*/
- private Integer idleConsumerLimit;
+ private Integer idleConsumerLimit = 1;
/**
* Specifies the maximum number of concurrent consumers when consuming from
* JMS (not for request/reply over JMS). See also the maxMessagesPerTask
@@ -242,14 +243,14 @@ public class JmsComponentConfiguration {
* Specifies the maximum number of concurrent consumers for continue routing
* when timeout occurred when using request/reply over JMS.
*/
- private Integer replyOnTimeoutToMaxConcurrentConsumers;
+ private Integer replyOnTimeoutToMaxConcurrentConsumers = 1;
/**
* The number of messages per task. -1 is unlimited. If you use a range for
* concurrent consumers (eg min max) then this option can be used to set a
* value to eg 100 to control how fast the consumers will shrink when less
* work is required.
*/
- private Integer maxMessagesPerTask;
+ private Integer maxMessagesPerTask = -1;
/**
* To use a custom Spring
* org.springframework.jms.support.converter.MessageConverter so you can be
@@ -262,16 +263,19 @@ public class JmsComponentConfiguration {
* suited payload type such as javax.jms.TextMessage to a String etc. See
* section about how mapping works below for more details.
*/
- private Boolean mapJmsMessage;
+ private Boolean mapJmsMessage = true;
/**
- * When sending specifies whether message IDs should be added.
+ * When sending specifies whether message IDs should be added. This is just
+ * an hint to the JMS Broker. If the JMS provider accepts this hint these
+ * messages must have the message ID set to null; if the provider ignores
+ * the hint the message ID must be set to its normal unique value
*/
- private Boolean messageIdEnabled;
+ private Boolean messageIdEnabled = true;
/**
* Specifies whether timestamps should be enabled by default on sending
* messages.
*/
- private Boolean messageTimestampEnabled;
+ private Boolean messageTimestampEnabled = true;
/**
* If true Camel will always make a JMS message copy of the message when it
* is passed to the producer for sending. Copying the message is needed in
@@ -290,7 +294,7 @@ public class JmsComponentConfiguration {
* is the lowest priority and 9 is the highest). The explicitQosEnabled
* option must also be enabled in order for this option to have any effect.
*/
- private Integer priority;
+ private Integer priority = 4;
/**
* Specifies whether to inhibit the delivery of messages published by its
* own connection.
@@ -299,13 +303,13 @@ public class JmsComponentConfiguration {
/**
* The timeout for receiving messages (in milliseconds).
*/
- private Long receiveTimeout;
+ private Long receiveTimeout = 1000L;
/**
* 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.
*/
- private Long recoveryInterval;
+ private Long recoveryInterval = 5000L;
/**
* Deprecated: Enabled by default if you specify a durableSubscriptionName
* and a clientId.
@@ -321,7 +325,7 @@ public class JmsComponentConfiguration {
* When sending messages specifies the time-to-live of the message (in
* milliseconds).
*/
- private Long timeToLive;
+ private Long timeToLive = -1L;
/**
* Specifies whether to use transacted mode
*/
@@ -330,7 +334,7 @@ public class JmsComponentConfiguration {
* If true Camel will create a JmsTransactionManager if there is no
* transactionManager injected when option transacted=true.
*/
- private Boolean lazyCreateTransactionManager;
+ private Boolean lazyCreateTransactionManager = true;
/**
* The Spring transaction manager to use.
*/
@@ -344,7 +348,7 @@ public class JmsComponentConfiguration {
* The timeout value of the transaction (in seconds) if using transacted
* mode.
*/
- private Integer transactionTimeout;
+ private Integer transactionTimeout = -1;
/**
* Specifies whether to test the connection on startup. This ensures that
* when Camel starts that all the JMS consumers have a valid connection to
@@ -385,7 +389,7 @@ public class JmsComponentConfiguration {
* and thus have per message individual timeout values. See also the
* requestTimeoutCheckerInterval option.
*/
- private Long requestTimeout;
+ private Long requestTimeout = 20000L;
/**
* Configures how often Camel should check for timed out Exchanges when
* doing request/reply over JMS. By default Camel checks once per second.
@@ -393,7 +397,7 @@ public class JmsComponentConfiguration {
* this interval to check more frequently. The timeout is determined by the
* option requestTimeout.
*/
- private Long requestTimeoutCheckerInterval;
+ private Long requestTimeoutCheckerInterval = 1000L;
/**
* You can transfer the exchange over the wire instead of just the body and
* headers. The following fields are transferred: In body Out body Fault
@@ -483,7 +487,7 @@ public class JmsComponentConfiguration {
* Whether to allow sending messages with no body. If this option is false
* and the message body is null then an JMSException is thrown.
*/
- private Boolean allowNullBody;
+ private Boolean allowNullBody = true;
/**
* Only applicable when sending to JMS destination using InOnly (eg fire and
* forget). Enabling this option will enrich the Camel Exchange with the
@@ -544,12 +548,12 @@ public class JmsComponentConfiguration {
* the actual correlation id when doing request/reply over JMS and when the
* option useMessageIDAsCorrelationID is enabled.
*/
- private Integer waitForProvisionCorrelationToBeUpdatedCounter;
+ private Integer waitForProvisionCorrelationToBeUpdatedCounter = 50;
/**
* Interval in millis to sleep each time while waiting for provisional
* correlation id to be updated.
*/
- private Long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime;
+ private Long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime = 100L;
/**
* To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter
* header to and from Camel message.
@@ -1216,7 +1220,7 @@ public class JmsComponentConfiguration {
/**
* 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 enqued on the
+ * 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
http://git-wip-us.apache.org/repos/asf/camel/blob/8c0f3c3c/components/camel-jms/src/main/docs/jms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc
index c010d54..3315299 100644
--- a/components/camel-jms/src/main/docs/jms-component.adoc
+++ b/components/camel-jms/src/main/docs/jms-component.adoc
@@ -223,7 +223,7 @@ The JMS component supports 74 options which are listed below.
|=======================================================================
| Name | Java Type | Description
| configuration | JmsConfiguration | To use a shared JMS configuration
-| acceptMessagesWhileStopping | boolean | 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 enqued 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.
+| acceptMessagesWhileStopping | boolean | 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.
| allowReplyManagerQuickStop | boolean | 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.
| acknowledgementMode | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead.
| eagerLoadingOfProperties | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties
@@ -235,7 +235,7 @@ The JMS component supports 74 options which are listed below.
| clientId | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead.
| concurrentConsumers | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
| replyToConcurrentConsumers | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
-| connectionFactory | ConnectionFactory | Sets the default connection factory to be use
+| connectionFactory | ConnectionFactory | The connection factory to be use. A connection factory must be configured either on the component or endpoint.
| username | String | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
| password | String | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
| deliveryPersistent | boolean | Specifies whether persistent delivery is used by default.
@@ -255,7 +255,7 @@ The JMS component supports 74 options which are listed below.
| maxMessagesPerTask | int | The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max) then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required.
| messageConverter | MessageConverter | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message.
| mapJmsMessage | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
-| messageIdEnabled | boolean | When sending specifies whether message IDs should be added.
+| messageIdEnabled | boolean | When sending specifies whether message IDs should be added. This is just an hint to the JMS Broker. If the JMS provider accepts this hint these messages must have the message ID set to null; if the provider ignores the hint the message ID must be set to its normal unique value
| messageTimestampEnabled | boolean | Specifies whether timestamps should be enabled by default on sending messages.
| alwaysCopyMessage | boolean | If true Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations such as when a replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a replyToDestinationSelectorName is set)
| useMessageIDAsCorrelationID | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
@@ -320,7 +320,7 @@ Endpoint options
// endpoint options: START
-The JMS component supports 83 endpoint options which are listed below:
+The JMS component supports 84 endpoint options which are listed below:
{% raw %}
[width="100%",cols="2,1,1m,1m,5",options="header"]
@@ -344,8 +344,8 @@ The JMS component supports 83 endpoint options which are listed below:
| replyTo | consumer | | String | Provides an explicit ReplyTo destination which overrides any incoming value of Message.getJMSReplyTo().
| replyToDeliveryPersistent | consumer | true | boolean | Specifies whether to use persistent delivery by default for replies.
| selector | consumer | | String | Sets the JMS selector to use
-| acceptMessagesWhileStopping | consumer (advanced) | false | boolean | 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 enqued 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.
-| allowReplyManagerQuickStop | consumer (advanced) | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case link 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.
+| acceptMessagesWhileStopping | consumer (advanced) | false | boolean | 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.
+| allowReplyManagerQuickStop | consumer (advanced) | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the link DefaultMessageListenerContainerrunningAllowed() flag to quick stop in case link 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.
| consumerType | consumer (advanced) | Default | ConsumerType | 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.
| defaultTaskExecutorType | consumer (advanced) | | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set it defaults to the previous behaviour which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers.
| eagerLoadingOfProperties | consumer (advanced) | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties
@@ -353,6 +353,7 @@ The JMS component supports 83 endpoint options which are listed below:
| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
| exposeListenerSession | consumer (advanced) | false | boolean | Specifies whether the listener session should be exposed when consuming messages.
| replyToSameDestinationAllowed | consumer (advanced) | false | boolean | Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself.
+| taskExecutor | consumer (advanced) | | TaskExecutor | Allows you to specify a custom task executor for consuming messages.
| deliveryMode | producer | | Integer | Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
| deliveryPersistent | producer | true | boolean | Specifies whether persistent delivery is used by default.
| explicitQosEnabled | producer | false | Boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers.
http://git-wip-us.apache.org/repos/asf/camel/blob/8c0f3c3c/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
index b1ee124..749d018 100644
--- a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
+++ b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
@@ -20,6 +20,7 @@ import java.util.Map;
import java.util.concurrent.ExecutorService;
import javax.jms.ConnectionFactory;
import javax.jms.ExceptionListener;
+import javax.jms.Message;
import javax.jms.Session;
import org.apache.camel.CamelContext;
@@ -27,6 +28,7 @@ import org.apache.camel.Endpoint;
import org.apache.camel.LoggingLevel;
import org.apache.camel.impl.HeaderFilterStrategyComponent;
import org.apache.camel.spi.Metadata;
+import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -204,10 +206,16 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* 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
- * enqued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected,
+ * 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.
*/
+ @Metadata(label = "consumer,advanced",
+ description = "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.")
public void setAcceptMessagesWhileStopping(boolean acceptMessagesWhileStopping) {
getConfiguration().setAcceptMessagesWhileStopping(acceptMessagesWhileStopping);
}
@@ -218,6 +226,11 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* 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.
*/
+ @Metadata(label = "consumer,advanced",
+ description = "Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow "
+ + " the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping"
+ + " 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.")
public void setAllowReplyManagerQuickStop(boolean allowReplyManagerQuickStop) {
getConfiguration().setAllowReplyManagerQuickStop(allowReplyManagerQuickStop);
}
@@ -227,6 +240,9 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Allows you to set vendor-specific extensions to the acknowledgment mode.
* For the regular modes, it is preferable to use the acknowledgementModeName instead.
*/
+ @Metadata(label = "consumer",
+ description = "The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode."
+ + "For the regular modes, it is preferable to use the acknowledgementModeName instead.")
public void setAcknowledgementMode(int consumerAcknowledgementMode) {
getConfiguration().setAcknowledgementMode(consumerAcknowledgementMode);
}
@@ -237,6 +253,11 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* but sometimes can catch early any issues with the underlying JMS provider
* and the use of JMS properties
*/
+ @Metadata(label = "consumer,advanced",
+ description = "Enables eager loading of JMS properties as soon as a message is loaded"
+ + " which generally is inefficient as the JMS properties may not be required"
+ + " but sometimes can catch early any issues with the underlying JMS provider"
+ + " and the use of JMS properties")
public void setEagerLoadingOfProperties(boolean eagerLoadingOfProperties) {
getConfiguration().setEagerLoadingOfProperties(eagerLoadingOfProperties);
}
@@ -244,6 +265,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE
*/
+ @Metadata(defaultValue = "AUTO_ACKNOWLEDGE", label = "consumer",
+ description = "The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE")
public void setAcknowledgementModeName(String consumerAcknowledgementMode) {
getConfiguration().setAcknowledgementModeName(consumerAcknowledgementMode);
}
@@ -251,6 +274,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specifies whether the consumer container should auto-startup.
*/
+ @Metadata(label = "consumer", defaultValue = "true",
+ description = "Specifies whether the consumer container should auto-startup.")
public void setAutoStartup(boolean autoStartup) {
getConfiguration().setAutoStartup(autoStartup);
}
@@ -258,6 +283,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
*/
+ @Metadata(label = "consumer", defaultValue = "true",
+ description = "Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.")
public void setCacheLevel(int cacheLevel) {
getConfiguration().setCacheLevel(cacheLevel);
}
@@ -267,6 +294,10 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION.
* The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.
*/
+ @Metadata(defaultValue = "CACHE_AUTO", label = "consumer",
+ description = "Sets the cache level by name for the underlying JMS resources."
+ + " Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION."
+ + " The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.")
public void setCacheLevelName(String cacheName) {
getConfiguration().setCacheLevelName(cacheName);
}
@@ -280,6 +311,14 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Note: If using temporary queues then CACHE_NONE is not allowed,
* and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION.
*/
+ @Metadata(label = "producer,advanced",
+ description = "Sets the cache level by name for the reply consumer when doing request/reply over JMS."
+ + " This option only applies when using fixed reply queues (not temporary)."
+ + " Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName."
+ + " And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere"
+ + " may require to set the replyToCacheLevelName=CACHE_NONE to work."
+ + " Note: If using temporary queues then CACHE_NONE is not allowed,"
+ + " and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION.")
public void setReplyToCacheLevelName(String cacheName) {
getConfiguration().setReplyToCacheLevelName(cacheName);
}
@@ -290,6 +329,9 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* <p/>
* If using Apache ActiveMQ you may prefer to use Virtual Topics instead.
*/
+ @Metadata(description = "Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance."
+ + " It is typically only required for durable topic subscriptions."
+ + " If using Apache ActiveMQ you may prefer to use Virtual Topics instead.")
public void setClientId(String consumerClientId) {
getConfiguration().setClientId(consumerClientId);
}
@@ -301,6 +343,11 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number
* of concurrent consumers on the reply message listener.
*/
+ @Metadata(defaultValue = "1", label = "consumer",
+ description = "Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS)."
+ + " See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."
+ + " When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number"
+ + " of concurrent consumers on the reply message listener.")
public void setConcurrentConsumers(int concurrentConsumers) {
getConfiguration().setConcurrentConsumers(concurrentConsumers);
}
@@ -309,13 +356,17 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Specifies the default number of concurrent consumers when doing request/reply over JMS.
* See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
*/
+ @Metadata(defaultValue = "1", label = "producer",
+ description = "Specifies the default number of concurrent consumers when doing request/reply over JMS."
+ + " See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.")
public void setReplyToConcurrentConsumers(int concurrentConsumers) {
getConfiguration().setReplyToConcurrentConsumers(concurrentConsumers);
}
/**
- * Sets the default connection factory to be use
+ * The connection factory to be use. A connection factory must be configured either on the component or endpoint.
*/
+ @Metadata(description = "The connection factory to be use. A connection factory must be configured either on the component or endpoint.")
public void setConnectionFactory(ConnectionFactory connectionFactory) {
getConfiguration().setConnectionFactory(connectionFactory);
}
@@ -323,7 +374,7 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
*/
- @Metadata(secret = true)
+ @Metadata(label = "security", secret = true, description = "Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.")
public void setUsername(String username) {
getConfiguration().setUsername(username);
}
@@ -331,7 +382,7 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
*/
- @Metadata(secret = true)
+ @Metadata(label = "security", secret = true, description = "Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.")
public void setPassword(String password) {
getConfiguration().setPassword(password);
}
@@ -339,6 +390,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specifies whether persistent delivery is used by default.
*/
+ @Metadata(defaultValue = "true", label = "producer",
+ description = "Specifies whether persistent delivery is used by default.")
public void setDeliveryPersistent(boolean deliveryPersistent) {
getConfiguration().setDeliveryPersistent(deliveryPersistent);
}
@@ -348,6 +401,10 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Possibles values are those defined by javax.jms.DeliveryMode.
* NON_PERSISTENT = 1 and PERSISTENT = 2.
*/
+ @Metadata(label = "producer",
+ description = "Specifies the delivery mode to be used."
+ + " Possibles values are those defined by javax.jms.DeliveryMode."
+ + " NON_PERSISTENT = 1 and PERSISTENT = 2.")
public void setDeliveryMode(Integer deliveryMode) {
getConfiguration().setDeliveryMode(deliveryMode);
}
@@ -355,6 +412,7 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
*/
+ @Metadata(description = "The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.")
public void setDurableSubscriptionName(String durableSubscriptionName) {
getConfiguration().setDurableSubscriptionName(durableSubscriptionName);
}
@@ -362,6 +420,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
*/
+ @Metadata(label = "advanced",
+ description = "Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.")
public void setExceptionListener(ExceptionListener exceptionListener) {
getConfiguration().setExceptionListener(exceptionListener);
}
@@ -372,6 +432,11 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options.
* This makes it much easier to configure, than having to code a custom errorHandler.
*/
+ @Metadata(label = "advanced",
+ description = "Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message."
+ + " By default these exceptions will be logged at the WARN level, if no errorHandler has been configured."
+ + " You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options."
+ + " This makes it much easier to configure, than having to code a custom errorHandler.")
public void setErrorHandler(ErrorHandler errorHandler) {
getConfiguration().setErrorHandler(errorHandler);
}
@@ -379,6 +444,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Allows to configure the default errorHandler logging level for logging uncaught exceptions.
*/
+ @Metadata(defaultValue = "WARN", label = "advanced",
+ description = "Allows to configure the default errorHandler logging level for logging uncaught exceptions.")
public void setErrorHandlerLoggingLevel(LoggingLevel errorHandlerLoggingLevel) {
getConfiguration().setErrorHandlerLoggingLevel(errorHandlerLoggingLevel);
}
@@ -386,6 +453,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Allows to control whether stacktraces should be logged or not, by the default errorHandler.
*/
+ @Metadata(defaultValue = "true", label = "advanced",
+ description = "Allows to control whether stacktraces should be logged or not, by the default errorHandler.")
public void setErrorHandlerLogStackTrace(boolean errorHandlerLogStackTrace) {
getConfiguration().setErrorHandlerLogStackTrace(errorHandlerLogStackTrace);
}
@@ -396,6 +465,11 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* This contrasts with the preserveMessageQos option, which operates at message granularity,
* reading QoS properties exclusively from the Camel In message headers.
*/
+ @Metadata(label = "producer", defaultValue = "false",
+ description = "Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages."
+ + " This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint."
+ + " This contrasts with the preserveMessageQos option, which operates at message granularity,"
+ + " reading QoS properties exclusively from the Camel In message headers.")
public void setExplicitQosEnabled(boolean explicitQosEnabled) {
getConfiguration().setExplicitQosEnabled(explicitQosEnabled);
}
@@ -403,6 +477,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specifies whether the listener session should be exposed when consuming messages.
*/
+ @Metadata(label = "consumer,advanced",
+ description = "Specifies whether the listener session should be exposed when consuming messages.")
public void setExposeListenerSession(boolean exposeListenerSession) {
getConfiguration().setExposeListenerSession(exposeListenerSession);
}
@@ -413,6 +489,11 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* (in the case of dynamic scheduling; see the maxConcurrentConsumers setting).
* There is additional doc available from Spring.
*/
+ @Metadata(defaultValue = "1", label = "advanced",
+ description = "Specifies the limit for idle executions of a receive task, not having received any message within its execution."
+ + " If this limit is reached, the task will shut down and leave receiving to other executing tasks"
+ + " (in the case of dynamic scheduling; see the maxConcurrentConsumers setting)."
+ + " There is additional doc available from Spring.")
public void setIdleTaskExecutionLimit(int idleTaskExecutionLimit) {
getConfiguration().setIdleTaskExecutionLimit(idleTaskExecutionLimit);
}
@@ -420,6 +501,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specify the limit for the number of consumers that are allowed to be idle at any given time.
*/
+ @Metadata(defaultValue = "1", label = "advanced",
+ description = "Specify the limit for the number of consumers that are allowed to be idle at any given time.")
public void setIdleConsumerLimit(int idleConsumerLimit) {
getConfiguration().setIdleConsumerLimit(idleConsumerLimit);
}
@@ -431,6 +514,11 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number
* of concurrent consumers on the reply message listener.
*/
+ @Metadata(label = "consumer",
+ description = "Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS)."
+ + " See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."
+ + " When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number"
+ + " of concurrent consumers on the reply message listener.")
public void setMaxConcurrentConsumers(int maxConcurrentConsumers) {
getConfiguration().setMaxConcurrentConsumers(maxConcurrentConsumers);
}
@@ -439,6 +527,9 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Specifies the maximum number of concurrent consumers when using request/reply over JMS.
* See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
*/
+ @Metadata(label = "producer",
+ description = "Specifies the maximum number of concurrent consumers when using request/reply over JMS."
+ + " See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.")
public void setReplyToMaxConcurrentConsumers(int maxConcurrentConsumers) {
getConfiguration().setReplyToMaxConcurrentConsumers(maxConcurrentConsumers);
}
@@ -446,6 +537,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
*/
+ @Metadata(label = "producer", defaultValue = "1",
+ description = "Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.")
public void setReplyOnTimeoutToMaxConcurrentConsumers(int maxConcurrentConsumers) {
getConfiguration().setReplyToOnTimeoutMaxConcurrentConsumers(maxConcurrentConsumers);
}
@@ -455,6 +548,10 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* If you use a range for concurrent consumers (eg min < max), then this option can be used to set
* a value to eg 100 to control how fast the consumers will shrink when less work is required.
*/
+ @Metadata(defaultValue = "-1", label = "advanced",
+ description = "The number of messages per task. -1 is unlimited."
+ + " If you use a range for concurrent consumers (eg min < max), then this option can be used to set"
+ + " a value to eg 100 to control how fast the consumers will shrink when less work is required.")
public void setMaxMessagesPerTask(int maxMessagesPerTask) {
getConfiguration().setMaxMessagesPerTask(maxMessagesPerTask);
}
@@ -463,6 +560,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control
* how to map to/from a javax.jms.Message.
*/
+ @Metadata(label = "advanced",
+ description = "To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message.")
public void setMessageConverter(MessageConverter messageConverter) {
getConfiguration().setMessageConverter(messageConverter);
}
@@ -471,13 +570,20 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc.
* See section about how mapping works below for more details.
*/
+ @Metadata(defaultValue = "true", label = "advanced",
+ description = "Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc.")
public void setMapJmsMessage(boolean mapJmsMessage) {
getConfiguration().setMapJmsMessage(mapJmsMessage);
}
/**
- * When sending, specifies whether message IDs should be added.
+ * When sending, specifies whether message IDs should be added. This is just an hint to the JMS Broker.
+ * If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value
*/
+ @Metadata(defaultValue = "true", label = "advanced",
+ description = "When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker."
+ + "If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, "
+ + "the message ID must be set to its normal unique value")
public void setMessageIdEnabled(boolean messageIdEnabled) {
getConfiguration().setMessageIdEnabled(messageIdEnabled);
}
@@ -485,6 +591,10 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specifies whether timestamps should be enabled by default on sending messages.
*/
+ @Metadata(defaultValue = "true", label = "advanced",
+ description = "Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker."
+ + "If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint "
+ + "the timestamp must be set to its normal value")
public void setMessageTimestampEnabled(boolean messageTimestampEnabled) {
getConfiguration().setMessageTimestampEnabled(messageTimestampEnabled);
}
@@ -494,6 +604,10 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set
* (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)
*/
+ @Metadata(label = "producer,advanced",
+ description = "If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending."
+ + " Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set"
+ + " (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)")
public void setAlwaysCopyMessage(boolean alwaysCopyMessage) {
getConfiguration().setAlwaysCopyMessage(alwaysCopyMessage);
}
@@ -501,6 +615,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
*/
+ @Metadata(label = "advanced",
+ description = "Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.")
public void setUseMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID) {
getConfiguration().setUseMessageIDAsCorrelationID(useMessageIDAsCorrelationID);
}
@@ -509,6 +625,9 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest).
* The explicitQosEnabled option must also be enabled in order for this option to have any effect.
*/
+ @Metadata(defaultValue = "" + Message.DEFAULT_PRIORITY, label = "producer",
+ description = "Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest)."
+ + " The explicitQosEnabled option must also be enabled in order for this option to have any effect.")
public void setPriority(int priority) {
getConfiguration().setPriority(priority);
}
@@ -516,6 +635,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specifies whether to inhibit the delivery of messages published by its own connection.
*/
+ @Metadata(label = "advanced",
+ description = "Specifies whether to inhibit the delivery of messages published by its own connection.")
public void setPubSubNoLocal(boolean pubSubNoLocal) {
getConfiguration().setPubSubNoLocal(pubSubNoLocal);
}
@@ -523,6 +644,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* The timeout for receiving messages (in milliseconds).
*/
+ @Metadata(defaultValue = "1000", label = "advanced",
+ description = "The timeout for receiving messages (in milliseconds).")
public void setReceiveTimeout(long receiveTimeout) {
getConfiguration().setReceiveTimeout(receiveTimeout);
}
@@ -531,6 +654,9 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* 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.
*/
+ @Metadata(defaultValue = "5000", label = "advanced",
+ description = "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.")
public void setRecoveryInterval(long recoveryInterval) {
getConfiguration().setRecoveryInterval(recoveryInterval);
}
@@ -546,6 +672,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Allows you to specify a custom task executor for consuming messages.
*/
+ @Metadata(label = "consumer.advanced",
+ description = "Allows you to specify a custom task executor for consuming messages.")
public void setTaskExecutor(TaskExecutor taskExecutor) {
getConfiguration().setTaskExecutor(taskExecutor);
}
@@ -553,6 +681,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* When sending messages, specifies the time-to-live of the message (in milliseconds).
*/
+ @Metadata(defaultValue = "-1", label = "producer",
+ description = "When sending messages, specifies the time-to-live of the message (in milliseconds).")
public void setTimeToLive(long timeToLive) {
getConfiguration().setTimeToLive(timeToLive);
}
@@ -560,6 +690,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Specifies whether to use transacted mode
*/
+ @Metadata(label = "transaction",
+ description = "Specifies whether to use transacted mode")
public void setTransacted(boolean consumerTransacted) {
getConfiguration().setTransacted(consumerTransacted);
}
@@ -567,6 +699,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.
*/
+ @Metadata(defaultValue = "true", label = "transaction,advanced",
+ description = "If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.")
public void setLazyCreateTransactionManager(boolean lazyCreating) {
getConfiguration().setLazyCreateTransactionManager(lazyCreating);
}
@@ -574,6 +708,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* The Spring transaction manager to use.
*/
+ @Metadata(label = "transaction,advanced",
+ description = "The Spring transaction manager to use.")
public void setTransactionManager(PlatformTransactionManager transactionManager) {
getConfiguration().setTransactionManager(transactionManager);
}
@@ -581,6 +717,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* The name of the transaction to use.
*/
+ @Metadata(label = "transaction,advanced",
+ description = "The name of the transaction to use.")
public void setTransactionName(String transactionName) {
getConfiguration().setTransactionName(transactionName);
}
@@ -588,6 +726,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* The timeout value of the transaction (in seconds), if using transacted mode.
*/
+ @Metadata(defaultValue = "-1", label = "transaction,advanced",
+ description = "The timeout value of the transaction (in seconds), if using transacted mode.")
public void setTransactionTimeout(int transactionTimeout) {
getConfiguration().setTransactionTimeout(transactionTimeout);
}
@@ -599,6 +739,11 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* This ensures that Camel is not started with failed connections.
* The JMS producers is tested as well.
*/
+ @Metadata(description = "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.")
public void setTestConnectionOnStartup(boolean testConnectionOnStartup) {
getConfiguration().setTestConnectionOnStartup(testConnectionOnStartup);
}
@@ -612,6 +757,14 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* then an exception is logged at WARN level, and the consumer will not be able to receive messages;
* You can then restart the route to retry.
*/
+ @Metadata(label = "advanced",
+ description = "Whether to startup the JmsConsumer message listener asynchronously, when starting a route."
+ + " For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying"
+ + " and/or failover. This will cause Camel to block while starting routes. By setting this option to true,"
+ + " you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread"
+ + " in asynchronous mode. If this option is used, then beware that if the connection could not be established,"
+ + " then an exception is logged at WARN level, and the consumer will not be able to receive messages;"
+ + " You can then restart the route to retry.")
public void setAsyncStartListener(boolean asyncStartListener) {
getConfiguration().setAsyncStartListener(asyncStartListener);
}
@@ -619,6 +772,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.
*/
+ @Metadata(label = "advanced",
+ description = "Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.")
public void setAsyncStopListener(boolean asyncStopListener) {
getConfiguration().setAsyncStopListener(asyncStopListener);
}
@@ -628,6 +783,10 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* if you touch the headers (get or set) during the route. Set this option to true to force Camel to send
* the original JMS message that was received.
*/
+ @Metadata(label = "producer,advanced",
+ description = "When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination"
+ + " if you touch the headers (get or set) during the route. Set this option to true to force Camel to send"
+ + " the original JMS message that was received.")
public void setForceSendOriginalMessage(boolean forceSendOriginalMessage) {
getConfiguration().setForceSendOriginalMessage(forceSendOriginalMessage);
}
@@ -638,6 +797,11 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* timeout value, and thus have per message individual timeout values.
* See also the requestTimeoutCheckerInterval option.
*/
+ @Metadata(defaultValue = "20000", label = "producer",
+ description = "The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds)."
+ + " The default is 20 seconds. You can include the header \"CamelJmsRequestTimeout\" to override this endpoint configured"
+ + " timeout value, and thus have per message individual timeout values."
+ + " See also the requestTimeoutCheckerInterval option.")
public void setRequestTimeout(long requestTimeout) {
getConfiguration().setRequestTimeout(requestTimeout);
}
@@ -647,6 +811,10 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* By default Camel checks once per second. But if you must react faster when a timeout occurs,
* then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout.
*/
+ @Metadata(defaultValue = "1000", label = "advanced",
+ description = "Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS."
+ + " By default Camel checks once per second. But if you must react faster when a timeout occurs,"
+ + " then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout.")
public void setRequestTimeoutCheckerInterval(long requestTimeoutCheckerInterval) {
getConfiguration().setRequestTimeoutCheckerInterval(requestTimeoutCheckerInterval);
}
@@ -658,6 +826,12 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.
* You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload.
*/
+ @Metadata(label = "advanced",
+ description = "You can transfer the exchange over the wire instead of just the body and headers."
+ + " The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers,"
+ + " exchange properties, exchange exception."
+ + " This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."
+ + " You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload.")
public void setTransferExchange(boolean transferExchange) {
getConfiguration().setTransferExchange(transferExchange);
}
@@ -672,6 +846,15 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* The original Exception on the consumer side can be wrapped in an outer exception
* such as org.apache.camel.RuntimeCamelException when returned to the producer.
*/
+ @Metadata(label = "advanced",
+ description = "If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side,"
+ + " then the caused Exception will be send back in response as a javax.jms.ObjectMessage."
+ + " If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge"
+ + " in your routing - for example, using persistent queues to enable robust routing."
+ + " Notice that if you also have transferExchange enabled, this option takes precedence."
+ + " The caught exception is required to be serializable."
+ + " The original Exception on the consumer side can be wrapped in an outer exception"
+ + " such as org.apache.camel.RuntimeCamelException when returned to the producer.")
public void setTransferException(boolean transferException) {
getConfiguration().setTransferException(transferException);
}
@@ -684,6 +867,12 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* <p/>
* You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.
*/
+ @Metadata(label = "advanced",
+ description = "If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side,"
+ + " then the fault flag on Message#isFault() will be send back in the response as a JMS header with the key"
+ + " org.apache.camel.component.jms.JmsConstants#JMS_TRANSFER_FAULT#JMS_TRANSFER_FAULT."
+ + " If the client is Camel, the returned fault flag will be set on the {@link org.apache.camel.Message#setFault(boolean)}."
+ + " You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.")
public void setTransferFault(boolean transferFault) {
getConfiguration().setTransferFault(transferFault);
}
@@ -692,6 +881,9 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface.
* Camel uses JmsTemplate as default. Can be used for testing purpose, but not used much as stated in the spring API docs.
*/
+ @Metadata(label = "advanced",
+ description = "Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface."
+ + " Camel uses JmsTemplate as default. Can be used for testing purpose, but not used much as stated in the spring API docs.")
public void setJmsOperations(JmsOperations jmsOperations) {
getConfiguration().setJmsOperations(jmsOperations);
}
@@ -700,6 +892,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver
* (for example, to lookup the real destination in a JNDI registry).
*/
+ @Metadata(label = "advanced", description = "A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver"
+ + " (for example, to lookup the real destination in a JNDI registry).")
public void setDestinationResolver(DestinationResolver destinationResolver) {
getConfiguration().setDestinationResolver(destinationResolver);
}
@@ -712,6 +906,13 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment,
* and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive.
*/
+ @Metadata(label = "producer",
+ description = "Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS."
+ + " Possible values are: Temporary, Shared, or Exclusive."
+ + " By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default."
+ + " This option allows you to use exclusive queues instead of shared ones."
+ + " See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment,"
+ + " and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive.")
public void setReplyToType(ReplyToType replyToType) {
getConfiguration().setReplyToType(replyToType);
}
@@ -723,6 +924,12 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* values from the endpoint instead. So, when using this option, the headers override the values from the endpoint.
* The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header.
*/
+ @Metadata(label = "producer",
+ description = "Set to true, if you want to send message using the QoS settings specified on the message,"
+ + " instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode,"
+ + " and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the"
+ + " values from the endpoint instead. So, when using this option, the headers override the values from the endpoint."
+ + " The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header.")
public void setPreserveMessageQos(boolean preserveMessageQos) {
getConfiguration().setPreserveMessageQos(preserveMessageQos);
}
@@ -736,6 +943,14 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction
* must be executed synchronously (Camel 3.0 may support async transactions).
*/
+ @Metadata(label = "consumer",
+ description = "Whether the JmsConsumer processes the Exchange asynchronously."
+ + " If enabled then the JmsConsumer may pickup the next message from the JMS queue,"
+ + " while the previous message is being processed asynchronously (by the Asynchronous Routing Engine)."
+ + " This means that messages may be processed not 100% strictly in order. If disabled (as default)"
+ + " then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue."
+ + " Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction"
+ + " must be executed synchronously (Camel 3.0 may support async transactions).")
public void setAsyncConsumer(boolean asyncConsumer) {
getConfiguration().setAsyncConsumer(asyncConsumer);
}
@@ -743,6 +958,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown.
*/
+ @Metadata(defaultValue = "true", label = "producer,advanced",
+ description = "Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown.")
public void setAllowNullBody(boolean allowNullBody) {
getConfiguration().setAllowNullBody(allowNullBody);
}
@@ -752,6 +969,10 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Enabling this option will enrich the Camel Exchange with the actual JMSMessageID
* that was used by the JMS client when the message was sent to the JMS destination.
*/
+ @Metadata(label = "producer,advanced",
+ description = "Only applicable when sending to JMS destination using InOnly (eg fire and forget)."
+ + " Enabling this option will enrich the Camel Exchange with the actual JMSMessageID"
+ + " that was used by the JMS client when the message was sent to the JMS destination.")
public void setIncludeSentJMSMessageID(boolean includeSentJMSMessageID) {
getConfiguration().setIncludeSentJMSMessageID(includeSentJMSMessageID);
}
@@ -761,6 +982,10 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc.
* Note: If you are using a custom headerFilterStrategy then this option does not apply.
*/
+ @Metadata(label = "advanced",
+ description = "Whether to include all JMSXxxx properties when mapping from JMS to Camel Message."
+ + " Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc."
+ + " Note: If you are using a custom headerFilterStrategy then this option does not apply.")
public void setIncludeAllJMSXProperties(boolean includeAllJMSXProperties) {
getConfiguration().setIncludeAllJMSXProperties(includeAllJMSXProperties);
}
@@ -775,6 +1000,15 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* The use of ThreadPool is recommended to reduce "thread trash" in elastic configurations
* with dynamically increasing and decreasing concurrent consumers.
*/
+ @Metadata(label = "consumer,advanced",
+ description = "Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer,"
+ + " for both consumer endpoints and the ReplyTo consumer of producer endpoints."
+ + " Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool"
+ + " (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like)."
+ + " If not set, it defaults to the previous behaviour, which uses a cached thread pool"
+ + " for consumer endpoints and SimpleAsync for reply consumers."
+ + " The use of ThreadPool is recommended to reduce thread trash in elastic configurations"
+ + " with dynamically increasing and decreasing concurrent consumers.")
public void setDefaultTaskExecutorType(DefaultTaskExecutorType type) {
getConfiguration().setDefaultTaskExecutorType(type);
}
@@ -787,6 +1021,13 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy
* and refer to it using the # notation.
*/
+ @Metadata(label = "advanced",
+ description = "Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification."
+ + " Camel provides two implementations out of the box: default and passthrough."
+ + " The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is."
+ + " Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters."
+ + " You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy"
+ + " and refer to it using the # notation.")
public void setJmsKeyFormatStrategy(JmsKeyFormatStrategy jmsKeyFormatStrategy) {
getConfiguration().setJmsKeyFormatStrategy(jmsKeyFormatStrategy);
}
@@ -850,6 +1091,9 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
* 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.
*/
+ @Metadata(defaultValue = "50", label = "advanced",
+ description = "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.")
public void setWaitForProvisionCorrelationToBeUpdatedCounter(int counter) {
getConfiguration().setWaitForProvisionCorrelationToBeUpdatedCounter(counter);
}
@@ -861,6 +1105,8 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
*/
+ @Metadata(defaultValue = "100", label = "advanced",
+ description = "Interval in millis to sleep each time while waiting for provisional correlation id to be updated.")
public void setWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime(long sleepingTime) {
getConfiguration().setWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime(sleepingTime);
}
http://git-wip-us.apache.org/repos/asf/camel/blob/8c0f3c3c/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
index 3a99b5e..be84a8a 100644
--- a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
+++ b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
@@ -79,7 +79,8 @@ public class JmsConfiguration implements Cloneable {
@UriParam(defaultValue = "AUTO_ACKNOWLEDGE", enums = "SESSION_TRANSACTED,CLIENT_ACKNOWLEDGE,AUTO_ACKNOWLEDGE,DUPS_OK_ACKNOWLEDGE", label = "consumer",
description = "The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE")
private String acknowledgementModeName;
- @UriParam(label = "advanced")
+ @UriParam(label = "advanced", description = "A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver"
+ + " (for example, to lookup the real destination in a JNDI registry).")
private DestinationResolver destinationResolver;
// Used to configure the spring Container
@UriParam(label = "advanced",
@@ -116,7 +117,7 @@ public class JmsConfiguration implements Cloneable {
@UriParam(label = "consumer,advanced",
description = "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"
- + " enqued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected,"
+ + " 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.")
private boolean acceptMessagesWhileStopping;
@@ -131,6 +132,8 @@ public class JmsConfiguration implements Cloneable {
@UriParam(label = "consumer,advanced",
description = "Specifies whether the listener session should be exposed when consuming messages.")
private boolean exposeListenerSession = true;
+ @UriParam(label = "consumer,advanced",
+ description = "Allows you to specify a custom task executor for consuming messages.")
private TaskExecutor taskExecutor;
@UriParam(label = "advanced",
description = "Specifies whether to inhibit the delivery of messages published by its own connection.")
@@ -807,7 +810,7 @@ public class JmsConfiguration implements Cloneable {
/**
* 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
- * enqued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected,
+ * 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.
*/
@@ -817,7 +820,7 @@ public class JmsConfiguration implements Cloneable {
/**
* Whether the {@link DefaultMessageListenerContainer} used in the reply managers for request-reply messaging allow
- * the {@link DefaultMessageListenerContainer.runningAllowed} flag to quick stop in case {@link JmsConfiguration#isAcceptMessagesWhileStopping()}
+ * the {@link DefaultMessageListenerContainer#runningAllowed()} flag to quick stop in case {@link JmsConfiguration#isAcceptMessagesWhileStopping()}
* is enabled, and {@link 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.
*/
[6/8] camel git commit: CAMEL-10636: Component options docs - Include
more details like endpoint options.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc
index 8d82fd7..eacdd93 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc
@@ -57,10 +57,10 @@ The Hazelcast component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| hazelcastInstance | HazelcastInstance | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance.
+| Name | Group | Default | Java Type | Description
+| hazelcastInstance | | | HazelcastInstance | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-hbase/src/main/docs/hbase-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hbase/src/main/docs/hbase-component.adoc b/components/camel-hbase/src/main/docs/hbase-component.adoc
index 5e796bd..b7620d0 100644
--- a/components/camel-hbase/src/main/docs/hbase-component.adoc
+++ b/components/camel-hbase/src/main/docs/hbase-component.adoc
@@ -118,11 +118,11 @@ The HBase component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | Configuration | To use the shared configuration
-| poolMaxSize | int | Maximum number of references to keep for each table in the HTable pool. The default value is 10.
+| Name | Group | Default | Java Type | Description
+| configuration | | | Configuration | To use the shared configuration
+| poolMaxSize | | 10 | int | Maximum number of references to keep for each table in the HTable pool. The default value is 10.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-hdfs/src/main/docs/hdfs-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hdfs/src/main/docs/hdfs-component.adoc b/components/camel-hdfs/src/main/docs/hdfs-component.adoc
index 3d3b5ca..b535914 100644
--- a/components/camel-hdfs/src/main/docs/hdfs-component.adoc
+++ b/components/camel-hdfs/src/main/docs/hdfs-component.adoc
@@ -66,10 +66,10 @@ The HDFS component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| jAASConfiguration | Configuration | To use the given configuration for security with JAAS.
+| Name | Group | Default | Java Type | Description
+| jAASConfiguration | | | Configuration | To use the given configuration for security with JAAS.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc b/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc
index f8a3e8c..0f8fbce 100644
--- a/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc
+++ b/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc
@@ -64,10 +64,10 @@ The HDFS2 component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| jAASConfiguration | Configuration | To use the given configuration for security with JAAS.
+| Name | Group | Default | Java Type | Description
+| jAASConfiguration | | | Configuration | To use the given configuration for security with JAAS.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-http/src/main/docs/http-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-http/src/main/docs/http-component.adoc b/components/camel-http/src/main/docs/http-component.adoc
index e4ce46a..7aebd67 100644
--- a/components/camel-http/src/main/docs/http-component.adoc
+++ b/components/camel-http/src/main/docs/http-component.adoc
@@ -125,15 +125,15 @@ The HTTP component supports 6 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| httpClientConfigurer | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.
-| httpConnectionManager | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
-| httpBinding | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-| httpConfiguration | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
-| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| httpClientConfigurer | | | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.
+| httpConnectionManager | | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
+| httpBinding | | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
+| httpConfiguration | | | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
+| allowJavaSerializedObject | | | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-http4/src/main/docs/http4-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-http4/src/main/docs/http4-component.adoc b/components/camel-http4/src/main/docs/http4-component.adoc
index b22346e..8a5a06f 100644
--- a/components/camel-http4/src/main/docs/http4-component.adoc
+++ b/components/camel-http4/src/main/docs/http4-component.adoc
@@ -62,22 +62,22 @@ The HTTP4 component supports 13 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| httpClientConfigurer | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.
-| clientConnectionManager | HttpClientConnectionManager | To use a custom HttpClientConnectionManager to manage connections
-| httpBinding | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-| httpConfiguration | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
-| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
-| httpContext | HttpContext | To use a custom org.apache.http.protocol.HttpContext when executing requests.
-| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances you need to define a new HttpComponent per instance you need.
-| x509HostnameVerifier | X509HostnameVerifier | To use a custom X509HostnameVerifier such as org.apache.http.conn.ssl.StrictHostnameVerifier or org.apache.http.conn.ssl.AllowAllHostnameVerifier.
-| maxTotalConnections | int | The maximum number of connections.
-| connectionsPerRoute | int | The maximum number of connections per route.
-| connectionTimeToLive | long | The time for connection to live the time unit is millisecond the default value is always keep alive.
-| cookieStore | CookieStore | To use a custom org.apache.http.client.CookieStore. By default the org.apache.http.impl.client.BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy).
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| httpClientConfigurer | | | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.
+| clientConnectionManager | | | HttpClientConnectionManager | To use a custom HttpClientConnectionManager to manage connections
+| httpBinding | | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
+| httpConfiguration | | | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
+| allowJavaSerializedObject | | | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| httpContext | | | HttpContext | To use a custom org.apache.http.protocol.HttpContext when executing requests.
+| sslContextParameters | | | SSLContextParameters | To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances you need to define a new HttpComponent per instance you need.
+| x509HostnameVerifier | | | X509HostnameVerifier | To use a custom X509HostnameVerifier such as org.apache.http.conn.ssl.StrictHostnameVerifier or org.apache.http.conn.ssl.AllowAllHostnameVerifier.
+| maxTotalConnections | | 200 | int | The maximum number of connections.
+| connectionsPerRoute | | 20 | int | The maximum number of connections per route.
+| connectionTimeToLive | | | long | The time for connection to live the time unit is millisecond the default value is always keep alive.
+| cookieStore | | | CookieStore | To use a custom org.apache.http.client.CookieStore. By default the org.apache.http.impl.client.BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy).
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-ibatis/src/main/docs/ibatis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ibatis/src/main/docs/ibatis-component.adoc b/components/camel-ibatis/src/main/docs/ibatis-component.adoc
index 061df7c..b25f376 100644
--- a/components/camel-ibatis/src/main/docs/ibatis-component.adoc
+++ b/components/camel-ibatis/src/main/docs/ibatis-component.adoc
@@ -65,12 +65,12 @@ The iBatis component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| sqlMapClient | SqlMapClient | To use the given com.ibatis.sqlmap.client.SqlMapClient
-| sqlMapConfig | String | Location of iBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath
-| useTransactions | boolean | Whether to use transactions. This option is by default true.
+| Name | Group | Default | Java Type | Description
+| sqlMapClient | | | SqlMapClient | To use the given com.ibatis.sqlmap.client.SqlMapClient
+| sqlMapConfig | | classpath:SqlMapConfig.xml | String | Location of iBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath
+| useTransactions | | true | boolean | Whether to use transactions. This option is by default true.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jclouds/src/main/docs/jclouds-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jclouds/src/main/docs/jclouds-component.adoc b/components/camel-jclouds/src/main/docs/jclouds-component.adoc
index e6fdec8..db8202b 100644
--- a/components/camel-jclouds/src/main/docs/jclouds-component.adoc
+++ b/components/camel-jclouds/src/main/docs/jclouds-component.adoc
@@ -115,11 +115,11 @@ The JClouds component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| blobStores | List | To use the given BlobStore which must be configured when using blobstore.
-| computeServices | List | To use the given ComputeService which must be configured when use compute.
+| Name | Group | Default | Java Type | Description
+| blobStores | | | List | To use the given BlobStore which must be configured when using blobstore.
+| computeServices | | | List | To use the given ComputeService which must be configured when use compute.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jdbc/src/main/docs/jdbc-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jdbc/src/main/docs/jdbc-component.adoc b/components/camel-jdbc/src/main/docs/jdbc-component.adoc
index 1490dde..52a5c51 100644
--- a/components/camel-jdbc/src/main/docs/jdbc-component.adoc
+++ b/components/camel-jdbc/src/main/docs/jdbc-component.adoc
@@ -51,10 +51,10 @@ The JDBC component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| dataSource | DataSource | To use the DataSource instance instead of looking up the data source by name from the registry.
+| Name | Group | Default | Java Type | Description
+| dataSource | | | DataSource | To use the DataSource instance instead of looking up the data source by name from the registry.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jetty9/src/main/docs/jetty-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jetty9/src/main/docs/jetty-component.adoc b/components/camel-jetty9/src/main/docs/jetty-component.adoc
index 816be63..120be69 100644
--- a/components/camel-jetty9/src/main/docs/jetty-component.adoc
+++ b/components/camel-jetty9/src/main/docs/jetty-component.adoc
@@ -59,40 +59,40 @@ The Jetty 9 component supports 31 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| sslKeyPassword | String | The key password which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option).
-| sslPassword | String | The ssl password which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option).
-| keystore | String | Specifies the location of the Java keystore file which contains the Jetty server's own X.509 certificate in a key entry.
-| errorHandler | ErrorHandler | This option is used to set the ErrorHandler that Jetty server uses.
-| sslSocketConnectors | Map | A map which contains per port number specific SSL connectors.
-| socketConnectors | Map | A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors.
-| httpClientMinThreads | Integer | To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured.
-| httpClientMaxThreads | Integer | To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured.
-| minThreads | Integer | To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured.
-| maxThreads | Integer | To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured.
-| threadPool | ThreadPool | To use a custom thread pool for the server. This option should only be used in special circumstances.
-| enableJmx | boolean | If this option is true Jetty JMX support will be enabled for this endpoint.
-| jettyHttpBinding | JettyHttpBinding | To use a custom org.apache.camel.component.jetty.JettyHttpBinding which are used to customize how a response should be written for the producer.
-| httpBinding | HttpBinding | Not to be used - use JettyHttpBinding instead.
-| httpConfiguration | HttpConfiguration | Jetty component does not use HttpConfiguration.
-| mbContainer | MBeanContainer | To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans.
-| sslSocketConnectorProperties | Map | A map which contains general SSL connector properties.
-| socketConnectorProperties | Map | A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties.
-| continuationTimeout | Long | Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine.
-| useContinuation | boolean | Whether or not to use Jetty continuations for the Jetty Server.
-| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters
-| responseBufferSize | Integer | Allows to configure a custom value of the response buffer size on the Jetty connectors.
-| requestBufferSize | Integer | Allows to configure a custom value of the request buffer size on the Jetty connectors.
-| requestHeaderSize | Integer | Allows to configure a custom value of the request header size on the Jetty connectors.
-| responseHeaderSize | Integer | Allows to configure a custom value of the response header size on the Jetty connectors.
-| proxyHost | String | To use a http proxy to configure the hostname.
-| proxyPort | Integer | To use a http proxy to configure the port number.
-| useXForwardedForHeader | boolean | To use the X-Forwarded-For header in HttpServletRequest.getRemoteAddr.
-| sendServerVersion | boolean | If the option is true jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port otherwise this option may not work as expected.
-| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| sslKeyPassword | | | String | The key password which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option).
+| sslPassword | | | String | The ssl password which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option).
+| keystore | | | String | Specifies the location of the Java keystore file which contains the Jetty server's own X.509 certificate in a key entry.
+| errorHandler | | | ErrorHandler | This option is used to set the ErrorHandler that Jetty server uses.
+| sslSocketConnectors | | | Map | A map which contains per port number specific SSL connectors.
+| socketConnectors | | | Map | A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors.
+| httpClientMinThreads | | | Integer | To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured.
+| httpClientMaxThreads | | | Integer | To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured.
+| minThreads | | | Integer | To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured.
+| maxThreads | | | Integer | To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured.
+| threadPool | | | ThreadPool | To use a custom thread pool for the server. This option should only be used in special circumstances.
+| enableJmx | | | boolean | If this option is true Jetty JMX support will be enabled for this endpoint.
+| jettyHttpBinding | | | JettyHttpBinding | To use a custom org.apache.camel.component.jetty.JettyHttpBinding which are used to customize how a response should be written for the producer.
+| httpBinding | | | HttpBinding | Not to be used - use JettyHttpBinding instead.
+| httpConfiguration | | | HttpConfiguration | Jetty component does not use HttpConfiguration.
+| mbContainer | | | MBeanContainer | To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans.
+| sslSocketConnectorProperties | | | Map | A map which contains general SSL connector properties.
+| socketConnectorProperties | | | Map | A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties.
+| continuationTimeout | | 30000 | Long | Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine.
+| useContinuation | | true | boolean | Whether or not to use Jetty continuations for the Jetty Server.
+| sslContextParameters | | | SSLContextParameters | To configure security using SSLContextParameters
+| responseBufferSize | | | Integer | Allows to configure a custom value of the response buffer size on the Jetty connectors.
+| requestBufferSize | | | Integer | Allows to configure a custom value of the request buffer size on the Jetty connectors.
+| requestHeaderSize | | | Integer | Allows to configure a custom value of the request header size on the Jetty connectors.
+| responseHeaderSize | | | Integer | Allows to configure a custom value of the response header size on the Jetty connectors.
+| proxyHost | | | String | To use a http proxy to configure the hostname.
+| proxyPort | | | Integer | To use a http proxy to configure the port number.
+| useXForwardedForHeader | | | boolean | To use the X-Forwarded-For header in HttpServletRequest.getRemoteAddr.
+| sendServerVersion | | true | boolean | If the option is true jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port otherwise this option may not work as expected.
+| allowJavaSerializedObject | | | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jgroups/src/main/docs/jgroups-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jgroups/src/main/docs/jgroups-component.adoc b/components/camel-jgroups/src/main/docs/jgroups-component.adoc
index 0df57f8..01e4832 100644
--- a/components/camel-jgroups/src/main/docs/jgroups-component.adoc
+++ b/components/camel-jgroups/src/main/docs/jgroups-component.adoc
@@ -60,12 +60,12 @@ The JGroups component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| channel | Channel | Channel to use
-| channelProperties | String | Specifies configuration properties of the JChannel used by the endpoint.
-| enableViewMessages | boolean | If set to true the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint.
+| Name | Group | Default | Java Type | Description
+| channel | | | Channel | Channel to use
+| channelProperties | | | String | Specifies configuration properties of the JChannel used by the endpoint.
+| enableViewMessages | | | boolean | If set to true the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jms/src/main/docs/jms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc
index 3315299..07fdaa8 100644
--- a/components/camel-jms/src/main/docs/jms-component.adoc
+++ b/components/camel-jms/src/main/docs/jms-component.adoc
@@ -219,83 +219,83 @@ The JMS component supports 74 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | JmsConfiguration | To use a shared JMS configuration
-| acceptMessagesWhileStopping | boolean | 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.
-| allowReplyManagerQuickStop | boolean | 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.
-| acknowledgementMode | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead.
-| eagerLoadingOfProperties | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties
-| acknowledgementModeName | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
-| autoStartup | boolean | Specifies whether the consumer container should auto-startup.
-| cacheLevel | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
-| cacheLevelName | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.
-| replyToCacheLevelName | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION.
-| clientId | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead.
-| concurrentConsumers | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
-| replyToConcurrentConsumers | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
-| connectionFactory | ConnectionFactory | The connection factory to be use. A connection factory must be configured either on the component or endpoint.
-| username | String | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
-| password | String | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
-| deliveryPersistent | boolean | Specifies whether persistent delivery is used by default.
-| deliveryMode | Integer | Specifies the delivery mode to be used. Possible values are Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
-| durableSubscriptionName | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
-| exceptionListener | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
-| errorHandler | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler.
-| errorHandlerLoggingLevel | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
-| errorHandlerLogStackTrace | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
-| explicitQosEnabled | boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers.
-| exposeListenerSession | boolean | Specifies whether the listener session should be exposed when consuming messages.
-| idleTaskExecutionLimit | int | Specifies the limit for idle executions of a receive task not having received any message within its execution. If this limit is reached the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring.
-| idleConsumerLimit | int | Specify the limit for the number of consumers that are allowed to be idle at any given time.
-| maxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
-| replyToMaxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
-| replyOnTimeoutToMaxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
-| maxMessagesPerTask | int | The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max) then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required.
-| messageConverter | MessageConverter | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message.
-| mapJmsMessage | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
-| messageIdEnabled | boolean | When sending specifies whether message IDs should be added. This is just an hint to the JMS Broker. If the JMS provider accepts this hint these messages must have the message ID set to null; if the provider ignores the hint the message ID must be set to its normal unique value
-| messageTimestampEnabled | boolean | Specifies whether timestamps should be enabled by default on sending messages.
-| alwaysCopyMessage | boolean | If true Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations such as when a replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a replyToDestinationSelectorName is set)
-| useMessageIDAsCorrelationID | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
-| priority | int | Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect.
-| pubSubNoLocal | boolean | Specifies whether to inhibit the delivery of messages published by its own connection.
-| receiveTimeout | long | The timeout for receiving messages (in milliseconds).
-| recoveryInterval | long | 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.
-| subscriptionDurable | boolean | Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId.
-| taskExecutor | TaskExecutor | Allows you to specify a custom task executor for consuming messages.
-| timeToLive | long | When sending messages specifies the time-to-live of the message (in milliseconds).
-| transacted | boolean | Specifies whether to use transacted mode
-| lazyCreateTransactionManager | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true.
-| transactionManager | PlatformTransactionManager | The Spring transaction manager to use.
-| transactionName | String | The name of the transaction to use.
-| transactionTimeout | int | The timeout value of the transaction (in seconds) if using transacted mode.
-| testConnectionOnStartup | boolean | 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.
-| asyncStartListener | boolean | Whether to startup the JmsConsumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry.
-| asyncStopListener | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route.
-| forceSendOriginalMessage | boolean | When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received.
-| requestTimeout | long | The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option.
-| requestTimeoutCheckerInterval | long | Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs then you can lower this interval to check more frequently. The timeout is determined by the option requestTimeout.
-| transferExchange | boolean | You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body Out body Fault body In headers Out headers Fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side so Camel knows the payloads is an Exchange and not a regular payload.
-| transferException | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer.
-| transferFault | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side then the fault flag on link org.apache.camel.MessageisFault() will be send back in the response as a JMS header with the key link JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.
-| jmsOperations | JmsOperations | Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface. Camel uses JmsTemplate as default. Can be used for testing purpose but not used much as stated in the spring API docs.
-| destinationResolver | DestinationResolver | A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example to lookup the real destination in a JNDI registry).
-| replyToType | ReplyToType | Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary Shared or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details and especially the notes about the implications if running in a clustered environment and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive.
-| preserveMessageQos | boolean | Set to true if you want to send message using the QoS settings specified on the message instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority JMSDeliveryMode and JMSExpiration. You can provide all or only some of them. If not provided Camel will fall back to use the values from the endpoint instead. So when using this option the headers override the values from the endpoint. The explicitQosEnabled option by contrast will only use options set on the endpoint and not values from the message header.
-| asyncConsumer | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions).
-| allowNullBody | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
-| includeSentJMSMessageID | boolean | Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination.
-| includeAllJMSXProperties | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply.
-| defaultTaskExecutorType | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set it defaults to the previous behaviour which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers.
-| jmsKeyFormatStrategy | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
-| applicationContext | ApplicationContext | Sets the Spring ApplicationContext to use
-| queueBrowseStrategy | QueueBrowseStrategy | To use a custom QueueBrowseStrategy when browsing queues
-| messageCreatedStrategy | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
-| waitForProvisionCorrelationToBeUpdatedCounter | int | 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.
-| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| configuration | | | JmsConfiguration | To use a shared JMS configuration
+| acceptMessagesWhileStopping | | | boolean | 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.
+| allowReplyManagerQuickStop | | | boolean | 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.
+| acknowledgementMode | | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead.
+| eagerLoadingOfProperties | | | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties
+| acknowledgementModeName | | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
+| autoStartup | | true | boolean | Specifies whether the consumer container should auto-startup.
+| cacheLevel | | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
+| cacheLevelName | | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.
+| replyToCacheLevelName | | | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION.
+| clientId | | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead.
+| concurrentConsumers | | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
+| replyToConcurrentConsumers | | 1 | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
+| connectionFactory | | | ConnectionFactory | The connection factory to be use. A connection factory must be configured either on the component or endpoint.
+| username | | | String | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
+| password | | | String | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
+| deliveryPersistent | | true | boolean | Specifies whether persistent delivery is used by default.
+| deliveryMode | | | Integer | Specifies the delivery mode to be used. Possible values are Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
+| durableSubscriptionName | | | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
+| exceptionListener | | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
+| errorHandler | | | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler.
+| errorHandlerLoggingLevel | | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
+| errorHandlerLogStackTrace | | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
+| explicitQosEnabled | | false | boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers.
+| exposeListenerSession | | | boolean | Specifies whether the listener session should be exposed when consuming messages.
+| idleTaskExecutionLimit | | 1 | int | Specifies the limit for idle executions of a receive task not having received any message within its execution. If this limit is reached the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring.
+| idleConsumerLimit | | 1 | int | Specify the limit for the number of consumers that are allowed to be idle at any given time.
+| maxConcurrentConsumers | | | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
+| replyToMaxConcurrentConsumers | | | int | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
+| replyOnTimeoutToMaxConcurrentConsumers | | 1 | int | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
+| maxMessagesPerTask | | -1 | int | The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max) then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required.
+| messageConverter | | | MessageConverter | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message.
+| mapJmsMessage | | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
+| messageIdEnabled | | true | boolean | When sending specifies whether message IDs should be added. This is just an hint to the JMS Broker. If the JMS provider accepts this hint these messages must have the message ID set to null; if the provider ignores the hint the message ID must be set to its normal unique value
+| messageTimestampEnabled | | true | boolean | Specifies whether timestamps should be enabled by default on sending messages.
+| alwaysCopyMessage | | | boolean | If true Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations such as when a replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a replyToDestinationSelectorName is set)
+| useMessageIDAsCorrelationID | | | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
+| priority | | 4 | int | Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect.
+| pubSubNoLocal | | | boolean | Specifies whether to inhibit the delivery of messages published by its own connection.
+| receiveTimeout | | 1000 | long | The timeout for receiving messages (in milliseconds).
+| recoveryInterval | | 5000 | long | 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.
+| subscriptionDurable | | | boolean | Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId.
+| taskExecutor | | | TaskExecutor | Allows you to specify a custom task executor for consuming messages.
+| timeToLive | | -1 | long | When sending messages specifies the time-to-live of the message (in milliseconds).
+| transacted | | | boolean | Specifies whether to use transacted mode
+| lazyCreateTransactionManager | | true | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true.
+| transactionManager | | | PlatformTransactionManager | The Spring transaction manager to use.
+| transactionName | | | String | The name of the transaction to use.
+| transactionTimeout | | -1 | int | The timeout value of the transaction (in seconds) if using transacted mode.
+| testConnectionOnStartup | | | boolean | 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.
+| asyncStartListener | | | boolean | Whether to startup the JmsConsumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry.
+| asyncStopListener | | | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route.
+| forceSendOriginalMessage | | | boolean | When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received.
+| requestTimeout | | 20000 | long | The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option.
+| requestTimeoutCheckerInterval | | 1000 | long | Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs then you can lower this interval to check more frequently. The timeout is determined by the option requestTimeout.
+| transferExchange | | | boolean | You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body Out body Fault body In headers Out headers Fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side so Camel knows the payloads is an Exchange and not a regular payload.
+| transferException | | | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer.
+| transferFault | | | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side then the fault flag on link org.apache.camel.MessageisFault() will be send back in the response as a JMS header with the key link JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.
+| jmsOperations | | | JmsOperations | Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface. Camel uses JmsTemplate as default. Can be used for testing purpose but not used much as stated in the spring API docs.
+| destinationResolver | | | DestinationResolver | A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example to lookup the real destination in a JNDI registry).
+| replyToType | | | ReplyToType | Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary Shared or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details and especially the notes about the implications if running in a clustered environment and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive.
+| preserveMessageQos | | | boolean | Set to true if you want to send message using the QoS settings specified on the message instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority JMSDeliveryMode and JMSExpiration. You can provide all or only some of them. If not provided Camel will fall back to use the values from the endpoint instead. So when using this option the headers override the values from the endpoint. The explicitQosEnabled option by contrast will only use options set on the endpoint and not values from the message header.
+| asyncConsumer | | | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions).
+| allowNullBody | | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
+| includeSentJMSMessageID | | | boolean | Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination.
+| includeAllJMSXProperties | | | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply.
+| defaultTaskExecutorType | | | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set it defaults to the previous behaviour which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers.
+| jmsKeyFormatStrategy | | | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
+| applicationContext | | | ApplicationContext | Sets the Spring ApplicationContext to use
+| queueBrowseStrategy | | | QueueBrowseStrategy | To use a custom QueueBrowseStrategy when browsing queues
+| messageCreatedStrategy | | | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
+| waitForProvisionCorrelationToBeUpdatedCounter | | 50 | int | 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.
+| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | | 100 | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
@@ -320,7 +320,7 @@ Endpoint options
// endpoint options: START
-The JMS component supports 84 endpoint options which are listed below:
+The JMS component supports 85 endpoint options which are listed below:
{% raw %}
[width="100%",cols="2,1,1m,1m,5",options="header"]
@@ -338,6 +338,7 @@ The JMS component supports 84 endpoint options which are listed below:
| asyncConsumer | consumer | false | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions).
| autoStartup | consumer | true | boolean | Specifies whether the consumer container should auto-startup.
| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| cacheLevel | consumer | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
| cacheLevelName | consumer | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.
| concurrentConsumers | consumer | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
| maxConcurrentConsumers | consumer | | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
index 749d018..82d100d 100644
--- a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
+++ b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
@@ -283,7 +283,7 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
*/
- @Metadata(label = "consumer", defaultValue = "true",
+ @Metadata(label = "consumer",
description = "Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.")
public void setCacheLevel(int cacheLevel) {
getConfiguration().setCacheLevel(cacheLevel);
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
index be84a8a..5c8e20f 100644
--- a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
+++ b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
@@ -153,6 +153,7 @@ public class JmsConfiguration implements Cloneable {
+ " If you use a range for concurrent consumers (eg min < max), then this option can be used to set"
+ " a value to eg 100 to control how fast the consumers will shrink when less work is required.")
private int maxMessagesPerTask = -1;
+ @UriParam(label = "consumer", description = "Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.")
private int cacheLevel = -1;
@UriParam(defaultValue = "CACHE_AUTO", enums = "CACHE_AUTO,CACHE_CONNECTION,CACHE_CONSUMER,CACHE_NONE,CACHE_SESSION", label = "consumer",
description = "Sets the cache level by name for the underlying JMS resources."
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jolt/src/main/docs/jolt-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jolt/src/main/docs/jolt-component.adoc b/components/camel-jolt/src/main/docs/jolt-component.adoc
index aac994e..8e37ba6 100644
--- a/components/camel-jolt/src/main/docs/jolt-component.adoc
+++ b/components/camel-jolt/src/main/docs/jolt-component.adoc
@@ -52,10 +52,10 @@ The JOLT component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| transform | Transform | Explicitly sets the Transform to use. If not set a Transform specified by the transformDsl will be created
+| Name | Group | Default | Java Type | Description
+| transform | | | Transform | Explicitly sets the Transform to use. If not set a Transform specified by the transformDsl will be created
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jpa/src/main/docs/jpa-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jpa/src/main/docs/jpa-component.adoc b/components/camel-jpa/src/main/docs/jpa-component.adoc
index 86d2e28..73f6f5b 100644
--- a/components/camel-jpa/src/main/docs/jpa-component.adoc
+++ b/components/camel-jpa/src/main/docs/jpa-component.adoc
@@ -97,13 +97,13 @@ The JPA component supports 4 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| entityManagerFactory | EntityManagerFactory | To use the EntityManagerFactory. This is strongly recommended to configure.
-| transactionManager | PlatformTransactionManager | To use the PlatformTransactionManager for managing transactions.
-| joinTransaction | boolean | The camel-jpa component will join transaction by default. You can use this option to turn this off for example if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent instead of having to set it on all endpoints.
-| sharedEntityManager | boolean | Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases joinTransaction should be set to false as this is not an EXTENDED EntityManager.
+| Name | Group | Default | Java Type | Description
+| entityManagerFactory | | | EntityManagerFactory | To use the EntityManagerFactory. This is strongly recommended to configure.
+| transactionManager | | | PlatformTransactionManager | To use the PlatformTransactionManager for managing transactions.
+| joinTransaction | | true | boolean | The camel-jpa component will join transaction by default. You can use this option to turn this off for example if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent instead of having to set it on all endpoints.
+| sharedEntityManager | | | boolean | Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases joinTransaction should be set to false as this is not an EXTENDED EntityManager.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jsch/src/main/docs/scp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jsch/src/main/docs/scp-component.adoc b/components/camel-jsch/src/main/docs/scp-component.adoc
index b6e615b..d895d43 100644
--- a/components/camel-jsch/src/main/docs/scp-component.adoc
+++ b/components/camel-jsch/src/main/docs/scp-component.adoc
@@ -50,10 +50,10 @@ The SCP component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| verboseLogging | boolean | JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again.
+| Name | Group | Default | Java Type | Description
+| verboseLogging | | | boolean | JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-jt400/src/main/docs/jt400-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jt400/src/main/docs/jt400-component.adoc b/components/camel-jt400/src/main/docs/jt400-component.adoc
index 9994714..f08d72c 100644
--- a/components/camel-jt400/src/main/docs/jt400-component.adoc
+++ b/components/camel-jt400/src/main/docs/jt400-component.adoc
@@ -47,10 +47,10 @@ The JT400 component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| connectionPool | AS400ConnectionPool | Returns the default connection pool used by this component.
+| Name | Group | Default | Java Type | Description
+| connectionPool | | | AS400ConnectionPool | Returns the default connection pool used by this component.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-kafka/src/main/docs/kafka-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-kafka/src/main/docs/kafka-component.adoc b/components/camel-kafka/src/main/docs/kafka-component.adoc
index 3966f5d..db42f60 100644
--- a/components/camel-kafka/src/main/docs/kafka-component.adoc
+++ b/components/camel-kafka/src/main/docs/kafka-component.adoc
@@ -68,10 +68,10 @@ The Kafka component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| workerPool | ExecutorService | To use a shared custom worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing. If using this option then you must handle the lifecycle of the thread pool to shut the pool down when no longer needed.
+| Name | Group | Default | Java Type | Description
+| workerPool | | | ExecutorService | To use a shared custom worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing. If using this option then you must handle the lifecycle of the thread pool to shut the pool down when no longer needed.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-kestrel/src/main/docs/kestrel-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-kestrel/src/main/docs/kestrel-component.adoc b/components/camel-kestrel/src/main/docs/kestrel-component.adoc
index 4eb0c4d..fb6aff4 100644
--- a/components/camel-kestrel/src/main/docs/kestrel-component.adoc
+++ b/components/camel-kestrel/src/main/docs/kestrel-component.adoc
@@ -75,10 +75,10 @@ The Kestrel component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | KestrelConfiguration | To use a shared configured configuration as base for creating new endpoints.
+| Name | Group | Default | Java Type | Description
+| configuration | | | KestrelConfiguration | To use a shared configured configuration as base for creating new endpoints.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
index 5a1bdbb..1e4f250 100644
--- a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
+++ b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
@@ -63,10 +63,10 @@ The Linkedin component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | LinkedInConfiguration | To use the shared configuration
+| Name | Group | Default | Java Type | Description
+| configuration | | | LinkedInConfiguration | To use the shared configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-lucene/src/main/docs/lucene-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-lucene/src/main/docs/lucene-component.adoc b/components/camel-lucene/src/main/docs/lucene-component.adoc
index 86a06e2..25e1ddd 100644
--- a/components/camel-lucene/src/main/docs/lucene-component.adoc
+++ b/components/camel-lucene/src/main/docs/lucene-component.adoc
@@ -62,10 +62,10 @@ The Lucene component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| config | LuceneConfiguration | To use a shared lucene configuration
+| Name | Group | Default | Java Type | Description
+| config | | | LuceneConfiguration | To use a shared lucene configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
index f7d1833..e2ae0a0 100644
--- a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
+++ b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
@@ -48,10 +48,10 @@ The Lumberjack component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| sslContextParameters | SSLContextParameters | Sets the default SSL configuration to use for all the endpoints. You can also configure it directly at the endpoint level.
+| Name | Group | Default | Java Type | Description
+| sslContextParameters | | | SSLContextParameters | Sets the default SSL configuration to use for all the endpoints. You can also configure it directly at the endpoint level.
|=======================================================================
{% endraw %}
// component options: END
[8/8] camel git commit: CAMEL-10636: Component options docs - Include
more details like endpoint options.
Posted by da...@apache.org.
CAMEL-10636: Component options docs - Include more details like endpoint options.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/1fd504a1
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/1fd504a1
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/1fd504a1
Branch: refs/heads/master
Commit: 1fd504a1253b5e9c0fe83cfd2c2aeeec1f44e1dd
Parents: bba84aa
Author: Claus Ibsen <da...@apache.org>
Authored: Wed Dec 21 20:53:56 2016 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Wed Dec 21 20:53:56 2016 +0100
----------------------------------------------------------------------
camel-core/src/main/docs/direct-component.adoc | 8 +-
.../src/main/docs/direct-vm-component.adoc | 12 +-
camel-core/src/main/docs/log-component.adoc | 6 +-
.../src/main/docs/properties-component.adoc | 36 ++---
camel-core/src/main/docs/rest-component.adoc | 10 +-
.../src/main/docs/scheduler-component.adoc | 6 +-
camel-core/src/main/docs/seda-component.adoc | 10 +-
camel-core/src/main/docs/stub-component.adoc | 10 +-
.../src/main/docs/validator-component.adoc | 6 +-
camel-core/src/main/docs/vm-component.adoc | 10 +-
camel-core/src/main/docs/xslt-component.adoc | 14 +-
.../springboot/AMQPComponentConfiguration.java | 123 ++++++++-------
.../springboot/JmsComponentConfiguration.java | 2 +-
.../src/main/docs/ahc-ws-component.adoc | 16 +-
.../camel-ahc/src/main/docs/ahc-component.adoc | 16 +-
.../src/main/docs/amqp-component.adoc | 158 ++++++++++---------
.../src/main/docs/apns-component.adoc | 6 +-
.../docs/atmosphere-websocket-component.adoc | 18 +--
.../src/main/docs/avro-component.adoc | 6 +-
.../src/main/docs/beanstalk-component.adoc | 6 +-
.../camel-box/src/main/docs/box-component.adoc | 6 +-
.../src/main/docs/braintree-component.adoc | 6 +-
.../src/main/docs/cache-component.adoc | 10 +-
.../src/main/docs/cometd-component.adoc | 16 +-
.../src/main/docs/crypto-component.adoc | 6 +-
.../camel-cxf/src/main/docs/cxf-component.adoc | 8 +-
.../src/main/docs/cxfrs-component.adoc | 6 +-
.../src/main/docs/disruptor-component.adoc | 18 +--
.../src/main/docs/docker-component.adoc | 6 +-
.../camel-ejb/src/main/docs/ejb-component.adoc | 8 +-
.../src/main/docs/elasticsearch-component.adoc | 6 +-
.../src/main/docs/elsql-component.adoc | 12 +-
.../src/main/docs/eventadmin-component.adoc | 6 +-
.../src/main/docs/facebook-component.adoc | 6 +-
.../src/main/docs/flink-component.adoc | 12 +-
.../src/main/docs/freemarker-component.adoc | 6 +-
.../src/main/docs/ganglia-component.adoc | 6 +-
.../main/docs/google-calendar-component.adoc | 8 +-
.../src/main/docs/google-drive-component.adoc | 8 +-
.../src/main/docs/google-mail-component.adoc | 8 +-
.../src/main/docs/google-pubsub-component.adoc | 6 +-
.../src/main/docs/guava-eventbus-component.adoc | 8 +-
.../src/main/docs/hazelcast-component.adoc | 6 +-
.../src/main/docs/hbase-component.adoc | 8 +-
.../src/main/docs/hdfs-component.adoc | 6 +-
.../src/main/docs/hdfs2-component.adoc | 6 +-
.../src/main/docs/http-component.adoc | 16 +-
.../src/main/docs/http4-component.adoc | 30 ++--
.../src/main/docs/ibatis-component.adoc | 10 +-
.../src/main/docs/jclouds-component.adoc | 8 +-
.../src/main/docs/jdbc-component.adoc | 6 +-
.../src/main/docs/jetty-component.adoc | 66 ++++----
.../src/main/docs/jgroups-component.adoc | 10 +-
.../camel-jms/src/main/docs/jms-component.adoc | 155 +++++++++---------
.../camel/component/jms/JmsComponent.java | 2 +-
.../camel/component/jms/JmsConfiguration.java | 1 +
.../src/main/docs/jolt-component.adoc | 6 +-
.../camel-jpa/src/main/docs/jpa-component.adoc | 12 +-
.../camel-jsch/src/main/docs/scp-component.adoc | 6 +-
.../src/main/docs/jt400-component.adoc | 6 +-
.../src/main/docs/kafka-component.adoc | 6 +-
.../src/main/docs/kestrel-component.adoc | 6 +-
.../src/main/docs/linkedin-component.adoc | 6 +-
.../src/main/docs/lucene-component.adoc | 6 +-
.../src/main/docs/lumberjack-component.adoc | 6 +-
.../src/main/docs/mail-component.adoc | 8 +-
.../src/main/docs/metrics-component.adoc | 6 +-
.../src/main/docs/mina-component.adoc | 6 +-
.../src/main/docs/mina2-component.adoc | 6 +-
.../src/main/docs/mqtt-component.adoc | 10 +-
.../camel-msv/src/main/docs/msv-component.adoc | 8 +-
.../src/main/docs/mustache-component.adoc | 6 +-
.../src/main/docs/mybatis-component.adoc | 8 +-
.../src/main/docs/nagios-component.adoc | 6 +-
.../src/main/docs/netty-http-component.adoc | 14 +-
.../src/main/docs/netty-component.adoc | 8 +-
.../src/main/docs/netty4-http-component.adoc | 16 +-
.../src/main/docs/netty4-component.adoc | 10 +-
.../src/main/docs/olingo2-component.adoc | 6 +-
.../src/main/docs/openshift-component.adoc | 12 +-
.../src/main/docs/paho-component.adoc | 10 +-
.../src/main/docs/paxlogging-component.adoc | 6 +-
.../src/main/docs/quartz-component.adoc | 18 +--
.../src/main/docs/quartz2-component.adoc | 22 +--
.../src/main/docs/quickfix-component.adoc | 14 +-
.../src/main/docs/restlet-component.adoc | 44 +++---
.../src/main/docs/salesforce-component.adoc | 36 ++---
.../src/main/docs/xquery-component.adoc | 6 +-
.../src/main/docs/servicenow-component.adoc | 18 +--
.../src/main/docs/servlet-component.adoc | 18 +--
.../src/main/docs/sjms-batch-component.adoc | 8 +-
.../src/main/docs/sjms-component.adoc | 22 +--
.../src/main/docs/slack-component.adoc | 6 +-
.../src/main/docs/smpp-component.adoc | 6 +-
.../src/main/docs/spark-rest-component.adoc | 26 +--
.../src/main/docs/spark-component.adoc | 8 +-
.../src/main/docs/splunk-component.adoc | 6 +-
.../src/main/docs/spring-batch-component.adoc | 8 +-
.../src/main/docs/spring-event-component.adoc | 6 +-
.../camel-sql/src/main/docs/sql-component.adoc | 8 +-
.../src/main/docs/sql-stored-component.adoc | 6 +-
.../camel-ssh/src/main/docs/ssh-component.adoc | 26 +--
.../src/main/docs/stomp-component.adoc | 14 +-
.../src/main/docs/telegram-component.adoc | 6 +-
.../src/main/docs/twitter-component.adoc | 20 +--
.../src/main/docs/undertow-component.adoc | 8 +-
.../src/main/docs/velocity-component.adoc | 6 +-
.../src/main/docs/vertx-component.adoc | 16 +-
.../src/main/docs/websocket-component.adoc | 28 ++--
.../src/main/docs/xmlsecurity-component.adoc | 8 +-
.../src/main/docs/yammer-component.adoc | 12 +-
.../src/main/docs/zookeeper-component.adoc | 6 +-
components/readme.adoc | 24 ---
docs/user-manual/en/SUMMARY.md | 8 -
.../maven/packaging/ReadmeComponentMojo.java | 8 +
.../packaging/model/ComponentOptionModel.java | 18 +++
.../src/main/resources/component-options.mvel | 6 +-
117 files changed, 851 insertions(+), 846 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/direct-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/direct-component.adoc b/camel-core/src/main/docs/direct-component.adoc
index b14afc2..e383065 100644
--- a/camel-core/src/main/docs/direct-component.adoc
+++ b/camel-core/src/main/docs/direct-component.adoc
@@ -38,11 +38,11 @@ The Direct component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| block | boolean | If sending a message to a direct endpoint which has no active consumer then we can tell the producer to block and wait for the consumer to become active.
-| timeout | long | The timeout value to use if block is enabled.
+| Name | Group | Default | Java Type | Description
+| block | | | boolean | If sending a message to a direct endpoint which has no active consumer then we can tell the producer to block and wait for the consumer to become active.
+| timeout | | 30000 | long | The timeout value to use if block is enabled.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/direct-vm-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/direct-vm-component.adoc b/camel-core/src/main/docs/direct-vm-component.adoc
index 1895e65..a6122be 100644
--- a/camel-core/src/main/docs/direct-vm-component.adoc
+++ b/camel-core/src/main/docs/direct-vm-component.adoc
@@ -51,13 +51,13 @@ The Direct VM component supports 4 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| block | boolean | If sending a message to a direct endpoint which has no active consumer then we can tell the producer to block and wait for the consumer to become active.
-| timeout | long | The timeout value to use if block is enabled.
-| headerFilterStrategy | HeaderFilterStrategy | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none.
-| propagateProperties | boolean | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true.
+| Name | Group | Default | Java Type | Description
+| block | | | boolean | If sending a message to a direct endpoint which has no active consumer then we can tell the producer to block and wait for the consumer to become active.
+| timeout | | 30000 | long | The timeout value to use if block is enabled.
+| headerFilterStrategy | | | HeaderFilterStrategy | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none.
+| propagateProperties | | true | boolean | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/log-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/log-component.adoc b/camel-core/src/main/docs/log-component.adoc
index e23b558..43c9d76 100644
--- a/camel-core/src/main/docs/log-component.adoc
+++ b/camel-core/src/main/docs/log-component.adoc
@@ -65,10 +65,10 @@ The Log component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| exchangeFormatter | ExchangeFormatter | Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging. If not specified we default to DefaultExchangeFormatter.
+| Name | Group | Default | Java Type | Description
+| exchangeFormatter | | | ExchangeFormatter | Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging. If not specified we default to DefaultExchangeFormatter.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/properties-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/properties-component.adoc b/camel-core/src/main/docs/properties-component.adoc
index 0a6f4a9..291be88 100644
--- a/camel-core/src/main/docs/properties-component.adoc
+++ b/camel-core/src/main/docs/properties-component.adoc
@@ -25,25 +25,25 @@ The Properties component supports 16 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| locations | List | A list of locations to load properties. This option will override any default locations and only use the locations from this option.
-| location | String | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option.
-| encoding | String | Encoding to use when loading properties file from the file system or classpath. If no encoding has been set then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by link java.util.Propertiesload(java.io.InputStream)
-| propertiesResolver | PropertiesResolver | To use a custom PropertiesResolver
-| propertiesParser | PropertiesParser | To use a custom PropertiesParser
-| cache | boolean | Whether or not to cache loaded properties. The default value is true.
-| propertyPrefix | String | Optional prefix prepended to property names before resolution.
-| propertySuffix | String | Optional suffix appended to property names before resolution.
-| fallbackToUnaugmentedProperty | boolean | If true first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified. If false only the augmented property name is searched.
-| defaultFallbackEnabled | boolean | If false the component does not attempt to find a default for the key by looking after the colon separator.
-| ignoreMissingLocation | boolean | Whether to silently ignore if a location cannot be located such as a properties file not found.
-| prefixToken | String | Sets the value of the prefix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_PREFIX_TOKEN).
-| suffixToken | String | Sets the value of the suffix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_SUFFIX_TOKEN).
-| initialProperties | Properties | Sets initial properties which will be used before any locations are resolved.
-| overrideProperties | Properties | Sets a special list of override properties that take precedence and will use first if a property exist.
-| systemPropertiesMode | int | Sets the system property mode.
+| Name | Group | Default | Java Type | Description
+| locations | | | List | A list of locations to load properties. This option will override any default locations and only use the locations from this option.
+| location | | | String | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option.
+| encoding | | | String | Encoding to use when loading properties file from the file system or classpath. If no encoding has been set then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by link java.util.Propertiesload(java.io.InputStream)
+| propertiesResolver | | | PropertiesResolver | To use a custom PropertiesResolver
+| propertiesParser | | | PropertiesParser | To use a custom PropertiesParser
+| cache | | | boolean | Whether or not to cache loaded properties. The default value is true.
+| propertyPrefix | | | String | Optional prefix prepended to property names before resolution.
+| propertySuffix | | | String | Optional suffix appended to property names before resolution.
+| fallbackToUnaugmentedProperty | | | boolean | If true first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified. If false only the augmented property name is searched.
+| defaultFallbackEnabled | | | boolean | If false the component does not attempt to find a default for the key by looking after the colon separator.
+| ignoreMissingLocation | | | boolean | Whether to silently ignore if a location cannot be located such as a properties file not found.
+| prefixToken | | | String | Sets the value of the prefix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_PREFIX_TOKEN).
+| suffixToken | | | String | Sets the value of the suffix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_SUFFIX_TOKEN).
+| initialProperties | | | Properties | Sets initial properties which will be used before any locations are resolved.
+| overrideProperties | | | Properties | Sets a special list of override properties that take precedence and will use first if a property exist.
+| systemPropertiesMode | | | int | Sets the system property mode.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/rest-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/rest-component.adoc b/camel-core/src/main/docs/rest-component.adoc
index d7396c9..791ddbb 100644
--- a/camel-core/src/main/docs/rest-component.adoc
+++ b/camel-core/src/main/docs/rest-component.adoc
@@ -29,12 +29,12 @@ The REST component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| componentName | String | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory (consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered in the registry. If either one is found then that is being used.
-| apiDoc | String | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format.
-| host | String | Host and port of HTTP service to use (override host in swagger schema)
+| Name | Group | Default | Java Type | Description
+| componentName | | | String | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory (consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered in the registry. If either one is found then that is being used.
+| apiDoc | | | String | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format.
+| host | | | String | Host and port of HTTP service to use (override host in swagger schema)
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/scheduler-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/scheduler-component.adoc b/camel-core/src/main/docs/scheduler-component.adoc
index 8c67b61..989225e 100644
--- a/camel-core/src/main/docs/scheduler-component.adoc
+++ b/camel-core/src/main/docs/scheduler-component.adoc
@@ -42,10 +42,10 @@ The Scheduler component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| concurrentTasks | int | Number of threads used by the scheduling thread pool. Is by default using a single thread
+| Name | Group | Default | Java Type | Description
+| concurrentTasks | | 1 | int | Number of threads used by the scheduling thread pool. Is by default using a single thread
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/seda-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/seda-component.adoc b/camel-core/src/main/docs/seda-component.adoc
index dd177b7..00307d0 100644
--- a/camel-core/src/main/docs/seda-component.adoc
+++ b/camel-core/src/main/docs/seda-component.adoc
@@ -47,12 +47,12 @@ The SEDA component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| queueSize | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
-| concurrentConsumers | int | Sets the default number of concurrent threads processing exchanges.
-| defaultQueueFactory | Exchange> | Sets the default queue factory.
+| Name | Group | Default | Java Type | Description
+| queueSize | | | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
+| concurrentConsumers | | 1 | int | Sets the default number of concurrent threads processing exchanges.
+| defaultQueueFactory | | | Exchange> | Sets the default queue factory.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/stub-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/stub-component.adoc b/camel-core/src/main/docs/stub-component.adoc
index 7400187..e7bf421 100644
--- a/camel-core/src/main/docs/stub-component.adoc
+++ b/camel-core/src/main/docs/stub-component.adoc
@@ -39,12 +39,12 @@ The Stub component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| queueSize | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
-| concurrentConsumers | int | Sets the default number of concurrent threads processing exchanges.
-| defaultQueueFactory | Exchange> | Sets the default queue factory.
+| Name | Group | Default | Java Type | Description
+| queueSize | | | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
+| concurrentConsumers | | 1 | int | Sets the default number of concurrent threads processing exchanges.
+| defaultQueueFactory | | | Exchange> | Sets the default queue factory.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/validator-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/validator-component.adoc b/camel-core/src/main/docs/validator-component.adoc
index 6bc38cd..8ac1e35 100644
--- a/camel-core/src/main/docs/validator-component.adoc
+++ b/camel-core/src/main/docs/validator-component.adoc
@@ -61,10 +61,10 @@ The Validator component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| resourceResolverFactory | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI
+| Name | Group | Default | Java Type | Description
+| resourceResolverFactory | | | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/vm-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/vm-component.adoc b/camel-core/src/main/docs/vm-component.adoc
index b27fbfe..3939353 100644
--- a/camel-core/src/main/docs/vm-component.adoc
+++ b/camel-core/src/main/docs/vm-component.adoc
@@ -70,12 +70,12 @@ The VM component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| queueSize | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
-| concurrentConsumers | int | Sets the default number of concurrent threads processing exchanges.
-| defaultQueueFactory | Exchange> | Sets the default queue factory.
+| Name | Group | Default | Java Type | Description
+| queueSize | | | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
+| concurrentConsumers | | 1 | int | Sets the default number of concurrent threads processing exchanges.
+| defaultQueueFactory | | | Exchange> | Sets the default queue factory.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/xslt-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/xslt-component.adoc b/camel-core/src/main/docs/xslt-component.adoc
index ca7428d..3c10bbc 100644
--- a/camel-core/src/main/docs/xslt-component.adoc
+++ b/camel-core/src/main/docs/xslt-component.adoc
@@ -76,14 +76,14 @@ The XSLT component supports 5 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| xmlConverter | XmlConverter | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter
-| uriResolverFactory | XsltUriResolverFactory | To use a custom javax.xml.transform.URIResolver which depends on a dynamic endpoint resource URI or which is a subclass of XsltUriResolver. Do not use in combination with uriResolver. See also link setUriResolver(URIResolver).
-| uriResolver | URIResolver | To use a custom javax.xml.transform.URIResolver. Do not use in combination with uriResolverFactory. See also link setUriResolverFactory(XsltUriResolverFactory).
-| contentCache | boolean | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation.
-| saxon | boolean | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath.
+| Name | Group | Default | Java Type | Description
+| xmlConverter | | | XmlConverter | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter
+| uriResolverFactory | | | XsltUriResolverFactory | To use a custom javax.xml.transform.URIResolver which depends on a dynamic endpoint resource URI or which is a subclass of XsltUriResolver. Do not use in combination with uriResolver. See also link setUriResolver(URIResolver).
+| uriResolver | | | URIResolver | To use a custom javax.xml.transform.URIResolver. Do not use in combination with uriResolverFactory. See also link setUriResolverFactory(XsltUriResolverFactory).
+| contentCache | | true | boolean | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation.
+| saxon | | | boolean | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java b/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java
index 114bcc8..719141c 100644
--- a/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java
+++ b/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java
@@ -19,6 +19,7 @@ package org.apache.camel.component.amqp.springboot;
import javax.jms.ConnectionFactory;
import javax.jms.ExceptionListener;
import org.apache.camel.LoggingLevel;
+import org.apache.camel.component.amqp.AMQPComponent;
import org.apache.camel.component.jms.DefaultTaskExecutorType;
import org.apache.camel.component.jms.JmsConfiguration;
import org.apache.camel.component.jms.JmsKeyFormatStrategy;
@@ -53,7 +54,7 @@ public class AMQPComponentConfiguration {
/**
* 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 enqued on the queue. If this
+ * 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
@@ -73,7 +74,7 @@ public class AMQPComponentConfiguration {
private Boolean allowReplyManagerQuickStop;
/**
* The JMS acknowledgement mode defined as an Integer. Allows you to set
- * vendor-specific extensions to the acknowledgment mode. For the regular
+ * vendor-specific extensions to the acknowledgment mode.For the regular
* modes it is preferable to use the acknowledgementModeName instead.
*/
private Integer acknowledgementMode;
@@ -88,11 +89,11 @@ public class AMQPComponentConfiguration {
* The JMS acknowledgement name which is one of: SESSION_TRANSACTED
* CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
*/
- private String acknowledgementModeName;
+ private String acknowledgementModeName = "AUTO_ACKNOWLEDGE";
/**
* Specifies whether the consumer container should auto-startup.
*/
- private Boolean autoStartup;
+ private Boolean autoStartup = true;
/**
* Sets the cache level by ID for the underlying JMS resources. See
* cacheLevelName option for more details.
@@ -104,7 +105,7 @@ public class AMQPComponentConfiguration {
* CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring
* documentation and Transactions Cache Levels for more information.
*/
- private String cacheLevelName;
+ private String cacheLevelName = "CACHE_AUTO";
/**
* Sets the cache level by name for the reply consumer when doing
* request/reply over JMS. This option only applies when using fixed reply
@@ -130,15 +131,16 @@ public class AMQPComponentConfiguration {
* request/reply over JMS then the option replyToConcurrentConsumers is used
* to control number of concurrent consumers on the reply message listener.
*/
- private Integer concurrentConsumers;
+ private Integer concurrentConsumers = 1;
/**
* Specifies the default number of concurrent consumers when doing
* request/reply over JMS. See also the maxMessagesPerTask option to control
* dynamic scaling up/down of threads.
*/
- private Integer replyToConcurrentConsumers;
+ private Integer replyToConcurrentConsumers = 1;
/**
- * Sets the default connection factory to be use
+ * The connection factory to be use. A connection factory must be configured
+ * either on the component or endpoint.
*/
private ConnectionFactory connectionFactory;
/**
@@ -154,11 +156,10 @@ public class AMQPComponentConfiguration {
/**
* Specifies whether persistent delivery is used by default.
*/
- private Boolean deliveryPersistent;
+ private Boolean deliveryPersistent = true;
/**
- * Specifies the delivery mode to be used. Possible values are Possibles
- * values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1
- * and PERSISTENT = 2.
+ * Specifies the delivery mode to be used. Possibles values are those
+ * defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
*/
private Integer deliveryMode;
/**
@@ -186,12 +187,12 @@ public class AMQPComponentConfiguration {
* Allows to configure the default errorHandler logging level for logging
* uncaught exceptions.
*/
- private LoggingLevel errorHandlerLoggingLevel;
+ private LoggingLevel errorHandlerLoggingLevel = LoggingLevel.WARN;
/**
* Allows to control whether stacktraces should be logged or not by the
* default errorHandler.
*/
- private Boolean errorHandlerLogStackTrace;
+ private Boolean errorHandlerLogStackTrace = true;
/**
* Set if the deliveryMode priority or timeToLive qualities of service
* should be used when sending messages. This option is based on Spring's
@@ -200,7 +201,7 @@ public class AMQPComponentConfiguration {
* option which operates at message granularity reading QoS properties
* exclusively from the Camel In message headers.
*/
- private Boolean explicitQosEnabled;
+ private Boolean explicitQosEnabled = false;
/**
* Specifies whether the listener session should be exposed when consuming
* messages.
@@ -213,12 +214,12 @@ public class AMQPComponentConfiguration {
* case of dynamic scheduling; see the maxConcurrentConsumers setting).
* There is additional doc available from Spring.
*/
- private Integer idleTaskExecutionLimit;
+ private Integer idleTaskExecutionLimit = 1;
/**
* Specify the limit for the number of consumers that are allowed to be idle
* at any given time.
*/
- private Integer idleConsumerLimit;
+ private Integer idleConsumerLimit = 1;
/**
* Specifies the maximum number of concurrent consumers when consuming from
* JMS (not for request/reply over JMS). See also the maxMessagesPerTask
@@ -238,14 +239,14 @@ public class AMQPComponentConfiguration {
* Specifies the maximum number of concurrent consumers for continue routing
* when timeout occurred when using request/reply over JMS.
*/
- private Integer replyOnTimeoutToMaxConcurrentConsumers;
+ private Integer replyOnTimeoutToMaxConcurrentConsumers = 1;
/**
* The number of messages per task. -1 is unlimited. If you use a range for
* concurrent consumers (eg min max) then this option can be used to set a
* value to eg 100 to control how fast the consumers will shrink when less
* work is required.
*/
- private Integer maxMessagesPerTask;
+ private Integer maxMessagesPerTask = -1;
/**
* To use a custom Spring
* org.springframework.jms.support.converter.MessageConverter so you can be
@@ -255,19 +256,24 @@ public class AMQPComponentConfiguration {
private MessageConverter messageConverter;
/**
* Specifies whether Camel should auto map the received JMS message to a
- * suited payload type such as javax.jms.TextMessage to a String etc. See
- * section about how mapping works below for more details.
+ * suited payload type such as javax.jms.TextMessage to a String etc.
*/
- private Boolean mapJmsMessage;
+ private Boolean mapJmsMessage = true;
/**
- * When sending specifies whether message IDs should be added.
+ * When sending specifies whether message IDs should be added. This is just
+ * an hint to the JMS broker.If the JMS provider accepts this hint these
+ * messages must have the message ID set to null; if the provider ignores
+ * the hint the message ID must be set to its normal unique value
*/
- private Boolean messageIdEnabled;
+ private Boolean messageIdEnabled = true;
/**
* Specifies whether timestamps should be enabled by default on sending
- * messages.
+ * messages. This is just an hint to the JMS broker.If the JMS provider
+ * accepts this hint these messages must have the timestamp set to zero; if
+ * the provider ignores the hint the timestamp must be set to its normal
+ * value
*/
- private Boolean messageTimestampEnabled;
+ private Boolean messageTimestampEnabled = true;
/**
* If true Camel will always make a JMS message copy of the message when it
* is passed to the producer for sending. Copying the message is needed in
@@ -286,7 +292,7 @@ public class AMQPComponentConfiguration {
* is the lowest priority and 9 is the highest). The explicitQosEnabled
* option must also be enabled in order for this option to have any effect.
*/
- private Integer priority;
+ private Integer priority = 4;
/**
* Specifies whether to inhibit the delivery of messages published by its
* own connection.
@@ -295,13 +301,13 @@ public class AMQPComponentConfiguration {
/**
* The timeout for receiving messages (in milliseconds).
*/
- private Long receiveTimeout;
+ private Long receiveTimeout = 1000L;
/**
* 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.
*/
- private Long recoveryInterval;
+ private Long recoveryInterval = 5000L;
/**
* Deprecated: Enabled by default if you specify a durableSubscriptionName
* and a clientId.
@@ -317,7 +323,7 @@ public class AMQPComponentConfiguration {
* When sending messages specifies the time-to-live of the message (in
* milliseconds).
*/
- private Long timeToLive;
+ private Long timeToLive = -1L;
/**
* Specifies whether to use transacted mode
*/
@@ -326,7 +332,7 @@ public class AMQPComponentConfiguration {
* If true Camel will create a JmsTransactionManager if there is no
* transactionManager injected when option transacted=true.
*/
- private Boolean lazyCreateTransactionManager;
+ private Boolean lazyCreateTransactionManager = true;
/**
* The Spring transaction manager to use.
*/
@@ -340,7 +346,7 @@ public class AMQPComponentConfiguration {
* The timeout value of the transaction (in seconds) if using transacted
* mode.
*/
- private Integer transactionTimeout;
+ private Integer transactionTimeout = -1;
/**
* Specifies whether to test the connection on startup. This ensures that
* when Camel starts that all the JMS consumers have a valid connection to
@@ -381,7 +387,7 @@ public class AMQPComponentConfiguration {
* and thus have per message individual timeout values. See also the
* requestTimeoutCheckerInterval option.
*/
- private Long requestTimeout;
+ private Long requestTimeout = 20000L;
/**
* Configures how often Camel should check for timed out Exchanges when
* doing request/reply over JMS. By default Camel checks once per second.
@@ -389,7 +395,7 @@ public class AMQPComponentConfiguration {
* this interval to check more frequently. The timeout is determined by the
* option requestTimeout.
*/
- private Long requestTimeoutCheckerInterval;
+ private Long requestTimeoutCheckerInterval = 1000L;
/**
* You can transfer the exchange over the wire instead of just the body and
* headers. The following fields are transferred: In body Out body Fault
@@ -416,12 +422,13 @@ public class AMQPComponentConfiguration {
/**
* If enabled and you are using Request Reply messaging (InOut) and an
* Exchange failed with a SOAP fault (not exception) on the consumer side
- * then the fault flag on link org.apache.camel.MessageisFault() will be
- * send back in the response as a JMS header with the key link
- * JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel the returned fault
- * flag will be set on the link org.apache.camel.MessagesetFault(boolean).
- * You may want to enable this when using Camel components that support
- * faults such as SOAP based such as cxf or spring-ws.
+ * then the fault flag on MessageisFault() will be send back in the response
+ * as a JMS header with the key org.apache.camel.component.jms.
+ * JmsConstantsJMS_TRANSFER_FAULTJMS_TRANSFER_FAULT. If the client is Camel
+ * the returned fault flag will be set on the link
+ * org.apache.camel.MessagesetFault(boolean). You may want to enable this
+ * when using Camel components that support faults such as SOAP based such
+ * as cxf or spring-ws.
*/
private Boolean transferFault;
/**
@@ -479,7 +486,7 @@ public class AMQPComponentConfiguration {
* Whether to allow sending messages with no body. If this option is false
* and the message body is null then an JMSException is thrown.
*/
- private Boolean allowNullBody;
+ private Boolean allowNullBody = true;
/**
* Only applicable when sending to JMS destination using InOnly (eg fire and
* forget). Enabling this option will enrich the Camel Exchange with the
@@ -529,12 +536,6 @@ public class AMQPComponentConfiguration {
@NestedConfigurationProperty
private QueueBrowseStrategy queueBrowseStrategy;
/**
- * To use a custom HeaderFilterStrategy to filter header to and from Camel
- * message.
- */
- @NestedConfigurationProperty
- private HeaderFilterStrategy headerFilterStrategy;
- /**
* To use the given MessageCreatedStrategy which are invoked when Camel
* creates new instances of javax.jms.Message objects when Camel is sending
* a JMS message.
@@ -546,12 +547,18 @@ public class AMQPComponentConfiguration {
* the actual correlation id when doing request/reply over JMS and when the
* option useMessageIDAsCorrelationID is enabled.
*/
- private Integer waitForProvisionCorrelationToBeUpdatedCounter;
+ private Integer waitForProvisionCorrelationToBeUpdatedCounter = 50;
/**
* Interval in millis to sleep each time while waiting for provisional
* correlation id to be updated.
*/
- private Long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime;
+ private Long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime = 100L;
+ /**
+ * To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter
+ * header to and from Camel message.
+ */
+ @NestedConfigurationProperty
+ private HeaderFilterStrategy headerFilterStrategy;
public JmsConfiguration getConfiguration() {
return configuration;
@@ -1126,15 +1133,6 @@ public class AMQPComponentConfiguration {
this.queueBrowseStrategy = queueBrowseStrategy;
}
- public HeaderFilterStrategy getHeaderFilterStrategy() {
- return headerFilterStrategy;
- }
-
- public void setHeaderFilterStrategy(
- HeaderFilterStrategy headerFilterStrategy) {
- this.headerFilterStrategy = headerFilterStrategy;
- }
-
public MessageCreatedStrategy getMessageCreatedStrategy() {
return messageCreatedStrategy;
}
@@ -1161,4 +1159,13 @@ public class AMQPComponentConfiguration {
Long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime) {
this.waitForProvisionCorrelationToBeUpdatedThreadSleepingTime = waitForProvisionCorrelationToBeUpdatedThreadSleepingTime;
}
+
+ public HeaderFilterStrategy getHeaderFilterStrategy() {
+ return headerFilterStrategy;
+ }
+
+ public void setHeaderFilterStrategy(
+ HeaderFilterStrategy headerFilterStrategy) {
+ this.headerFilterStrategy = headerFilterStrategy;
+ }
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java b/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
index fad5811..caa722f 100644
--- a/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
+++ b/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
@@ -101,7 +101,7 @@ public class JmsComponentConfiguration {
* Sets the cache level by ID for the underlying JMS resources. See
* cacheLevelName option for more details.
*/
- private Integer cacheLevel = true;
+ private Integer cacheLevel;
/**
* Sets the cache level by name for the underlying JMS resources. Possible
* values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
index 5768333..9b3ff5c 100644
--- a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
+++ b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
@@ -52,15 +52,15 @@ The AHC Websocket component supports 6 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| client | AsyncHttpClient | To use a custom AsyncHttpClient
-| binding | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
-| clientConfig | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
-| sslContextParameters | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.
-| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| client | | | AsyncHttpClient | To use a custom AsyncHttpClient
+| binding | | | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
+| clientConfig | | | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
+| sslContextParameters | | | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.
+| allowJavaSerializedObject | | | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-ahc/src/main/docs/ahc-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ahc/src/main/docs/ahc-component.adoc b/components/camel-ahc/src/main/docs/ahc-component.adoc
index 17bbe52..411d9b5 100644
--- a/components/camel-ahc/src/main/docs/ahc-component.adoc
+++ b/components/camel-ahc/src/main/docs/ahc-component.adoc
@@ -99,15 +99,15 @@ The AHC component supports 6 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| client | AsyncHttpClient | To use a custom AsyncHttpClient
-| binding | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
-| clientConfig | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
-| sslContextParameters | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.
-| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| client | | | AsyncHttpClient | To use a custom AsyncHttpClient
+| binding | | | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
+| clientConfig | | | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
+| sslContextParameters | | | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.
+| allowJavaSerializedObject | | | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
[5/8] camel git commit: CAMEL-10636: Component options docs - Include
more details like endpoint options.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-mail/src/main/docs/mail-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mail/src/main/docs/mail-component.adoc b/components/camel-mail/src/main/docs/mail-component.adoc
index 96d614a..eb58f9d 100644
--- a/components/camel-mail/src/main/docs/mail-component.adoc
+++ b/components/camel-mail/src/main/docs/mail-component.adoc
@@ -85,11 +85,11 @@ The Mail component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | MailConfiguration | Sets the Mail configuration
-| contentTypeResolver | ContentTypeResolver | Resolver to determine Content-Type for file attachments.
+| Name | Group | Default | Java Type | Description
+| configuration | | | MailConfiguration | Sets the Mail configuration
+| contentTypeResolver | | | ContentTypeResolver | Resolver to determine Content-Type for file attachments.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-metrics/src/main/docs/metrics-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-metrics/src/main/docs/metrics-component.adoc b/components/camel-metrics/src/main/docs/metrics-component.adoc
index dcc8557..4bacac4 100644
--- a/components/camel-metrics/src/main/docs/metrics-component.adoc
+++ b/components/camel-metrics/src/main/docs/metrics-component.adoc
@@ -54,10 +54,10 @@ The Metrics component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| metricRegistry | MetricRegistry | To use a custom configured MetricRegistry.
+| Name | Group | Default | Java Type | Description
+| metricRegistry | | | MetricRegistry | To use a custom configured MetricRegistry.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-mina/src/main/docs/mina-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina/src/main/docs/mina-component.adoc b/components/camel-mina/src/main/docs/mina-component.adoc
index 0dcb739..c7d3a12 100644
--- a/components/camel-mina/src/main/docs/mina-component.adoc
+++ b/components/camel-mina/src/main/docs/mina-component.adoc
@@ -73,10 +73,10 @@ The Mina component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | MinaConfiguration | To use the shared mina configuration.
+| Name | Group | Default | Java Type | Description
+| configuration | | | MinaConfiguration | To use the shared mina configuration.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-mina2/src/main/docs/mina2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina2/src/main/docs/mina2-component.adoc b/components/camel-mina2/src/main/docs/mina2-component.adoc
index d624be9..d610b3f 100644
--- a/components/camel-mina2/src/main/docs/mina2-component.adoc
+++ b/components/camel-mina2/src/main/docs/mina2-component.adoc
@@ -74,10 +74,10 @@ The Mina2 component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | Mina2Configuration | To use the shared mina configuration.
+| Name | Group | Default | Java Type | Description
+| configuration | | | Mina2Configuration | To use the shared mina configuration.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-mqtt/src/main/docs/mqtt-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mqtt/src/main/docs/mqtt-component.adoc b/components/camel-mqtt/src/main/docs/mqtt-component.adoc
index fe76c8a..3b8e918 100644
--- a/components/camel-mqtt/src/main/docs/mqtt-component.adoc
+++ b/components/camel-mqtt/src/main/docs/mqtt-component.adoc
@@ -46,12 +46,12 @@ The MQTT component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| host | String | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883
-| userName | String | Username to be used for authentication against the MQTT broker
-| password | String | Password to be used for authentication against the MQTT broker
+| Name | Group | Default | Java Type | Description
+| host | | | String | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883
+| userName | | | String | Username to be used for authentication against the MQTT broker
+| password | | | String | Password to be used for authentication against the MQTT broker
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-msv/src/main/docs/msv-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-msv/src/main/docs/msv-component.adoc b/components/camel-msv/src/main/docs/msv-component.adoc
index 857a77a..a5dcf90 100644
--- a/components/camel-msv/src/main/docs/msv-component.adoc
+++ b/components/camel-msv/src/main/docs/msv-component.adoc
@@ -60,11 +60,11 @@ The MSV component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| schemaFactory | SchemaFactory | To use the javax.xml.validation.SchemaFactory.
-| resourceResolverFactory | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI
+| Name | Group | Default | Java Type | Description
+| schemaFactory | | | SchemaFactory | To use the javax.xml.validation.SchemaFactory.
+| resourceResolverFactory | | | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-mustache/src/main/docs/mustache-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mustache/src/main/docs/mustache-component.adoc b/components/camel-mustache/src/main/docs/mustache-component.adoc
index cedfeee..681f264 100644
--- a/components/camel-mustache/src/main/docs/mustache-component.adoc
+++ b/components/camel-mustache/src/main/docs/mustache-component.adoc
@@ -51,10 +51,10 @@ The Mustache component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| mustacheFactory | MustacheFactory | To use a custom MustacheFactory
+| Name | Group | Default | Java Type | Description
+| mustacheFactory | | | MustacheFactory | To use a custom MustacheFactory
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-mybatis/src/main/docs/mybatis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mybatis/src/main/docs/mybatis-component.adoc b/components/camel-mybatis/src/main/docs/mybatis-component.adoc
index 28aaa0f..46d4b23 100644
--- a/components/camel-mybatis/src/main/docs/mybatis-component.adoc
+++ b/components/camel-mybatis/src/main/docs/mybatis-component.adoc
@@ -55,11 +55,11 @@ The MyBatis component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| sqlSessionFactory | SqlSessionFactory | To use the SqlSessionFactory
-| configurationUri | String | Location of MyBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath
+| Name | Group | Default | Java Type | Description
+| sqlSessionFactory | | | SqlSessionFactory | To use the SqlSessionFactory
+| configurationUri | | SqlMapConfig.xml | String | Location of MyBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-nagios/src/main/docs/nagios-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc
index cdd5ca3..2b92977 100644
--- a/components/camel-nagios/src/main/docs/nagios-component.adoc
+++ b/components/camel-nagios/src/main/docs/nagios-component.adoc
@@ -49,10 +49,10 @@ The Nagios component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | NagiosConfiguration | To use a shared NagiosConfiguration
+| Name | Group | Default | Java Type | Description
+| configuration | | | NagiosConfiguration | To use a shared NagiosConfiguration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-netty-http/src/main/docs/netty-http-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-netty-http/src/main/docs/netty-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc
index 9726a1e..f309672 100644
--- a/components/camel-netty-http/src/main/docs/netty-http-component.adoc
+++ b/components/camel-netty-http/src/main/docs/netty-http-component.adoc
@@ -87,14 +87,14 @@ The Netty HTTP component supports 5 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| nettyHttpBinding | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
-| configuration | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
-| securityConfiguration | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.
-| maximumPoolSize | int | The core pool size for the ordered thread pool if its in use. The default value is 16.
+| Name | Group | Default | Java Type | Description
+| nettyHttpBinding | | | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
+| configuration | | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
+| securityConfiguration | | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.
+| maximumPoolSize | | 16 | int | The core pool size for the ordered thread pool if its in use. The default value is 16.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-netty/src/main/docs/netty-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-netty/src/main/docs/netty-component.adoc b/components/camel-netty/src/main/docs/netty-component.adoc
index 73af65d..ea32801 100644
--- a/components/camel-netty/src/main/docs/netty-component.adoc
+++ b/components/camel-netty/src/main/docs/netty-component.adoc
@@ -67,11 +67,11 @@ The Netty component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
-| maximumPoolSize | int | The core pool size for the ordered thread pool if its in use. The default value is 16.
+| Name | Group | Default | Java Type | Description
+| configuration | | | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
+| maximumPoolSize | | 16 | int | The core pool size for the ordered thread pool if its in use. The default value is 16.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc
index bb7d1ca..c6b65b0 100644
--- a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc
+++ b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc
@@ -86,15 +86,15 @@ The Netty4 HTTP component supports 6 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| nettyHttpBinding | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
-| configuration | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
-| securityConfiguration | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources.
-| maximumPoolSize | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16.
-| executorService | EventExecutorGroup | To use the given EventExecutorGroup
+| Name | Group | Default | Java Type | Description
+| nettyHttpBinding | | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
+| configuration | | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
+| securityConfiguration | | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources.
+| maximumPoolSize | | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16.
+| executorService | | | EventExecutorGroup | To use the given EventExecutorGroup
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-netty4/src/main/docs/netty4-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-netty4/src/main/docs/netty4-component.adoc b/components/camel-netty4/src/main/docs/netty4-component.adoc
index 745ac05..cdb1dd7 100644
--- a/components/camel-netty4/src/main/docs/netty4-component.adoc
+++ b/components/camel-netty4/src/main/docs/netty4-component.adoc
@@ -64,12 +64,12 @@ The Netty4 component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| maximumPoolSize | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16.
-| configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
-| executorService | EventExecutorGroup | To use the given EventExecutorGroup
+| Name | Group | Default | Java Type | Description
+| maximumPoolSize | | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16.
+| configuration | | | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
+| executorService | | | EventExecutorGroup | To use the given EventExecutorGroup
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
index 2bb0839..84cc765 100644
--- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
+++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
@@ -54,10 +54,10 @@ The Olingo2 component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | Olingo2Configuration | To use the shared configuration
+| Name | Group | Default | Java Type | Description
+| configuration | | | Olingo2Configuration | To use the shared configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-openshift/src/main/docs/openshift-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-openshift/src/main/docs/openshift-component.adoc b/components/camel-openshift/src/main/docs/openshift-component.adoc
index b655c6f..d996ddb 100644
--- a/components/camel-openshift/src/main/docs/openshift-component.adoc
+++ b/components/camel-openshift/src/main/docs/openshift-component.adoc
@@ -44,13 +44,13 @@ The OpenShift component supports 4 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| username | String | The username to login to openshift server.
-| password | String | The password for login to openshift server.
-| domain | String | Domain name. If not specified then the default domain is used.
-| server | String | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used.
+| Name | Group | Default | Java Type | Description
+| username | | | String | The username to login to openshift server.
+| password | | | String | The password for login to openshift server.
+| domain | | | String | Domain name. If not specified then the default domain is used.
+| server | | | String | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-paho/src/main/docs/paho-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-paho/src/main/docs/paho-component.adoc b/components/camel-paho/src/main/docs/paho-component.adoc
index adcfe9b..6378461 100644
--- a/components/camel-paho/src/main/docs/paho-component.adoc
+++ b/components/camel-paho/src/main/docs/paho-component.adoc
@@ -132,12 +132,12 @@ The Paho component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| brokerUrl | String | The URL of the MQTT broker.
-| clientId | String | MQTT client identifier.
-| connectOptions | MqttConnectOptions | Client connection options
+| Name | Group | Default | Java Type | Description
+| brokerUrl | | | String | The URL of the MQTT broker.
+| clientId | | | String | MQTT client identifier.
+| connectOptions | | | MqttConnectOptions | Client connection options
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc
index c24f5b9..0c25595 100644
--- a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc
+++ b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc
@@ -50,10 +50,10 @@ The OSGi PAX Logging component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| bundleContext | BundleContext | The OSGi BundleContext is automatic injected by Camel
+| Name | Group | Default | Java Type | Description
+| bundleContext | | | BundleContext | The OSGi BundleContext is automatic injected by Camel
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-quartz/src/main/docs/quartz-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-quartz/src/main/docs/quartz-component.adoc b/components/camel-quartz/src/main/docs/quartz-component.adoc
index 6970c6a..cc53808 100644
--- a/components/camel-quartz/src/main/docs/quartz-component.adoc
+++ b/components/camel-quartz/src/main/docs/quartz-component.adoc
@@ -55,16 +55,16 @@ The Quartz component supports 7 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| factory | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler.
-| scheduler | Scheduler | To use the custom configured Quartz scheduler instead of creating a new Scheduler.
-| properties | Properties | Properties to configure the Quartz scheduler.
-| propertiesFile | String | File name of the properties to load from the classpath
-| startDelayedSeconds | int | Seconds to wait before starting the quartz scheduler.
-| autoStartScheduler | boolean | Whether or not the scheduler should be auto started. This options is default true
-| enableJmx | boolean | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true
+| Name | Group | Default | Java Type | Description
+| factory | | | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler.
+| scheduler | | | Scheduler | To use the custom configured Quartz scheduler instead of creating a new Scheduler.
+| properties | | | Properties | Properties to configure the Quartz scheduler.
+| propertiesFile | | | String | File name of the properties to load from the classpath
+| startDelayedSeconds | | | int | Seconds to wait before starting the quartz scheduler.
+| autoStartScheduler | | true | boolean | Whether or not the scheduler should be auto started. This options is default true
+| enableJmx | | true | boolean | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-quartz2/src/main/docs/quartz2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-quartz2/src/main/docs/quartz2-component.adoc b/components/camel-quartz2/src/main/docs/quartz2-component.adoc
index 541942c..85fd477 100644
--- a/components/camel-quartz2/src/main/docs/quartz2-component.adoc
+++ b/components/camel-quartz2/src/main/docs/quartz2-component.adoc
@@ -58,18 +58,18 @@ The Quartz2 component supports 9 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| autoStartScheduler | boolean | Whether or not the scheduler should be auto started. This options is default true
-| startDelayedSeconds | int | Seconds to wait before starting the quartz scheduler.
-| prefixJobNameWithEndpointId | boolean | Whether to prefix the quartz job with the endpoint id. This option is default false.
-| enableJmx | boolean | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true
-| properties | Properties | Properties to configure the Quartz scheduler.
-| propertiesFile | String | File name of the properties to load from the classpath
-| prefixInstanceName | boolean | Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext's.
-| schedulerFactory | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler.
-| scheduler | Scheduler | To use the custom configured Quartz scheduler instead of creating a new Scheduler.
+| Name | Group | Default | Java Type | Description
+| autoStartScheduler | | true | boolean | Whether or not the scheduler should be auto started. This options is default true
+| startDelayedSeconds | | | int | Seconds to wait before starting the quartz scheduler.
+| prefixJobNameWithEndpointId | | | boolean | Whether to prefix the quartz job with the endpoint id. This option is default false.
+| enableJmx | | true | boolean | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true
+| properties | | | Properties | Properties to configure the Quartz scheduler.
+| propertiesFile | | | String | File name of the properties to load from the classpath
+| prefixInstanceName | | true | boolean | Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext's.
+| schedulerFactory | | | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler.
+| scheduler | | | Scheduler | To use the custom configured Quartz scheduler instead of creating a new Scheduler.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-quickfix/src/main/docs/quickfix-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-quickfix/src/main/docs/quickfix-component.adoc b/components/camel-quickfix/src/main/docs/quickfix-component.adoc
index f036c6c..fec1290 100644
--- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc
+++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc
@@ -96,14 +96,14 @@ The QuickFix component supports 5 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| messageFactory | MessageFactory | To use the given MessageFactory
-| logFactory | LogFactory | To use the given LogFactory
-| messageStoreFactory | MessageStoreFactory | To use the given MessageStoreFactory
-| configurations | Map | To use the given map of pre configured QuickFix configurations mapped to the key
-| lazyCreateEngines | boolean | If set to true the engines will be created and started when needed (when first message is send)
+| Name | Group | Default | Java Type | Description
+| messageFactory | | | MessageFactory | To use the given MessageFactory
+| logFactory | | | LogFactory | To use the given LogFactory
+| messageStoreFactory | | | MessageStoreFactory | To use the given MessageStoreFactory
+| configurations | | | Map | To use the given map of pre configured QuickFix configurations mapped to the key
+| lazyCreateEngines | | | boolean | If set to true the engines will be created and started when needed (when first message is send)
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-restlet/src/main/docs/restlet-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-restlet/src/main/docs/restlet-component.adoc b/components/camel-restlet/src/main/docs/restlet-component.adoc
index 96039ca..73ed736 100644
--- a/components/camel-restlet/src/main/docs/restlet-component.adoc
+++ b/components/camel-restlet/src/main/docs/restlet-component.adoc
@@ -71,29 +71,29 @@ The Restlet component supports 20 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| controllerDaemon | Boolean | Indicates if the controller thread should be a daemon (not blocking JVM exit).
-| controllerSleepTimeMs | Integer | Time for the controller thread to sleep between each control.
-| inboundBufferSize | Integer | The size of the buffer when reading messages.
-| maxConnectionsPerHost | Integer | Maximum number of concurrent connections per host (IP address).
-| maxThreads | Integer | Maximum threads that will service requests.
-| lowThreads | Integer | Number of worker threads determining when the connector is considered overloaded.
-| maxTotalConnections | Integer | Maximum number of concurrent connections in total.
-| minThreads | Integer | Minimum threads waiting to service requests.
-| outboundBufferSize | Integer | The size of the buffer when writing messages.
-| persistingConnections | Boolean | Indicates if connections should be kept alive after a call.
-| pipeliningConnections | Boolean | Indicates if pipelining connections are supported.
-| threadMaxIdleTimeMs | Integer | Time for an idle thread to wait for an operation before being collected.
-| useForwardedForHeader | Boolean | Lookup the X-Forwarded-For header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks.
-| reuseAddress | Boolean | Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocketreuseAddress property for additional details.
-| maxQueued | Integer | Maximum number of calls that can be queued if there aren't any worker thread available to service them. If the value is '0' then no queue is used and calls are rejected if no worker thread is immediately available. If the value is '-1' then an unbounded queue is used and calls are never rejected.
-| disableStreamCache | boolean | Determines whether or not the raw input stream from Restlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Restlet input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times.
-| port | int | To configure the port number for the restlet consumer routes. This allows to configure this once to reuse the same port for these consumers.
-| synchronous | Boolean | Whether to use synchronous Restlet Client for the producer. Setting this option to true can yield faster performance as it seems the Restlet synchronous Client works better.
-| enabledConverters | List | A list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| controllerDaemon | | | Boolean | Indicates if the controller thread should be a daemon (not blocking JVM exit).
+| controllerSleepTimeMs | | | Integer | Time for the controller thread to sleep between each control.
+| inboundBufferSize | | | Integer | The size of the buffer when reading messages.
+| maxConnectionsPerHost | | | Integer | Maximum number of concurrent connections per host (IP address).
+| maxThreads | | | Integer | Maximum threads that will service requests.
+| lowThreads | | | Integer | Number of worker threads determining when the connector is considered overloaded.
+| maxTotalConnections | | | Integer | Maximum number of concurrent connections in total.
+| minThreads | | | Integer | Minimum threads waiting to service requests.
+| outboundBufferSize | | | Integer | The size of the buffer when writing messages.
+| persistingConnections | | | Boolean | Indicates if connections should be kept alive after a call.
+| pipeliningConnections | | | Boolean | Indicates if pipelining connections are supported.
+| threadMaxIdleTimeMs | | | Integer | Time for an idle thread to wait for an operation before being collected.
+| useForwardedForHeader | | | Boolean | Lookup the X-Forwarded-For header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks.
+| reuseAddress | | | Boolean | Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocketreuseAddress property for additional details.
+| maxQueued | | | Integer | Maximum number of calls that can be queued if there aren't any worker thread available to service them. If the value is '0' then no queue is used and calls are rejected if no worker thread is immediately available. If the value is '-1' then an unbounded queue is used and calls are never rejected.
+| disableStreamCache | | | boolean | Determines whether or not the raw input stream from Restlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Restlet input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times.
+| port | | | int | To configure the port number for the restlet consumer routes. This allows to configure this once to reuse the same port for these consumers.
+| synchronous | | | Boolean | Whether to use synchronous Restlet Client for the producer. Setting this option to true can yield faster performance as it seems the Restlet synchronous Client works better.
+| enabledConverters | | | List | A list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
index cbbf0b1..9ca4211 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
+++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
@@ -459,25 +459,25 @@ The Salesforce component supports 16 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| loginConfig | SalesforceLoginConfig | To use the shared SalesforceLoginConfig as login configuration
-| config | SalesforceEndpointConfig | To use the shared SalesforceLoginConfig as configuration
-| httpClientProperties | Map | Used for configuring HTTP client properties as key/value pairs
-| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters
-| httpProxyHost | String | To configure HTTP proxy host
-| httpProxyPort | Integer | To configure HTTP proxy port
-| httpProxyUsername | String | To configure HTTP proxy username
-| httpProxyPassword | String | To configure HTTP proxy password
-| isHttpProxySocks4 | boolean | Enable for Socks4 proxy false by default
-| isHttpProxySecure | boolean | Enable for TLS connections true by default
-| httpProxyIncludedAddresses | Set | HTTP proxy included addresses
-| httpProxyExcludedAddresses | Set | HTTP proxy excluded addresses
-| httpProxyAuthUri | String | HTTP proxy authentication URI
-| httpProxyRealm | String | HTTP proxy authentication realm
-| httpProxyUseDigestAuth | boolean | Use HTTP proxy Digest authentication false by default
-| packages | String[] | Package names to scan for DTO classes (multiple packages can be separated by comma).
+| Name | Group | Default | Java Type | Description
+| loginConfig | | | SalesforceLoginConfig | To use the shared SalesforceLoginConfig as login configuration
+| config | | | SalesforceEndpointConfig | To use the shared SalesforceLoginConfig as configuration
+| httpClientProperties | | | Map | Used for configuring HTTP client properties as key/value pairs
+| sslContextParameters | | | SSLContextParameters | To configure security using SSLContextParameters
+| httpProxyHost | | | String | To configure HTTP proxy host
+| httpProxyPort | | | Integer | To configure HTTP proxy port
+| httpProxyUsername | | | String | To configure HTTP proxy username
+| httpProxyPassword | | | String | To configure HTTP proxy password
+| isHttpProxySocks4 | | | boolean | Enable for Socks4 proxy false by default
+| isHttpProxySecure | | | boolean | Enable for TLS connections true by default
+| httpProxyIncludedAddresses | | | Set | HTTP proxy included addresses
+| httpProxyExcludedAddresses | | | Set | HTTP proxy excluded addresses
+| httpProxyAuthUri | | | String | HTTP proxy authentication URI
+| httpProxyRealm | | | String | HTTP proxy authentication realm
+| httpProxyUseDigestAuth | | | boolean | Use HTTP proxy Digest authentication false by default
+| packages | | | String[] | Package names to scan for DTO classes (multiple packages can be separated by comma).
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-saxon/src/main/docs/xquery-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc
index 79c2c79..6a3cad9 100644
--- a/components/camel-saxon/src/main/docs/xquery-component.adoc
+++ b/components/camel-saxon/src/main/docs/xquery-component.adoc
@@ -22,10 +22,10 @@ The XQuery component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| moduleURIResolver | ModuleURIResolver | To use the custom ModuleURIResolver
+| Name | Group | Default | Java Type | Description
+| moduleURIResolver | | | ModuleURIResolver | To use the custom ModuleURIResolver
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-servicenow/src/main/docs/servicenow-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-servicenow/src/main/docs/servicenow-component.adoc b/components/camel-servicenow/src/main/docs/servicenow-component.adoc
index f122586..9cc703b 100644
--- a/components/camel-servicenow/src/main/docs/servicenow-component.adoc
+++ b/components/camel-servicenow/src/main/docs/servicenow-component.adoc
@@ -41,16 +41,16 @@ The ServiceNow component supports 7 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | ServiceNowConfiguration | The ServiceNow default configuration
-| apiUrl | String | The ServiceNow REST API url
-| userName | String | ServiceNow user account name
-| password | String | ServiceNow account password
-| oauthClientId | String | OAuth2 ClientID
-| oauthClientSecret | String | OAuth2 ClientSecret
-| oauthTokenUrl | String | OAuth token Url
+| Name | Group | Default | Java Type | Description
+| configuration | | | ServiceNowConfiguration | The ServiceNow default configuration
+| apiUrl | | | String | The ServiceNow REST API url
+| userName | | | String | ServiceNow user account name
+| password | | | String | ServiceNow account password
+| oauthClientId | | | String | OAuth2 ClientID
+| oauthClientSecret | | | String | OAuth2 ClientSecret
+| oauthTokenUrl | | | String | OAuth token Url
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-servlet/src/main/docs/servlet-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-servlet/src/main/docs/servlet-component.adoc b/components/camel-servlet/src/main/docs/servlet-component.adoc
index cc715b5..34ce17b 100644
--- a/components/camel-servlet/src/main/docs/servlet-component.adoc
+++ b/components/camel-servlet/src/main/docs/servlet-component.adoc
@@ -51,16 +51,16 @@ The Servlet component supports 7 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| servletName | String | Default name of servlet to use. The default name is CamelServlet.
-| httpRegistry | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry.
-| attachmentMultipartBinding | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's.
-| httpBinding | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-| httpConfiguration | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
-| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| servletName | | | String | Default name of servlet to use. The default name is CamelServlet.
+| httpRegistry | | | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry.
+| attachmentMultipartBinding | | | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's.
+| httpBinding | | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
+| httpConfiguration | | | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
+| allowJavaSerializedObject | | | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
index 6f8715e..03f7c81 100644
--- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
+++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
@@ -122,11 +122,11 @@ The Simple JMS Batch component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| connectionFactory | ConnectionFactory | A ConnectionFactory is required to enable the SjmsBatchComponent.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| connectionFactory | | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsBatchComponent.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-sjms/src/main/docs/sjms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/docs/sjms-component.adoc b/components/camel-sjms/src/main/docs/sjms-component.adoc
index 7a55fb9..f528e56 100644
--- a/components/camel-sjms/src/main/docs/sjms-component.adoc
+++ b/components/camel-sjms/src/main/docs/sjms-component.adoc
@@ -109,18 +109,18 @@ The Simple JMS component supports 9 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| connectionFactory | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource.
-| connectionResource | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details.
-| connectionCount | Integer | The maximum number of connections available to endpoints started under this component
-| jmsKeyFormatStrategy | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
-| transactionCommitStrategy | TransactionCommitStrategy | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch.
-| destinationCreationStrategy | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
-| timedTaskManager | TimedTaskManager | To use a custom TimedTaskManager
-| messageCreatedStrategy | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| connectionFactory | | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource.
+| connectionResource | | | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details.
+| connectionCount | | 1 | Integer | The maximum number of connections available to endpoints started under this component
+| jmsKeyFormatStrategy | | | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
+| transactionCommitStrategy | | | TransactionCommitStrategy | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch.
+| destinationCreationStrategy | | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
+| timedTaskManager | | | TimedTaskManager | To use a custom TimedTaskManager
+| messageCreatedStrategy | | | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-slack/src/main/docs/slack-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-slack/src/main/docs/slack-component.adoc b/components/camel-slack/src/main/docs/slack-component.adoc
index 15595f2..4eae3ac 100644
--- a/components/camel-slack/src/main/docs/slack-component.adoc
+++ b/components/camel-slack/src/main/docs/slack-component.adoc
@@ -53,10 +53,10 @@ The Slack component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| webhookUrl | String | The incoming webhook URL
+| Name | Group | Default | Java Type | Description
+| webhookUrl | | | String | The incoming webhook URL
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-smpp/src/main/docs/smpp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-smpp/src/main/docs/smpp-component.adoc b/components/camel-smpp/src/main/docs/smpp-component.adoc
index 8dbe995..4167da9 100644
--- a/components/camel-smpp/src/main/docs/smpp-component.adoc
+++ b/components/camel-smpp/src/main/docs/smpp-component.adoc
@@ -184,10 +184,10 @@ The SMPP component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | SmppConfiguration | To use the shared SmppConfiguration as configuration.
+| Name | Group | Default | Java Type | Description
+| configuration | | | SmppConfiguration | To use the shared SmppConfiguration as configuration.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
index f176b0b..7cd7005 100644
--- a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
+++ b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
@@ -43,20 +43,20 @@ The Spark Rest component supports 11 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| port | int | Port number. Will by default use 4567
-| ipAddress | String | Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'.
-| minThreads | int | Minimum number of threads in Spark thread-pool (shared globally)
-| maxThreads | int | Maximum number of threads in Spark thread-pool (shared globally)
-| timeOutMillis | int | Thread idle timeout in millis where threads that has been idle for a longer period will be terminated from the thread pool
-| keystoreFile | String | Configures connection to be secure to use the keystore file
-| keystorePassword | String | Configures connection to be secure to use the keystore password
-| truststoreFile | String | Configures connection to be secure to use the truststore file
-| truststorePassword | String | Configures connection to be secure to use the truststore password
-| sparkConfiguration | SparkConfiguration | To use the shared SparkConfiguration
-| sparkBinding | SparkBinding | To use a custom SparkBinding to map to/from Camel message.
+| Name | Group | Default | Java Type | Description
+| port | | 4567 | int | Port number. Will by default use 4567
+| ipAddress | | 0.0.0.0 | String | Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'.
+| minThreads | | | int | Minimum number of threads in Spark thread-pool (shared globally)
+| maxThreads | | | int | Maximum number of threads in Spark thread-pool (shared globally)
+| timeOutMillis | | | int | Thread idle timeout in millis where threads that has been idle for a longer period will be terminated from the thread pool
+| keystoreFile | | | String | Configures connection to be secure to use the keystore file
+| keystorePassword | | | String | Configures connection to be secure to use the keystore password
+| truststoreFile | | | String | Configures connection to be secure to use the truststore file
+| truststorePassword | | | String | Configures connection to be secure to use the truststore password
+| sparkConfiguration | | | SparkConfiguration | To use the shared SparkConfiguration
+| sparkBinding | | | SparkBinding | To use a custom SparkBinding to map to/from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-spark/src/main/docs/spark-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spark/src/main/docs/spark-component.adoc b/components/camel-spark/src/main/docs/spark-component.adoc
index 5e1127a..5597249 100644
--- a/components/camel-spark/src/main/docs/spark-component.adoc
+++ b/components/camel-spark/src/main/docs/spark-component.adoc
@@ -66,11 +66,11 @@ The Apache Spark component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| rdd | JavaRDDLike | RDD to compute against.
-| rddCallback | RddCallback | Function performing action against an RDD.
+| Name | Group | Default | Java Type | Description
+| rdd | | | JavaRDDLike | RDD to compute against.
+| rddCallback | | | RddCallback | Function performing action against an RDD.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-splunk/src/main/docs/splunk-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-splunk/src/main/docs/splunk-component.adoc b/components/camel-splunk/src/main/docs/splunk-component.adoc
index c62b790..7215abe 100644
--- a/components/camel-splunk/src/main/docs/splunk-component.adoc
+++ b/components/camel-splunk/src/main/docs/splunk-component.adoc
@@ -101,10 +101,10 @@ The Splunk component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| splunkConfigurationFactory | SplunkConfigurationFactory | To use the SplunkConfigurationFactory
+| Name | Group | Default | Java Type | Description
+| splunkConfigurationFactory | | | SplunkConfigurationFactory | To use the SplunkConfigurationFactory
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
index 83ee89a..466a943 100644
--- a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
+++ b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
@@ -49,11 +49,11 @@ The Spring Batch component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| jobLauncher | JobLauncher | Explicitly specifies a JobLauncher to be used.
-| jobRegistry | JobRegistry | Explicitly specifies a JobRegistry to be used.
+| Name | Group | Default | Java Type | Description
+| jobLauncher | | | JobLauncher | Explicitly specifies a JobLauncher to be used.
+| jobRegistry | | | JobRegistry | Explicitly specifies a JobRegistry to be used.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-spring/src/main/docs/spring-event-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring/src/main/docs/spring-event-component.adoc b/components/camel-spring/src/main/docs/spring-event-component.adoc
index 0aedb2e..42d65a4 100644
--- a/components/camel-spring/src/main/docs/spring-event-component.adoc
+++ b/components/camel-spring/src/main/docs/spring-event-component.adoc
@@ -34,10 +34,10 @@ The Spring Event component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| applicationContext | ApplicationContext | The Spring ApplicationContext
+| Name | Group | Default | Java Type | Description
+| applicationContext | | | ApplicationContext | The Spring ApplicationContext
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-sql/src/main/docs/sql-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc
index 0231778..a7be726 100644
--- a/components/camel-sql/src/main/docs/sql-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-component.adoc
@@ -116,11 +116,11 @@ The SQL component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| dataSource | DataSource | Sets the DataSource to use to communicate with the database.
-| usePlaceholder | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true
+| Name | Group | Default | Java Type | Description
+| dataSource | | | DataSource | Sets the DataSource to use to communicate with the database.
+| usePlaceholder | | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-sql/src/main/docs/sql-stored-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sql/src/main/docs/sql-stored-component.adoc b/components/camel-sql/src/main/docs/sql-stored-component.adoc
index 1deff34..1b9944c 100644
--- a/components/camel-sql/src/main/docs/sql-stored-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-stored-component.adoc
@@ -74,10 +74,10 @@ The SQL StoredProcedure component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| dataSource | DataSource | Sets the DataSource to use to communicate with the database.
+| Name | Group | Default | Java Type | Description
+| dataSource | | | DataSource | Sets the DataSource to use to communicate with the database.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-ssh/src/main/docs/ssh-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc
index f75244b..b7cc63c 100644
--- a/components/camel-ssh/src/main/docs/ssh-component.adoc
+++ b/components/camel-ssh/src/main/docs/ssh-component.adoc
@@ -41,20 +41,20 @@ The SSH component supports 11 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | SshConfiguration | To use the shared SSH configuration
-| host | String | Sets the hostname of the remote SSH server.
-| port | int | Sets the port number for the remote SSH server.
-| username | String | Sets the username to use in logging into the remote SSH server.
-| password | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null.
-| pollCommand | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...). You may need to end your command with a newline and that must be URL encoded 0A
-| keyPairProvider | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
-| keyType | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa.
-| timeout | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds.
-| certFilename | String | Sets the resource path of the certificate to use for Authentication.
-| certResource | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting.
+| Name | Group | Default | Java Type | Description
+| configuration | | | SshConfiguration | To use the shared SSH configuration
+| host | | | String | Sets the hostname of the remote SSH server.
+| port | | | int | Sets the port number for the remote SSH server.
+| username | | | String | Sets the username to use in logging into the remote SSH server.
+| password | | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null.
+| pollCommand | | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...). You may need to end your command with a newline and that must be URL encoded 0A
+| keyPairProvider | | | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
+| keyType | | | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa.
+| timeout | | | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds.
+| certFilename | | | String | Sets the resource path of the certificate to use for Authentication.
+| certResource | | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-stomp/src/main/docs/stomp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stomp/src/main/docs/stomp-component.adoc b/components/camel-stomp/src/main/docs/stomp-component.adoc
index eb79b78..163cb0c 100644
--- a/components/camel-stomp/src/main/docs/stomp-component.adoc
+++ b/components/camel-stomp/src/main/docs/stomp-component.adoc
@@ -45,14 +45,14 @@ The Stomp component supports 5 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | StompConfiguration | To use the shared stomp configuration
-| brokerURL | String | The URI of the Stomp broker to connect to
-| login | String | The username
-| passcode | String | The password
-| host | String | The virtual host
+| Name | Group | Default | Java Type | Description
+| configuration | | | StompConfiguration | To use the shared stomp configuration
+| brokerURL | | | String | The URI of the Stomp broker to connect to
+| login | | | String | The username
+| passcode | | | String | The password
+| host | | | String | The virtual host
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-telegram/src/main/docs/telegram-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-telegram/src/main/docs/telegram-component.adoc b/components/camel-telegram/src/main/docs/telegram-component.adoc
index f194617..ccb9ff1 100644
--- a/components/camel-telegram/src/main/docs/telegram-component.adoc
+++ b/components/camel-telegram/src/main/docs/telegram-component.adoc
@@ -54,10 +54,10 @@ The Telegram component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| authorizationToken | String | The default Telegram authorization token to be used when the information is not provided in the endpoints.
+| Name | Group | Default | Java Type | Description
+| authorizationToken | | | String | The default Telegram authorization token to be used when the information is not provided in the endpoints.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-twitter/src/main/docs/twitter-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-twitter/src/main/docs/twitter-component.adoc b/components/camel-twitter/src/main/docs/twitter-component.adoc
index e63fcf8..d9168bb 100644
--- a/components/camel-twitter/src/main/docs/twitter-component.adoc
+++ b/components/camel-twitter/src/main/docs/twitter-component.adoc
@@ -63,17 +63,17 @@ The Twitter component supports 8 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| accessToken | String | The access token
-| accessTokenSecret | String | The access token secret
-| consumerKey | String | The consumer key
-| consumerSecret | String | The consumer secret
-| httpProxyHost | String | The http proxy host which can be used for the camel-twitter.
-| httpProxyUser | String | The http proxy user which can be used for the camel-twitter.
-| httpProxyPassword | String | The http proxy password which can be used for the camel-twitter.
-| httpProxyPort | int | The http proxy port which can be used for the camel-twitter.
+| Name | Group | Default | Java Type | Description
+| accessToken | | | String | The access token
+| accessTokenSecret | | | String | The access token secret
+| consumerKey | | | String | The consumer key
+| consumerSecret | | | String | The consumer secret
+| httpProxyHost | | | String | The http proxy host which can be used for the camel-twitter.
+| httpProxyUser | | | String | The http proxy user which can be used for the camel-twitter.
+| httpProxyPassword | | | String | The http proxy password which can be used for the camel-twitter.
+| httpProxyPort | | | int | The http proxy port which can be used for the camel-twitter.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-undertow/src/main/docs/undertow-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-undertow/src/main/docs/undertow-component.adoc b/components/camel-undertow/src/main/docs/undertow-component.adoc
index 2422104..262daf6 100644
--- a/components/camel-undertow/src/main/docs/undertow-component.adoc
+++ b/components/camel-undertow/src/main/docs/undertow-component.adoc
@@ -49,11 +49,11 @@ The Undertow component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| undertowHttpBinding | UndertowHttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters
+| Name | Group | Default | Java Type | Description
+| undertowHttpBinding | | | UndertowHttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
+| sslContextParameters | | | SSLContextParameters | To configure security using SSLContextParameters
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-velocity/src/main/docs/velocity-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-velocity/src/main/docs/velocity-component.adoc b/components/camel-velocity/src/main/docs/velocity-component.adoc
index e6ab2ed..7a2de50 100644
--- a/components/camel-velocity/src/main/docs/velocity-component.adoc
+++ b/components/camel-velocity/src/main/docs/velocity-component.adoc
@@ -48,10 +48,10 @@ The Velocity component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| velocityEngine | VelocityEngine | To use the VelocityEngine otherwise a new engine is created
+| Name | Group | Default | Java Type | Description
+| velocityEngine | | | VelocityEngine | To use the VelocityEngine otherwise a new engine is created
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-vertx/src/main/docs/vertx-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-vertx/src/main/docs/vertx-component.adoc b/components/camel-vertx/src/main/docs/vertx-component.adoc
index 797e28e..1d8ea2c 100644
--- a/components/camel-vertx/src/main/docs/vertx-component.adoc
+++ b/components/camel-vertx/src/main/docs/vertx-component.adoc
@@ -47,15 +47,15 @@ The Vert.x component supports 6 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| vertxFactory | VertxFactory | To use a custom VertxFactory implementation
-| host | String | Hostname for creating an embedded clustered EventBus
-| port | int | Port for creating an embedded clustered EventBus
-| vertxOptions | VertxOptions | Options to use for creating vertx
-| vertx | Vertx | To use the given vertx EventBus instead of creating a new embedded EventBus
-| timeout | int | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60.
+| Name | Group | Default | Java Type | Description
+| vertxFactory | | | VertxFactory | To use a custom VertxFactory implementation
+| host | | | String | Hostname for creating an embedded clustered EventBus
+| port | | | int | Port for creating an embedded clustered EventBus
+| vertxOptions | | | VertxOptions | Options to use for creating vertx
+| vertx | | | Vertx | To use the given vertx EventBus instead of creating a new embedded EventBus
+| timeout | | 60 | int | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-websocket/src/main/docs/websocket-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-websocket/src/main/docs/websocket-component.adoc b/components/camel-websocket/src/main/docs/websocket-component.adoc
index 7519d93..0618cc8 100644
--- a/components/camel-websocket/src/main/docs/websocket-component.adoc
+++ b/components/camel-websocket/src/main/docs/websocket-component.adoc
@@ -43,21 +43,21 @@ The Jetty Websocket component supports 12 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| staticResources | String | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use.
-| host | String | The hostname. The default value is 0.0.0.0
-| port | Integer | The port number. The default value is 9292
-| sslKeyPassword | String | The password for the keystore when using SSL.
-| sslPassword | String | The password when using SSL.
-| sslKeystore | String | The path to the keystore.
-| enableJmx | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
-| minThreads | Integer | To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1.
-| maxThreads | Integer | To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores.
-| threadPool | ThreadPool | To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9.
-| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters
-| socketFactory | Map | To configure a map which contains custom WebSocketFactory for sub protocols. The key in the map is the sub protocol. The default key is reserved for the default implementation.
+| Name | Group | Default | Java Type | Description
+| staticResources | | | String | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use.
+| host | | 0.0.0.0 | String | The hostname. The default value is 0.0.0.0
+| port | | 9292 | Integer | The port number. The default value is 9292
+| sslKeyPassword | | | String | The password for the keystore when using SSL.
+| sslPassword | | | String | The password when using SSL.
+| sslKeystore | | | String | The path to the keystore.
+| enableJmx | | | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
+| minThreads | | | Integer | To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1.
+| maxThreads | | | Integer | To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores.
+| threadPool | | | ThreadPool | To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9.
+| sslContextParameters | | | SSLContextParameters | To configure security using SSLContextParameters
+| socketFactory | | | Map | To configure a map which contains custom WebSocketFactory for sub protocols. The key in the map is the sub protocol. The default key is reserved for the default implementation.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc
index f462738..930e778 100644
--- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc
+++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc
@@ -240,11 +240,11 @@ The XML Security component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| signerConfiguration | XmlSignerConfiguration | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints.
-| verifierConfiguration | XmlVerifierConfiguration | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints.
+| Name | Group | Default | Java Type | Description
+| signerConfiguration | | | XmlSignerConfiguration | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints.
+| verifierConfiguration | | | XmlVerifierConfiguration | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints.
|=======================================================================
{% endraw %}
// component options: END
[4/8] camel git commit: CAMEL-10636: Component options docs - Include
more details like endpoint options.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-yammer/src/main/docs/yammer-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-yammer/src/main/docs/yammer-component.adoc b/components/camel-yammer/src/main/docs/yammer-component.adoc
index 5661768..cafa080 100644
--- a/components/camel-yammer/src/main/docs/yammer-component.adoc
+++ b/components/camel-yammer/src/main/docs/yammer-component.adoc
@@ -52,13 +52,13 @@ The Yammer component supports 4 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| consumerKey | String | The consumer key
-| consumerSecret | String | The consumer secret
-| accessToken | String | The access token
-| config | YammerConfiguration | To use a shared yammer configuration
+| Name | Group | Default | Java Type | Description
+| consumerKey | | | String | The consumer key
+| consumerSecret | | | String | The consumer secret
+| accessToken | | | String | The access token
+| config | | | YammerConfiguration | To use a shared yammer configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
index 5f8d5cf..1293990 100644
--- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
+++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
@@ -60,10 +60,10 @@ The ZooKeeper component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | ZooKeeperConfiguration | To use a shared ZooKeeperConfiguration
+| Name | Group | Default | Java Type | Description
+| configuration | | | ZooKeeperConfiguration | To use a shared ZooKeeperConfiguration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/readme.adoc
----------------------------------------------------------------------
diff --git a/components/readme.adoc b/components/readme.adoc
index 5c86856..972b0f3 100644
--- a/components/readme.adoc
+++ b/components/readme.adoc
@@ -204,9 +204,6 @@ Components
| link:camel-google-mail/src/main/docs/google-mail-component.adoc[Google Mail] (camel-google-mail) +
`google-mail:apiName/methodName` | The google-mail component provides access to Google Mail.
-| link:camel-google-pubsub/src/main/docs/google-pubsub-component.adoc[Google Pubsub] (camel-google-pubsub) +
-`google-pubsub:projectId:destinationName` | Messaging client for Google Cloud Platform PubSub Service: https://cloud.google.com/pubsub/
-
| link:camel-gora/src/main/docs/gora-component.adoc[Gora] (camel-gora) +
`gora:name` | The gora component allows you to work with NoSQL databases using the Apache Gora framework.
@@ -342,9 +339,6 @@ Components
| link:camel-mongodb/src/main/docs/mongodb-component.adoc[MongoDB] (camel-mongodb) +
`mongodb:connectionBean` | Component for working with documents stored in MongoDB database.
-| link:camel-mongodb3/src/main/docs/mongodb3-component.adoc[MongoDB] (camel-mongodb3) +
-`mongodb3:connectionBean` | Component for working with documents stored in MongoDB database.
-
| link:camel-mongodb-gridfs/src/main/docs/gridfs-component.adoc[MongoDBGridFS] (camel-mongodb-gridfs) +
`gridfs:connectionBean` | Component for working with MongoDB GridFS.
@@ -384,24 +378,6 @@ Components
| link:camel-openshift/src/main/docs/openshift-component.adoc[OpenShift] (camel-openshift) +
`openshift:clientId` | *deprecated* To manage your Openshift 2.x applications.
-| link:camel-openstack/src/main/docs/openstack-cinder-component.adoc[OpenStack Cinder] (camel-openstack) +
-`openstack-cinder:host` | The openstack-cinder component allows messages to be sent to an OpenStack block storage services.
-
-| link:camel-openstack/src/main/docs/openstack-glance-component.adoc[OpenStack Glance] (camel-openstack) +
-`openstack-glance:host` | The openstack-glance component allows messages to be sent to an OpenStack image services.
-
-| link:camel-openstack/src/main/docs/openstack-keystone-component.adoc[OpenStack Keystone] (camel-openstack) +
-`openstack-keystone:host` | The openstack-keystone component allows messages to be sent to an OpenStack identity services.
-
-| link:camel-openstack/src/main/docs/openstack-neutron-component.adoc[OpenStack Neutron] (camel-openstack) +
-`openstack-neutron:host` | The openstack-neutron component allows messages to be sent to an OpenStack network services.
-
-| link:camel-openstack/src/main/docs/openstack-nova-component.adoc[OpenStack Nova] (camel-openstack) +
-`openstack-nova:host` | The openstack-nova component allows messages to be sent to an OpenStack compute services.
-
-| link:camel-openstack/src/main/docs/openstack-swift-component.adoc[OpenStack Swift] (camel-openstack) +
-`openstack-swift:host` | The openstack-swift component allows messages to be sent to an OpenStack object storage services.
-
| link:camel-optaplanner/src/main/docs/optaplanner-component.adoc[OptaPlanner] (camel-optaplanner) +
`optaplanner:configFile` | Solves the planning problem contained in a message with OptaPlanner.
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index e6c39fb..bdcce6d 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -190,7 +190,6 @@
* [Google Calendar](google-calendar-component.adoc)
* [Google Drive](google-drive-component.adoc)
* [Google Mail](google-mail-component.adoc)
- * [Google Pubsub](google-pubsub-component.adoc)
* [Gora](gora-component.adoc)
* [Grape](grape-component.adoc)
* [Guava EventBus](guava-eventbus-component.adoc)
@@ -236,7 +235,6 @@
* [Mina2](mina2-component.adoc)
* [MLLP](mllp-component.adoc)
* [MongoDB](mongodb-component.adoc)
- * [MongoDB](mongodb3-component.adoc)
* [MongoDBGridFS](gridfs-component.adoc)
* [MQTT](mqtt-component.adoc)
* [MSV](msv-component.adoc)
@@ -250,12 +248,6 @@
* [Netty4](netty4-component.adoc)
* [Netty4 HTTP](netty4-http-component.adoc)
* [OpenShift](openshift-component.adoc)
- * [OpenStack Cinder](openstack-cinder-component.adoc)
- * [OpenStack Glance](openstack-glance-component.adoc)
- * [OpenStack Keystone](openstack-keystone-component.adoc)
- * [OpenStack Neutron](openstack-neutron-component.adoc)
- * [OpenStack Nova](openstack-nova-component.adoc)
- * [OpenStack Swift](openstack-swift-component.adoc)
* [OptaPlanner](optaplanner-component.adoc)
* [OSGi EventAdmin](eventadmin-component.adoc)
* [OSGi PAX Logging](paxlogging-component.adoc)
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java
----------------------------------------------------------------------
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java
index d355541..434e6e6 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java
+++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java
@@ -496,10 +496,18 @@ public class ReadmeComponentMojo extends AbstractMojo {
ComponentOptionModel option = new ComponentOptionModel();
option.setName(getSafeValue("name", row));
option.setKind(getSafeValue("kind", row));
+ option.setGroup(getSafeValue("group", row));
+ option.setRequired(getSafeValue("required", row));
option.setType(getSafeValue("type", row));
option.setJavaType(getSafeValue("javaType", row));
option.setDeprecated(getSafeValue("deprecated", row));
+ option.setDefaultValue(getSafeValue("defaultValue", row));
option.setDescription(getSafeValue("description", row));
+ // lets put required in the description
+ if ("true".equals(option.getRequired())) {
+ String desc = "*Required* " + option.getDescription();
+ option.setDescription(desc);
+ }
component.addComponentOption(option);
}
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java
----------------------------------------------------------------------
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java
index 435685f..c94e0dd 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java
+++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java
@@ -20,6 +20,8 @@ public class ComponentOptionModel {
private String name;
private String kind;
+ private String group;
+ private String required;
private String type;
private String javaType;
private String deprecated;
@@ -43,6 +45,22 @@ public class ComponentOptionModel {
this.kind = kind;
}
+ public String getGroup() {
+ return group;
+ }
+
+ public void setGroup(String group) {
+ this.group = group;
+ }
+
+ public String getRequired() {
+ return required;
+ }
+
+ public void setRequired(String required) {
+ this.required = required;
+ }
+
public String getType() {
return type;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel
----------------------------------------------------------------------
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel
index e90937b..020b125 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel
+++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel
@@ -6,10 +6,10 @@ The @{title} component supports @{componentOptions.size()} options which are lis
@if{!componentOptions.isEmpty()}
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-@foreach{row : componentOptions}| @{row.name} | @{row.shortJavaType} | @{row.description}
+| Name | Group | Default | Java Type | Description
+@foreach{row : componentOptions}| @{row.name} | @{row.group} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description}
@end{}|=======================================================================
{% endraw %}
@end{}
\ No newline at end of file
[7/8] camel git commit: CAMEL-10636: Component options docs - Include
more details like endpoint options.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/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 be4c702..f7253a2 100644
--- a/components/camel-amqp/src/main/docs/amqp-component.adoc
+++ b/components/camel-amqp/src/main/docs/amqp-component.adoc
@@ -47,83 +47,83 @@ The AMQP component supports 74 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | JmsConfiguration | To use a shared JMS configuration
-| acceptMessagesWhileStopping | boolean | 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 enqued 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.
-| allowReplyManagerQuickStop | boolean | 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.
-| acknowledgementMode | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead.
-| eagerLoadingOfProperties | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties
-| acknowledgementModeName | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
-| autoStartup | boolean | Specifies whether the consumer container should auto-startup.
-| cacheLevel | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
-| cacheLevelName | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.
-| replyToCacheLevelName | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION.
-| clientId | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead.
-| concurrentConsumers | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
-| replyToConcurrentConsumers | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
-| connectionFactory | ConnectionFactory | Sets the default connection factory to be use
-| username | String | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
-| password | String | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
-| deliveryPersistent | boolean | Specifies whether persistent delivery is used by default.
-| deliveryMode | Integer | Specifies the delivery mode to be used. Possible values are Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
-| durableSubscriptionName | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
-| exceptionListener | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
-| errorHandler | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler.
-| errorHandlerLoggingLevel | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
-| errorHandlerLogStackTrace | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
-| explicitQosEnabled | boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers.
-| exposeListenerSession | boolean | Specifies whether the listener session should be exposed when consuming messages.
-| idleTaskExecutionLimit | int | Specifies the limit for idle executions of a receive task not having received any message within its execution. If this limit is reached the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring.
-| idleConsumerLimit | int | Specify the limit for the number of consumers that are allowed to be idle at any given time.
-| maxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
-| replyToMaxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
-| replyOnTimeoutToMaxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
-| maxMessagesPerTask | int | The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max) then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required.
-| messageConverter | MessageConverter | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message.
-| mapJmsMessage | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
-| messageIdEnabled | boolean | When sending specifies whether message IDs should be added.
-| messageTimestampEnabled | boolean | Specifies whether timestamps should be enabled by default on sending messages.
-| alwaysCopyMessage | boolean | If true Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations such as when a replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a replyToDestinationSelectorName is set)
-| useMessageIDAsCorrelationID | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
-| priority | int | Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect.
-| pubSubNoLocal | boolean | Specifies whether to inhibit the delivery of messages published by its own connection.
-| receiveTimeout | long | The timeout for receiving messages (in milliseconds).
-| recoveryInterval | long | 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.
-| subscriptionDurable | boolean | Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId.
-| taskExecutor | TaskExecutor | Allows you to specify a custom task executor for consuming messages.
-| timeToLive | long | When sending messages specifies the time-to-live of the message (in milliseconds).
-| transacted | boolean | Specifies whether to use transacted mode
-| lazyCreateTransactionManager | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true.
-| transactionManager | PlatformTransactionManager | The Spring transaction manager to use.
-| transactionName | String | The name of the transaction to use.
-| transactionTimeout | int | The timeout value of the transaction (in seconds) if using transacted mode.
-| testConnectionOnStartup | boolean | 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.
-| asyncStartListener | boolean | Whether to startup the JmsConsumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry.
-| asyncStopListener | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route.
-| forceSendOriginalMessage | boolean | When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received.
-| requestTimeout | long | The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option.
-| requestTimeoutCheckerInterval | long | Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs then you can lower this interval to check more frequently. The timeout is determined by the option requestTimeout.
-| transferExchange | boolean | You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body Out body Fault body In headers Out headers Fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side so Camel knows the payloads is an Exchange and not a regular payload.
-| transferException | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer.
-| transferFault | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side then the fault flag on link org.apache.camel.MessageisFault() will be send back in the response as a JMS header with the key link JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.
-| jmsOperations | JmsOperations | Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface. Camel uses JmsTemplate as default. Can be used for testing purpose but not used much as stated in the spring API docs.
-| destinationResolver | DestinationResolver | A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example to lookup the real destination in a JNDI registry).
-| replyToType | ReplyToType | Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary Shared or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details and especially the notes about the implications if running in a clustered environment and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive.
-| preserveMessageQos | boolean | Set to true if you want to send message using the QoS settings specified on the message instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority JMSDeliveryMode and JMSExpiration. You can provide all or only some of them. If not provided Camel will fall back to use the values from the endpoint instead. So when using this option the headers override the values from the endpoint. The explicitQosEnabled option by contrast will only use options set on the endpoint and not values from the message header.
-| asyncConsumer | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions).
-| allowNullBody | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
-| includeSentJMSMessageID | boolean | Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination.
-| includeAllJMSXProperties | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply.
-| defaultTaskExecutorType | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set it defaults to the previous behaviour which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers.
-| jmsKeyFormatStrategy | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
-| applicationContext | ApplicationContext | Sets the Spring ApplicationContext to use
-| queueBrowseStrategy | QueueBrowseStrategy | To use a custom QueueBrowseStrategy when browsing queues
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-| messageCreatedStrategy | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
-| waitForProvisionCorrelationToBeUpdatedCounter | int | 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.
-| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
+| Name | Group | Default | Java Type | Description
+| configuration | | | JmsConfiguration | To use a shared JMS configuration
+| acceptMessagesWhileStopping | | | boolean | 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.
+| allowReplyManagerQuickStop | | | boolean | 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.
+| acknowledgementMode | | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode.For the regular modes it is preferable to use the acknowledgementModeName instead.
+| eagerLoadingOfProperties | | | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties
+| acknowledgementModeName | | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
+| autoStartup | | true | boolean | Specifies whether the consumer container should auto-startup.
+| cacheLevel | | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
+| cacheLevelName | | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.
+| replyToCacheLevelName | | | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION.
+| clientId | | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead.
+| concurrentConsumers | | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
+| replyToConcurrentConsumers | | 1 | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
+| connectionFactory | | | ConnectionFactory | The connection factory to be use. A connection factory must be configured either on the component or endpoint.
+| username | | | String | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
+| password | | | String | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
+| deliveryPersistent | | true | boolean | Specifies whether persistent delivery is used by default.
+| deliveryMode | | | Integer | Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
+| durableSubscriptionName | | | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
+| exceptionListener | | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
+| errorHandler | | | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler.
+| errorHandlerLoggingLevel | | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
+| errorHandlerLogStackTrace | | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
+| explicitQosEnabled | | false | boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers.
+| exposeListenerSession | | | boolean | Specifies whether the listener session should be exposed when consuming messages.
+| idleTaskExecutionLimit | | 1 | int | Specifies the limit for idle executions of a receive task not having received any message within its execution. If this limit is reached the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring.
+| idleConsumerLimit | | 1 | int | Specify the limit for the number of consumers that are allowed to be idle at any given time.
+| maxConcurrentConsumers | | | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
+| replyToMaxConcurrentConsumers | | | int | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
+| replyOnTimeoutToMaxConcurrentConsumers | | 1 | int | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
+| maxMessagesPerTask | | -1 | int | The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max) then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required.
+| messageConverter | | | MessageConverter | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message.
+| mapJmsMessage | | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc.
+| messageIdEnabled | | true | boolean | When sending specifies whether message IDs should be added. This is just an hint to the JMS broker.If the JMS provider accepts this hint these messages must have the message ID set to null; if the provider ignores the hint the message ID must be set to its normal unique value
+| messageTimestampEnabled | | true | boolean | Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker.If the JMS provider accepts this hint these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value
+| alwaysCopyMessage | | | boolean | If true Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations such as when a replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a replyToDestinationSelectorName is set)
+| useMessageIDAsCorrelationID | | | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
+| priority | | 4 | int | Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect.
+| pubSubNoLocal | | | boolean | Specifies whether to inhibit the delivery of messages published by its own connection.
+| receiveTimeout | | 1000 | long | The timeout for receiving messages (in milliseconds).
+| recoveryInterval | | 5000 | long | 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.
+| subscriptionDurable | | | boolean | Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId.
+| taskExecutor | | | TaskExecutor | Allows you to specify a custom task executor for consuming messages.
+| timeToLive | | -1 | long | When sending messages specifies the time-to-live of the message (in milliseconds).
+| transacted | | | boolean | Specifies whether to use transacted mode
+| lazyCreateTransactionManager | | true | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true.
+| transactionManager | | | PlatformTransactionManager | The Spring transaction manager to use.
+| transactionName | | | String | The name of the transaction to use.
+| transactionTimeout | | -1 | int | The timeout value of the transaction (in seconds) if using transacted mode.
+| testConnectionOnStartup | | | boolean | 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.
+| asyncStartListener | | | boolean | Whether to startup the JmsConsumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry.
+| asyncStopListener | | | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route.
+| forceSendOriginalMessage | | | boolean | When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received.
+| requestTimeout | | 20000 | long | The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option.
+| requestTimeoutCheckerInterval | | 1000 | long | Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs then you can lower this interval to check more frequently. The timeout is determined by the option requestTimeout.
+| transferExchange | | | boolean | You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body Out body Fault body In headers Out headers Fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side so Camel knows the payloads is an Exchange and not a regular payload.
+| transferException | | | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer.
+| transferFault | | | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side then the fault flag on MessageisFault() will be send back in the response as a JMS header with the key org.apache.camel.component.jms.JmsConstantsJMS_TRANSFER_FAULTJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.
+| jmsOperations | | | JmsOperations | Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface. Camel uses JmsTemplate as default. Can be used for testing purpose but not used much as stated in the spring API docs.
+| destinationResolver | | | DestinationResolver | A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example to lookup the real destination in a JNDI registry).
+| replyToType | | | ReplyToType | Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary Shared or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details and especially the notes about the implications if running in a clustered environment and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive.
+| preserveMessageQos | | | boolean | Set to true if you want to send message using the QoS settings specified on the message instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority JMSDeliveryMode and JMSExpiration. You can provide all or only some of them. If not provided Camel will fall back to use the values from the endpoint instead. So when using this option the headers override the values from the endpoint. The explicitQosEnabled option by contrast will only use options set on the endpoint and not values from the message header.
+| asyncConsumer | | | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions).
+| allowNullBody | | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
+| includeSentJMSMessageID | | | boolean | Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination.
+| includeAllJMSXProperties | | | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply.
+| defaultTaskExecutorType | | | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set it defaults to the previous behaviour which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers.
+| jmsKeyFormatStrategy | | | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
+| applicationContext | | | ApplicationContext | Sets the Spring ApplicationContext to use
+| queueBrowseStrategy | | | QueueBrowseStrategy | To use a custom QueueBrowseStrategy when browsing queues
+| messageCreatedStrategy | | | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
+| waitForProvisionCorrelationToBeUpdatedCounter | | 50 | int | 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.
+| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | | 100 | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
@@ -135,7 +135,7 @@ The AMQP component supports 74 options which are listed below.
// endpoint options: START
-The AMQP component supports 83 endpoint options which are listed below:
+The AMQP component supports 85 endpoint options which are listed below:
{% raw %}
[width="100%",cols="2,1,1m,1m,5",options="header"]
@@ -153,13 +153,14 @@ The AMQP component supports 83 endpoint options which are listed below:
| asyncConsumer | consumer | false | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions).
| autoStartup | consumer | true | boolean | Specifies whether the consumer container should auto-startup.
| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| cacheLevel | consumer | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
| cacheLevelName | consumer | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.
| concurrentConsumers | consumer | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
| maxConcurrentConsumers | consumer | | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
| replyTo | consumer | | String | Provides an explicit ReplyTo destination which overrides any incoming value of Message.getJMSReplyTo().
| replyToDeliveryPersistent | consumer | true | boolean | Specifies whether to use persistent delivery by default for replies.
| selector | consumer | | String | Sets the JMS selector to use
-| acceptMessagesWhileStopping | consumer (advanced) | false | boolean | 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 enqued 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.
+| acceptMessagesWhileStopping | consumer (advanced) | false | boolean | 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.
| allowReplyManagerQuickStop | consumer (advanced) | false | boolean | 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.
| consumerType | consumer (advanced) | Default | ConsumerType | 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.
| defaultTaskExecutorType | consumer (advanced) | | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set it defaults to the previous behaviour which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers.
@@ -168,6 +169,7 @@ The AMQP component supports 83 endpoint options which are listed below:
| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
| exposeListenerSession | consumer (advanced) | false | boolean | Specifies whether the listener session should be exposed when consuming messages.
| replyToSameDestinationAllowed | consumer (advanced) | false | boolean | Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself.
+| taskExecutor | consumer (advanced) | | TaskExecutor | Allows you to specify a custom task executor for consuming messages.
| deliveryMode | producer | | Integer | Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
| deliveryPersistent | producer | true | boolean | Specifies whether persistent delivery is used by default.
| explicitQosEnabled | producer | false | Boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers.
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-apns/src/main/docs/apns-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-apns/src/main/docs/apns-component.adoc b/components/camel-apns/src/main/docs/apns-component.adoc
index 3a7232c..3800de1 100644
--- a/components/camel-apns/src/main/docs/apns-component.adoc
+++ b/components/camel-apns/src/main/docs/apns-component.adoc
@@ -62,10 +62,10 @@ The APNS component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| apnsService | ApnsService | The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService
+| Name | Group | Default | Java Type | Description
+| apnsService | | | ApnsService | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
index 55ab94c..64405af 100644
--- a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
+++ b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
@@ -43,16 +43,16 @@ The Atmosphere Websocket component supports 7 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| servletName | String | Default name of servlet to use. The default name is CamelServlet.
-| httpRegistry | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry.
-| attachmentMultipartBinding | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's.
-| httpBinding | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-| httpConfiguration | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
-| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| servletName | | | String | Default name of servlet to use. The default name is CamelServlet.
+| httpRegistry | | | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry.
+| attachmentMultipartBinding | | | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's.
+| httpBinding | | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
+| httpConfiguration | | | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
+| allowJavaSerializedObject | | | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-avro/src/main/docs/avro-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-avro/src/main/docs/avro-component.adoc b/components/camel-avro/src/main/docs/avro-component.adoc
index 7d46a25..59792f5 100644
--- a/components/camel-avro/src/main/docs/avro-component.adoc
+++ b/components/camel-avro/src/main/docs/avro-component.adoc
@@ -186,10 +186,10 @@ The Avro component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | AvroConfiguration | To use a shared AvroConfiguration to configure options once
+| Name | Group | Default | Java Type | Description
+| configuration | | | AvroConfiguration | To use a shared AvroConfiguration to configure options once
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
index 2a3de09..5296d41 100644
--- a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
+++ b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
@@ -70,10 +70,10 @@ The Beanstalk component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| connectionSettingsFactory | ConnectionSettingsFactory | Custom ConnectionSettingsFactory. Specify which ConnectionSettingsFactory to use to make connections to Beanstalkd. Especially useful for unit testing without beanstalkd daemon (you can mock ConnectionSettings)
+| Name | Group | Default | Java Type | Description
+| connectionSettingsFactory | | | ConnectionSettingsFactory | Custom ConnectionSettingsFactory. Specify which ConnectionSettingsFactory to use to make connections to Beanstalkd. Especially useful for unit testing without beanstalkd daemon (you can mock ConnectionSettings)
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-box/src/main/docs/box-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-box/src/main/docs/box-component.adoc b/components/camel-box/src/main/docs/box-component.adoc
index f21de5b..b83ad21 100644
--- a/components/camel-box/src/main/docs/box-component.adoc
+++ b/components/camel-box/src/main/docs/box-component.adoc
@@ -47,10 +47,10 @@ The Box component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | BoxConfiguration | To use the shared configuration
+| Name | Group | Default | Java Type | Description
+| configuration | | | BoxConfiguration | To use the shared configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-braintree/src/main/docs/braintree-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc
index c985c87..f9682ca 100644
--- a/components/camel-braintree/src/main/docs/braintree-component.adoc
+++ b/components/camel-braintree/src/main/docs/braintree-component.adoc
@@ -44,10 +44,10 @@ The Braintree component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | BraintreeConfiguration | To use the shared configuration
+| Name | Group | Default | Java Type | Description
+| configuration | | | BraintreeConfiguration | To use the shared configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-cache/src/main/docs/cache-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cache/src/main/docs/cache-component.adoc b/components/camel-cache/src/main/docs/cache-component.adoc
index 9b1f336..b35930d 100644
--- a/components/camel-cache/src/main/docs/cache-component.adoc
+++ b/components/camel-cache/src/main/docs/cache-component.adoc
@@ -55,12 +55,12 @@ The EHCache component supports 3 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| cacheManagerFactory | CacheManagerFactory | To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used.
-| configuration | CacheConfiguration | Sets the Cache configuration
-| configurationFile | String | Sets the location of the ehcache.xml file to load from classpath or file system. By default the file is loaded from classpath:ehcache.xml
+| Name | Group | Default | Java Type | Description
+| cacheManagerFactory | | | CacheManagerFactory | To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used.
+| configuration | | | CacheConfiguration | Sets the Cache configuration
+| configurationFile | | classpath:ehcache.xml | String | Sets the location of the ehcache.xml file to load from classpath or file system. By default the file is loaded from classpath:ehcache.xml
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-cometd/src/main/docs/cometd-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc b/components/camel-cometd/src/main/docs/cometd-component.adoc
index 0a9d24a..4375068 100644
--- a/components/camel-cometd/src/main/docs/cometd-component.adoc
+++ b/components/camel-cometd/src/main/docs/cometd-component.adoc
@@ -59,15 +59,15 @@ The CometD component supports 6 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| sslKeyPassword | String | The password for the keystore when using SSL.
-| sslPassword | String | The password when using SSL.
-| sslKeystore | String | The path to the keystore.
-| securityPolicy | SecurityPolicy | To use a custom configured SecurityPolicy to control authorization
-| extensions | List | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests.
-| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters
+| Name | Group | Default | Java Type | Description
+| sslKeyPassword | | | String | The password for the keystore when using SSL.
+| sslPassword | | | String | The password when using SSL.
+| sslKeystore | | | String | The path to the keystore.
+| securityPolicy | | | SecurityPolicy | To use a custom configured SecurityPolicy to control authorization
+| extensions | | | List | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests.
+| sslContextParameters | | | SSLContextParameters | To configure security using SSLContextParameters
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-crypto/src/main/docs/crypto-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-crypto/src/main/docs/crypto-component.adoc b/components/camel-crypto/src/main/docs/crypto-component.adoc
index 2f24f34..e2ece0c 100644
--- a/components/camel-crypto/src/main/docs/crypto-component.adoc
+++ b/components/camel-crypto/src/main/docs/crypto-component.adoc
@@ -23,10 +23,10 @@ The Crypto (JCE) component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | DigitalSignatureConfiguration | To use the shared DigitalSignatureConfiguration as configuration
+| Name | Group | Default | Java Type | Description
+| configuration | | | DigitalSignatureConfiguration | To use the shared DigitalSignatureConfiguration as configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-cxf/src/main/docs/cxf-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc
index 41eabbd..5023fde 100644
--- a/components/camel-cxf/src/main/docs/cxf-component.adoc
+++ b/components/camel-cxf/src/main/docs/cxf-component.adoc
@@ -129,11 +129,11 @@ The CXF component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| allowStreaming | Boolean | This option controls whether the CXF component when running in PAYLOAD mode will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| allowStreaming | | | Boolean | This option controls whether the CXF component when running in PAYLOAD mode will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases.
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-cxf/src/main/docs/cxfrs-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cxf/src/main/docs/cxfrs-component.adoc b/components/camel-cxf/src/main/docs/cxfrs-component.adoc
index 41b04ac..0efcd10 100644
--- a/components/camel-cxf/src/main/docs/cxfrs-component.adoc
+++ b/components/camel-cxf/src/main/docs/cxfrs-component.adoc
@@ -69,10 +69,10 @@ The CXF-RS component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
+| Name | Group | Default | Java Type | Description
+| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-disruptor/src/main/docs/disruptor-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-disruptor/src/main/docs/disruptor-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-component.adoc
index 879636e..99a59e6 100644
--- a/components/camel-disruptor/src/main/docs/disruptor-component.adoc
+++ b/components/camel-disruptor/src/main/docs/disruptor-component.adoc
@@ -105,16 +105,16 @@ The Disruptor component supports 7 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| defaultConcurrentConsumers | int | To configure the default number of concurrent consumers
-| defaultMultipleConsumers | boolean | To configure the default value for multiple consumers
-| defaultProducerType | DisruptorProducerType | To configure the default value for DisruptorProducerType The default value is Multi.
-| defaultWaitStrategy | DisruptorWaitStrategy | To configure the default value for DisruptorWaitStrategy The default value is Blocking.
-| defaultBlockWhenFull | boolean | To configure the default value for block when full The default value is true.
-| queueSize | int | To configure the ring buffer size
-| bufferSize | int | To configure the ring buffer size
+| Name | Group | Default | Java Type | Description
+| defaultConcurrentConsumers | | 1 | int | To configure the default number of concurrent consumers
+| defaultMultipleConsumers | | | boolean | To configure the default value for multiple consumers
+| defaultProducerType | | Multi | DisruptorProducerType | To configure the default value for DisruptorProducerType The default value is Multi.
+| defaultWaitStrategy | | Blocking | DisruptorWaitStrategy | To configure the default value for DisruptorWaitStrategy The default value is Blocking.
+| defaultBlockWhenFull | | true | boolean | To configure the default value for block when full The default value is true.
+| queueSize | | | int | To configure the ring buffer size
+| bufferSize | | 1024 | int | To configure the ring buffer size
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-docker/src/main/docs/docker-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-docker/src/main/docs/docker-component.adoc b/components/camel-docker/src/main/docs/docker-component.adoc
index 09a93f7..0653adf 100644
--- a/components/camel-docker/src/main/docs/docker-component.adoc
+++ b/components/camel-docker/src/main/docs/docker-component.adoc
@@ -33,10 +33,10 @@ The Docker component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | DockerConfiguration | To use the shared docker configuration
+| Name | Group | Default | Java Type | Description
+| configuration | | | DockerConfiguration | To use the shared docker configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-ejb/src/main/docs/ejb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ejb/src/main/docs/ejb-component.adoc b/components/camel-ejb/src/main/docs/ejb-component.adoc
index 53c32a8..dcc320e 100644
--- a/components/camel-ejb/src/main/docs/ejb-component.adoc
+++ b/components/camel-ejb/src/main/docs/ejb-component.adoc
@@ -43,11 +43,11 @@ The EJB component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| context | Context | The Context to use for looking up the EJBs
-| properties | Properties | Properties for creating javax.naming.Context if a context has not been configured.
+| Name | Group | Default | Java Type | Description
+| context | | | Context | The Context to use for looking up the EJBs
+| properties | | | Properties | Properties for creating javax.naming.Context if a context has not been configured.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc
index 4d71b40..89db00c 100644
--- a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc
+++ b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc
@@ -52,10 +52,10 @@ The Elasticsearch component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| client | Client | To use an existing configured Elasticsearch client instead of creating a client per endpoint.
+| Name | Group | Default | Java Type | Description
+| client | | | Client | To use an existing configured Elasticsearch client instead of creating a client per endpoint.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-elsql/src/main/docs/elsql-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-elsql/src/main/docs/elsql-component.adoc b/components/camel-elsql/src/main/docs/elsql-component.adoc
index 647fd00..ae4a691 100644
--- a/components/camel-elsql/src/main/docs/elsql-component.adoc
+++ b/components/camel-elsql/src/main/docs/elsql-component.adoc
@@ -61,13 +61,13 @@ The ElSQL component supports 4 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| databaseVendor | ElSqlDatabaseVendor | To use a vendor specific com.opengamma.elsql.ElSqlConfig
-| dataSource | DataSource | Sets the DataSource to use to communicate with the database.
-| elSqlConfig | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead.
-| resourceUri | String | The resource file which contains the elsql SQL statements to use. You can specify multiple resources separated by comma. The resources are loaded on the classpath by default you can prefix with file: to load from file system. Notice you can set this option on the component and then you do not have to configure this on the endpoint.
+| Name | Group | Default | Java Type | Description
+| databaseVendor | | | ElSqlDatabaseVendor | To use a vendor specific com.opengamma.elsql.ElSqlConfig
+| dataSource | | | DataSource | Sets the DataSource to use to communicate with the database.
+| elSqlConfig | | | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead.
+| resourceUri | | | String | The resource file which contains the elsql SQL statements to use. You can specify multiple resources separated by comma. The resources are loaded on the classpath by default you can prefix with file: to load from file system. Notice you can set this option on the component and then you do not have to configure this on the endpoint.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc
index 545b7cf..86ebb99 100644
--- a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc
+++ b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc
@@ -46,10 +46,10 @@ The OSGi EventAdmin component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| bundleContext | BundleContext | The OSGi BundleContext is automatic injected by Camel
+| Name | Group | Default | Java Type | Description
+| bundleContext | | | BundleContext | The OSGi BundleContext is automatic injected by Camel
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-facebook/src/main/docs/facebook-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-facebook/src/main/docs/facebook-component.adoc b/components/camel-facebook/src/main/docs/facebook-component.adoc
index 5bec884..4574ce4 100644
--- a/components/camel-facebook/src/main/docs/facebook-component.adoc
+++ b/components/camel-facebook/src/main/docs/facebook-component.adoc
@@ -63,10 +63,10 @@ The Facebook component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | FacebookConfiguration | To use the shared configuration
+| Name | Group | Default | Java Type | Description
+| configuration | | | FacebookConfiguration | To use the shared configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-flink/src/main/docs/flink-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-flink/src/main/docs/flink-component.adoc b/components/camel-flink/src/main/docs/flink-component.adoc
index 9d3c5ca..b0f79f9 100644
--- a/components/camel-flink/src/main/docs/flink-component.adoc
+++ b/components/camel-flink/src/main/docs/flink-component.adoc
@@ -75,13 +75,13 @@ The Apache Flink component supports 4 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| dataSet | DataSet | DataSet to compute against.
-| dataStream | DataStream | DataStream to compute against.
-| dataSetCallback | DataSetCallback | Function performing action against a DataSet.
-| dataStreamCallback | DataStreamCallback | Function performing action against a DataStream.
+| Name | Group | Default | Java Type | Description
+| dataSet | | | DataSet | DataSet to compute against.
+| dataStream | | | DataStream | DataStream to compute against.
+| dataSetCallback | | | DataSetCallback | Function performing action against a DataSet.
+| dataStreamCallback | | | DataStreamCallback | Function performing action against a DataStream.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-freemarker/src/main/docs/freemarker-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-freemarker/src/main/docs/freemarker-component.adoc b/components/camel-freemarker/src/main/docs/freemarker-component.adoc
index 232caab..465c80e 100644
--- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc
+++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc
@@ -48,10 +48,10 @@ The Freemarker component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | Configuration | To use an existing freemarker.template.Configuration instance as the configuration.
+| Name | Group | Default | Java Type | Description
+| configuration | | | Configuration | To use an existing freemarker.template.Configuration instance as the configuration.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-ganglia/src/main/docs/ganglia-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ganglia/src/main/docs/ganglia-component.adoc b/components/camel-ganglia/src/main/docs/ganglia-component.adoc
index 7b887b1..cc59641 100644
--- a/components/camel-ganglia/src/main/docs/ganglia-component.adoc
+++ b/components/camel-ganglia/src/main/docs/ganglia-component.adoc
@@ -63,10 +63,10 @@ The Ganglia component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | GangliaConfiguration | To use the shared configuration
+| Name | Group | Default | Java Type | Description
+| configuration | | | GangliaConfiguration | To use the shared configuration
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
index 2a89ba0..6708568 100644
--- a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
+++ b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
@@ -48,11 +48,11 @@ The Google Calendar component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | GoogleCalendarConfiguration | To use the shared configuration
-| clientFactory | GoogleCalendarClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory
+| Name | Group | Default | Java Type | Description
+| configuration | | | GoogleCalendarConfiguration | To use the shared configuration
+| clientFactory | | | GoogleCalendarClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-google-drive/src/main/docs/google-drive-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-drive/src/main/docs/google-drive-component.adoc b/components/camel-google-drive/src/main/docs/google-drive-component.adoc
index 1da796f..2369186 100644
--- a/components/camel-google-drive/src/main/docs/google-drive-component.adoc
+++ b/components/camel-google-drive/src/main/docs/google-drive-component.adoc
@@ -73,11 +73,11 @@ The Google Drive component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | GoogleDriveConfiguration | To use the shared configuration
-| clientFactory | GoogleDriveClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory
+| Name | Group | Default | Java Type | Description
+| configuration | | | GoogleDriveConfiguration | To use the shared configuration
+| clientFactory | | | GoogleDriveClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-google-mail/src/main/docs/google-mail-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-mail/src/main/docs/google-mail-component.adoc b/components/camel-google-mail/src/main/docs/google-mail-component.adoc
index 40c99b1..202bc23 100644
--- a/components/camel-google-mail/src/main/docs/google-mail-component.adoc
+++ b/components/camel-google-mail/src/main/docs/google-mail-component.adoc
@@ -70,11 +70,11 @@ The Google Mail component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| configuration | GoogleMailConfiguration | To use the shared configuration
-| clientFactory | GoogleMailClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory
+| Name | Group | Default | Java Type | Description
+| configuration | | | GoogleMailConfiguration | To use the shared configuration
+| clientFactory | | | GoogleMailClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
index 0eb947f..3b5ea71 100644
--- a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
+++ b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
@@ -68,10 +68,10 @@ The Google Pubsub component supports 1 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| connectionFactory | GooglePubsubConnectionFactory | Sets the connection factory to use: provides the ability to explicitly manage connection credentials: - the path to the key file - the Service Account Key / Email pair
+| Name | Group | Default | Java Type | Description
+| connectionFactory | | | GooglePubsubConnectionFactory | Sets the connection factory to use: provides the ability to explicitly manage connection credentials: - the path to the key file - the Service Account Key / Email pair
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
index dd120b6..535aa98 100644
--- a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
+++ b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
@@ -56,11 +56,11 @@ The Guava EventBus component supports 2 options which are listed below.
{% raw %}
-[width="100%",cols="2,1m,7",options="header"]
+[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
-| Name | Java Type | Description
-| eventBus | EventBus | To use the given Guava EventBus instance
-| listenerInterface | Class<?> | The interface with method(s) marked with the Subscribe annotation. Dynamic proxy will be created over the interface so it could be registered as the EventBus listener. Particularly useful when creating multi-event listeners and for handling DeadEvent properly. This option cannot be used together with eventClass option.
+| Name | Group | Default | Java Type | Description
+| eventBus | | | EventBus | To use the given Guava EventBus instance
+| listenerInterface | | | Class<?> | The interface with method(s) marked with the Subscribe annotation. Dynamic proxy will be created over the interface so it could be registered as the EventBus listener. Particularly useful when creating multi-event listeners and for handling DeadEvent properly. This option cannot be used together with eventClass option.
|=======================================================================
{% endraw %}
// component options: END
[3/8] camel git commit: Lets reuse the header filter from the base
component instead
Posted by da...@apache.org.
Lets reuse the header filter from the base component instead
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/bba84aa2
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/bba84aa2
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/bba84aa2
Branch: refs/heads/master
Commit: bba84aa2416fc45cde917e7710ef9906f44b82f2
Parents: 8c0f3c3
Author: Claus Ibsen <da...@apache.org>
Authored: Wed Dec 21 19:58:07 2016 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Wed Dec 21 19:58:07 2016 +0100
----------------------------------------------------------------------
.../SjmsBatchComponentConfiguration.java | 17 +++++++++++
.../springboot/SjmsComponentConfiguration.java | 30 ++++++++++----------
.../src/main/docs/sjms-batch-component.adoc | 3 +-
.../src/main/docs/sjms-component.adoc | 2 +-
.../camel/component/sjms/SjmsComponent.java | 25 +++-------------
.../sjms/batch/SjmsBatchComponent.java | 4 +--
6 files changed, 41 insertions(+), 40 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/bba84aa2/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/batch/springboot/SjmsBatchComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/batch/springboot/SjmsBatchComponentConfiguration.java b/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/batch/springboot/SjmsBatchComponentConfiguration.java
index b611055..c1dc1a9 100644
--- a/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/batch/springboot/SjmsBatchComponentConfiguration.java
+++ b/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/batch/springboot/SjmsBatchComponentConfiguration.java
@@ -17,7 +17,9 @@
package org.apache.camel.component.sjms.batch.springboot;
import javax.jms.ConnectionFactory;
+import org.apache.camel.spi.HeaderFilterStrategy;
import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.NestedConfigurationProperty;
/**
* The sjms-batch component is a specialized for highly performant transactional
@@ -32,6 +34,12 @@ public class SjmsBatchComponentConfiguration {
* A ConnectionFactory is required to enable the SjmsBatchComponent.
*/
private ConnectionFactory connectionFactory;
+ /**
+ * To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter
+ * header to and from Camel message.
+ */
+ @NestedConfigurationProperty
+ private HeaderFilterStrategy headerFilterStrategy;
public ConnectionFactory getConnectionFactory() {
return connectionFactory;
@@ -40,4 +48,13 @@ public class SjmsBatchComponentConfiguration {
public void setConnectionFactory(ConnectionFactory connectionFactory) {
this.connectionFactory = connectionFactory;
}
+
+ public HeaderFilterStrategy getHeaderFilterStrategy() {
+ return headerFilterStrategy;
+ }
+
+ public void setHeaderFilterStrategy(
+ HeaderFilterStrategy headerFilterStrategy) {
+ this.headerFilterStrategy = headerFilterStrategy;
+ }
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/bba84aa2/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/springboot/SjmsComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/springboot/SjmsComponentConfiguration.java b/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/springboot/SjmsComponentConfiguration.java
index 0035ed3..daba7f4 100644
--- a/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/springboot/SjmsComponentConfiguration.java
+++ b/components-starter/camel-sjms-starter/src/main/java/org/apache/camel/component/sjms/springboot/SjmsComponentConfiguration.java
@@ -41,12 +41,6 @@ public class SjmsComponentConfiguration {
*/
private ConnectionFactory connectionFactory;
/**
- * To use a custom HeaderFilterStrategy to filter header to and from Camel
- * message.
- */
- @NestedConfigurationProperty
- private HeaderFilterStrategy headerFilterStrategy;
- /**
* A ConnectionResource is an interface that allows for customization and
* container control of the ConnectionFactory. See Plugable Connection
* Resource Management for further details.
@@ -92,6 +86,12 @@ public class SjmsComponentConfiguration {
*/
@NestedConfigurationProperty
private MessageCreatedStrategy messageCreatedStrategy;
+ /**
+ * To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter
+ * header to and from Camel message.
+ */
+ @NestedConfigurationProperty
+ private HeaderFilterStrategy headerFilterStrategy;
public ConnectionFactory getConnectionFactory() {
return connectionFactory;
@@ -101,15 +101,6 @@ public class SjmsComponentConfiguration {
this.connectionFactory = connectionFactory;
}
- public HeaderFilterStrategy getHeaderFilterStrategy() {
- return headerFilterStrategy;
- }
-
- public void setHeaderFilterStrategy(
- HeaderFilterStrategy headerFilterStrategy) {
- this.headerFilterStrategy = headerFilterStrategy;
- }
-
public ConnectionResource getConnectionResource() {
return connectionResource;
}
@@ -171,6 +162,15 @@ public class SjmsComponentConfiguration {
this.messageCreatedStrategy = messageCreatedStrategy;
}
+ public HeaderFilterStrategy getHeaderFilterStrategy() {
+ return headerFilterStrategy;
+ }
+
+ public void setHeaderFilterStrategy(
+ HeaderFilterStrategy headerFilterStrategy) {
+ this.headerFilterStrategy = headerFilterStrategy;
+ }
+
public static class TimedTaskManagerNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.sjms.taskmanager.TimedTaskManager.class;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/bba84aa2/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
index ba4bee4..6f8715e 100644
--- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
+++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
@@ -117,7 +117,7 @@ Component Options and Configurations
// component options: START
-The Simple JMS Batch component supports 1 options which are listed below.
+The Simple JMS Batch component supports 2 options which are listed below.
@@ -126,6 +126,7 @@ The Simple JMS Batch component supports 1 options which are listed below.
|=======================================================================
| Name | Java Type | Description
| connectionFactory | ConnectionFactory | A ConnectionFactory is required to enable the SjmsBatchComponent.
+| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/bba84aa2/components/camel-sjms/src/main/docs/sjms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/docs/sjms-component.adoc b/components/camel-sjms/src/main/docs/sjms-component.adoc
index 89cf99f..7a55fb9 100644
--- a/components/camel-sjms/src/main/docs/sjms-component.adoc
+++ b/components/camel-sjms/src/main/docs/sjms-component.adoc
@@ -113,7 +113,6 @@ The Simple JMS component supports 9 options which are listed below.
|=======================================================================
| Name | Java Type | Description
| connectionFactory | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
| connectionResource | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details.
| connectionCount | Integer | The maximum number of connections available to endpoints started under this component
| jmsKeyFormatStrategy | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
@@ -121,6 +120,7 @@ The Simple JMS component supports 9 options which are listed below.
| destinationCreationStrategy | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
| timedTaskManager | TimedTaskManager | To use a custom TimedTaskManager
| messageCreatedStrategy | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
+| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
|=======================================================================
{% endraw %}
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/bba84aa2/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsComponent.java b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsComponent.java
index 97797c9..01918a1 100644
--- a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsComponent.java
+++ b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsComponent.java
@@ -29,15 +29,13 @@ import org.apache.camel.component.sjms.jms.DestinationCreationStrategy;
import org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy;
import org.apache.camel.component.sjms.jms.MessageCreatedStrategy;
import org.apache.camel.component.sjms.taskmanager.TimedTaskManager;
-import org.apache.camel.impl.UriEndpointComponent;
-import org.apache.camel.spi.HeaderFilterStrategy;
-import org.apache.camel.spi.HeaderFilterStrategyAware;
+import org.apache.camel.impl.HeaderFilterStrategyComponent;
import org.apache.camel.spi.Metadata;
/**
* The <a href="http://camel.apache.org/sjms">Simple JMS</a> component.
*/
-public class SjmsComponent extends UriEndpointComponent implements HeaderFilterStrategyAware {
+public class SjmsComponent extends HeaderFilterStrategyComponent {
private ExecutorService asyncStartStopExecutorService;
@@ -46,8 +44,6 @@ public class SjmsComponent extends UriEndpointComponent implements HeaderFilterS
@Metadata(label = "advanced")
private ConnectionResource connectionResource;
@Metadata(label = "advanced")
- private HeaderFilterStrategy headerFilterStrategy = new SjmsHeaderFilterStrategy();
- @Metadata(label = "advanced")
private JmsKeyFormatStrategy jmsKeyFormatStrategy = new DefaultJmsKeyFormatStrategy();
@Metadata(defaultValue = "1")
private Integer connectionCount = 1;
@@ -78,8 +74,8 @@ public class SjmsComponent extends UriEndpointComponent implements HeaderFilterS
if (destinationCreationStrategy != null) {
endpoint.setDestinationCreationStrategy(destinationCreationStrategy);
}
- if (headerFilterStrategy != null) {
- endpoint.setHeaderFilterStrategy(headerFilterStrategy);
+ if (getHeaderFilterStrategy() != null) {
+ endpoint.setHeaderFilterStrategy(getHeaderFilterStrategy());
}
if (messageCreatedStrategy != null) {
endpoint.setMessageCreatedStrategy(messageCreatedStrategy);
@@ -154,19 +150,6 @@ public class SjmsComponent extends UriEndpointComponent implements HeaderFilterS
return connectionFactory;
}
- @Override
- public HeaderFilterStrategy getHeaderFilterStrategy() {
- return this.headerFilterStrategy;
- }
-
- /**
- * To use a custom HeaderFilterStrategy to filter header to and from Camel message.
- */
- @Override
- public void setHeaderFilterStrategy(HeaderFilterStrategy headerFilterStrategy) {
- this.headerFilterStrategy = headerFilterStrategy;
- }
-
/**
* A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory.
* See Plugable Connection Resource Management for further details.
http://git-wip-us.apache.org/repos/asf/camel/blob/bba84aa2/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchComponent.java b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchComponent.java
index 4403a68..9f2cf27 100644
--- a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchComponent.java
+++ b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchComponent.java
@@ -20,11 +20,11 @@ import java.util.Map;
import javax.jms.ConnectionFactory;
import org.apache.camel.Endpoint;
-import org.apache.camel.impl.UriEndpointComponent;
+import org.apache.camel.impl.HeaderFilterStrategyComponent;
import org.apache.camel.spi.Metadata;
import org.apache.camel.util.ObjectHelper;
-public class SjmsBatchComponent extends UriEndpointComponent {
+public class SjmsBatchComponent extends HeaderFilterStrategyComponent {
@Metadata(label = "advanced")
private ConnectionFactory connectionFactory;