| At line 1 changed one line |
| About __Java Message Service__: [https://en.wikipedia.org/wiki/Jakarta_Messaging]\\ |
| About __Java Message Service__: [Wikipedia: Jakarta Messaging API Link|https://en.wikipedia.org/wiki/Jakarta_Messaging]\\ |
| __Supported protocol__: AMQPS ([Wikipedia: Advanced Message Queuing Protocol Link|https://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol])\\ |
| At line 3 changed 3 lines |
| __Supported protocol__: AMQPS ([https://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol])\\ |
|
| __!!! After 10.4.0_24+:__ Dependency jar files needs to be placed. |
| ---- |
| __⚠️ 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|jms_dependency.zip]\\ |
| • 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\\ |
| At line 7 changed one line |
| !!1. Solace JMS AMQPS Integration\\ |
| More info about Solace JMS AMQP: [Why Solace Support for AMQP 1.0? Link|https://docs.solace.com/API/AMQP/Why-AMQP.htm]\\ |
| At line 9 changed one line |
| About Solace JMS : [https://docs.solace.com/API/AMQP/Why-AMQP.htm]\\ |
| Get the __AMQPS URL__, __username__, and __password__ from your Solace broker for use in the JMSTask JNDI configuration.\\ |
| At line 11 removed 2 lines |
| Get the __AMQPS URL__, __user name__, and __password__ for JMSTask's __JNDI config__ from the __Solace Broker Management__.\\ |
| \\ |
| At line 18 added 2 lines |
| ---- |
| !!2. Apache ActiveMQ Artemis and Amazon MQ Integration \\ |
| At line 15 changed one line |
| !!2. JMSTask configuration:\\ |
| !2.1 Apache ActiveMQ Artemis\\ |
| \\ |
| More info: [ActiveMQ Artemis Documentation Link|https://activemq.apache.org/components/artemis/documentation/]\\ |
| __⚠️ Important__: To connect JMSTask to __Apache ActiveMQ Artemis__ over __AMQPS__, ensure your Artemis broker is configured to accept secure __AMQP__ connections.\\ |
| \\ |
| [JMS (Java Message Service)/apache_artemis.png]\\ |
| \\__JNDI connection related settings example:__\\ |
| ---- |
| __a.)__\\ |
| {{{ |
| # Secured AMQP Host |
| connectionfactory.qpidConnectionfactory=amqps://192.168.0.10:5671?transport.trustAll=true&transport.verifyHost=false |
| }}}\\ |
| \\ |
| • __transport.trustAll=true__ -> Accepts all SSL certificates.\\ |
| • __transport.verifyHost=false__ -> Disables hostname verification in the TLS handshake.\\ |
| ---- |
| __b.)__\\ |
| \\ |
| {{{ |
| # Secured AMQP Host |
| connectionfactory.qpidConnectionfactory=amqps://my.artemis.com:5671 |
| }}}\\ |
| ---- |
| !2.2 Amazon MQ\\ |
| \\ |
| CrushFTP also supports integration with __Amazon MQ__, a managed message broker service compatible with ActiveMQ and Artemis. [Amazon MQ (official site) Link|https://aws.amazon.com/amazon-mq/] More info: [Amazon MQ – Managed Message Broker Service for ActiveMQ Link| https://aws.amazon.com/blogs/aws/amazon-mq-managed-message-broker-service-for-activemq/]\\ |
| \\ |
| Sign in to __AWS Console__ and Navigate to __Amazon MQ__ Select your Broker. Click on the name of your ActiveMQ or Artemis broker. Scroll down to the __Connections__ section.\\ |
| \\ |
| [JMS (Java Message Service)/amazon_amqps_url.png]\\ |
| {{{ |
| amqps://<broker-id>.mq.<region>.amazonaws.com:5671 |
| }}} |
| ---- |
| !!3 Azure Service Bus Integration:\\ |
| \\ |
| [Azure Service Bus Link|https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-messaging-overview]\\ |
| [AMQP 1.0 in Azure Service Bus and Event Hubs protocol guide Link|https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-amqp-overview]\\ |
| [JMS (Java Message Service)/azure_service_bus.png]\\ |
| \\ |
| To get __AMQPS URL__:\\ |
| __a.)__ Open your __Service Bus namespace__ in the __Azure Portal__\\ |
| __b.)__ Go to Settings → Shared access policies\\ |
| __c.)__ Select a policy (e.g., RootManageSharedAccessKey)\\ |
| __d.)__ Copy the namespace name (e.g., your-namespace.servicebus.windows.net)\\ |
| __e.)__ Combine as amqps://your-namespace.servicebus.windows.net:5671\\ |
| \\ |
| [JMS (Java Message Service)/azure_amqps_shared_access_key.png]\\ |
| \\ |
| {{{ |
| amqps://<namespace>.servicebus.windows.net:5671 |
| username = <SAS-key-name> |
| password = <SAS-key> |
| }}}\\ |
| \\ |
| ---- |
| !!4. JMSTask configuration:\\ |
| At line 17 changed 3 lines |
| !2.1 JNDI config: Variable replacement is supported.\\ |
| About Java Naming and Directory Interface: [https://en.wikipedia.org/wiki/Java_Naming_and_Directory_Interface]\\ |
| It stores the connection settings and required destinations (Topic and Queue).\\ |
| !4.1 JNDI config: Variable replacement is supported.\\ |
| More info about __Java Naming and Directory Interface__: [Wikipedia: Java Naming and Directory Interface Link|https://en.wikipedia.org/wiki/Java_Naming_and_Directory_Interface]\\ |
| __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.\\ |
| At line 25 changed one line |
| # Context Factory |
| # Context Factory (Do not change!) |
| At line 39 changed one line |
| !2.2 Producer Mode:\\ |
| __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!\\ |
| At line 41 changed one line |
| Sends messages to the given destination topic or queue.\\ |
| __connectionfactory.qpidConnectionfactory=amqps://mr-connection-XXXXd:56XX__ or\\ |
| __connectionfactory.qpidConnectionfactory=amqps://mr-connection-XXXXd:56XX?transport.trustAll=true&transport.verifyHost=false__\\ |
| 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.\\ |
| At line 108 added 10 lines |
| __⚠️ Important__: JMSTask uses __sasl.enabled.mechanisms=PLAIN__ by default.\\ |
| __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.\\ |
| ---- |
| !4.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.\\ |
| \\ |
| At line 45 changed one line |
| __1. Destination name__: Name of the __Topic__ or __Queue__ configured on __JNDI config__. Variable replacement is supported ([CrushTaskVariables]).\\ |
| __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.\\ |
| At line 49 changed 3 lines |
| __ Persistent:__ Delivery mode Persistent means the message is not lost when a messaging provider goes down for any reason and comes up again.\\ |
| __ Time to live:__ When the message is published, the specified time to live is added to the current time to give the expiration time\\ |
| __ Priority:__ There are 10 priority levels, 0 to 9. As per the JMS standard, a message with priority 0-4 is the normal priority, and 5-9 is considered an expedited priority.\\ |
| __ 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.\\ |
| At line 53 changed one line |
| __3. Message Type: Custom Message__: Send a custom message to the destination as text or binary. Variable replacement is also supported. You can loop through incoming files and send as many custom messages with file-related pieces of information like name, path, or URL.\\ |
| __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.\\ |
| At line 55 changed one line |
| __4. Message Type: Send files__: It sends the file content in binary mode. Max file size allowed: __10 MB__.\\ |
| __4. Message Type: Send files__: Sends the file content in binary mode directly to the destination. ⚠️ The maximum allowed file size is __10 MB__.\\ |
| ---- |
| !4.3 Consumer Mode:\\ |
| At line 57 changed one line |
| !2.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.\\ |
| At line 59 removed 2 lines |
| Receive messages from the given destination topic or queue.\\ |
| \\ |
| At line 62 changed one line |
| __1. Destination name__: Name of the __Topic__ or __Queue__ configured on __JNDI config__. Variable replacement is supported ([CrushTaskVariables]).\\ |
| __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.\\ |
| At line 64 changed one line |
| __2. Message settings__: Limit the number of messages, and control the read timeout of message reading.\\ |
| __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.\\ |
| At line 66 changed one line |
| __3. Store settings__: It saves the message (less than 10MB) as a file to the given location. Provide the file name and make it unique to avoid overwriting. Variable replacement is supported.\\ |
| __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.\\ |
