Bookshelf v7.7: About Output of the JMS Transport

Transports and Interfaces: Siebel eBusiness Application Integration Volume III > Java Message Service Transport > Detailed Input and Output Specifications >

About Output of the JMS Transport

The output of the JMS Transport methods includes the following parts:

The content of the received message (if the method involves receiving a message). See the previous section, About Dispatch Input Arguments for details about typing.
JMS properties of the received message (if the method involves receiving a message), as described in the section JMS Headers and Properties.
Certain JMS headers of the message sent or received, as described in Table 11.
The special properties TimedOut (if the method involves receiving a message) and DispatchError (if the method involves dispatching), as described in Table 11. Each property is either True or False.

Table 11 enumerates for each method of JMS Transport the JMS headers and other distinguished properties that appear as properties of the output property set of the method. An asterisk (*) means the argument appears; a dash (-) means the argument is absent.

Table 11. Dispatch Step Input Arguments
Output	Send	Publish	Send Receive	Receive	Subscribe	Receive Dispatch	Receive Dispatch Send	Subscribe Dispatch
`TimedOut`	-	-	*	*	*	*	*	*
`*JMSType`	-	-	*	*	*	-	-	-
`*JMSCorrelationID`	-	-	*	*	*	-	-	-
`JMSRedelivered`	-	-	*	*	*	-	-	-
`JMSTimestamp`	-	-	*	*	*	-	-	-
`JMSMessageID`	*¹	*¹	*²	*²	*²	-	*¹	-
`DispatchError`	-	-	-	-	-	*	*	*

Some special notes regarding the information in this table:

*¹: For Send, Publish, and ReceiveDispatchSend, the JMSMessageID is the value assigned by the JMS server to the message that was sent or published.
*²: For SendReceive, Receive, and Subscribe, the JMSMessageID is the value of the header on the message received.

For the multi-step methods ReceiveDispatch, ReceiveDispatchSend, and SubscribeDispatch, properties are passed between the individual steps according to the following rules:

All outputs of the Receive (or Subscribe) step are passed as inputs to the subsequent Dispatch step.
The Dispatch step also has available to it all properties in the original input (assuming they are not overwritten by output properties with the same name from the Receive/Subscribe step).
ReceiveDispatch and SubscribeDispatch return the output of the Dispatch step with the two additional properties TimedOut and DispatchError.
If an error occurs during the Dispatch step of ReceiveDispatchSend, the output is that of the Dispatch step with the two additional properties TimedOut and DispatchError.

Transports and Interfaces: Siebel eBusiness Application Integration Volume III