This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
The following commit(s) were added to refs/heads/main by this push:
new f5e4fba1d chore: the JMS Kamelets take transactions, priority, expiry
and an AMQP login (#3170) (#3219)
f5e4fba1d is described below
commit f5e4fba1d827602f60b67d621d8a8bbe7c7e7272
Author: Claus Ibsen <[email protected]>
AuthorDate: Wed Nov 18 22:32:33 2026 +0100
chore: the JMS Kamelets take transactions, priority, expiry and an AMQP
login (#3170) (#3219)
The JMS sources (jms-apache-artemis-source, jms-amqp-10-source,
jms-ibm-mq-source) take:
- transacted: a message whose flow fails is rolled back and delivered
again by the broker, which moves it to its dead letter queue (Artemis)
or backout queue (IBM MQ) after a number of attempts. Today a message
is removed when it is received, even when the flow then fails.
- acknowledgementModeName: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE or
DUPS_OK_ACKNOWLEDGE.
- concurrentConsumers: process several messages at the same time.
The JMS sinks take deliveryPersistent, timeToLive, priority, and
jmsMessageType (Text or Bytes).
jms-amqp-10-source and jms-amqp-10-sink take username and password,
which are used instead of jms.username and jms.password in remoteURI.
jms-ibm-mq-source and jms-ibm-mq-sink take connectionNameList, for a
multi-instance queue manager. serverName and serverPort take the place
of the first address of the list. The descriptions of sslCipherSuite
now say that the IBM MQ client takes the trust store and key store of
the Java runtime (javax.net.ssl.*), and not camel.ssl.
All the new options are optional and have no default: with them unset,
the endpoint URIs are the same as before.
Left out:
- transacted on the sinks: it commits each message as soon as it is
sent, whether or not a transacted source is in the same flow, so it
changes nothing a receiver sees.
- Map, Stream and Object for jmsMessageType: Map fails on a body that
is not a Map, Stream is received as a stream that most receivers do
not expect, and Object messages are disabled in camel-jms.
Co-authored-by: Claude Opus 5.5 <[email protected]>
---
.../partials/jms-amqp-10-sink-description.adoc | 40 ++++++++++-
.../partials/jms-amqp-10-source-description.adoc | 56 ++++++++++++---
.../jms-apache-artemis-sink-description.adoc | 29 ++++++++
.../jms-apache-artemis-source-description.adoc | 34 +++++++++
.../ROOT/partials/jms-ibm-mq-sink-description.adoc | 47 +++++++++++-
.../partials/jms-ibm-mq-source-description.adoc | 83 ++++++++++++++++++++++
kamelets/jms-amqp-10-sink.kamelet.yaml | 46 +++++++++++-
kamelets/jms-amqp-10-source.kamelet.yaml | 36 +++++++++-
kamelets/jms-apache-artemis-sink.kamelet.yaml | 29 +++++++-
kamelets/jms-apache-artemis-source.kamelet.yaml | 19 ++++-
kamelets/jms-ibm-mq-sink.kamelet.yaml | 40 +++++++++--
kamelets/jms-ibm-mq-source.kamelet.yaml | 30 +++++++-
.../main/resources/META-INF/kamelets-index.json | 12 ++--
.../kamelets/jms-amqp-10-sink.kamelet.yaml | 46 +++++++++++-
.../kamelets/jms-amqp-10-source.kamelet.yaml | 36 +++++++++-
.../kamelets/jms-apache-artemis-sink.kamelet.yaml | 29 +++++++-
.../jms-apache-artemis-source.kamelet.yaml | 19 ++++-
.../kamelets/jms-ibm-mq-sink.kamelet.yaml | 40 +++++++++--
.../kamelets/jms-ibm-mq-source.kamelet.yaml | 30 +++++++-
19 files changed, 655 insertions(+), 46 deletions(-)
diff --git a/docs/modules/ROOT/partials/jms-amqp-10-sink-description.adoc
b/docs/modules/ROOT/partials/jms-amqp-10-sink-description.adoc
index 7d2a9f931..6c9ab0593 100644
--- a/docs/modules/ROOT/partials/jms-amqp-10-sink-description.adoc
+++ b/docs/modules/ROOT/partials/jms-amqp-10-sink-description.adoc
@@ -10,4 +10,42 @@ The Kamelet supports both queue and topic destinations. The
destination type can
=== AMQP 1.0 Protocol
-This sink uses the AMQP 1.0 protocol for sending messages to the broker. AMQP
1.0 is an open standard messaging protocol that provides reliable, secure, and
interoperable messaging.
\ No newline at end of file
+This sink uses the AMQP 1.0 protocol for sending messages to the broker. AMQP
1.0 is an open standard messaging protocol that provides reliable, secure, and
interoperable messaging.
+
+=== Login and TLS
+
+A broker that needs a login takes it in the `username` and `password` options.
`jms.username` and `jms.password` in
+`remoteURI` work too, but `username` and `password` are used instead of them
when they are set. For TLS, use the
+`amqps://` scheme in `remoteURI`, with `transport.trustStoreLocation` and
`transport.trustStorePassword` after `?` when
+the broker certificate is not trusted by the Java runtime.
+
+=== Persistence, priority and expiry
+
+By default, each message is persistent, has priority 4, and never expires.
Three options change that for every message
+the sink sends:
+
+- `deliveryPersistent`: `false` sends non-persistent messages, which are
faster, but lost when the broker stops.
+- `priority`: from 0 (lowest) to 9 (highest). Of the messages waiting on a
queue, the broker delivers those with the
+ highest priority first.
+- `timeToLive`: how long a message may wait to be received, in milliseconds.
An expired message is not delivered; Apache ActiveMQ Artemis moves it to the
queue `ExpiryQueue`.
+
+`jmsMessageType` sends every message as a text message (`Text`) or a bytes
message (`Bytes`), whatever the body, for a
+receiver that expects one kind.
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:webhook-source"
+ steps:
+ - to:
+ uri: "kamelet:jms-amqp-10-sink"
+ parameters:
+ remoteURI: "amqp://broker.example.com:5672"
+ username: "app"
+ password: "secret"
+ destinationName: "alerts.queue"
+ priority: 7
+ timeToLive: 60000
+ jmsMessageType: "Text"
+----
diff --git a/docs/modules/ROOT/partials/jms-amqp-10-source-description.adoc
b/docs/modules/ROOT/partials/jms-amqp-10-source-description.adoc
index ad9e1091b..e660628dd 100644
--- a/docs/modules/ROOT/partials/jms-amqp-10-source-description.adoc
+++ b/docs/modules/ROOT/partials/jms-amqp-10-source-description.adoc
@@ -2,12 +2,11 @@
=== Login and TLS
-The Kamelet has no separate options for the login or TLS: they go in
`remoteURI`, as settings of the Apache Qpid JMS
-client after `?`.
-
-- A login:
`amqp://broker.example.com:5672?jms.username=app&jms.password=secret`
-- TLS: the `amqps://` scheme, with `transport.trustStoreLocation` and
`transport.trustStorePassword` when the broker
- certificate is not trusted by the Java runtime.
+- A login: `username` and `password`. `jms.username` and `jms.password` in
`remoteURI`, as
+ `amqp://broker.example.com:5672?jms.username=app&jms.password=secret`, work
too, but `username` and `password` are
+ used instead of them when they are set.
+- TLS: the `amqps://` scheme in `remoteURI`, with
`transport.trustStoreLocation` and `transport.trustStorePassword`
+ after `?` when the broker certificate is not trusted by the Java runtime.
=== Output format
@@ -18,12 +17,15 @@ the message become headers.
The Kamelet requires connection parameters for the AMQP 1.0 broker:
-- `remoteURI`: the address of the broker, with the login when the broker needs
one
+- `remoteURI`: the address of the broker
+- `username` and `password`: the login, when the broker needs one
- `destinationName`: the name of the queue or topic
- `destinationType`: `queue` (the default) or `topic`
- `subscriptionDurable`, `subscriptionShared`, `subscriptionName` and
`clientId`: a durable or shared subscription to
a topic (see below)
- `selector`: receive only the messages that match a condition on their
properties and headers
+- `transacted`, `acknowledgementModeName` and `concurrentConsumers`:
delivering a message again when its flow fails,
+ and processing several messages at the same time (see below)
=== Usage example
@@ -33,7 +35,9 @@ The Kamelet requires connection parameters for the AMQP 1.0
broker:
from:
uri: "kamelet:jms-amqp-10-source"
parameters:
- remoteURI:
"amqp://broker.example.com:5672?jms.username=app&jms.password=secret"
+ remoteURI: "amqp://broker.example.com:5672"
+ username: "app"
+ password: "secret"
destinationName: "my-queue"
steps:
- to:
@@ -78,3 +82,39 @@ The JMS rules to know:
With `selector`, the source receives only the messages that match it, a
condition on the JMS properties and headers of
the message, such as `priority > 5`. From a queue, the other messages stay on
the queue.
+
+=== Redelivery when the flow fails
+
+By default, the source removes each message from the queue when it receives
it, so a message whose flow fails is lost.
+With `transacted` set to `true`, each message is received in a transaction
that is committed only once the flow has
+processed it. When the flow fails, the transaction is rolled back and the
broker delivers the message again, with the
+header `JMSRedelivered` set to `true`.
+
+The broker decides how many times: Apache ActiveMQ Artemis moves the message
to the dead letter queue, `DLQ`, after 10
+attempts by default.
+
+`concurrentConsumers` processes several messages of the queue at the same
time, each in a thread of its own; the
+messages are then no longer processed in the order of the queue.
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:jms-amqp-10-source"
+ parameters:
+ remoteURI: "amqp://broker.example.com:5672"
+ username: "app"
+ password: "secret"
+ destinationName: "orders.queue"
+ transacted: true
+ concurrentConsumers: 5
+ steps:
+ - to:
+ uri: "kamelet:log-sink"
+----
+
+`acknowledgementModeName` set to `CLIENT_ACKNOWLEDGE` also delivers a message
again when its flow fails, without a
+transaction, but the Qpid client does it by itself, with no limit, unless
`remoteURI` sets
+`jms.redeliveryPolicy.maxRedeliveries`. Prefer `transacted`, which leaves the
attempts and the dead letter queue to the
+broker. With the Qpid client, `DUPS_OK_ACKNOWLEDGE` acknowledges each message
when it is received, as
+`AUTO_ACKNOWLEDGE` does.
diff --git
a/docs/modules/ROOT/partials/jms-apache-artemis-sink-description.adoc
b/docs/modules/ROOT/partials/jms-apache-artemis-sink-description.adoc
index 717029ca9..0a49635e0 100644
--- a/docs/modules/ROOT/partials/jms-apache-artemis-sink-description.adoc
+++ b/docs/modules/ROOT/partials/jms-apache-artemis-sink-description.adoc
@@ -25,3 +25,32 @@ new connection for each message. The pool is set with these
options:
- `maxSessionsPerConnection`: the most sessions open at the same time on each
connection (default: 500)
- `maxIdleSessionsPerConnection`: how many unused sessions each connection
keeps for reuse (default: 500)
- `connectionIdleTimeout`: how long an unused connection stays open, in
milliseconds (default: 30000)
+
+=== Persistence, priority and expiry
+
+By default, each message is persistent, has priority 4, and never expires.
Three options change that for every message
+the sink sends:
+
+- `deliveryPersistent`: `false` sends non-persistent messages, which are
faster, but lost when the broker stops.
+- `priority`: from 0 (lowest) to 9 (highest). Of the messages waiting on a
queue, the broker delivers those with the
+ highest priority first.
+- `timeToLive`: how long a message may wait to be received, in milliseconds.
An expired message is not delivered: Artemis moves it to the queue
`ExpiryQueue`.
+
+`jmsMessageType` sends every message as a text message (`Text`) or a bytes
message (`Bytes`), whatever the body, for a
+receiver that expects one kind.
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:webhook-source"
+ steps:
+ - to:
+ uri: "kamelet:jms-apache-artemis-sink"
+ parameters:
+ brokerURL: "tcp://artemis.example.com:61616"
+ destinationName: "alerts.queue"
+ priority: 7
+ timeToLive: 60000
+ jmsMessageType: "Text"
+----
diff --git
a/docs/modules/ROOT/partials/jms-apache-artemis-source-description.adoc
b/docs/modules/ROOT/partials/jms-apache-artemis-source-description.adoc
index f936a35d7..a89538fdf 100644
--- a/docs/modules/ROOT/partials/jms-apache-artemis-source-description.adoc
+++ b/docs/modules/ROOT/partials/jms-apache-artemis-source-description.adoc
@@ -16,6 +16,8 @@ The JMS Apache Artemis Source Kamelet supports the following
configurations:
- **Durable Subscription**, **Shared Subscription**, **Subscription Name** and
**Client ID**: a durable or shared
subscription to a topic (see below)
- **Message Selector**: receive only the messages that match a condition on
their properties and headers
+- **Transacted**, **Acknowledgement Mode** and **Concurrent Consumers**:
delivering a message again when its flow
+ fails, and processing several messages at the same time (see below)
=== Output Format
@@ -113,6 +115,38 @@ message. From a queue, the other messages stay on the
queue.
uri: "kamelet:log-sink"
----
+=== Redelivery when the flow fails
+
+By default, the source removes each message from the queue when it receives
it, so a message whose flow fails is lost.
+With `transacted` set to `true`, each message is received in a transaction
that is committed only once the flow has
+processed it. When the flow fails, the transaction is rolled back and the
broker delivers the message again, with the
+header `JMSRedelivered` set to `true`.
+
+After 10 attempts, the default of the broker (`max-delivery-attempts`),
Artemis moves the message to the dead letter
+queue, `DLQ` by default.
+
+`concurrentConsumers` processes several messages of the queue at the same
time, each in a thread of its own; the
+messages are then no longer processed in the order of the queue.
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:jms-apache-artemis-source"
+ parameters:
+ brokerURL: "tcp://artemis.example.com:61616"
+ destinationName: "orders.queue"
+ transacted: true
+ concurrentConsumers: 5
+ steps:
+ - to:
+ uri: "kamelet:log-sink"
+----
+
+`acknowledgementModeName` set to `CLIENT_ACKNOWLEDGE` also delivers a message
again when its flow fails, without a
+transaction. `DUPS_OK_ACKNOWLEDGE` acknowledges the messages in batches: it is
faster, but the messages processed since
+the last batch are delivered again after a crash.
+
=== Connection Management
When the broker cannot be reached, the Kamelet starts anyway and tries to
connect again every 5 seconds. It does not
diff --git a/docs/modules/ROOT/partials/jms-ibm-mq-sink-description.adoc
b/docs/modules/ROOT/partials/jms-ibm-mq-sink-description.adoc
index a2a49e3cb..44a274cb2 100644
--- a/docs/modules/ROOT/partials/jms-ibm-mq-sink-description.adoc
+++ b/docs/modules/ROOT/partials/jms-ibm-mq-sink-description.adoc
@@ -14,4 +14,49 @@ The Kamelet supports both queue and topic destinations. The
destination type can
=== SSL/TLS Support
-Optional SSL/TLS encryption can be enabled by configuring the `sslCipherSuite`
property with an appropriate cipher suite.
\ No newline at end of file
+Optional SSL/TLS encryption can be enabled by configuring the `sslCipherSuite`
property with an appropriate cipher suite.
+The IBM MQ client checks the certificate of the queue manager against the
trust store of the Java runtime, and sends
+the client certificate from its key store: set them with the Java system
properties `javax.net.ssl.trustStore` and
+`javax.net.ssl.keyStore`, with their passwords. Camel's own TLS settings
(`camel.ssl.*`) do not apply to the IBM MQ
+client.
+
+=== Multi-instance queue manager
+
+For a multi-instance queue manager, list its instances in
`connectionNameList`, such as
+`mq1.example.com(1414),mq2.example.com(1414)`. The client tries them in order
and connects to the first that
+answers. `serverName` and `serverPort` take the place of the first address of
the list, so set them to the first
+instance too.
+
+=== Persistence, priority and expiry
+
+By default, each message is persistent, has priority 4, and never expires.
Three options change that for every message
+the sink sends:
+
+- `deliveryPersistent`: `false` sends non-persistent messages, which are
faster, but lost when the queue manager stops.
+- `priority`: from 0 (lowest) to 9 (highest). Of the messages waiting on a
queue, the queue manager delivers those with the
+ highest priority first.
+- `timeToLive`: how long a message may wait to be received, in milliseconds.
An expired message is not delivered: the queue manager removes it.
+
+`jmsMessageType` sends every message as a text message (`Text`) or a bytes
message (`Bytes`), whatever the body, for a
+receiver that expects one kind.
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:webhook-source"
+ steps:
+ - to:
+ uri: "kamelet:jms-ibm-mq-sink"
+ parameters:
+ serverName: "mq.example.com"
+ serverPort: 1414
+ queueManager: "QM1"
+ channel: "DEV.APP.SVRCONN"
+ username: "app"
+ password: "passw0rd"
+ destinationName: "DEV.QUEUE.1"
+ priority: 7
+ timeToLive: 60000
+ jmsMessageType: "Text"
+----
diff --git a/docs/modules/ROOT/partials/jms-ibm-mq-source-description.adoc
b/docs/modules/ROOT/partials/jms-ibm-mq-source-description.adoc
index 80e028f11..9da71b643 100644
--- a/docs/modules/ROOT/partials/jms-ibm-mq-source-description.adoc
+++ b/docs/modules/ROOT/partials/jms-ibm-mq-source-description.adoc
@@ -27,6 +27,9 @@ The Kamelet requires IBM MQ specific connection parameters:
- `channel`: IBM MQ channel name
- `username` and `password`: the login
- `destinationName`: The destination queue name
+- `connectionNameList`: the instances of a multi-instance queue manager (see
below)
+- `transacted`, `acknowledgementModeName` and `concurrentConsumers`:
delivering a message again when its flow fails,
+ and processing several messages at the same time (see below)
=== Usage example
@@ -92,3 +95,83 @@ The JMS rules to know:
With `selector`, the source receives only the messages that match it, a
condition on the JMS properties and headers of
the message, such as `priority > 5`. From a queue, the other messages stay on
the queue.
+
+=== TLS
+
+Set `sslCipherSuite` to a cipher suite that matches the cipher spec of the
channel, such as
+`TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` for `ANY_TLS12_OR_HIGHER`. The IBM MQ
client checks the certificate of the
+queue manager against the trust store of the Java runtime, and sends the
client certificate from its key store when
+the channel asks for one (`SSLCAUTH(REQUIRED)`). The Kamelet has no options
for them: set the Java system properties,
+for example in `JAVA_TOOL_OPTIONS`:
+
+[source,bash]
+----
+export JAVA_TOOL_OPTIONS="-Djavax.net.ssl.trustStore=/etc/mq/truststore.p12
-Djavax.net.ssl.trustStorePassword=changeit
-Djavax.net.ssl.keyStore=/etc/mq/client.p12
-Djavax.net.ssl.keyStorePassword=changeit"
+----
+
+Camel's own TLS settings (`camel.ssl.*`) do not apply to the IBM MQ client.
+
+=== Multi-instance queue manager
+
+For a multi-instance queue manager, list its instances in
`connectionNameList`, as `host(port)` separated by commas.
+The client tries them in order and connects to the first that answers.
`serverName` and `serverPort` take the place of
+the first address of the list, so set them to the first instance too.
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:jms-ibm-mq-source"
+ parameters:
+ serverName: "mq1.example.com"
+ serverPort: 1414
+ connectionNameList: "mq1.example.com(1414),mq2.example.com(1414)"
+ queueManager: "QM1"
+ channel: "DEV.APP.SVRCONN"
+ username: "app"
+ password: "passw0rd"
+ destinationName: "DEV.QUEUE.1"
+ steps:
+ - to:
+ uri: "kamelet:log-sink"
+----
+
+=== Redelivery when the flow fails
+
+By default, the source removes each message from the queue when it receives
it, so a message whose flow fails is lost.
+With `transacted` set to `true`, each message is received in a transaction
that is committed only once the flow has
+processed it. When the flow fails, the transaction is rolled back and the
queue manager delivers the message again, with the
+header `JMSRedelivered` set to `true`.
+
+Give the queue a backout threshold and a backout queue, such as
+`ALTER QLOCAL(DEV.QUEUE.1) BOTHRESH(3) BOQNAME(DEV.DEAD.LETTER.QUEUE)`: once
the message has been delivered that many
+times, the client moves it to the backout queue. The user of the Kamelet needs
the authority to put messages on the
+backout queue with their context (`put` and `passall`), or the source stops
receiving from the queue. Without a backout threshold (`BOTHRESH(0)`, the
default),
+a message that always fails is delivered again and again.
+
+`concurrentConsumers` processes several messages of the queue at the same
time, each in a thread of its own; the
+messages are then no longer processed in the order of the queue.
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:jms-ibm-mq-source"
+ parameters:
+ serverName: "mq.example.com"
+ serverPort: 1414
+ queueManager: "QM1"
+ channel: "DEV.APP.SVRCONN"
+ username: "app"
+ password: "passw0rd"
+ destinationName: "DEV.QUEUE.1"
+ transacted: true
+ concurrentConsumers: 5
+ steps:
+ - to:
+ uri: "kamelet:log-sink"
+----
+
+`acknowledgementModeName` set to `CLIENT_ACKNOWLEDGE` also delivers a message
again when its flow fails, without a
+transaction. `DUPS_OK_ACKNOWLEDGE` acknowledges the messages in batches: it is
faster, but the messages processed since
+the last batch are delivered again after a crash.
diff --git a/kamelets/jms-amqp-10-sink.kamelet.yaml
b/kamelets/jms-amqp-10-sink.kamelet.yaml
index 2fa5027c0..84b19876e 100644
--- a/kamelets/jms-amqp-10-sink.kamelet.yaml
+++ b/kamelets/jms-amqp-10-sink.kamelet.yaml
@@ -36,11 +36,11 @@ spec:
Use it to hand work to another application through a queue, or to
publish events on a topic, on any broker that supports the AMQP 1.0 protocol.
For an Artemis broker, `jms-apache-artemis-sink` works too.
- Input: text is sent as a JMS text message, bytes as a JMS bytes message,
and a Map as a JMS map message. The headers of the message, except the Camel
ones, are sent along as JMS properties of the message.
+ Input: text is sent as a JMS text message, bytes as a JMS bytes message,
and a Map as a JMS map message; `jmsMessageType` sends text or bytes as the
other kind. The headers of the message, except the Camel ones, are sent along
as JMS properties of the message.
Output: the message is unchanged.
- Good to know: Messages go to a queue unless `destinationType` is
`topic`, and a message sent to a topic reaches only the receivers subscribed at
that moment. The login and the TLS settings go in `remoteURI`: there are no
separate options for them. It opens a new connection to the broker for each
message. It does not wait for a reply, even when the incoming message expects
one, as one from `webhook-source` does.
+ Good to know: Messages go to a queue unless `destinationType` is
`topic`, and a message sent to a topic reaches only the receivers subscribed at
that moment. Messages are persistent, with priority 4, and never expire, unless
`deliveryPersistent`, `priority` and `timeToLive` say otherwise. It logs in
with `username` and `password` when they are set; the TLS settings go in
`remoteURI`. It opens a new connection to the broker for each message. It does
not wait for a reply, even when t [...]
required:
- destinationName
- remoteURI
@@ -58,9 +58,43 @@ spec:
type: string
remoteURI:
title: "Broker URL"
- description: "The address of the broker, as `amqp://host:port` (the
AMQP port is usually 5672), or `amqps://host:port` for TLS. Settings of the
Qpid JMS client go after `?`: `jms.username` and `jms.password` for a login, as
`amqp://host:5672?jms.username=app&jms.password=secret`, and
`transport.trustStoreLocation`, `transport.trustStorePassword`,
`transport.keyStoreLocation` and `transport.keyStorePassword` for TLS."
+ description: "The address of the broker, as `amqp://host:port` (the
AMQP port is usually 5672), or `amqps://host:port` for TLS. Settings of the
Qpid JMS client go after `?`, such as `transport.trustStoreLocation`,
`transport.trustStorePassword`, `transport.keyStoreLocation` and
`transport.keyStorePassword` for TLS. The login goes in `username` and
`password`; `jms.username` and `jms.password` in the address work too."
type: string
example: "amqp://localhost:5672"
+ username:
+ title: "Username"
+ description: "The user name to log in to the broker with. Leave it
empty for a broker that accepts clients without a login. When it is set, it is
used instead of `jms.username` in `remoteURI`."
+ type: string
+ x-descriptors:
+ - urn:camel:group:credentials
+ password:
+ title: "Password"
+ description: "The password to log in to the broker with, for the user
`username`. When it is set, it is used instead of `jms.password` in
`remoteURI`."
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ deliveryPersistent:
+ title: "Persistent Delivery"
+ description: "Whether the broker stores each message on disk, so that
it survives a restart of the broker. False sends non-persistent messages, which
are faster but lost when the broker stops. When it is not set, the messages are
persistent."
+ type: boolean
+ timeToLive:
+ title: "Time to Live"
+ description: "How long each message may wait to be received, in
milliseconds, such as 60000 for one minute. A message still waiting after that
time expires: the broker does not deliver it (Apache ActiveMQ Artemis moves it
to the queue `ExpiryQueue`). When it is not set, the messages never expire."
+ type: integer
+ example: 60000
+ priority:
+ title: "Priority"
+ description: "The JMS priority of each message, from 0 (lowest) to 9
(highest). Of the messages waiting on a queue, the broker delivers those with
the highest priority first. When it is not set, 4."
+ type: integer
+ minimum: 0
+ maximum: 9
+ example: 7
+ jmsMessageType:
+ title: "JMS Message Type"
+ description: "The kind of JMS message to send, whatever the body:
`Text` sends a text message, and `Bytes` a bytes message, for a receiver that
expects one kind. When it is not set, the kind follows the body: text is sent
as a text message, and bytes as a bytes message."
+ type: string
+ enum: ["Text", "Bytes"]
dependencies:
- "camel:jms"
- "camel:amqp"
@@ -71,6 +105,8 @@ spec:
type: "#class:org.apache.qpid.jms.JmsConnectionFactory"
properties:
remoteURI: "{{remoteURI}}"
+ username: "{{?username}}"
+ password: "{{?password}}"
from:
uri: kamelet:source
steps:
@@ -80,4 +116,8 @@ spec:
parameters:
destinationType: "{{destinationType}}"
destinationName: "{{destinationName}}"
+ deliveryPersistent: "{{?deliveryPersistent}}"
+ timeToLive: "{{?timeToLive}}"
+ priority: "{{?priority}}"
+ jmsMessageType: "{{?jmsMessageType}}"
connectionFactory: "#bean:{{connectionFactoryBean}}"
diff --git a/kamelets/jms-amqp-10-source.kamelet.yaml
b/kamelets/jms-amqp-10-source.kamelet.yaml
index aafff383e..d88864c76 100644
--- a/kamelets/jms-amqp-10-source.kamelet.yaml
+++ b/kamelets/jms-amqp-10-source.kamelet.yaml
@@ -38,7 +38,7 @@ spec:
Output: the body is text for a JMS text message, bytes for a bytes
message, and a Map for a map message. The JMS properties of the message become
headers, along with the JMS headers such as `JMSMessageID`, `JMSDestination`,
`JMSTimestamp`, `JMSPriority` and `JMSRedelivered`.
- Good to know: From a queue, each message is removed when it is received,
even when the rest of the flow then fails, and several copies of this source
share the messages. From a topic (`destinationType` set to `topic`), it
receives only the messages sent while it is connected, unless
`subscriptionDurable` is true: then the broker keeps the messages sent while it
is stopped, under `subscriptionName`. A durable subscription needs `clientId`
unless it is shared (`subscriptionShared`, J [...]
+ Good to know: From a queue, each message is removed when it is received,
even when the rest of the flow then fails, unless `transacted` is true or
`acknowledgementModeName` is `CLIENT_ACKNOWLEDGE`: then a message whose flow
failed is delivered again. Several copies of this source share the messages of
a queue, and `concurrentConsumers` processes several messages at the same time.
From a topic (`destinationType` set to `topic`), it receives only the messages
sent while it is connect [...]
required:
- destinationName
- remoteURI
@@ -56,9 +56,22 @@ spec:
type: string
remoteURI:
title: "Broker URL"
- description: "The address of the broker, as `amqp://host:port` (the
AMQP port is usually 5672), or `amqps://host:port` for TLS. Settings of the
Qpid JMS client go after `?`: `jms.username` and `jms.password` for a login, as
`amqp://host:5672?jms.username=app&jms.password=secret`, and
`transport.trustStoreLocation`, `transport.trustStorePassword`,
`transport.keyStoreLocation` and `transport.keyStorePassword` for TLS."
+ description: "The address of the broker, as `amqp://host:port` (the
AMQP port is usually 5672), or `amqps://host:port` for TLS. Settings of the
Qpid JMS client go after `?`, such as `transport.trustStoreLocation`,
`transport.trustStorePassword`, `transport.keyStoreLocation` and
`transport.keyStorePassword` for TLS. The login goes in `username` and
`password`; `jms.username` and `jms.password` in the address work too."
type: string
example: "amqp://localhost:5672"
+ username:
+ title: "Username"
+ description: "The user name to log in to the broker with. Leave it
empty for a broker that accepts clients without a login. When it is set, it is
used instead of `jms.username` in `remoteURI`."
+ type: string
+ x-descriptors:
+ - urn:camel:group:credentials
+ password:
+ title: "Password"
+ description: "The password to log in to the broker with, for the user
`username`. When it is set, it is used instead of `jms.password` in
`remoteURI`."
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
clientId:
title: "Client ID"
description: "The JMS client ID of the connection, which names this
application to the broker. A durable subscription that is not shared needs one:
the broker keeps the subscription under the client ID and `subscriptionName`,
so use the same client ID each time the source starts. Only one connection may
use a client ID at a time: two running copies of this source need different
client IDs. When it is not set, the connection has no client ID."
@@ -84,6 +97,20 @@ spec:
description: "A JMS message selector: the source receives only the
messages that match it. It is a condition, in a syntax like the WHERE clause of
SQL, on the JMS properties and headers of the message, not on its body, such as
`priority > 5` or `region = 'EU' AND JMSPriority >= 7`. From a queue, the
messages that do not match stay on the queue. When it is not set, the source
receives every message."
example: "priority > 5"
type: string
+ concurrentConsumers:
+ title: "Concurrent Consumers"
+ description: "How many messages the source processes at the same time,
each in a thread of its own. From a queue, more than one makes the source
faster when each message takes a while, but the messages are then no longer
processed in the order of the queue. On a topic, each consumer is a
subscription of its own and receives every message, so each message is
processed that many times, unless `subscriptionShared` is true; a durable
subscription that is not shared takes only one con [...]
+ type: integer
+ example: 5
+ transacted:
+ title: "Transacted"
+ description: "Whether each message is received in a JMS transaction,
which is committed once the rest of the flow has processed the message. When
the flow fails, the transaction is rolled back and the broker delivers the
message again, with the header `JMSRedelivered` true; after the number of
attempts set in the broker (Apache ActiveMQ Artemis: 10 by default), the broker
moves it to a dead letter queue (Artemis: `DLQ`). When it is not set, the
message is removed from the queue w [...]
+ type: boolean
+ acknowledgementModeName:
+ title: "Acknowledgement Mode"
+ description: "When the source acknowledges each message to the broker,
which then removes it from the queue. `AUTO_ACKNOWLEDGE`: as soon as the
message is received. `CLIENT_ACKNOWLEDGE`: once the rest of the flow has
processed it; when the flow fails, the Qpid client delivers the message to the
flow again by itself, with no limit, unless `remoteURI` sets
`jms.redeliveryPolicy.maxRedeliveries`. Use `transacted` instead to leave the
attempts and the dead letter queue to the broker. [...]
+ type: string
+ enum: ["AUTO_ACKNOWLEDGE", "CLIENT_ACKNOWLEDGE", "DUPS_OK_ACKNOWLEDGE"]
dataTypes:
out:
headers:
@@ -113,6 +140,8 @@ spec:
type: "#class:org.apache.qpid.jms.JmsConnectionFactory"
properties:
remoteURI: "{{remoteURI}}"
+ username: "{{?username}}"
+ password: "{{?password}}"
from:
uri: jms
parameters:
@@ -123,6 +152,9 @@ spec:
subscriptionName: "{{?subscriptionName}}"
selector: "{{?selector}}"
clientId: "{{?clientId}}"
+ concurrentConsumers: "{{?concurrentConsumers}}"
+ transacted: "{{?transacted}}"
+ acknowledgementModeName: "{{?acknowledgementModeName}}"
connectionFactory: "#bean:{{connectionFactoryBean}}"
steps:
- to:
diff --git a/kamelets/jms-apache-artemis-sink.kamelet.yaml
b/kamelets/jms-apache-artemis-sink.kamelet.yaml
index 3c2cd4e78..172291950 100644
--- a/kamelets/jms-apache-artemis-sink.kamelet.yaml
+++ b/kamelets/jms-apache-artemis-sink.kamelet.yaml
@@ -36,11 +36,11 @@ spec:
Use it to hand work to another application through a queue, such as
orders to process, or to publish events on a topic for every application that
listens. For another broker that speaks AMQP 1.0, use `jms-amqp-10-sink`.
- Input: text is sent as a JMS text message, bytes as a JMS bytes message,
and a Map as a JMS map message. The headers of the message, except the Camel
ones, are sent along as JMS properties of the message.
+ Input: text is sent as a JMS text message, bytes as a JMS bytes message,
and a Map as a JMS map message; `jmsMessageType` sends text or bytes as the
other kind. The headers of the message, except the Camel ones, are sent along
as JMS properties of the message.
Output: the message is unchanged.
- Good to know: Messages go to a queue unless `destinationType` is
`topic`, and a message sent to a topic reaches only the receivers subscribed at
that moment. It connects with no TLS unless `brokerURL` asks for it, and logs
in with `username` and `password` when they are set. It keeps its connections
to the broker in a pool and reuses them for the next messages. It does not wait
for a reply, even when the incoming message expects one, as one from
`webhook-source` does.
+ Good to know: Messages go to a queue unless `destinationType` is
`topic`, and a message sent to a topic reaches only the receivers subscribed at
that moment. Messages are persistent, with priority 4, and never expire, unless
`deliveryPersistent`, `priority` and `timeToLive` say otherwise. It connects
with no TLS unless `brokerURL` asks for it, and logs in with `username` and
`password` when they are set. It keeps its connections to the broker in a pool
and reuses them for the next [...]
required:
- destinationName
- brokerURL
@@ -89,6 +89,27 @@ spec:
description: "How long a connection of the pool can stay unused before
it is closed, in milliseconds. For example, 30000 is 30 seconds."
type: integer
default: 30000
+ deliveryPersistent:
+ title: "Persistent Delivery"
+ description: "Whether the broker stores each message on disk, so that
it survives a restart of the broker. False sends non-persistent messages, which
are faster but lost when the broker stops. When it is not set, the messages are
persistent."
+ type: boolean
+ timeToLive:
+ title: "Time to Live"
+ description: "How long each message may wait to be received, in
milliseconds, such as 60000 for one minute. A message still waiting after that
time expires: the broker does not deliver it, and moves it to the queue
`ExpiryQueue` (the default of the broker). When it is not set, the messages
never expire."
+ type: integer
+ example: 60000
+ priority:
+ title: "Priority"
+ description: "The JMS priority of each message, from 0 (lowest) to 9
(highest). Of the messages waiting on a queue, the broker delivers those with
the highest priority first. When it is not set, 4."
+ type: integer
+ minimum: 0
+ maximum: 9
+ example: 7
+ jmsMessageType:
+ title: "JMS Message Type"
+ description: "The kind of JMS message to send, whatever the body:
`Text` sends a text message, and `Bytes` a bytes message, for a receiver that
expects one kind. When it is not set, the kind follows the body: text is sent
as a text message, and bytes as a bytes message."
+ type: string
+ enum: ["Text", "Bytes"]
dependencies:
- "camel:jms"
- "camel:kamelet"
@@ -118,4 +139,8 @@ spec:
parameters:
destinationType: "{{destinationType}}"
destinationName: "{{destinationName}}"
+ deliveryPersistent: "{{?deliveryPersistent}}"
+ timeToLive: "{{?timeToLive}}"
+ priority: "{{?priority}}"
+ jmsMessageType: "{{?jmsMessageType}}"
connectionFactory: "#bean:{{pooledFactoryBean}}"
diff --git a/kamelets/jms-apache-artemis-source.kamelet.yaml
b/kamelets/jms-apache-artemis-source.kamelet.yaml
index 5f59b65e2..754e638b0 100644
--- a/kamelets/jms-apache-artemis-source.kamelet.yaml
+++ b/kamelets/jms-apache-artemis-source.kamelet.yaml
@@ -38,7 +38,7 @@ spec:
Output: the body is text for a JMS text message, bytes for a bytes
message, and a Map for a map message. The JMS properties of the message become
headers, along with the JMS headers such as `JMSMessageID`, `JMSDestination`,
`JMSTimestamp`, `JMSPriority` and `JMSRedelivered`.
- Good to know: From a queue, each message is removed when it is received,
even when the rest of the flow then fails, and several copies of this source
share the messages. From a topic (`destinationType` set to `topic`), it
receives only the messages sent while it is connected, unless
`subscriptionDurable` is true: then the broker keeps the messages sent while it
is stopped, under `subscriptionName`. A durable subscription needs `clientId`
unless it is shared (`subscriptionShared`, J [...]
+ Good to know: From a queue, each message is removed when it is received,
even when the rest of the flow then fails, unless `transacted` is true or
`acknowledgementModeName` is `CLIENT_ACKNOWLEDGE`: then a message whose flow
failed is delivered again. Several copies of this source share the messages of
a queue, and `concurrentConsumers` processes several messages at the same time.
From a topic (`destinationType` set to `topic`), it receives only the messages
sent while it is connect [...]
required:
- destinationName
- brokerURL
@@ -97,6 +97,20 @@ spec:
description: "A JMS message selector: the source receives only the
messages that match it. It is a condition, in a syntax like the WHERE clause of
SQL, on the JMS properties and headers of the message, not on its body, such as
`priority > 5` or `region = 'EU' AND JMSPriority >= 7`. From a queue, the
messages that do not match stay on the queue. When it is not set, the source
receives every message."
example: "priority > 5"
type: string
+ concurrentConsumers:
+ title: "Concurrent Consumers"
+ description: "How many messages the source processes at the same time,
each in a thread of its own. From a queue, more than one makes the source
faster when each message takes a while, but the messages are then no longer
processed in the order of the queue. On a topic, each consumer is a
subscription of its own and receives every message, so each message is
processed that many times, unless `subscriptionShared` is true; a durable
subscription that is not shared takes only one con [...]
+ type: integer
+ example: 5
+ transacted:
+ title: "Transacted"
+ description: "Whether each message is received in a JMS transaction,
which is committed once the rest of the flow has processed the message. When
the flow fails, the transaction is rolled back and the broker delivers the
message again, with the header `JMSRedelivered` true; after the number of
attempts set in the broker (10 by default), the broker moves it to the dead
letter queue (`DLQ` by default). When it is not set, the message is removed
from the queue when it is received, e [...]
+ type: boolean
+ acknowledgementModeName:
+ title: "Acknowledgement Mode"
+ description: "When the source acknowledges each message to the broker,
which then removes it from the queue. `AUTO_ACKNOWLEDGE`: as soon as the
message is received. `CLIENT_ACKNOWLEDGE`: once the rest of the flow has
processed it; when the flow fails, the broker delivers it again, as with
`transacted`, and moves it to the dead letter queue after the number of
attempts set in the broker. `DUPS_OK_ACKNOWLEDGE`: in batches, which is faster,
but the messages processed since the last [...]
+ type: string
+ enum: ["AUTO_ACKNOWLEDGE", "CLIENT_ACKNOWLEDGE", "DUPS_OK_ACKNOWLEDGE"]
dataTypes:
out:
headers:
@@ -138,6 +152,9 @@ spec:
subscriptionName: "{{?subscriptionName}}"
selector: "{{?selector}}"
clientId: "{{?clientId}}"
+ concurrentConsumers: "{{?concurrentConsumers}}"
+ transacted: "{{?transacted}}"
+ acknowledgementModeName: "{{?acknowledgementModeName}}"
connectionFactory: "#bean:{{connectionFactoryBean}}"
steps:
- to:
diff --git a/kamelets/jms-ibm-mq-sink.kamelet.yaml
b/kamelets/jms-ibm-mq-sink.kamelet.yaml
index 2dbb7078d..4cad0ae10 100644
--- a/kamelets/jms-ibm-mq-sink.kamelet.yaml
+++ b/kamelets/jms-ibm-mq-sink.kamelet.yaml
@@ -36,11 +36,11 @@ spec:
Use it to hand work or events to applications that read from IBM MQ,
such as an existing enterprise or mainframe system. Use `jms-ibm-mq-source` to
read from IBM MQ.
- Input: text is sent as a JMS text message, and bytes as a JMS bytes
message. The headers of the message, except the Camel ones, are sent along as
JMS properties of the message.
+ Input: text is sent as a JMS text message, and bytes as a JMS bytes
message; `jmsMessageType` sends text or bytes as the other kind. The headers of
the message, except the Camel ones, are sent along as JMS properties of the
message.
Output: the message is unchanged.
- Good to know: the IBM MQ client library is not included, as its licence
is not the Apache one: add `mvn:com.ibm.mq:com.ibm.mq.jakarta.client` with a
version to the dependencies of the integration (Camel JBang adds it by itself).
It connects as a client over the network, with no TLS unless `sslCipherSuite`
is set. Messages go to a queue unless `destinationType` is `topic`, and a
message sent to a topic reaches only the receivers subscribed at that moment.
It does not wait for a repl [...]
+ Good to know: the IBM MQ client library is not included, as its licence
is not the Apache one: add `mvn:com.ibm.mq:com.ibm.mq.jakarta.client` with a
version to the dependencies of the integration (Camel JBang adds it by itself).
It connects as a client over the network, with no TLS unless `sslCipherSuite`
is set; the trust store and the key store for TLS are those of the Java runtime
(`javax.net.ssl.trustStore`, `javax.net.ssl.keyStore`). For a multi-instance
queue manager, list it [...]
required:
- serverName
- serverPort
@@ -96,11 +96,38 @@ spec:
format: password
x-descriptors:
- urn:camel:group:credentials
+ connectionNameList:
+ title: "Connection Name List"
+ description: "The addresses of the instances of a multi-instance queue
manager, as `host(port)` separated by commas, such as
`mq1.example.com(1414),mq2.example.com(1414)`. The client tries them in order
and connects to the first that answers. `serverName` and `serverPort` take the
place of the first address of the list, so set them to the first instance too.
When it is not set, the client connects only to `serverName` and `serverPort`."
+ type: string
+ pattern: '^[^,()\s]+(\(\d+\))?(\s*,\s*[^,()\s]+(\(\d+\))?)*$'
+ example: "mq1.example.com(1414),mq2.example.com(1414)"
sslCipherSuite:
title: "TLS Cipher Suite"
- description: "The TLS cipher suite to connect with, which must match
the cipher spec of the channel on the queue manager. When it is set, the
connection uses TLS; when it is not set, it does not."
- example: "TLS_RSA_WITH_AES_128_CBC_SHA256"
+ description: "The TLS cipher suite to connect with, which must match
the cipher spec of the channel on the queue manager, such as
`TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` for `ANY_TLS12_OR_HIGHER`. When it is
set, the connection uses TLS; when it is not set, it does not. The certificate
of the queue manager is checked against the trust store of the Java runtime,
and a channel that asks for a client certificate gets one from its key store:
set them with the Java system properties ` [...]
+ example: "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
+ type: string
+ deliveryPersistent:
+ title: "Persistent Delivery"
+ description: "Whether the queue manager stores each message on disk,
so that it survives a restart of the queue manager. False sends non-persistent
messages, which are faster but lost when the queue manager stops. When it is
not set, the messages are persistent."
+ type: boolean
+ timeToLive:
+ title: "Time to Live"
+ description: "How long each message may wait to be received, in
milliseconds, such as 60000 for one minute. A message still waiting after that
time expires: the queue manager does not deliver it, and removes it. When it is
not set, the messages never expire."
+ type: integer
+ example: 60000
+ priority:
+ title: "Priority"
+ description: "The JMS priority of each message, from 0 (lowest) to 9
(highest). Of the messages waiting on a queue, the queue manager delivers those
with the highest priority first. When it is not set, 4."
+ type: integer
+ minimum: 0
+ maximum: 9
+ example: 7
+ jmsMessageType:
+ title: "JMS Message Type"
+ description: "The kind of JMS message to send, whatever the body:
`Text` sends a text message, and `Bytes` a bytes message, for a receiver that
expects one kind. When it is not set, the kind follows the body: text is sent
as a text message, and bytes as a bytes message."
type: string
+ enum: ["Text", "Bytes"]
dependencies:
- "camel:jms"
- "camel:kamelet"
@@ -118,6 +145,7 @@ spec:
XMSC_PASSWORD: "{{password}}"
XMSC_CLIENT_ID: "{{?clientId}}"
XMSC_WMQ_SSL_CIPHER_SUITE: "{{?sslCipherSuite}}"
+ XMSC_WMQ_CONNECTION_NAME_LIST: "{{?connectionNameList}}"
from:
uri: kamelet:source
steps:
@@ -127,4 +155,8 @@ spec:
parameters:
destinationType: "{{destinationType}}"
destinationName: "{{destinationName}}"
+ deliveryPersistent: "{{?deliveryPersistent}}"
+ timeToLive: "{{?timeToLive}}"
+ priority: "{{?priority}}"
+ jmsMessageType: "{{?jmsMessageType}}"
connectionFactory: "#bean:{{wmqConnectionFactory}}"
diff --git a/kamelets/jms-ibm-mq-source.kamelet.yaml
b/kamelets/jms-ibm-mq-source.kamelet.yaml
index 7f0807ab2..8d050bfc5 100644
--- a/kamelets/jms-ibm-mq-source.kamelet.yaml
+++ b/kamelets/jms-ibm-mq-source.kamelet.yaml
@@ -38,7 +38,7 @@ spec:
Output: the body is text for a JMS text message, and bytes for a bytes
message. The JMS properties of the message become headers, along with the JMS
headers such as `JMSMessageID` and `JMSTimestamp`, and IBM MQ details such as
`JMSXUserID`, `JMS_IBM_PutDate` and `JMS_IBM_Format`.
- Good to know: the IBM MQ client library is not included, as its licence
is not the Apache one: add `mvn:com.ibm.mq:com.ibm.mq.jakarta.client` with a
version to the dependencies of the integration (Camel JBang adds it by itself).
From a queue, each message is removed when it is received, even when the rest
of the flow then fails, and several copies of this source share the messages.
From a topic (`destinationType` set to `topic`), it receives only the messages
sent while it is conne [...]
+ Good to know: the IBM MQ client library is not included, as its licence
is not the Apache one: add `mvn:com.ibm.mq:com.ibm.mq.jakarta.client` with a
version to the dependencies of the integration (Camel JBang adds it by itself).
From a queue, each message is removed when it is received, even when the rest
of the flow then fails, unless `transacted` is true or
`acknowledgementModeName` is `CLIENT_ACKNOWLEDGE`: then a message whose flow
failed is delivered again. Several copies of th [...]
required:
- serverName
- serverPort
@@ -95,10 +95,16 @@ spec:
format: password
x-descriptors:
- urn:camel:group:credentials
+ connectionNameList:
+ title: "Connection Name List"
+ description: "The addresses of the instances of a multi-instance queue
manager, as `host(port)` separated by commas, such as
`mq1.example.com(1414),mq2.example.com(1414)`. The client tries them in order
and connects to the first that answers. `serverName` and `serverPort` take the
place of the first address of the list, so set them to the first instance too.
When it is not set, the client connects only to `serverName` and `serverPort`."
+ type: string
+ pattern: '^[^,()\s]+(\(\d+\))?(\s*,\s*[^,()\s]+(\(\d+\))?)*$'
+ example: "mq1.example.com(1414),mq2.example.com(1414)"
sslCipherSuite:
title: "TLS Cipher Suite"
- description: "The TLS cipher suite to connect with, which must match
the cipher spec of the channel on the queue manager. When it is set, the
connection uses TLS; when it is not set, it does not."
- example: "TLS_RSA_WITH_AES_128_CBC_SHA256"
+ description: "The TLS cipher suite to connect with, which must match
the cipher spec of the channel on the queue manager, such as
`TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` for `ANY_TLS12_OR_HIGHER`. When it is
set, the connection uses TLS; when it is not set, it does not. The certificate
of the queue manager is checked against the trust store of the Java runtime,
and a channel that asks for a client certificate gets one from its key store:
set them with the Java system properties ` [...]
+ example: "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
type: string
subscriptionDurable:
title: "Durable Subscription"
@@ -120,6 +126,20 @@ spec:
description: "A JMS message selector: the source receives only the
messages that match it. It is a condition, in a syntax like the WHERE clause of
SQL, on the JMS properties and headers of the message, not on its body, such as
`priority > 5` or `region = 'EU' AND JMSPriority >= 7`. From a queue, the
messages that do not match stay on the queue. When it is not set, the source
receives every message."
example: "priority > 5"
type: string
+ concurrentConsumers:
+ title: "Concurrent Consumers"
+ description: "How many messages the source processes at the same time,
each in a thread of its own. From a queue, more than one makes the source
faster when each message takes a while, but the messages are then no longer
processed in the order of the queue. On a topic, each consumer is a
subscription of its own and receives every message, so each message is
processed that many times, unless `subscriptionShared` is true; a durable
subscription that is not shared takes only one con [...]
+ type: integer
+ example: 5
+ transacted:
+ title: "Transacted"
+ description: "Whether each message is received in a JMS transaction,
which is committed once the rest of the flow has processed the message. When
the flow fails, the transaction is rolled back and the queue manager delivers
the message again, with the header `JMSRedelivered` true. Once the message has
been delivered as many times as the backout threshold of the queue
(`BOTHRESH`), the client moves it to the backout queue of the queue
(`BOQNAME`); the user needs the authority to p [...]
+ type: boolean
+ acknowledgementModeName:
+ title: "Acknowledgement Mode"
+ description: "When the source acknowledges each message to the queue
manager, which then removes it from the queue. `AUTO_ACKNOWLEDGE`: as soon as
the message is received. `CLIENT_ACKNOWLEDGE`: once the rest of the flow has
processed it; when the flow fails, the queue manager delivers it again, and the
backout threshold and backout queue of the queue apply, as with `transacted`.
`DUPS_OK_ACKNOWLEDGE`: in batches, which is faster, but the messages processed
since the last batch ar [...]
+ type: string
+ enum: ["AUTO_ACKNOWLEDGE", "CLIENT_ACKNOWLEDGE", "DUPS_OK_ACKNOWLEDGE"]
dataTypes:
out:
headers:
@@ -156,6 +176,7 @@ spec:
XMSC_PASSWORD: "{{password}}"
XMSC_CLIENT_ID: "{{?clientId}}"
XMSC_WMQ_SSL_CIPHER_SUITE: "{{?sslCipherSuite}}"
+ XMSC_WMQ_CONNECTION_NAME_LIST: "{{?connectionNameList}}"
from:
uri: jms
parameters:
@@ -165,6 +186,9 @@ spec:
subscriptionShared: "{{subscriptionShared}}"
subscriptionName: "{{?subscriptionName}}"
selector: "{{?selector}}"
+ concurrentConsumers: "{{?concurrentConsumers}}"
+ transacted: "{{?transacted}}"
+ acknowledgementModeName: "{{?acknowledgementModeName}}"
connectionFactory: "#bean:{{wmqConnectionFactory}}"
steps:
- to:
diff --git
a/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
b/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
index d227ba047..54f4121fa 100644
--- a/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
+++ b/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
@@ -1185,7 +1185,7 @@
"supportLevel" : "Stable",
"title" : "JMS - AMQP 1.0 Sink",
"summary" : "Sends each message to a queue or a topic in a message broker
that speaks AMQP 1.0, such as Apache ActiveMQ Artemis, through JMS and the
Apache Qpid client.",
- "description" : "Sends each message to a queue or a topic in a message
broker that speaks AMQP 1.0, such as Apache ActiveMQ Artemis, through JMS and
the Apache Qpid client.\n\nUse it to hand work to another application through a
queue, or to publish events on a topic, on any broker that supports the AMQP
1.0 protocol. For an Artemis broker, `jms-apache-artemis-sink` works
too.\n\nInput: text is sent as a JMS text message, bytes as a JMS bytes
message, and a Map as a JMS map message. [...]
+ "description" : "Sends each message to a queue or a topic in a message
broker that speaks AMQP 1.0, such as Apache ActiveMQ Artemis, through JMS and
the Apache Qpid client.\n\nUse it to hand work to another application through a
queue, or to publish events on a topic, on any broker that supports the AMQP
1.0 protocol. For an Artemis broker, `jms-apache-artemis-sink` works
too.\n\nInput: text is sent as a JMS text message, bytes as a JMS bytes
message, and a Map as a JMS map message; [...]
"group" : "JMS",
"namespace" : "Messaging",
"provider" : "Apache Software Foundation"
@@ -1195,7 +1195,7 @@
"supportLevel" : "Stable",
"title" : "JMS - AMQP 1.0 Source",
"summary" : "Receives each message from a queue or a topic in a message
broker that speaks AMQP 1.0, such as Apache ActiveMQ Artemis, through JMS and
the Apache Qpid client.",
- "description" : "Receives each message from a queue or a topic in a
message broker that speaks AMQP 1.0, such as Apache ActiveMQ Artemis, through
JMS and the Apache Qpid client.\n\nUse it to process work that other
applications put on a queue, or to react to events published on a topic, on any
broker that supports the AMQP 1.0 protocol. For an Artemis broker,
`jms-apache-artemis-source` works too.\n\nOutput: the body is text for a JMS
text message, bytes for a bytes message, and a Ma [...]
+ "description" : "Receives each message from a queue or a topic in a
message broker that speaks AMQP 1.0, such as Apache ActiveMQ Artemis, through
JMS and the Apache Qpid client.\n\nUse it to process work that other
applications put on a queue, or to react to events published on a topic, on any
broker that supports the AMQP 1.0 protocol. For an Artemis broker,
`jms-apache-artemis-source` works too.\n\nOutput: the body is text for a JMS
text message, bytes for a bytes message, and a Ma [...]
"group" : "JMS",
"namespace" : "Messaging",
"provider" : "Apache Software Foundation"
@@ -1205,7 +1205,7 @@
"supportLevel" : "Stable",
"title" : "JMS - Apache Artemis Sink",
"summary" : "Sends each message to a queue or a topic in an Apache
ActiveMQ Artemis broker, through JMS.",
- "description" : "Sends each message to a queue or a topic in an Apache
ActiveMQ Artemis broker, through JMS.\n\nUse it to hand work to another
application through a queue, such as orders to process, or to publish events on
a topic for every application that listens. For another broker that speaks AMQP
1.0, use `jms-amqp-10-sink`.\n\nInput: text is sent as a JMS text message,
bytes as a JMS bytes message, and a Map as a JMS map message. The headers of
the message, except the Camel one [...]
+ "description" : "Sends each message to a queue or a topic in an Apache
ActiveMQ Artemis broker, through JMS.\n\nUse it to hand work to another
application through a queue, such as orders to process, or to publish events on
a topic for every application that listens. For another broker that speaks AMQP
1.0, use `jms-amqp-10-sink`.\n\nInput: text is sent as a JMS text message,
bytes as a JMS bytes message, and a Map as a JMS map message; `jmsMessageType`
sends text or bytes as the othe [...]
"group" : "JMS",
"namespace" : "Messaging",
"provider" : "Apache Software Foundation"
@@ -1215,7 +1215,7 @@
"supportLevel" : "Stable",
"title" : "JMS - Apache Artemis Source",
"summary" : "Receives each message from a queue or a topic in an Apache
ActiveMQ Artemis broker, through JMS.",
- "description" : "Receives each message from a queue or a topic in an
Apache ActiveMQ Artemis broker, through JMS.\n\nUse it to process work that
other applications put on a queue, such as orders or jobs, or to react to
events published on a topic. For another broker that speaks AMQP 1.0, use
`jms-amqp-10-source`.\n\nOutput: the body is text for a JMS text message, bytes
for a bytes message, and a Map for a map message. The JMS properties of the
message become headers, along with the [...]
+ "description" : "Receives each message from a queue or a topic in an
Apache ActiveMQ Artemis broker, through JMS.\n\nUse it to process work that
other applications put on a queue, such as orders or jobs, or to react to
events published on a topic. For another broker that speaks AMQP 1.0, use
`jms-amqp-10-source`.\n\nOutput: the body is text for a JMS text message, bytes
for a bytes message, and a Map for a map message. The JMS properties of the
message become headers, along with the [...]
"group" : "JMS",
"namespace" : "Messaging",
"provider" : "Apache Software Foundation"
@@ -1225,7 +1225,7 @@
"supportLevel" : "Stable",
"title" : "JMS - IBM MQ Sink",
"summary" : "Sends each message to a queue or a topic of an IBM MQ queue
manager, through JMS.",
- "description" : "Sends each message to a queue or a topic of an IBM MQ
queue manager, through JMS.\n\nUse it to hand work or events to applications
that read from IBM MQ, such as an existing enterprise or mainframe system. Use
`jms-ibm-mq-source` to read from IBM MQ.\n\nInput: text is sent as a JMS text
message, and bytes as a JMS bytes message. The headers of the message, except
the Camel ones, are sent along as JMS properties of the message.\n\nOutput: the
message is unchanged.\n\n [...]
+ "description" : "Sends each message to a queue or a topic of an IBM MQ
queue manager, through JMS.\n\nUse it to hand work or events to applications
that read from IBM MQ, such as an existing enterprise or mainframe system. Use
`jms-ibm-mq-source` to read from IBM MQ.\n\nInput: text is sent as a JMS text
message, and bytes as a JMS bytes message; `jmsMessageType` sends text or bytes
as the other kind. The headers of the message, except the Camel ones, are sent
along as JMS properties [...]
"group" : "JMS",
"namespace" : "Messaging",
"provider" : "Apache Software Foundation"
@@ -1235,7 +1235,7 @@
"supportLevel" : "Stable",
"title" : "JMS - IBM MQ Source",
"summary" : "Receives each message from a queue or a topic of an IBM MQ
queue manager, through JMS.",
- "description" : "Receives each message from a queue or a topic of an IBM
MQ queue manager, through JMS.\n\nUse it to process work or events that other
applications put on IBM MQ, such as an existing enterprise or mainframe system.
Use `jms-ibm-mq-sink` to send to IBM MQ.\n\nOutput: the body is text for a JMS
text message, and bytes for a bytes message. The JMS properties of the message
become headers, along with the JMS headers such as `JMSMessageID` and
`JMSTimestamp`, and IBM MQ de [...]
+ "description" : "Receives each message from a queue or a topic of an IBM
MQ queue manager, through JMS.\n\nUse it to process work or events that other
applications put on IBM MQ, such as an existing enterprise or mainframe system.
Use `jms-ibm-mq-sink` to send to IBM MQ.\n\nOutput: the body is text for a JMS
text message, and bytes for a bytes message. The JMS properties of the message
become headers, along with the JMS headers such as `JMSMessageID` and
`JMSTimestamp`, and IBM MQ de [...]
"group" : "JMS",
"namespace" : "Messaging",
"provider" : "Apache Software Foundation"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/jms-amqp-10-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/jms-amqp-10-sink.kamelet.yaml
index 2fa5027c0..84b19876e 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/jms-amqp-10-sink.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/jms-amqp-10-sink.kamelet.yaml
@@ -36,11 +36,11 @@ spec:
Use it to hand work to another application through a queue, or to
publish events on a topic, on any broker that supports the AMQP 1.0 protocol.
For an Artemis broker, `jms-apache-artemis-sink` works too.
- Input: text is sent as a JMS text message, bytes as a JMS bytes message,
and a Map as a JMS map message. The headers of the message, except the Camel
ones, are sent along as JMS properties of the message.
+ Input: text is sent as a JMS text message, bytes as a JMS bytes message,
and a Map as a JMS map message; `jmsMessageType` sends text or bytes as the
other kind. The headers of the message, except the Camel ones, are sent along
as JMS properties of the message.
Output: the message is unchanged.
- Good to know: Messages go to a queue unless `destinationType` is
`topic`, and a message sent to a topic reaches only the receivers subscribed at
that moment. The login and the TLS settings go in `remoteURI`: there are no
separate options for them. It opens a new connection to the broker for each
message. It does not wait for a reply, even when the incoming message expects
one, as one from `webhook-source` does.
+ Good to know: Messages go to a queue unless `destinationType` is
`topic`, and a message sent to a topic reaches only the receivers subscribed at
that moment. Messages are persistent, with priority 4, and never expire, unless
`deliveryPersistent`, `priority` and `timeToLive` say otherwise. It logs in
with `username` and `password` when they are set; the TLS settings go in
`remoteURI`. It opens a new connection to the broker for each message. It does
not wait for a reply, even when t [...]
required:
- destinationName
- remoteURI
@@ -58,9 +58,43 @@ spec:
type: string
remoteURI:
title: "Broker URL"
- description: "The address of the broker, as `amqp://host:port` (the
AMQP port is usually 5672), or `amqps://host:port` for TLS. Settings of the
Qpid JMS client go after `?`: `jms.username` and `jms.password` for a login, as
`amqp://host:5672?jms.username=app&jms.password=secret`, and
`transport.trustStoreLocation`, `transport.trustStorePassword`,
`transport.keyStoreLocation` and `transport.keyStorePassword` for TLS."
+ description: "The address of the broker, as `amqp://host:port` (the
AMQP port is usually 5672), or `amqps://host:port` for TLS. Settings of the
Qpid JMS client go after `?`, such as `transport.trustStoreLocation`,
`transport.trustStorePassword`, `transport.keyStoreLocation` and
`transport.keyStorePassword` for TLS. The login goes in `username` and
`password`; `jms.username` and `jms.password` in the address work too."
type: string
example: "amqp://localhost:5672"
+ username:
+ title: "Username"
+ description: "The user name to log in to the broker with. Leave it
empty for a broker that accepts clients without a login. When it is set, it is
used instead of `jms.username` in `remoteURI`."
+ type: string
+ x-descriptors:
+ - urn:camel:group:credentials
+ password:
+ title: "Password"
+ description: "The password to log in to the broker with, for the user
`username`. When it is set, it is used instead of `jms.password` in
`remoteURI`."
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ deliveryPersistent:
+ title: "Persistent Delivery"
+ description: "Whether the broker stores each message on disk, so that
it survives a restart of the broker. False sends non-persistent messages, which
are faster but lost when the broker stops. When it is not set, the messages are
persistent."
+ type: boolean
+ timeToLive:
+ title: "Time to Live"
+ description: "How long each message may wait to be received, in
milliseconds, such as 60000 for one minute. A message still waiting after that
time expires: the broker does not deliver it (Apache ActiveMQ Artemis moves it
to the queue `ExpiryQueue`). When it is not set, the messages never expire."
+ type: integer
+ example: 60000
+ priority:
+ title: "Priority"
+ description: "The JMS priority of each message, from 0 (lowest) to 9
(highest). Of the messages waiting on a queue, the broker delivers those with
the highest priority first. When it is not set, 4."
+ type: integer
+ minimum: 0
+ maximum: 9
+ example: 7
+ jmsMessageType:
+ title: "JMS Message Type"
+ description: "The kind of JMS message to send, whatever the body:
`Text` sends a text message, and `Bytes` a bytes message, for a receiver that
expects one kind. When it is not set, the kind follows the body: text is sent
as a text message, and bytes as a bytes message."
+ type: string
+ enum: ["Text", "Bytes"]
dependencies:
- "camel:jms"
- "camel:amqp"
@@ -71,6 +105,8 @@ spec:
type: "#class:org.apache.qpid.jms.JmsConnectionFactory"
properties:
remoteURI: "{{remoteURI}}"
+ username: "{{?username}}"
+ password: "{{?password}}"
from:
uri: kamelet:source
steps:
@@ -80,4 +116,8 @@ spec:
parameters:
destinationType: "{{destinationType}}"
destinationName: "{{destinationName}}"
+ deliveryPersistent: "{{?deliveryPersistent}}"
+ timeToLive: "{{?timeToLive}}"
+ priority: "{{?priority}}"
+ jmsMessageType: "{{?jmsMessageType}}"
connectionFactory: "#bean:{{connectionFactoryBean}}"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/jms-amqp-10-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/jms-amqp-10-source.kamelet.yaml
index aafff383e..d88864c76 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/jms-amqp-10-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/jms-amqp-10-source.kamelet.yaml
@@ -38,7 +38,7 @@ spec:
Output: the body is text for a JMS text message, bytes for a bytes
message, and a Map for a map message. The JMS properties of the message become
headers, along with the JMS headers such as `JMSMessageID`, `JMSDestination`,
`JMSTimestamp`, `JMSPriority` and `JMSRedelivered`.
- Good to know: From a queue, each message is removed when it is received,
even when the rest of the flow then fails, and several copies of this source
share the messages. From a topic (`destinationType` set to `topic`), it
receives only the messages sent while it is connected, unless
`subscriptionDurable` is true: then the broker keeps the messages sent while it
is stopped, under `subscriptionName`. A durable subscription needs `clientId`
unless it is shared (`subscriptionShared`, J [...]
+ Good to know: From a queue, each message is removed when it is received,
even when the rest of the flow then fails, unless `transacted` is true or
`acknowledgementModeName` is `CLIENT_ACKNOWLEDGE`: then a message whose flow
failed is delivered again. Several copies of this source share the messages of
a queue, and `concurrentConsumers` processes several messages at the same time.
From a topic (`destinationType` set to `topic`), it receives only the messages
sent while it is connect [...]
required:
- destinationName
- remoteURI
@@ -56,9 +56,22 @@ spec:
type: string
remoteURI:
title: "Broker URL"
- description: "The address of the broker, as `amqp://host:port` (the
AMQP port is usually 5672), or `amqps://host:port` for TLS. Settings of the
Qpid JMS client go after `?`: `jms.username` and `jms.password` for a login, as
`amqp://host:5672?jms.username=app&jms.password=secret`, and
`transport.trustStoreLocation`, `transport.trustStorePassword`,
`transport.keyStoreLocation` and `transport.keyStorePassword` for TLS."
+ description: "The address of the broker, as `amqp://host:port` (the
AMQP port is usually 5672), or `amqps://host:port` for TLS. Settings of the
Qpid JMS client go after `?`, such as `transport.trustStoreLocation`,
`transport.trustStorePassword`, `transport.keyStoreLocation` and
`transport.keyStorePassword` for TLS. The login goes in `username` and
`password`; `jms.username` and `jms.password` in the address work too."
type: string
example: "amqp://localhost:5672"
+ username:
+ title: "Username"
+ description: "The user name to log in to the broker with. Leave it
empty for a broker that accepts clients without a login. When it is set, it is
used instead of `jms.username` in `remoteURI`."
+ type: string
+ x-descriptors:
+ - urn:camel:group:credentials
+ password:
+ title: "Password"
+ description: "The password to log in to the broker with, for the user
`username`. When it is set, it is used instead of `jms.password` in
`remoteURI`."
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
clientId:
title: "Client ID"
description: "The JMS client ID of the connection, which names this
application to the broker. A durable subscription that is not shared needs one:
the broker keeps the subscription under the client ID and `subscriptionName`,
so use the same client ID each time the source starts. Only one connection may
use a client ID at a time: two running copies of this source need different
client IDs. When it is not set, the connection has no client ID."
@@ -84,6 +97,20 @@ spec:
description: "A JMS message selector: the source receives only the
messages that match it. It is a condition, in a syntax like the WHERE clause of
SQL, on the JMS properties and headers of the message, not on its body, such as
`priority > 5` or `region = 'EU' AND JMSPriority >= 7`. From a queue, the
messages that do not match stay on the queue. When it is not set, the source
receives every message."
example: "priority > 5"
type: string
+ concurrentConsumers:
+ title: "Concurrent Consumers"
+ description: "How many messages the source processes at the same time,
each in a thread of its own. From a queue, more than one makes the source
faster when each message takes a while, but the messages are then no longer
processed in the order of the queue. On a topic, each consumer is a
subscription of its own and receives every message, so each message is
processed that many times, unless `subscriptionShared` is true; a durable
subscription that is not shared takes only one con [...]
+ type: integer
+ example: 5
+ transacted:
+ title: "Transacted"
+ description: "Whether each message is received in a JMS transaction,
which is committed once the rest of the flow has processed the message. When
the flow fails, the transaction is rolled back and the broker delivers the
message again, with the header `JMSRedelivered` true; after the number of
attempts set in the broker (Apache ActiveMQ Artemis: 10 by default), the broker
moves it to a dead letter queue (Artemis: `DLQ`). When it is not set, the
message is removed from the queue w [...]
+ type: boolean
+ acknowledgementModeName:
+ title: "Acknowledgement Mode"
+ description: "When the source acknowledges each message to the broker,
which then removes it from the queue. `AUTO_ACKNOWLEDGE`: as soon as the
message is received. `CLIENT_ACKNOWLEDGE`: once the rest of the flow has
processed it; when the flow fails, the Qpid client delivers the message to the
flow again by itself, with no limit, unless `remoteURI` sets
`jms.redeliveryPolicy.maxRedeliveries`. Use `transacted` instead to leave the
attempts and the dead letter queue to the broker. [...]
+ type: string
+ enum: ["AUTO_ACKNOWLEDGE", "CLIENT_ACKNOWLEDGE", "DUPS_OK_ACKNOWLEDGE"]
dataTypes:
out:
headers:
@@ -113,6 +140,8 @@ spec:
type: "#class:org.apache.qpid.jms.JmsConnectionFactory"
properties:
remoteURI: "{{remoteURI}}"
+ username: "{{?username}}"
+ password: "{{?password}}"
from:
uri: jms
parameters:
@@ -123,6 +152,9 @@ spec:
subscriptionName: "{{?subscriptionName}}"
selector: "{{?selector}}"
clientId: "{{?clientId}}"
+ concurrentConsumers: "{{?concurrentConsumers}}"
+ transacted: "{{?transacted}}"
+ acknowledgementModeName: "{{?acknowledgementModeName}}"
connectionFactory: "#bean:{{connectionFactoryBean}}"
steps:
- to:
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/jms-apache-artemis-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/jms-apache-artemis-sink.kamelet.yaml
index 3c2cd4e78..172291950 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/jms-apache-artemis-sink.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/jms-apache-artemis-sink.kamelet.yaml
@@ -36,11 +36,11 @@ spec:
Use it to hand work to another application through a queue, such as
orders to process, or to publish events on a topic for every application that
listens. For another broker that speaks AMQP 1.0, use `jms-amqp-10-sink`.
- Input: text is sent as a JMS text message, bytes as a JMS bytes message,
and a Map as a JMS map message. The headers of the message, except the Camel
ones, are sent along as JMS properties of the message.
+ Input: text is sent as a JMS text message, bytes as a JMS bytes message,
and a Map as a JMS map message; `jmsMessageType` sends text or bytes as the
other kind. The headers of the message, except the Camel ones, are sent along
as JMS properties of the message.
Output: the message is unchanged.
- Good to know: Messages go to a queue unless `destinationType` is
`topic`, and a message sent to a topic reaches only the receivers subscribed at
that moment. It connects with no TLS unless `brokerURL` asks for it, and logs
in with `username` and `password` when they are set. It keeps its connections
to the broker in a pool and reuses them for the next messages. It does not wait
for a reply, even when the incoming message expects one, as one from
`webhook-source` does.
+ Good to know: Messages go to a queue unless `destinationType` is
`topic`, and a message sent to a topic reaches only the receivers subscribed at
that moment. Messages are persistent, with priority 4, and never expire, unless
`deliveryPersistent`, `priority` and `timeToLive` say otherwise. It connects
with no TLS unless `brokerURL` asks for it, and logs in with `username` and
`password` when they are set. It keeps its connections to the broker in a pool
and reuses them for the next [...]
required:
- destinationName
- brokerURL
@@ -89,6 +89,27 @@ spec:
description: "How long a connection of the pool can stay unused before
it is closed, in milliseconds. For example, 30000 is 30 seconds."
type: integer
default: 30000
+ deliveryPersistent:
+ title: "Persistent Delivery"
+ description: "Whether the broker stores each message on disk, so that
it survives a restart of the broker. False sends non-persistent messages, which
are faster but lost when the broker stops. When it is not set, the messages are
persistent."
+ type: boolean
+ timeToLive:
+ title: "Time to Live"
+ description: "How long each message may wait to be received, in
milliseconds, such as 60000 for one minute. A message still waiting after that
time expires: the broker does not deliver it, and moves it to the queue
`ExpiryQueue` (the default of the broker). When it is not set, the messages
never expire."
+ type: integer
+ example: 60000
+ priority:
+ title: "Priority"
+ description: "The JMS priority of each message, from 0 (lowest) to 9
(highest). Of the messages waiting on a queue, the broker delivers those with
the highest priority first. When it is not set, 4."
+ type: integer
+ minimum: 0
+ maximum: 9
+ example: 7
+ jmsMessageType:
+ title: "JMS Message Type"
+ description: "The kind of JMS message to send, whatever the body:
`Text` sends a text message, and `Bytes` a bytes message, for a receiver that
expects one kind. When it is not set, the kind follows the body: text is sent
as a text message, and bytes as a bytes message."
+ type: string
+ enum: ["Text", "Bytes"]
dependencies:
- "camel:jms"
- "camel:kamelet"
@@ -118,4 +139,8 @@ spec:
parameters:
destinationType: "{{destinationType}}"
destinationName: "{{destinationName}}"
+ deliveryPersistent: "{{?deliveryPersistent}}"
+ timeToLive: "{{?timeToLive}}"
+ priority: "{{?priority}}"
+ jmsMessageType: "{{?jmsMessageType}}"
connectionFactory: "#bean:{{pooledFactoryBean}}"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/jms-apache-artemis-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/jms-apache-artemis-source.kamelet.yaml
index 5f59b65e2..754e638b0 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/jms-apache-artemis-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/jms-apache-artemis-source.kamelet.yaml
@@ -38,7 +38,7 @@ spec:
Output: the body is text for a JMS text message, bytes for a bytes
message, and a Map for a map message. The JMS properties of the message become
headers, along with the JMS headers such as `JMSMessageID`, `JMSDestination`,
`JMSTimestamp`, `JMSPriority` and `JMSRedelivered`.
- Good to know: From a queue, each message is removed when it is received,
even when the rest of the flow then fails, and several copies of this source
share the messages. From a topic (`destinationType` set to `topic`), it
receives only the messages sent while it is connected, unless
`subscriptionDurable` is true: then the broker keeps the messages sent while it
is stopped, under `subscriptionName`. A durable subscription needs `clientId`
unless it is shared (`subscriptionShared`, J [...]
+ Good to know: From a queue, each message is removed when it is received,
even when the rest of the flow then fails, unless `transacted` is true or
`acknowledgementModeName` is `CLIENT_ACKNOWLEDGE`: then a message whose flow
failed is delivered again. Several copies of this source share the messages of
a queue, and `concurrentConsumers` processes several messages at the same time.
From a topic (`destinationType` set to `topic`), it receives only the messages
sent while it is connect [...]
required:
- destinationName
- brokerURL
@@ -97,6 +97,20 @@ spec:
description: "A JMS message selector: the source receives only the
messages that match it. It is a condition, in a syntax like the WHERE clause of
SQL, on the JMS properties and headers of the message, not on its body, such as
`priority > 5` or `region = 'EU' AND JMSPriority >= 7`. From a queue, the
messages that do not match stay on the queue. When it is not set, the source
receives every message."
example: "priority > 5"
type: string
+ concurrentConsumers:
+ title: "Concurrent Consumers"
+ description: "How many messages the source processes at the same time,
each in a thread of its own. From a queue, more than one makes the source
faster when each message takes a while, but the messages are then no longer
processed in the order of the queue. On a topic, each consumer is a
subscription of its own and receives every message, so each message is
processed that many times, unless `subscriptionShared` is true; a durable
subscription that is not shared takes only one con [...]
+ type: integer
+ example: 5
+ transacted:
+ title: "Transacted"
+ description: "Whether each message is received in a JMS transaction,
which is committed once the rest of the flow has processed the message. When
the flow fails, the transaction is rolled back and the broker delivers the
message again, with the header `JMSRedelivered` true; after the number of
attempts set in the broker (10 by default), the broker moves it to the dead
letter queue (`DLQ` by default). When it is not set, the message is removed
from the queue when it is received, e [...]
+ type: boolean
+ acknowledgementModeName:
+ title: "Acknowledgement Mode"
+ description: "When the source acknowledges each message to the broker,
which then removes it from the queue. `AUTO_ACKNOWLEDGE`: as soon as the
message is received. `CLIENT_ACKNOWLEDGE`: once the rest of the flow has
processed it; when the flow fails, the broker delivers it again, as with
`transacted`, and moves it to the dead letter queue after the number of
attempts set in the broker. `DUPS_OK_ACKNOWLEDGE`: in batches, which is faster,
but the messages processed since the last [...]
+ type: string
+ enum: ["AUTO_ACKNOWLEDGE", "CLIENT_ACKNOWLEDGE", "DUPS_OK_ACKNOWLEDGE"]
dataTypes:
out:
headers:
@@ -138,6 +152,9 @@ spec:
subscriptionName: "{{?subscriptionName}}"
selector: "{{?selector}}"
clientId: "{{?clientId}}"
+ concurrentConsumers: "{{?concurrentConsumers}}"
+ transacted: "{{?transacted}}"
+ acknowledgementModeName: "{{?acknowledgementModeName}}"
connectionFactory: "#bean:{{connectionFactoryBean}}"
steps:
- to:
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/jms-ibm-mq-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/jms-ibm-mq-sink.kamelet.yaml
index 2dbb7078d..4cad0ae10 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/jms-ibm-mq-sink.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/jms-ibm-mq-sink.kamelet.yaml
@@ -36,11 +36,11 @@ spec:
Use it to hand work or events to applications that read from IBM MQ,
such as an existing enterprise or mainframe system. Use `jms-ibm-mq-source` to
read from IBM MQ.
- Input: text is sent as a JMS text message, and bytes as a JMS bytes
message. The headers of the message, except the Camel ones, are sent along as
JMS properties of the message.
+ Input: text is sent as a JMS text message, and bytes as a JMS bytes
message; `jmsMessageType` sends text or bytes as the other kind. The headers of
the message, except the Camel ones, are sent along as JMS properties of the
message.
Output: the message is unchanged.
- Good to know: the IBM MQ client library is not included, as its licence
is not the Apache one: add `mvn:com.ibm.mq:com.ibm.mq.jakarta.client` with a
version to the dependencies of the integration (Camel JBang adds it by itself).
It connects as a client over the network, with no TLS unless `sslCipherSuite`
is set. Messages go to a queue unless `destinationType` is `topic`, and a
message sent to a topic reaches only the receivers subscribed at that moment.
It does not wait for a repl [...]
+ Good to know: the IBM MQ client library is not included, as its licence
is not the Apache one: add `mvn:com.ibm.mq:com.ibm.mq.jakarta.client` with a
version to the dependencies of the integration (Camel JBang adds it by itself).
It connects as a client over the network, with no TLS unless `sslCipherSuite`
is set; the trust store and the key store for TLS are those of the Java runtime
(`javax.net.ssl.trustStore`, `javax.net.ssl.keyStore`). For a multi-instance
queue manager, list it [...]
required:
- serverName
- serverPort
@@ -96,11 +96,38 @@ spec:
format: password
x-descriptors:
- urn:camel:group:credentials
+ connectionNameList:
+ title: "Connection Name List"
+ description: "The addresses of the instances of a multi-instance queue
manager, as `host(port)` separated by commas, such as
`mq1.example.com(1414),mq2.example.com(1414)`. The client tries them in order
and connects to the first that answers. `serverName` and `serverPort` take the
place of the first address of the list, so set them to the first instance too.
When it is not set, the client connects only to `serverName` and `serverPort`."
+ type: string
+ pattern: '^[^,()\s]+(\(\d+\))?(\s*,\s*[^,()\s]+(\(\d+\))?)*$'
+ example: "mq1.example.com(1414),mq2.example.com(1414)"
sslCipherSuite:
title: "TLS Cipher Suite"
- description: "The TLS cipher suite to connect with, which must match
the cipher spec of the channel on the queue manager. When it is set, the
connection uses TLS; when it is not set, it does not."
- example: "TLS_RSA_WITH_AES_128_CBC_SHA256"
+ description: "The TLS cipher suite to connect with, which must match
the cipher spec of the channel on the queue manager, such as
`TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` for `ANY_TLS12_OR_HIGHER`. When it is
set, the connection uses TLS; when it is not set, it does not. The certificate
of the queue manager is checked against the trust store of the Java runtime,
and a channel that asks for a client certificate gets one from its key store:
set them with the Java system properties ` [...]
+ example: "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
+ type: string
+ deliveryPersistent:
+ title: "Persistent Delivery"
+ description: "Whether the queue manager stores each message on disk,
so that it survives a restart of the queue manager. False sends non-persistent
messages, which are faster but lost when the queue manager stops. When it is
not set, the messages are persistent."
+ type: boolean
+ timeToLive:
+ title: "Time to Live"
+ description: "How long each message may wait to be received, in
milliseconds, such as 60000 for one minute. A message still waiting after that
time expires: the queue manager does not deliver it, and removes it. When it is
not set, the messages never expire."
+ type: integer
+ example: 60000
+ priority:
+ title: "Priority"
+ description: "The JMS priority of each message, from 0 (lowest) to 9
(highest). Of the messages waiting on a queue, the queue manager delivers those
with the highest priority first. When it is not set, 4."
+ type: integer
+ minimum: 0
+ maximum: 9
+ example: 7
+ jmsMessageType:
+ title: "JMS Message Type"
+ description: "The kind of JMS message to send, whatever the body:
`Text` sends a text message, and `Bytes` a bytes message, for a receiver that
expects one kind. When it is not set, the kind follows the body: text is sent
as a text message, and bytes as a bytes message."
type: string
+ enum: ["Text", "Bytes"]
dependencies:
- "camel:jms"
- "camel:kamelet"
@@ -118,6 +145,7 @@ spec:
XMSC_PASSWORD: "{{password}}"
XMSC_CLIENT_ID: "{{?clientId}}"
XMSC_WMQ_SSL_CIPHER_SUITE: "{{?sslCipherSuite}}"
+ XMSC_WMQ_CONNECTION_NAME_LIST: "{{?connectionNameList}}"
from:
uri: kamelet:source
steps:
@@ -127,4 +155,8 @@ spec:
parameters:
destinationType: "{{destinationType}}"
destinationName: "{{destinationName}}"
+ deliveryPersistent: "{{?deliveryPersistent}}"
+ timeToLive: "{{?timeToLive}}"
+ priority: "{{?priority}}"
+ jmsMessageType: "{{?jmsMessageType}}"
connectionFactory: "#bean:{{wmqConnectionFactory}}"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/jms-ibm-mq-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/jms-ibm-mq-source.kamelet.yaml
index 7f0807ab2..8d050bfc5 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/jms-ibm-mq-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/jms-ibm-mq-source.kamelet.yaml
@@ -38,7 +38,7 @@ spec:
Output: the body is text for a JMS text message, and bytes for a bytes
message. The JMS properties of the message become headers, along with the JMS
headers such as `JMSMessageID` and `JMSTimestamp`, and IBM MQ details such as
`JMSXUserID`, `JMS_IBM_PutDate` and `JMS_IBM_Format`.
- Good to know: the IBM MQ client library is not included, as its licence
is not the Apache one: add `mvn:com.ibm.mq:com.ibm.mq.jakarta.client` with a
version to the dependencies of the integration (Camel JBang adds it by itself).
From a queue, each message is removed when it is received, even when the rest
of the flow then fails, and several copies of this source share the messages.
From a topic (`destinationType` set to `topic`), it receives only the messages
sent while it is conne [...]
+ Good to know: the IBM MQ client library is not included, as its licence
is not the Apache one: add `mvn:com.ibm.mq:com.ibm.mq.jakarta.client` with a
version to the dependencies of the integration (Camel JBang adds it by itself).
From a queue, each message is removed when it is received, even when the rest
of the flow then fails, unless `transacted` is true or
`acknowledgementModeName` is `CLIENT_ACKNOWLEDGE`: then a message whose flow
failed is delivered again. Several copies of th [...]
required:
- serverName
- serverPort
@@ -95,10 +95,16 @@ spec:
format: password
x-descriptors:
- urn:camel:group:credentials
+ connectionNameList:
+ title: "Connection Name List"
+ description: "The addresses of the instances of a multi-instance queue
manager, as `host(port)` separated by commas, such as
`mq1.example.com(1414),mq2.example.com(1414)`. The client tries them in order
and connects to the first that answers. `serverName` and `serverPort` take the
place of the first address of the list, so set them to the first instance too.
When it is not set, the client connects only to `serverName` and `serverPort`."
+ type: string
+ pattern: '^[^,()\s]+(\(\d+\))?(\s*,\s*[^,()\s]+(\(\d+\))?)*$'
+ example: "mq1.example.com(1414),mq2.example.com(1414)"
sslCipherSuite:
title: "TLS Cipher Suite"
- description: "The TLS cipher suite to connect with, which must match
the cipher spec of the channel on the queue manager. When it is set, the
connection uses TLS; when it is not set, it does not."
- example: "TLS_RSA_WITH_AES_128_CBC_SHA256"
+ description: "The TLS cipher suite to connect with, which must match
the cipher spec of the channel on the queue manager, such as
`TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` for `ANY_TLS12_OR_HIGHER`. When it is
set, the connection uses TLS; when it is not set, it does not. The certificate
of the queue manager is checked against the trust store of the Java runtime,
and a channel that asks for a client certificate gets one from its key store:
set them with the Java system properties ` [...]
+ example: "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
type: string
subscriptionDurable:
title: "Durable Subscription"
@@ -120,6 +126,20 @@ spec:
description: "A JMS message selector: the source receives only the
messages that match it. It is a condition, in a syntax like the WHERE clause of
SQL, on the JMS properties and headers of the message, not on its body, such as
`priority > 5` or `region = 'EU' AND JMSPriority >= 7`. From a queue, the
messages that do not match stay on the queue. When it is not set, the source
receives every message."
example: "priority > 5"
type: string
+ concurrentConsumers:
+ title: "Concurrent Consumers"
+ description: "How many messages the source processes at the same time,
each in a thread of its own. From a queue, more than one makes the source
faster when each message takes a while, but the messages are then no longer
processed in the order of the queue. On a topic, each consumer is a
subscription of its own and receives every message, so each message is
processed that many times, unless `subscriptionShared` is true; a durable
subscription that is not shared takes only one con [...]
+ type: integer
+ example: 5
+ transacted:
+ title: "Transacted"
+ description: "Whether each message is received in a JMS transaction,
which is committed once the rest of the flow has processed the message. When
the flow fails, the transaction is rolled back and the queue manager delivers
the message again, with the header `JMSRedelivered` true. Once the message has
been delivered as many times as the backout threshold of the queue
(`BOTHRESH`), the client moves it to the backout queue of the queue
(`BOQNAME`); the user needs the authority to p [...]
+ type: boolean
+ acknowledgementModeName:
+ title: "Acknowledgement Mode"
+ description: "When the source acknowledges each message to the queue
manager, which then removes it from the queue. `AUTO_ACKNOWLEDGE`: as soon as
the message is received. `CLIENT_ACKNOWLEDGE`: once the rest of the flow has
processed it; when the flow fails, the queue manager delivers it again, and the
backout threshold and backout queue of the queue apply, as with `transacted`.
`DUPS_OK_ACKNOWLEDGE`: in batches, which is faster, but the messages processed
since the last batch ar [...]
+ type: string
+ enum: ["AUTO_ACKNOWLEDGE", "CLIENT_ACKNOWLEDGE", "DUPS_OK_ACKNOWLEDGE"]
dataTypes:
out:
headers:
@@ -156,6 +176,7 @@ spec:
XMSC_PASSWORD: "{{password}}"
XMSC_CLIENT_ID: "{{?clientId}}"
XMSC_WMQ_SSL_CIPHER_SUITE: "{{?sslCipherSuite}}"
+ XMSC_WMQ_CONNECTION_NAME_LIST: "{{?connectionNameList}}"
from:
uri: jms
parameters:
@@ -165,6 +186,9 @@ spec:
subscriptionShared: "{{subscriptionShared}}"
subscriptionName: "{{?subscriptionName}}"
selector: "{{?selector}}"
+ concurrentConsumers: "{{?concurrentConsumers}}"
+ transacted: "{{?transacted}}"
+ acknowledgementModeName: "{{?acknowledgementModeName}}"
connectionFactory: "#bean:{{wmqConnectionFactory}}"
steps:
- to: