This topic contains sections marked as revised for this release
Use the JMSInput node to receive messages from JMS destinations. JMS destinations are accessed through a connection to a JMS provider.
This topic contains the following sections:
The JMSInput node acts as a JMS message consumer and can receive all six message types that are defined in the Java Message Service Specification, version 1.1. Messages are received by using method calls, which are described in the JMS specification.
The JMSInput node is contained in the JMS drawer of the palette, and is represented in the workbench by the following icon:
The JMSInput node receives and propagates messages with a JMS message tree. You can set the properties of the JMSInput node to control the way in which the JMS messages are received.
Message flows that handle messages that are received from connections to JMS providers must always start with a JMSInput node. If you include an output node in a message flow that starts with a JMSInput node, it can be any of the supported output nodes (including user-defined output nodes); you do not need to include a JMSOutput node. However, if you do not include a JMSOutput node, you must include the JMSMQTransform node to transform the message to the format that is expected by the output node.
If you are propagating JMS messages and creating a message flow to use as a subflow, you cannot use a standard input node; you must use an instance of the JMSInput node as the first node in order to create an In terminal for the subflow.
Use the -c parameter on the mqsichangeproperties command to change the property settings for an object name that already exists in the broker persistent store. For a JMS provider, this object name is a JMS Provider name.
Use the mqsideleteconfigurableservice command to delete a JMS provider resource that was created by the mqsicreateconfigurableservice command.
Use the -c parameter on the mqsireportproperties command to report on the properties of any JMS provider resource (both default and user-defined).
When you have put an instance of the JMSInput node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view.
All mandatory properties that do not have a default value defined are marked with an asterisk.
Configure the JMSInput node.
com.sun.jndi.fscontext.RefFSContextFactory, which defines the file-based initial context factory for the WebSphere MQ JMS provider.
To identify the name of the Initial Context Factory for the JMS provider, refer to the JMS provider documentation.
When you enter a value for Location JNDI Bindings, ensure that it complies with the following instructions:
For information about constructing the JNDI administered objects bindings file, refer to the documentation that is supplied with the JMS provider.
Leave Message Set blank for XML, XMLNS, XMLNSC, JMS, MIME, and BLOB parsers.
Leave Message Type blank for XML, XMLNS, XMLNSC, JMS, MIME, BLOB, and IDOC parsers.
Leave Message Format blank for XML, XMLNS, XMLNSC, JMS, MIME, and BLOB parsers.
Leave this property blank if you do not want the input node to make a selection based upon application property. For a description of how to construct the JMS message selector, see JMS message selector.
Leave this property blank if you do not want the input node to make a selection based on JMSTimeStamp.
Valid values for message priority are from 0 (lowest) to 9 (highest); for example, you can enter 5 to receive messages of priority 5. You can also qualify the selector; for example, > 4 to receive messages with a priority greater than 4, or BETWEEN 4 AND 8 to receive messages with a priority in the range 4 to 8.
Leave this property blank if you do not want the input node to make a selection based on JMSPriority.
Enter a specific Message ID, or enter a conditional selector; for example, enter > WMBRK123456 to return messages where the Message ID is greater than WMBRK123456.
Leave this property blank if you do not want the input node to make a selection based on JMSMessageID.
Enter a specific Correlation ID or enter a conditional string; for example, WMBRKABCDEFG returns messages with a Correlation ID that matches this value.
Leave this property blank if you do not want the input node to make a selection based on JMSCorrelationID.
For more details, see Validating messages and Validation properties.
For each message that is received successfully, the JMSInput node routes the message to the Out terminal. If this action fails, the message is retried. If the retry threshold is reached, where the threshold is defined by the BackoutThreshold property of the node, the message is routed to the Failure terminal. You can connect nodes to the Failure terminal to handle this condition. If you have not connected nodes to the Failure terminal, the message is written to the backout destination. If a backout destination has not been provided, the node issues a BIP4669 error message and stops processing further input.
If the message is caught by the JMSInput node after an exception has been generated elsewhere in the message flow, the message is routed to the Catch terminal. If you have not connected nodes to the Catch terminal, the node backs out messages for re-delivery until the problem is resolved, or the backout threshold is reached.
You must define a backout destination. If you do not define a backout destination, the node issues a BIP4669 error message and stops processing further input.
When you include a JMSInput node in a message flow, the value that you set for Transaction Mode defines whether messages are received under syncpoint.
The JMS provider can supply additional .jar files that are required for transactional support. Refer to the JMS provider documentation. For example, on distributed systems, the WebSphere MQ JMS provider supplies an extra .jar file: com.ibm,mqetclient.jar. You must add this .jar file to the broker shared-classes directory. Refer to Making the JMS provider client available to the JMS nodes in this topic.
install_dir/bin/ JMSSwitch.dll XAOpenString=Initial Context,location JNDI,Optional_parms ThreadOfControl=THREAD
install_dir/bin/ JMSSwitch.dll XAOpenString=Initial Context,location JNDI,Optional_parms ThreadOfControl=THREAD
XAResourceManager: Name=Jms_Provider_Name SwitchFile=/install_dir/bin/ JMSSwitch.so XAOpenString=Initial Context,location JNDI,Optional_parms ThreadOfControl=THREADWhere:
The optional parameters are comma separated and are positional. Therefore, any parameters that are missing must be represented by a comma.
install_dir/classes/xarecovery.jar
install_dir/bin
For more information, refer to the System Administration Guide section of the WebSphere MQ Version 6 information center online.
To use the same queue manager for both the broker and the JMS provider, ensure that your WebSphere MQ installation is at the minimum required level: WebSphere® MQ Version 6.0 Fix Pack 1 or above is required for XA to use the same queue manager for both the broker and the provider.
Syncpoint control for the JMS provider is managed with RRS syncpoint coordination of the queue manager of the broker. You do not need to modify the .ini file.
The terminals of the JMSInput node are described in the following table.
Terminal | Description |
---|---|
Failure | The output terminal to which the message is routed if an error occurs. Even if the Validation property is set, messages that are propagated to this terminal are not validated. |
Out | The output terminal to which the message is routed if it is retrieved successfully. |
Catch | The output terminal to which the message is routed if an exception is generated downstream and caught by this node. |
The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the bar file to deploy it).
The Description properties of the JMSInput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type, JMSInput | The name of the node. |
Short Description | No | No | A brief description of the node. | |
Long Description | No | No | Text that describes the purpose of the node in the message flow. |
The JMS Connection properties of the JMSInput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Initial Context Factory | Yes | Yes | com.sun.jndi.fscontext.RefFSContextFactory | The starting point for a JNDI name space. A JMS application
uses the initial context to obtain and look up the connection factory and
queue or topic objects for the JMS provider. The default value is the value that is used when WebSphere MQ Java is used as the JMS provider. |
Location JNDI Bindings | Yes | Yes | The system path or the LDAP location for the bindings file. | |
Connection Factory Name | Yes | Yes | The name of the connection factory that is used by the JMSInputnode to create a connection to the JMS provider. | |
Backout Destination | No | Yes | The destination that is used by the JMSInput node when a message cannot be processed by the message flow because of errors in the message. | |
Backout Threshold | No | Yes | 0 | The value that controls when a re-delivered message is put to the backout destination. |
The Basic properties of the JMSInput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Source Queue | No | No | Selected | The name of the queue from which the node receives incoming messages. |
Subscription Topic | No | No | Cleared | The name of the topic to which the node is subscribed. |
Durable Subscription ID | No | No | The identifier for a durable subscription topic. |
The Input Message Parsing properties of the JMSInput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Message Domain | No | No | The domain that is used to parse the incoming message. | |
Message Set | No | No | The name or identifier of the message set in which the incoming message is defined. | |
Message Type | No | No | The name of the incoming message. | |
Message Format | No | No | The name of the physical format of the incoming message. |
The properties of the Parser Options for the JMSInput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Parse Timing | Yes | No | On Demand | This property controls when an input message is parsed.
Valid values are On Demand, Immediate, and Complete. For a full description of this property, see Parsing on demand. |
Use XMLNSC Compact Parser for XMLNS Domain | Yes | No | Cleared | This property controls whether the XMLNSC Compact Parser is used for messages in the XMLNS Domain. If you set this property, the message data appears under XMLNSC in nodes that are connected to the output terminal when the input MQRFH2 header or Input Message Parsing properties Domain is XMLNS. |
Retain Mixed Content | Yes | No | Cleared | This property controls whether the XMLNSC parser creates elements in the message tree when it encounters mixed text in an input message. If you select the check box, elements are created for mixed text. If you clear the check box, mixed text is ignored and no elements are created. |
Retain Comments | Yes | No | Cleared | This property controls whether the XMLNSC parser creates elements in the message tree when it encounters comments in an input message. If you select the check box, elements are created for comments. If you clear the check box, comments are ignored and no elements are created. |
Retain Processing Instructions | Yes | No | Cleared | This property controls whether the XMLNSC parser creates elements in the message tree when it encounters processing instructions in an input message. If you select the check box, elements are created for processing instructions. If you clear the check box, processing instructions are ignored and no elements are created. |
The Message Selectors properties of the JMSInput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Application Property | No | Yes | The message selector that filters messages according to the application property value. | |
Timestamp | No | Yes | The message selector that filters messages according to the JMSTimestamp. | |
Delivery Mode | No | Yes | The message selector that filters messages according to the message delivery mode. | |
Priority | No | Yes | The message selector that filters messages according to the message priority. | |
Message ID | No | Yes | The message selector that filters messages according to the message ID. | |
Correlation ID | No | Yes | The message selector that filters messages according to the correlation ID. |
The Advanced properties of the JMSInput node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Transaction Mode | Yes | No | none | This property controls whether the incoming message is received under external syncpoint, local syncpoint, or out of syncpoint. Valid values are none, local, and global. |
The Validation properties of the JMSInput node are described in the following table. For more details, see Validation properties.
Property | M | C | Default | Description |
---|---|---|---|---|
Validate | Yes | Yes | None | This property controls whether validation takes place. Valid values are None, Content, and Content And Value. |
Failure Action | Yes | No | Exception | This property controls what happens if validation fails. You can set this property only if you set Validate to Content or Content and Value. Valid values are User Trace, Local Error Log, Exception, and Exception List. |
Include All Value Constraints | Yes | No | Selected | You cannot edit this property. Basic value constraint checks are included in Content and Value validation. |
Fix | Yes | No | None | You cannot edit this property. |