Was this helpful?
JMS Queue
Note:  For general information about Queue Steps, see Queue Step.
The JMS Queue component facilitates interaction with Java Message Service (JMS) compliant message brokers. The supported JMS queue component versions are 2.0.0 and 3.0.0.
The JMS Queue 3.0.0 differs from version 2.0.0 in that it provides support for durable topic subscriptions and you can set the JMSPriority header when sending messages.
Note:  The JMS 1.0.0 component is deprecated.
Use the following information to migrate from JMS 1.0.0 to the currently supported versions.
 
Component Version
Display Name
Actual Option Name Used in Process
Option Type
1.0.0, 2.0.0, and 3.0.0 (component configuration)
 
User Name
com.pervasive.di.queue.connection.userid
text
Password
com.pervasive.di.queue.connection.password
password
java.naming.factory.initial
contextfactory
text
javax.jms.connectionfactory
connectionfactory
text
java.naming.provider.url
providerurl
text
PropertiesFile
propertiesfile
file
OutputMessageType
msgtype
enum
MessageSelector
msgselector
text
Timeout
timeout
number
1.0.0 (component configuration)
 
Server Name
com.pervasive.di.queue.connection.server
text
JMSCorrelationID
jmscorrelationid
text
JMSReplyTo
jmsreplyto
text
JMSType
jmstype
text
2.0.0 and 3.0.0
(component configuration)
JarLocation
jarlocation
text
2.0.0 and 3.0.0
(configured with PutMessage action in step)
JMSCorrelationID
jmscorrelationid
text
JMSReplyTo
jmsreplyto
text
JMSType
jmstype
text
Note:  Possible values for msgtype are - javax.jms.TextMessage, javax.jms.BygtesMessage, or javax.jms.StreamMessage.
JarLocation is a directory that contains all client jars that comprise a single JMS client OR the full path to a single client jar file.
JMS Queue 2.0.0 Property Descriptions
Property
Default Value
Description
User Name
 
Username to connect to the host.
Password
 
The password to authenticate the above username.
Messaging Styles
Point-to-Point
Select one:
Point-to-Point
Publish-Subscribe
java.naming.factory.initial
 
Fully qualified class name of the initial context factory for the JNDI service provider.
javax.jms.connectionfactory
 
JNDI lookup name of the JMS Queue connection factory.
java.naming.provider.url
 
URL for the JNDI provider-specific configuration information.
PropertiesFile
 
Specifies the name of a properties file that contains the JMS Queue configuration information. You can either specify the three properties above separately or place them in a Java properties file. See the note at the end of this topic for additional details.
OutputMessageType
javax.jms.TextMessage
Type of JMS Queue message to create when writing messages.
javax.jms.TextMessage
javax.jms.BytesMessage
javax.jms.StreamMessage
MessageSelector
 
JMS Queue message selector to use for reading messages.
JarLocation
 
Directory that contains all client jars that comprise a single JMS client OR the full path to a single client jar file.
Timeout
0
Maximum number of seconds to wait for a message to arrive on a queue when retrieving messages.
JMS Queue 3.0.0 Property Descriptions
Property
Default Value
Description
User Name
 
Username to connect to the host.
Password
 
The password to authenticate the above username.
Messaging Styles
Point-to-Point
Select one:
Point-to-Point
Publish-Subscribe
Durable Subscriber
FALSE
Designates whether the topic subscription is durable or not. Brokers will store messages sent to topics while durable subscribers are disconnected.
This property is displayed if you have selected Messaging Style as Publish-Subscribe.
Client ID
actian-dc-jms
Sets the client ID for a durable subscription.
This property is displayed if Durable Subscriber is set to TRUE.
Subscriber Name
actian-dc-durable-subscriber
Sets a unique name for the durable subscription.
This property is displayed if Durable Subscriber is set to TRUE.
Unsubscribe from Durable Subscription
TRUE
If the value is TRUE, the component will automatically unsubscribe the durable subscription when the Disconnect action is called.
If the value is FALSE, the subscription will be active after it is disconnected.
This property is displayed if Durable Subscriber is set to TRUE.
java.naming.factory.initial
 
Fully qualified class name of the initial context factory for the JNDI service provider.
javax.jms.connectionfactory
 
JNDI lookup name of the JMS Queue connection factory.
java.naming.provider.url
 
URL for the JNDI provider-specific configuration information.
PropertiesFile
 
Specifies the name of a properties file that contains the JMS Queue configuration information. You can either specify the above three properties separately, or include them in a properties file. See the note at the end of this topic for additional details.
OutputMessageType
javax.jms.TextMessage
Type of JMS Queue message to create when writing messages.
javax.jms.TextMessage
javax.jms.BytesMessage
javax.jms.StreamMessage
MessageSelector
 
JMS Queue message selector to use for reading messages.
JarLocation
 
Directory that contains all client jars that comprise a single JMS client OR the full path to a single client jar file.
Timeout
0
Maximum number of seconds to wait for a message to arrive on a queue when retrieving messages.
JMS Priority
 
Prompts the component to set the JMSPriority header when sending messages. It requests the broker to assign lower or higher priority to the message when routing to consumers.
Valid values are 0 to 9. 9 is the highest. Brokers typically set the default value as 4.
Supported Actions
Action
Description
Connect
Establishes a connection to the server.
Disconnect
Disconnects from the server.
GetMessage
Retrieves message into a message object.
PutMessage
Writes a message object into the queue.
BeginTransaction
Starts a JMS Queue transaction.
CommitTransaction
Commits a JMS Queue transaction.
RollbackTransaction
Rolls back a JMS Queue transaction.
Supported Action Parameters
Action
Parameter
Description
Connect
Queue
Name of the queue used to connect to.
GetMessage
Queue
Name of the queue that contains the message object from where the message must be retrieved.
Message
DJMessage that will contain the contents of the consumed JMS message.
PutMessage
Queue
Name of the queue that contains the message object to where the message must be written.
Message
DJMessage which contains the content which will be published to the JMS message queue.
Supported Action Properties
Action
Property
Description
PutMessage
JMSCorrelationID
Links one message with another message. For example, you can link a request message with the appropriate response message.
Make sure to start your message ID value with the ID prefix.
Enter any of the following:
Provider-specific message ID
Application-specific string
Provider-native byte value
JMSReplyTo
Destination queue or topic name where replies to this message are sent. If this value is null, no reply is expected.
JMSType
Sets the type of message definition to expect from applications.
Note:  A Java properties file is a simple text file containing a set of property/value pairs. Each property and value is on a separate line. The property name and value are separated by an equal sign (=). For example, a properties file that contains configuration properties for an ActiveMQ connection will look similar to the following:
java.naming.factory.initial=org.apache.activemq.jndi.ActiveMQInitialContextFactory
javax.jms.connectionfactory=ConnectionFactory
java.naming.provider.url=tcp://myhost:61616

For more information on JMS, see the JMS API documentation.
Last modified date: 07/26/2024