http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 969b86a..26480ae 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -222,80 +222,80 @@ The JMS component supports 74 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configuration | | | JmsConfiguration | To use a shared JMS configuration -| acceptMessagesWhileStopping | | 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 | | 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. -| 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 | | 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 -| 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 | | false | 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 | | false | 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 | | false | 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 | | false | 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 | | false | 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 | | false | 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 | | false | 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 | | false | 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 | | false | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route. -| forceSendOriginalMessage | | false | 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 | | false | 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 | | false | 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 | | false | 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 | | false | 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 | | 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). -| 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 | | false | 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 | | false | 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. +| configuration | advanced | | JmsConfiguration | To use a shared JMS configuration +| 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. +| acknowledgementMode | consumer | | 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 | 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 +| acknowledgementModeName | consumer | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE +| autoStartup | consumer | true | boolean | Specifies whether the consumer container should auto-startup. +| 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. +| replyToCacheLevelName | producer (advanced) | | 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 | common | | 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 | 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. +| replyToConcurrentConsumers | producer | 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 | common | | ConnectionFactory | The connection factory to be use. A connection factory must be configured either on the component or endpoint. +| username | security | | String | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. +| password | security | | String | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. +| deliveryPersistent | producer | true | boolean | Specifies whether persistent delivery is used by default. +| deliveryMode | producer | | 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 | common | | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. +| exceptionListener | advanced | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. +| errorHandler | advanced | | 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 | advanced | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions. +| errorHandlerLogStackTrace | advanced | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler. +| 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. +| exposeListenerSession | consumer (advanced) | false | boolean | Specifies whether the listener session should be exposed when consuming messages. +| idleTaskExecutionLimit | advanced | 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 | advanced | 1 | int | Specify the limit for the number of consumers that are allowed to be idle at any given time. +| 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. +| replyToMaxConcurrentConsumers | producer | | 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 | producer | 1 | int | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS. +| maxMessagesPerTask | advanced | -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 | advanced | | 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 | advanced | 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 | advanced | 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 | advanced | true | boolean | Specifies whether timestamps should be enabled by default on sending messages. +| alwaysCopyMessage | producer (advanced) | false | 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 | advanced | false | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. +| priority | producer | 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 | advanced | false | boolean | Specifies whether to inhibit the delivery of messages published by its own connection. +| receiveTimeout | advanced | 1000 | long | The timeout for receiving messages (in milliseconds). +| recoveryInterval | advanced | 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 | common | false | boolean | Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId. +| taskExecutor | consumer (advanced) | | TaskExecutor | Allows you to specify a custom task executor for consuming messages. +| timeToLive | producer | -1 | long | When sending messages specifies the time-to-live of the message (in milliseconds). +| transacted | transaction | false | boolean | Specifies whether to use transacted mode +| lazyCreateTransactionManager | transaction (advanced) | true | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true. +| transactionManager | transaction (advanced) | | PlatformTransactionManager | The Spring transaction manager to use. +| transactionName | transaction (advanced) | | String | The name of the transaction to use. +| transactionTimeout | transaction (advanced) | -1 | int | The timeout value of the transaction (in seconds) if using transacted mode. +| testConnectionOnStartup | common | false | 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 | advanced | false | 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 | advanced | false | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route. +| forceSendOriginalMessage | producer (advanced) | false | 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 | producer | 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 | advanced | 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 | advanced | false | 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 | advanced | false | 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 | advanced | false | 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 | advanced | | 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 | advanced | | 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 | producer | | 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 | producer | false | 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 | 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). +| allowNullBody | producer (advanced) | 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 | producer (advanced) | false | 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 | advanced | false | 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 | 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. +| jmsKeyFormatStrategy | advanced | | 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 | common | | ApplicationContext | Sets the Spring ApplicationContext to use +| queueBrowseStrategy | advanced | | QueueBrowseStrategy | To use a custom QueueBrowseStrategy when browsing queues +| messageCreatedStrategy | advanced | | 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 | advanced | 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 | advanced | 100 | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated. +| headerFilterStrategy | filter | | 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/e4c6ab4e/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 8e37ba6..f025c3f 100644 --- a/components/camel-jolt/src/main/docs/jolt-component.adoc +++ b/components/camel-jolt/src/main/docs/jolt-component.adoc @@ -55,7 +55,7 @@ The JOLT component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 +| transform | advanced | | 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/e4c6ab4e/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 f017236..64ad18e 100644 --- a/components/camel-jpa/src/main/docs/jpa-component.adoc +++ b/components/camel-jpa/src/main/docs/jpa-component.adoc @@ -100,10 +100,10 @@ The JPA component supports 4 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 | | false | 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. +| entityManagerFactory | common | | EntityManagerFactory | To use the EntityManagerFactory. This is strongly recommended to configure. +| transactionManager | common | | PlatformTransactionManager | To use the PlatformTransactionManager for managing transactions. +| joinTransaction | common | 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 | common | false | 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/e4c6ab4e/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 8de2509..d1b2636 100644 --- a/components/camel-jsch/src/main/docs/scp-component.adoc +++ b/components/camel-jsch/src/main/docs/scp-component.adoc @@ -53,7 +53,7 @@ The SCP component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| verboseLogging | | false | 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. +| verboseLogging | producer | false | 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/e4c6ab4e/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 f08d72c..1fcd876 100644 --- a/components/camel-jt400/src/main/docs/jt400-component.adoc +++ b/components/camel-jt400/src/main/docs/jt400-component.adoc @@ -50,7 +50,7 @@ The JT400 component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| connectionPool | | | AS400ConnectionPool | Returns the default connection pool used by this component. +| connectionPool | advanced | | AS400ConnectionPool | Returns the default connection pool used by this component. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 db42f60..0a04ca9 100644 --- a/components/camel-kafka/src/main/docs/kafka-component.adoc +++ b/components/camel-kafka/src/main/docs/kafka-component.adoc @@ -71,7 +71,7 @@ The Kafka component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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. +| workerPool | advanced | | 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/e4c6ab4e/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 fb6aff4..36d0c75 100644 --- a/components/camel-kestrel/src/main/docs/kestrel-component.adoc +++ b/components/camel-kestrel/src/main/docs/kestrel-component.adoc @@ -78,7 +78,7 @@ The Kestrel component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configuration | | | KestrelConfiguration | To use a shared configured configuration as base for creating new endpoints. +| configuration | advanced | | 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/e4c6ab4e/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 1e4f250..d69dd74 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 @@ -66,7 +66,7 @@ The Linkedin component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configuration | | | LinkedInConfiguration | To use the shared configuration +| configuration | common | | LinkedInConfiguration | To use the shared configuration |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 25e1ddd..165574d 100644 --- a/components/camel-lucene/src/main/docs/lucene-component.adoc +++ b/components/camel-lucene/src/main/docs/lucene-component.adoc @@ -65,7 +65,7 @@ The Lucene component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| config | | | LuceneConfiguration | To use a shared lucene configuration +| config | advanced | | LuceneConfiguration | To use a shared lucene configuration |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 e2ae0a0..66d567b 100644 --- a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc +++ b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc @@ -51,7 +51,7 @@ The Lumberjack component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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. +| sslContextParameters | security | | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 eb58f9d..5fa43dd 100644 --- a/components/camel-mail/src/main/docs/mail-component.adoc +++ b/components/camel-mail/src/main/docs/mail-component.adoc @@ -88,8 +88,8 @@ The Mail component supports 2 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configuration | | | MailConfiguration | Sets the Mail configuration -| contentTypeResolver | | | ContentTypeResolver | Resolver to determine Content-Type for file attachments. +| configuration | advanced | | MailConfiguration | Sets the Mail configuration +| contentTypeResolver | advanced | | ContentTypeResolver | Resolver to determine Content-Type for file attachments. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 4bacac4..37500a1 100644 --- a/components/camel-metrics/src/main/docs/metrics-component.adoc +++ b/components/camel-metrics/src/main/docs/metrics-component.adoc @@ -57,7 +57,7 @@ The Metrics component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| metricRegistry | | | MetricRegistry | To use a custom configured MetricRegistry. +| metricRegistry | advanced | | MetricRegistry | To use a custom configured MetricRegistry. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 c7d3a12..e9d70be 100644 --- a/components/camel-mina/src/main/docs/mina-component.adoc +++ b/components/camel-mina/src/main/docs/mina-component.adoc @@ -76,7 +76,7 @@ The Mina component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configuration | | | MinaConfiguration | To use the shared mina configuration. +| configuration | advanced | | MinaConfiguration | To use the shared mina configuration. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 d610b3f..5a7b284 100644 --- a/components/camel-mina2/src/main/docs/mina2-component.adoc +++ b/components/camel-mina2/src/main/docs/mina2-component.adoc @@ -77,7 +77,7 @@ The Mina2 component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configuration | | | Mina2Configuration | To use the shared mina configuration. +| configuration | advanced | | Mina2Configuration | To use the shared mina configuration. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 3b8e918..92c3859 100644 --- a/components/camel-mqtt/src/main/docs/mqtt-component.adoc +++ b/components/camel-mqtt/src/main/docs/mqtt-component.adoc @@ -49,9 +49,9 @@ The MQTT component supports 3 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 +| host | common | | String | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883 +| userName | security | | String | Username to be used for authentication against the MQTT broker +| password | security | | 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/e4c6ab4e/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 a5dcf90..6aed8af 100644 --- a/components/camel-msv/src/main/docs/msv-component.adoc +++ b/components/camel-msv/src/main/docs/msv-component.adoc @@ -63,8 +63,8 @@ The MSV component supports 2 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 +| schemaFactory | advanced | | SchemaFactory | To use the javax.xml.validation.SchemaFactory. +| resourceResolverFactory | advanced | | 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/e4c6ab4e/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 681f264..bd806a9 100644 --- a/components/camel-mustache/src/main/docs/mustache-component.adoc +++ b/components/camel-mustache/src/main/docs/mustache-component.adoc @@ -54,7 +54,7 @@ The Mustache component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| mustacheFactory | | | MustacheFactory | To use a custom MustacheFactory +| mustacheFactory | advanced | | MustacheFactory | To use a custom MustacheFactory |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 46d4b23..bc476f0 100644 --- a/components/camel-mybatis/src/main/docs/mybatis-component.adoc +++ b/components/camel-mybatis/src/main/docs/mybatis-component.adoc @@ -58,8 +58,8 @@ The MyBatis component supports 2 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 +| sqlSessionFactory | advanced | | SqlSessionFactory | To use the SqlSessionFactory +| configurationUri | common | 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/e4c6ab4e/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 2b92977..710d28f 100644 --- a/components/camel-nagios/src/main/docs/nagios-component.adoc +++ b/components/camel-nagios/src/main/docs/nagios-component.adoc @@ -52,7 +52,7 @@ The Nagios component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configuration | | | NagiosConfiguration | To use a shared NagiosConfiguration +| configuration | advanced | | NagiosConfiguration | To use a shared NagiosConfiguration |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 f309672..78ee8f7 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 @@ -90,11 +90,11 @@ The Netty HTTP component supports 5 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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. +| nettyHttpBinding | advanced | | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. +| configuration | common | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints. +| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. +| securityConfiguration | security | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. +| maximumPoolSize | advanced | 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/e4c6ab4e/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 ea32801..b694e39 100644 --- a/components/camel-netty/src/main/docs/netty-component.adoc +++ b/components/camel-netty/src/main/docs/netty-component.adoc @@ -70,8 +70,8 @@ The Netty component supports 2 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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. +| configuration | advanced | | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. +| maximumPoolSize | advanced | 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/e4c6ab4e/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 c6b65b0..f5d0616 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 @@ -89,12 +89,12 @@ The Netty4 HTTP component supports 6 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 +| nettyHttpBinding | advanced | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. +| configuration | common | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints. +| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. +| securityConfiguration | security | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. +| maximumPoolSize | advanced | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. +| executorService | advanced | | EventExecutorGroup | To use the given EventExecutorGroup |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 cdb1dd7..1546d1d 100644 --- a/components/camel-netty4/src/main/docs/netty4-component.adoc +++ b/components/camel-netty4/src/main/docs/netty4-component.adoc @@ -67,9 +67,9 @@ The Netty4 component supports 3 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 +| maximumPoolSize | advanced | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. +| configuration | advanced | | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. +| executorService | advanced | | EventExecutorGroup | To use the given EventExecutorGroup |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 84cc765..60b63d7 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 @@ -57,7 +57,7 @@ The Olingo2 component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configuration | | | Olingo2Configuration | To use the shared configuration +| configuration | common | | Olingo2Configuration | To use the shared configuration |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 d996ddb..dc9cfbc 100644 --- a/components/camel-openshift/src/main/docs/openshift-component.adoc +++ b/components/camel-openshift/src/main/docs/openshift-component.adoc @@ -47,10 +47,10 @@ The OpenShift component supports 4 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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. +| username | security | | String | The username to login to openshift server. +| password | security | | String | The password for login to openshift server. +| domain | common | | String | Domain name. If not specified then the default domain is used. +| server | common | | 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/e4c6ab4e/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 6378461..0555dae 100644 --- a/components/camel-paho/src/main/docs/paho-component.adoc +++ b/components/camel-paho/src/main/docs/paho-component.adoc @@ -135,9 +135,9 @@ The Paho component supports 3 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| brokerUrl | | | String | The URL of the MQTT broker. -| clientId | | | String | MQTT client identifier. -| connectOptions | | | MqttConnectOptions | Client connection options +| brokerUrl | common | | String | The URL of the MQTT broker. +| clientId | common | | String | MQTT client identifier. +| connectOptions | advanced | | MqttConnectOptions | Client connection options |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 0c25595..727d14c 100644 --- a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc +++ b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc @@ -53,7 +53,7 @@ The OSGi PAX Logging component supports 1 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| bundleContext | | | BundleContext | The OSGi BundleContext is automatic injected by Camel +| bundleContext | consumer | | BundleContext | The OSGi BundleContext is automatic injected by Camel |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/e4c6ab4e/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 cc53808..702c4a9 100644 --- a/components/camel-quartz/src/main/docs/quartz-component.adoc +++ b/components/camel-quartz/src/main/docs/quartz-component.adoc @@ -58,13 +58,13 @@ The Quartz component supports 7 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 +| factory | advanced | | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler. +| scheduler | advanced | | Scheduler | To use the custom configured Quartz scheduler instead of creating a new Scheduler. +| properties | consumer | | Properties | Properties to configure the Quartz scheduler. +| propertiesFile | consumer | | String | File name of the properties to load from the classpath +| startDelayedSeconds | scheduler | | int | Seconds to wait before starting the quartz scheduler. +| autoStartScheduler | consumer | true | boolean | Whether or not the scheduler should be auto started. This options is default true +| enableJmx | consumer | 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/e4c6ab4e/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 8d80737..cbbf6cd 100644 --- a/components/camel-quartz2/src/main/docs/quartz2-component.adoc +++ b/components/camel-quartz2/src/main/docs/quartz2-component.adoc @@ -61,15 +61,15 @@ The Quartz2 component supports 9 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 | | false | 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. +| autoStartScheduler | scheduler | true | boolean | Whether or not the scheduler should be auto started. This options is default true +| startDelayedSeconds | scheduler | | int | Seconds to wait before starting the quartz scheduler. +| prefixJobNameWithEndpointId | consumer | false | boolean | Whether to prefix the quartz job with the endpoint id. This option is default false. +| enableJmx | consumer | true | boolean | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true +| properties | consumer | | Properties | Properties to configure the Quartz scheduler. +| propertiesFile | consumer | | String | File name of the properties to load from the classpath +| prefixInstanceName | consumer | 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 | advanced | | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler. +| scheduler | advanced | | 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/e4c6ab4e/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 e39e750..b093148 100644 --- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc +++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc @@ -99,11 +99,11 @@ The QuickFix component supports 5 options which are listed below. [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | 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 | | false | boolean | If set to true the engines will be created and started when needed (when first message is send) +| messageFactory | advanced | | MessageFactory | To use the given MessageFactory +| logFactory | advanced | | LogFactory | To use the given LogFactory +| messageStoreFactory | advanced | | MessageStoreFactory | To use the given MessageStoreFactory +| configurations | common | | Map | To use the given map of pre configured QuickFix configurations mapped to the key +| lazyCreateEngines | common | false | boolean | If set to true the engines will be created and started when needed (when first message is send) |======================================================================= {% endraw %} // component options: END
