| // kafka-connector options: START |
| [[camel-amqp-kafka-connector-source]] |
| = camel-amqp-kafka-connector source configuration |
| |
| When using camel-amqp-kafka-connector as source make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-amqp-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-amqp source connector supports 134 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.destination Type* | The kind of destination to use One of: [queue] [topic] [temp-queue] [temp-topic] | "queue" | ConfigDef.Importance.MEDIUM |
| | *camel.source.path.destination Name* | Name of the queue or topic to use as destination | null | ConfigDef.Importance.HIGH |
| | *camel.source.endpoint.clientId* | 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. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.connection Factory* | The connection factory to be use. A connection factory must be configured either on the component or endpoint. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.disable ReplyTo* | Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.durable SubscriptionName* | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.jms MessageType* | Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it. One of: [Bytes] [Map] [Object] [Stream] [Text] | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.test ConnectionOnStartup* | Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well. | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.acknowledgement ModeName* | The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE One of: [SESSION_TRANSACTED] [CLIENT_ACKNOWLEDGE] [AUTO_ACKNOWLEDGE] [DUPS_OK_ACKNOWLEDGE] | "AUTO_ACKNOWLEDGE" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.async Consumer* | 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). | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.auto Startup* | Specifies whether the consumer container should auto-startup. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.cache Level* | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.cache LevelName* | 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. One of: [CACHE_AUTO] [CACHE_CONNECTION] [CACHE_CONSUMER] [CACHE_NONE] [CACHE_SESSION] | "CACHE_AUTO" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.concurrent Consumers* | 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. | 1 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.max ConcurrentConsumers* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.replyTo* | Provides an explicit ReplyTo destination, which overrides any incoming value of Message.getJMSReplyTo(). | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.replyTo DeliveryPersistent* | Specifies whether to use persistent delivery by default for replies. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.selector* | Sets the JMS selector to use | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.subscription Durable* | Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.subscription Name* | Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0). | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.subscription Shared* | Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.accept MessagesWhileStopping* | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.allow ReplyManagerQuickStop* | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.consumer Type* | 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. One of: [Simple] [Default] [Custom] | "Default" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.default TaskExecutorType* | 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. One of: [ThreadPool] [SimpleAsync] | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.eager LoadingOfProperties* | Enables eager loading of JMS properties and payload 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. See also the option eagerPoisonBody. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.eager PoisonBody* | If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties. | "Poison JMS message due to ${exception.message}" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.exception Handler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.expose ListenerSession* | Specifies whether the listener session should be exposed when consuming messages. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.replyTo SameDestinationAllowed* | 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. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.task Executor* | Allows you to specify a custom task executor for consuming messages. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.allow SerializedHeaders* | Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.async StartListener* | 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. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.async StopListener* | Whether to stop the JmsConsumer message listener asynchronously, when stopping a route. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.destination Resolver* | 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). | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.error Handler* | 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. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.exception Listener* | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.header FilterStrategy* | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.idle ConsumerLimit* | Specify the limit for the number of consumers that are allowed to be idle at any given time. | 1 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.idleTask ExecutionLimit* | 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. | 1 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.include AllJMSXProperties* | 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. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.jmsKey FormatStrategy* | 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. One of: [default] [passthrough] | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.mapJms Message* | Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.max MessagesPerTask* | 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. | -1 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.message Converter* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.message CreatedStrategy* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.message IdEnabled* | 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. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.message ListenerContainerFactory* | Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.message TimestampEnabled* | 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. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.pubSubNo Local* | Specifies whether to inhibit the delivery of messages published by its own connection. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.receive Timeout* | The timeout for receiving messages (in milliseconds). | 1000L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.recovery Interval* | 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. | 5000L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.request TimeoutCheckerInterval* | 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. | 1000L | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.transfer Exception* | 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. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer! | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.transfer Exchange* | 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. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer having to use compatible Camel versions! | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.use MessageIDAsCorrelationID* | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.waitFor ProvisionCorrelationToBe UpdatedCounter* | Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled. | 50 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.waitFor ProvisionCorrelationToBe UpdatedThreadSleepingTime* | Interval in millis to sleep each time while waiting for provisional correlation id to be updated. | 100L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.error HandlerLoggingLevel* | Allows to configure the default errorHandler logging level for logging uncaught exceptions. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF] | "WARN" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.error HandlerLogStackTrace* | Allows to control whether stacktraces should be logged or not, by the default errorHandler. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.password* | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.username* | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.transacted* | Specifies whether to use transacted mode | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.lazy CreateTransactionManager* | If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true. | true | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.transaction Manager* | The Spring transaction manager to use. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.transaction Name* | The name of the transaction to use. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.transaction Timeout* | The timeout value of the transaction (in seconds), if using transacted mode. | -1 | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.clientId* | 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. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.connection Factory* | The connection factory to be use. A connection factory must be configured either on the component or endpoint. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.durable SubscriptionName* | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.include AmqpAnnotations* | Whether to include AMQP annotations when mapping from AMQP to Camel Message. Setting this to true will map AMQP message annotations to message headers. Due to limitations in Apache Qpid JMS API, currently delivery annotations are ignored. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.test ConnectionOnStartup* | Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well. | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.acknowledgement Mode* | 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. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.acknowledgement ModeName* | The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE One of: [SESSION_TRANSACTED] [CLIENT_ACKNOWLEDGE] [AUTO_ACKNOWLEDGE] [DUPS_OK_ACKNOWLEDGE] | "AUTO_ACKNOWLEDGE" | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.async Consumer* | 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). | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.auto Startup* | Specifies whether the consumer container should auto-startup. | true | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.bridge ErrorHandler* | 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 or ERROR level and ignored. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.cache Level* | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.cache LevelName* | 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. One of: [CACHE_AUTO] [CACHE_CONNECTION] [CACHE_CONSUMER] [CACHE_NONE] [CACHE_SESSION] | "CACHE_AUTO" | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.concurrent Consumers* | 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. | 1 | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.max ConcurrentConsumers* | 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. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.subscription Durable* | Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.subscription Name* | Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0). | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.subscription Shared* | Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.accept MessagesWhileStopping* | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.allow ReplyManagerQuickStop* | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.default TaskExecutorType* | 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. One of: [ThreadPool] [SimpleAsync] | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.eager LoadingOfProperties* | 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. See also the option eagerLoadingOfBody. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.eager PoisonBody* | If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties. | "Poison JMS message due to ${exception.message}" | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.expose ListenerSession* | Specifies whether the listener session should be exposed when consuming messages. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.task Executor* | Allows you to specify a custom task executor for consuming messages. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.allowAuto WiredConnectionFactory* | Whether to auto-discover ConnectionFactory from the registry, if no connection factory has been configured. If only one instance of ConnectionFactory is found then it will be used. This is enabled by default. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.allowAuto WiredDestinationResolver* | Whether to auto-discover DestinationResolver from the registry, if no destination resolver has been configured. If only one instance of DestinationResolver is found then it will be used. This is enabled by default. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.async StartListener* | 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. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.asyncStop Listener* | Whether to stop the JmsConsumer message listener asynchronously, when stopping a route. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.configuration* | To use a shared JMS configuration | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.destination Resolver* | 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). | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.error Handler* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.exception Listener* | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.idle ConsumerLimit* | Specify the limit for the number of consumers that are allowed to be idle at any given time. | 1 | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.idleTask ExecutionLimit* | 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. | 1 | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.include AllJMSXProperties* | 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. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.jmsKey FormatStrategy* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.jms Operations* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.mapJms Message* | Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc. | true | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.max MessagesPerTask* | 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. | -1 | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.message Converter* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.message CreatedStrategy* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.messageId Enabled* | 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. | true | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.message TimestampEnabled* | 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. | true | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.pubSubNo Local* | Specifies whether to inhibit the delivery of messages published by its own connection. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.queue BrowseStrategy* | To use a custom QueueBrowseStrategy when browsing queues | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.receive Timeout* | The timeout for receiving messages (in milliseconds). | 1000L | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.recovery Interval* | 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. | 5000L | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.request TimeoutCheckerInterval* | 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. | 1000L | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.transfer Exception* | 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. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer! | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.transfer Exchange* | 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. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer having to use compatible Camel versions! | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.use MessageIDAsCorrelationID* | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.waitFor ProvisionCorrelationToBe UpdatedCounter* | Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled. | 50 | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.waitFor ProvisionCorrelationToBe UpdatedThreadSleepingTime* | Interval in millis to sleep each time while waiting for provisional correlation id to be updated. | 100L | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.error HandlerLoggingLevel* | Allows to configure the default errorHandler logging level for logging uncaught exceptions. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF] | "WARN" | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.error HandlerLogStackTrace* | Allows to control whether stacktraces should be logged or not, by the default errorHandler. | true | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.header FilterStrategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.password* | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.username* | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.transacted* | Specifies whether to use transacted mode | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.amqp.lazy CreateTransactionManager* | If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true. | true | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.transaction Manager* | The Spring transaction manager to use. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.transaction Name* | The name of the transaction to use. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.amqp.transaction Timeout* | The timeout value of the transaction (in seconds), if using transacted mode. | -1 | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
