connectors.camel-sjms2-sink.json Maven / Gradle / Ivy
The newest version!
{
"connector": {
"class": "org.apache.camel.kafkaconnector.sjms2.CamelSjms2SinkConnector",
"artifactId": "camel-sjms2-kafka-connector",
"groupId": "org.apache.camel.kafkaconnector",
"id": "camel-sjms2-sink",
"type": "sink",
"version": "4.8.0",
"description": "Send and receive messages to\/from a JMS Queue or Topic using plain JMS 2.x API."
},
"properties": {
"camel.sink.path.destinationType": {
"name": "camel.sink.path.destinationType",
"description": "The kind of destination to use One of: [queue] [topic]",
"defaultValue": "\"queue\"",
"priority": "MEDIUM",
"required": "false",
"enum": [
"queue",
"topic"
]
},
"camel.sink.path.destinationName": {
"name": "camel.sink.path.destinationName",
"description": "DestinationName is a JMS queue or topic name. By default, the destinationName is interpreted as a queue name.",
"priority": "HIGH",
"required": "true"
},
"camel.sink.endpoint.acknowledgementMode": {
"name": "camel.sink.endpoint.acknowledgementMode",
"description": "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]",
"defaultValue": "\"AUTO_ACKNOWLEDGE\"",
"priority": "MEDIUM",
"required": "false",
"enum": [
"SESSION_TRANSACTED",
"CLIENT_ACKNOWLEDGE",
"AUTO_ACKNOWLEDGE",
"DUPS_OK_ACKNOWLEDGE"
]
},
"camel.sink.endpoint.connectionFactory": {
"name": "camel.sink.endpoint.connectionFactory",
"description": "The connection factory to be use. A connection factory must be configured either on the component or endpoint.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.disableReplyTo": {
"name": "camel.sink.endpoint.disableReplyTo",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.replyTo": {
"name": "camel.sink.endpoint.replyTo",
"description": "Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer).",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.testConnectionOnStartup": {
"name": "camel.sink.endpoint.testConnectionOnStartup",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.deliveryMode": {
"name": "camel.sink.endpoint.deliveryMode",
"description": "Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2. One of: [1] [2]",
"priority": "MEDIUM",
"required": "false",
"enum": [
"1",
"2"
]
},
"camel.sink.endpoint.deliveryPersistent": {
"name": "camel.sink.endpoint.deliveryPersistent",
"description": "Specifies whether persistent delivery is used by default.",
"defaultValue": "true",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.priority": {
"name": "camel.sink.endpoint.priority",
"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. One of: [1] [2] [3] [4] [5] [6] [7] [8] [9]",
"defaultValue": "4",
"priority": "MEDIUM",
"required": "false",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
]
},
"camel.sink.endpoint.replyToConcurrentConsumers": {
"name": "camel.sink.endpoint.replyToConcurrentConsumers",
"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.",
"defaultValue": "1",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.replyToOverride": {
"name": "camel.sink.endpoint.replyToOverride",
"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.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.replyToType": {
"name": "camel.sink.endpoint.replyToType",
"description": "Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request\/reply over JMS. Possible values are: Temporary or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Exclusive is used. One of: [Temporary] [Exclusive]",
"priority": "MEDIUM",
"required": "false",
"enum": [
"Temporary",
"Exclusive"
]
},
"camel.sink.endpoint.requestTimeout": {
"name": "camel.sink.endpoint.requestTimeout",
"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.",
"defaultValue": "20000L",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.timeToLive": {
"name": "camel.sink.endpoint.timeToLive",
"description": "When sending messages, specifies the time-to-live of the message (in milliseconds).",
"defaultValue": "-1L",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.allowNullBody": {
"name": "camel.sink.endpoint.allowNullBody",
"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.",
"defaultValue": "true",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.disableTimeToLive": {
"name": "camel.sink.endpoint.disableTimeToLive",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.explicitQosEnabled": {
"name": "camel.sink.endpoint.explicitQosEnabled",
"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.",
"defaultValue": "\"false\"",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.lazyStartProducer": {
"name": "camel.sink.endpoint.lazyStartProducer",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.preserveMessageQos": {
"name": "camel.sink.endpoint.preserveMessageQos",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.asyncStartListener": {
"name": "camel.sink.endpoint.asyncStartListener",
"description": "Whether to startup the consumer 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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.asyncStopListener": {
"name": "camel.sink.endpoint.asyncStopListener",
"description": "Whether to stop the consumer message listener asynchronously, when stopping a route.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.destinationCreationStrategy": {
"name": "camel.sink.endpoint.destinationCreationStrategy",
"description": "To use a custom DestinationCreationStrategy.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.exceptionListener": {
"name": "camel.sink.endpoint.exceptionListener",
"description": "Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.headerFilterStrategy": {
"name": "camel.sink.endpoint.headerFilterStrategy",
"description": "To use a custom HeaderFilterStrategy to filter header to and from Camel message.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.includeAllJMSXProperties": {
"name": "camel.sink.endpoint.includeAllJMSXProperties",
"description": "Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.jmsKeyFormatStrategy": {
"name": "camel.sink.endpoint.jmsKeyFormatStrategy",
"description": "Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.mapJmsMessage": {
"name": "camel.sink.endpoint.mapJmsMessage",
"description": "Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc. See section about how mapping works below for more details.",
"defaultValue": "true",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.messageCreatedStrategy": {
"name": "camel.sink.endpoint.messageCreatedStrategy",
"description": "To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.recoveryInterval": {
"name": "camel.sink.endpoint.recoveryInterval",
"description": "Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds.",
"defaultValue": "5000L",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.synchronous": {
"name": "camel.sink.endpoint.synchronous",
"description": "Sets whether synchronous processing should be strictly used",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.transferException": {
"name": "camel.sink.endpoint.transferException",
"description": "If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.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!",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.transacted": {
"name": "camel.sink.endpoint.transacted",
"description": "Specifies whether to use transacted mode",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.connectionFactory": {
"name": "camel.component.sjms2.connectionFactory",
"description": "The connection factory to be use. A connection factory must be configured either on the component or endpoint.",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.lazyStartProducer": {
"name": "camel.component.sjms2.lazyStartProducer",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.autowiredEnabled": {
"name": "camel.component.sjms2.autowiredEnabled",
"description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.",
"defaultValue": "true",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.destinationCreationStrategy": {
"name": "camel.component.sjms2.destinationCreationStrategy",
"description": "To use a custom DestinationCreationStrategy.",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.exceptionListener": {
"name": "camel.component.sjms2.exceptionListener",
"description": "Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.jmsKeyFormatStrategy": {
"name": "camel.component.sjms2.jmsKeyFormatStrategy",
"description": "Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation.",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.messageCreatedStrategy": {
"name": "camel.component.sjms2.messageCreatedStrategy",
"description": "To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message.",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.recoveryInterval": {
"name": "camel.component.sjms2.recoveryInterval",
"description": "Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds.",
"defaultValue": "5000L",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.replyToOnTimeoutMaxConcurrentConsumers": {
"name": "camel.component.sjms2.replyToOnTimeoutMaxConcurrentConsumers",
"description": "Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request\/reply over JMS.",
"defaultValue": "1",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.requestTimeoutCheckerInterval": {
"name": "camel.component.sjms2.requestTimeoutCheckerInterval",
"description": "Configures how often Camel should check for timed out Exchanges when doing request\/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout.",
"defaultValue": "1000L",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.sjms2.headerFilterStrategy": {
"name": "camel.component.sjms2.headerFilterStrategy",
"description": "To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.",
"priority": "MEDIUM",
"required": "false"
}
}
}