This is version 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 . It is not the current version, and thus it cannot be edited.
[Back to current version]   [Restore this version]

About Java Message Service: Wikipedia: Jakarta Messaging API Link
Supported protocol: AMQPS (Wikipedia: Advanced Message Queuing Protocol Link)

---

⚠️ Important:
- Dependency jar files must be downloaded (unzip) and placed in your CrushFTP Install Folder/plugins/ lib. ⚠️ Restart is required to load the new JMS-related dependency jars. Download Link
- CrushFTP’s JMSTask supports JMS providers that use the AMQP 1.0 protocol.

---

⚠️ Proxy Configuration: If your server accesses the internet through a proxy, ensure that the AMQPS domains are whitelisted.

---

1. Solace JMS Integration
#

More info about Solace JMS AMQP: Why Solace Support for AMQP 1.0? Link

Get the AMQPS URL, Username, and Password for JMSTask's JNDI configuration from the Solace Broker Management.

---

2. Apache Artemis Integration
#

⚠️ Important: To connect JMSTask to Apache Artemis (formerly ActiveMQ Artemis) over AMQPS, ensure your Artemis broker is configured to accept secure AMQP connections.



JNDI connection related settings example:

# Secured AMQP Host 
connectionfactory.qpidConnectionfactory=amqps://my.artemis.com:5672?transport.trustAll=true&transport.verifyHost=false

---

3. JMSTask configuration:
#

3.1 JNDI config: Variable replacement is supported.
#

More info about Java Naming and Directory Interface: Wikipedia: Java Naming and Directory Interface Link
JNDI is a system used by some applications to store and access connection details—like the server address, username, and password—as well as the names of messaging channels (called topics and queues).In simple terms, it helps the application know where to connect and where to send or receive messages, without needing to hard-code those details every time.



Configuration example:

# Context Factory (Do not change!)
java.naming.factory.initial=org.apache.qpid.jms.jndi.JmsInitialContextFactory

# Secured AMQP Host 
connectionfactory.qpidConnectionfactory=amqps://mr-connection-XXXXd:56XX

#User name and password
username=solace-XXXX
password=rsaXXXXXX
#Topic name
topic.my_topic_name=my_topic_name
queue.my_queue=my_queue

java.naming.factory.initial=org.apache.qpid.jms.jndi.JmsInitialContextFactory: This tells the application which type of messaging system it is connecting to. ⚠️ Do not change!
connectionfactory.qpidConnectionfactory=amqps://mr-connection-XXXXd:56XX: This is the secure address of the messaging server (uses AMQPS, which is encrypted). It tells the application where to connect to send and receive messages.
username=solace-XXXX password=rsaXXXXXX: These are the login credentials used to access the messaging server.
topic.my_topic_name=my_topic_name: A topic is a named channel where messages are published. Applications can subscribe to this topic to receive relevant messages.
queue.my_queue=my_queue: A queue is another type of message destination. Unlike topics, queues hold messages until they are delivered to a specific recipient.

---

3.2 Producer Mode:
#

Producer mode means the system is acting as a sender, creating and sending messages to a messaging server. It does not receive or process incoming messages—its role is only to send out information, such as updates or alerts, to other systems or services.



1. Destination Name: It refers to the Topic or Queue that has been set up in the JNDI configuration. You can also use CrushTaskVariables to automatically insert values into the name, allowing for flexible and dynamic message routing.

2. Advanced Options:

Persistent: If enabled, messages will not be lost even if the messaging server goes down and restarts. They are stored safely until delivered.
Time to live: Sets how long a message remains valid. After this time passes, the message will automatically expire if not delivered.
Priority: Determines the importance of the message. Values range from 0 to 9 — 0 to 4 are normal priority, while 5 to 9 are treated as high priority.

3. Message Type: Custom Message: Send a custom message to the destination as text or binary. Variable replacement is supported, allowing you to insert dynamic values. You can loop through incoming files and send multiple custom messages containing file-related details such as name, path, or URL.

4. Message Type: Send files: Sends the file content in binary mode directly to the destination. ⚠️ The maximum allowed file size is 10 MB.

---

3.3 Consumer Mode:
#

Consumer mode means the system is set up to receive messages from a messaging server, such as updates, alerts, or file notifications. It listens on a specific topic or queue and processes incoming messages as they arrive. This mode is used when the system needs to react to events or data sent by other systems.


1. Destination name: It refers to the Topic or Queue that has been set up in the JNDI configuration. You can also use CrushTaskVariables to automatically insert values into the name, allowing for flexible and dynamic message routing.

2. Message settings: Configure how messages are received by setting a limit on the number of messages to process and a timeout that defines how long the system should wait for new messages. These settings help control how the system handles incoming message traffic and delays.

3. Store settings: Saves the received message (⚠️ up to 10 MB) as a file at the specified location. You need to provide a File Name, ⚠️ and it’s recommended to make it unique to prevent overwriting existing files. Variable replacement is supported for dynamic file naming.
Message-related variables:

{message_id}, {message_priority}, {message_expiration}, {message_type}, {message_correlation_id}, {message_reply_to}