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
