UNPKG

karavan-core

Version:
2 lines 6.36 MB
[ {"component":{"kind":"component","name":"activemq","title":"ActiveMQ 5.x","description":"Send messages to (or consume from) Apache ActiveMQ 5.x. This component extends the Camel JMS component.","deprecated":false,"firstVersion":"1.0.0","label":"messaging","javaType":"org.apache.camel.component.activemq.ActiveMQComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-activemq","version":"4.8.0","scheme":"activemq","extendsScheme":"jms","syntax":"activemq:destinationType:destinationName","async":true,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false,"remote":true},"headers":{"CamelJmsDestination":{"index":0,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION"},"CamelJmsDestinationName":{"index":1,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic to use as destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME"},"CamelJMSDestinationProduced":{"index":2,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the queue or topic the message was sent to.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_DESTINATION_NAME_PRODUCED"},"JMSXGroupID":{"index":3,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS group ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_X_GROUP_ID"},"JMSMessageID":{"index":4,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS unique message ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_MESSAGE_ID"},"JMSCorrelationID":{"index":5,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID"},"JMSCorrelationIDAsBytes":{"index":6,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS correlation ID as bytes.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_CORRELATION_ID_AS_BYTES"},"JMSDeliveryMode":{"index":7,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS delivery mode.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DELIVERY_MODE"},"JMSDestination":{"index":8,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_DESTINATION"},"JMSExpiration":{"index":9,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS expiration.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_EXPIRATION"},"JMSPriority":{"index":10,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS priority (with 0 as the lowest priority and 9 as the highest).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_PRIORITY"},"JMSRedelivered":{"index":11,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is the JMS message redelivered.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REDELIVERED"},"JMSTimestamp":{"index":12,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS timestamp.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TIMESTAMP"},"JMSReplyTo":{"index":13,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"jakarta.jms.Destination","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS reply-to destination.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_REPLY_TO"},"JMSType":{"index":14,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The JMS type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_TYPE"},"JMSXUserID":{"index":15,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The XUser id.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_HEADER_XUSER_ID"},"CamelJmsMessageType":{"index":16,"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text","Blob"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message type.","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_MESSAGE_TYPE"},"CamelJmsRequestTimeout":{"index":17,"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"20_000","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).","constantName":"org.apache.camel.component.jms.JmsConstants#JMS_REQUEST_TIMEOUT"}},"properties":{"destinationType":{"index":0,"kind":"path","displayName":"Destination Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["queue","topic","temp-queue","temp-topic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"queue","description":"The kind of destination to use"},"destinationName":{"index":1,"kind":"path","displayName":"Destination Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the queue or topic to use as destination"},"clientId":{"index":2,"kind":"parameter","displayName":"Client Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions with JMS 1.1."},"connectionFactory":{"index":3,"kind":"parameter","displayName":"Connection Factory","group":"common","label":"","required":false,"type":"object","javaType":"jakarta.jms.ConnectionFactory","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The connection factory to be use. A connection factory must be configured either on the component or endpoint."},"disableReplyTo":{"index":4,"kind":"parameter","displayName":"Disable Reply To","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"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."},"durableSubscriptionName":{"index":5,"kind":"parameter","displayName":"Durable Subscription Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."},"jmsMessageType":{"index":6,"kind":"parameter","displayName":"Jms Message Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.jms.JmsMessageType","enum":["Bytes","Map","Object","Stream","Text"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to force the use of a specific jakarta.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."},"replyTo":{"index":7,"kind":"parameter","displayName":"Reply To","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer)."},"testConnectionOnStartup":{"index":8,"kind":"parameter","displayName":"Test Connection On Startup","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."},"acknowledgementModeName":{"index":9,"kind":"parameter","displayName":"Acknowledgement Mode Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["SESSION_TRANSACTED","CLIENT_ACKNOWLEDGE","AUTO_ACKNOWLEDGE","DUPS_OK_ACKNOWLEDGE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AUTO_ACKNOWLEDGE","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"},"artemisConsumerPriority":{"index":10,"kind":"parameter","displayName":"Artemis Consumer Priority","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer)."},"asyncConsumer":{"index":11,"kind":"parameter","displayName":"Async Consumer","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."},"autoStartup":{"index":12,"kind":"parameter","displayName":"Auto Startup","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer container should auto-startup."},"cacheLevel":{"index":13,"kind":"parameter","displayName":"Cache Level","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."},"cacheLevelName":{"index":14,"kind":"parameter","displayName":"Cache Level Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CACHE_AUTO","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."},"concurrentConsumers":{"index":15,"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"maxConcurrentConsumers":{"index":16,"kind":"parameter","displayName":"Max Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."},"replyToDeliveryPersistent":{"index":17,"kind":"parameter","displayName":"Reply To Delivery Persistent","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether to use persistent delivery by default for replies."},"selector":{"index":18,"kind":"parameter","displayName":"Selector","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS selector to use"},"subscriptionDurable":{"index":19,"kind":"parameter","displayName":"Subscription Durable","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"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."},"subscriptionName":{"index":20,"kind":"parameter","displayName":"Subscription Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"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)."},"subscriptionShared":{"index":21,"kind":"parameter","displayName":"Subscription Shared","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"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."},"acceptMessagesWhileStopping":{"index":22,"kind":"parameter","displayName":"Accept Messages While Stopping","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."},"allowReplyManagerQuickStop":{"index":23,"kind":"parameter","displayName":"Allow Reply Manager Quick Stop","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."},"consumerType":{"index":24,"kind":"parameter","displayName":"Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"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":{"index":25,"kind":"parameter","displayName":"Default Task Executor Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.DefaultTaskExecutorType","enum":["ThreadPool","SimpleAsync"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached thread-pool-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."},"destinationOptions":{"index":26,"kind":"parameter","displayName":"Destination Options","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.String>","prefix":"destination.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Destination Options are a way to provide extended configuration options to a JMS consumer without having to extend the JMS API. The options are encoded using URL query syntax in the destination name that the consumer is created on. See more details at https://activemq.apache.org/destination-options."},"eagerLoadingOfProperties":{"index":27,"kind":"parameter","displayName":"Eager Loading Of Properties","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"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."},"eagerPoisonBody":{"index":28,"kind":"parameter","displayName":"Eager Poison Body","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Poison JMS message due to ${exception.message}","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"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."},"exceptionHandler":{"index":29,"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"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."},"exchangePattern":{"index":30,"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"exposeListenerSession":{"index":31,"kind":"parameter","displayName":"Expose Listener Session","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether the listener session should be exposed when consuming messages."},"replyToConsumerType":{"index":32,"kind":"parameter","displayName":"Reply To Consumer Type","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ConsumerType","enum":["Simple","Default","Custom"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Default","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The consumer type of the reply consumer (when doing request/reply), 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."},"replyToSameDestinationAllowed":{"index":33,"kind":"parameter","displayName":"Reply To Same Destination Allowed","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"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":{"index":34,"kind":"parameter","displayName":"Task Executor","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.springframework.core.task.TaskExecutor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows you to specify a custom task executor for consuming messages."},"deliveryDelay":{"index":35,"kind":"parameter","displayName":"Delivery Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker."},"deliveryMode":{"index":36,"kind":"parameter","displayName":"Delivery Mode","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","enum":["1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."},"deliveryPersistent":{"index":37,"kind":"parameter","displayName":"Delivery Persistent","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies whether persistent delivery is used by default."},"explicitQosEnabled":{"index":38,"kind":"parameter","displayName":"Explicit Qos Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."},"formatDateHeadersToIso8601":{"index":39,"kind":"parameter","displayName":"Format Date Headers To Iso8601","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether JMS date properties should be formatted according to the ISO 8601 standard."},"preserveMessageQos":{"index":40,"kind":"parameter","displayName":"Preserve Message Qos","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."},"priority":{"index":41,"kind":"parameter","displayName":"Priority","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","enum":["1","2","3","4","5","6","7","8","9"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":4,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Values greater than 1 specify the message priority when sending (where 1 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."},"replyToConcurrentConsumers":{"index":42,"kind":"parameter","displayName":"Reply To Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToMaxConcurrentConsumers":{"index":43,"kind":"parameter","displayName":"Reply To Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."},"replyToOnTimeoutMaxConcurrentConsumers":{"index":44,"kind":"parameter","displayName":"Reply To On Timeout Max Concurrent Consumers","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."},"replyToOverride":{"index":45,"kind":"parameter","displayName":"Reply To Override","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."},"replyToType":{"index":46,"kind":"parameter","displayName":"Reply To Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.jms.ReplyToType","enum":["Temporary","Shared","Exclusive"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."},"requestTimeout":{"index":47,"kind":"parameter","displayName":"Request Timeout","group":"producer","label":"producer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"20000","configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."},"timeToLive":{"index":48,"kind":"parameter","displayName":"Time To Live","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When sending messages, specifies the time-to-live of the message (in milliseconds)."},"allowAdditionalHeaders":{"index":49,"kind":"parameter","displayName":"Allow Additional Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example, some message systems, such as WMQ, do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."},"allowNullBody":{"index":50,"kind":"parameter","displayName":"Allow Null Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."},"alwaysCopyMessage":{"index":51,"kind":"parameter","displayName":"Always Copy Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"},"correlationProperty":{"index":52,"kind":"parameter","displayName":"Correlation Property","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel."},"disableTimeToLive":{"index":53,"kind":"parameter","displayName":"Disable Time To Live","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."},"forceSendOriginalMessage":{"index":54,"kind":"parameter","displayName":"Force Send Original Message","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."},"includeSentJMSMessageID":{"index":55,"kind":"parameter","displayName":"Include Sent JMSMessage ID","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."},"lazyStartProducer":{"index":56,"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."},"replyToCacheLevelName":{"index":57,"kind":"parameter","displayName":"Reply To Cache Level Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","enum":["CACHE_AUTO","CACHE_CONNECTION","CACHE_CONSUMER","CACHE_NONE","CACHE_SESSION"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."},"replyToDestinationSelectorName":{"index":58,"kind":"parameter","displayName":"Reply To Destination Selector Name","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."},"streamMessageTypeEnabled":{"index":59,"kind":"parameter","displayName":"Stream Message Type Enabled","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."},"allowSerializedHeaders":{"index":60,"kind":"parameter","displayName":"Allow Serialized Headers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"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."},"artemisStreamingEnabled":{"index":61,"kind":"parameter","displayName":"Artemis Streaming Enabled","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used."},"asyncStartListener":{"index":62,"kind":"parameter","displayName":"Async Start Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jms.JmsConfiguration","configurationField":"configuration","description":"Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail-over. 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":{"index":63,"kind":"parameter","displayName":"Async Stop Listener","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecate