atg.dms.patchbay

Interface MessageSourceContext

public interface MessageSourceContext

This is the interface that MessageSource implementations use to generate and send messages. In each of the methods the "portName" corresponds to the name of an output port as defined for the component in the patch bay definition file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
javax.jms.BytesMessage	createBytesMessage() Creates and returns a new BytesMessage intended for delivery through the "DEFAULT" output port.
javax.jms.BytesMessage	createBytesMessage(java.lang.String pPortName) Creates and returns a new BytesMessage intended for delivery through the specified output port.
javax.jms.MapMessage	createMapMessage() Creates and returns a new MapMessage intended for delivery through the "DEFAULT" output port.
javax.jms.MapMessage	createMapMessage(java.lang.String pPortName) Creates and returns a new MapMessage intended for delivery through the specified output port.
javax.jms.ObjectMessage	createObjectMessage() Creates and returns a new ObjectMessage intended for delivery through the "DEFAULT" output port.
javax.jms.ObjectMessage	createObjectMessage(java.lang.String pPortName) Creates and returns a new ObjectMessage intended for delivery through the specified output port.
javax.jms.StreamMessage	createStreamMessage() Creates and returns a new StreamMessage intended for delivery through the "DEFAULT" output port.
javax.jms.StreamMessage	createStreamMessage(java.lang.String pPortName) Creates and returns a new StreamMessage intended for delivery through the specified output port.
javax.jms.TextMessage	createTextMessage() Creates and returns a new TextMessage intended for delivery through the "DEFAULT" output port.
javax.jms.TextMessage	createTextMessage(java.lang.String pPortName) Creates and returns a new TextMessage intended for delivery through the specified output port.
void	sendMessage(javax.jms.Message pMessage) This sends a Message through the "DEFAULT" output port and returns when the Message has been successfully sent (although, depending on the JMS provider, it may not have yet been delivered).
void	sendMessage(java.lang.String pPortName, javax.jms.Message pMessage) This sends a Message through the given output port and returns when the Message has been successfully sent (although, depending on the JMS provider, it may not have yet been delivered).

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

sendMessage

void sendMessage(java.lang.String pPortName,
                 javax.jms.Message pMessage)
          throws javax.jms.JMSException

This sends a Message through the given output port and returns when the Message has been successfully sent (although, depending on the JMS provider, it may not have yet been delivered). Although it is not required, it is recommended that the Message be generated by calling the appropriate createXMessage with the same port name.

Throws:

javax.jms.JMSException

sendMessage

void sendMessage(javax.jms.Message pMessage)
          throws javax.jms.JMSException

This sends a Message through the "DEFAULT" output port and returns when the Message has been successfully sent (although, depending on the JMS provider, it may not have yet been delivered). Although it is not required, it is recommended that the Message be generated by calling the appropriate createXMessage with the same port name.

Throws:

javax.jms.JMSException

createBytesMessage

javax.jms.BytesMessage createBytesMessage(java.lang.String pPortName)
                                   throws javax.jms.JMSException

Creates and returns a new BytesMessage intended for delivery through the specified output port.

Throws:

javax.jms.JMSException

createBytesMessage

javax.jms.BytesMessage createBytesMessage()
                                   throws javax.jms.JMSException

Creates and returns a new BytesMessage intended for delivery through the "DEFAULT" output port.

Throws:

javax.jms.JMSException

createMapMessage

javax.jms.MapMessage createMapMessage(java.lang.String pPortName)
                               throws javax.jms.JMSException

Creates and returns a new MapMessage intended for delivery through the specified output port.

Throws:

javax.jms.JMSException

createMapMessage

javax.jms.MapMessage createMapMessage()
                               throws javax.jms.JMSException

Creates and returns a new MapMessage intended for delivery through the "DEFAULT" output port.

Throws:

javax.jms.JMSException

createObjectMessage

javax.jms.ObjectMessage createObjectMessage(java.lang.String pPortName)
                                     throws javax.jms.JMSException

Creates and returns a new ObjectMessage intended for delivery through the specified output port.

Throws:

javax.jms.JMSException

createObjectMessage

javax.jms.ObjectMessage createObjectMessage()
                                     throws javax.jms.JMSException

Creates and returns a new ObjectMessage intended for delivery through the "DEFAULT" output port.

Throws:

javax.jms.JMSException

createStreamMessage

javax.jms.StreamMessage createStreamMessage(java.lang.String pPortName)
                                     throws javax.jms.JMSException

Creates and returns a new StreamMessage intended for delivery through the specified output port.

Throws:

javax.jms.JMSException

createStreamMessage

javax.jms.StreamMessage createStreamMessage()
                                     throws javax.jms.JMSException

Creates and returns a new StreamMessage intended for delivery through the "DEFAULT" output port.

Throws:

javax.jms.JMSException

createTextMessage

javax.jms.TextMessage createTextMessage(java.lang.String pPortName)
                                 throws javax.jms.JMSException

Creates and returns a new TextMessage intended for delivery through the specified output port.

Throws:

javax.jms.JMSException

createTextMessage

javax.jms.TextMessage createTextMessage()
                                 throws javax.jms.JMSException

Creates and returns a new TextMessage intended for delivery through the "DEFAULT" output port.

Throws:

javax.jms.JMSException