JMS Object Type Definitions

The JMS Object Type Definition (OTD) is a special type of OTD that allows Collaborations to read from and write to topics or queues. It supplies operators and Java methods for creating, sending, and receiving JMS messages (see JMS OTD Methods).

The JMS OTD is included with Sun Enterprise Service Bus, and is installed automatically. The template resides in the CAPS Components Library\Enterprise Service Bus folder under the NetBeans Projects tab, as shown in the following figure.

Figure 1–12 Project Explorer - JMS OTD

The send, receive, and receiveWait nodes represent web service operations that are available in the Collaboration Definition Wizard (Java) when you create a Java based Collaboration Definition implementing an existing web service. The Message, sendInput, and receiveWaitInput nodes represent messages used with these operations, as listed in the following table.

When you select one of the web service operations for a Java based Collaboration Definition implementing an existing web service, the corresponding message becomes available in the Collaboration Definition Editor as the input argument. When you create a Java based Collaboration Definition implementing a new web service, the three messages become available as both input and output arguments.

The send, receive, and receiveWait nodes can also be dragged and dropped into the Sun Business Process Editor as activities. The corresponding messages are then displayed in the mapper while performing assigns. See Designing Business Processes in the Sun Business Process Manager for additional information.

Message Types

The JMS OTD currently supports the following message types:

• Message

  A Message carries no payload, and is generally used for event notification. Java methods specifically available for use with this message type are:

  • createMessage()

  • createMessage(msg)

  BytesMessage

  A BytesMessage carries a byte array as its payload, and is often used in cases where JMS is simply used as a transport between systems. Java methods specifically available for use with this message type are:

  • createBytesMessage()

  • createBytesMessage(msg)

  • getBytesMessage()

  • retrieveBytesFromMessage()

  • retrieveBytesFromMessage(arg0)

  • setBytesMessage(arg0)

  MapMessage

  A MapMessage carries a set of name-value pairs as its payload, and is often used for delivering keyed data. Java methods specifically available for use with this message type are:

  • createMapMessage()

  • countMapMessage()

  • getMapMessage()

  • getMapMessage(arg0)

  • retrieveMapMessage(arg0)

  • retrieveMapMessageList()

  • storeMapMessage(arg0, arg1)

  StreamMessage

  A StreamMessage carries a stream of primitive Java types (such as char, double, and int) as its payload, and is often used when delivering primitive application data in a fixed order. Java methods specifically available for use with this message type are:

  • createStreamMessage()

  • countStreamMessage()

  • getStreamMessage()

  • setStreamMessage(arg0, arg1)

  TextMessage

  A TextMessage carries a string, of type java.lang.Stringas its payload, and is used for exchanging both text messages and XML documents. As such, it is the most often used message type. Java methods specifically available for use with this message type are:

  • createTextMessage()

  • createTextMessage(msg)

  • getTextMessage()

  • retrieveStringFromMessage(arg0)

  • retrieveStringFromMessage()

  • setTextMessage(arg0)