Websphere MQ Everyplace

com.ibm.mqe.mqbridge
Interface MQeTransformerInterface

All Known Implementing Classes:
MQeBaseTransformer, MQeBaseTransformer, MQeGeneralRFHTransformer, MQeJMSRFHTransformer, MQeListTransformer

public interface MQeTransformerInterface

All classes that transform Websphere MQ messages to MQeMsgObjects, and vice versa, must conform to this interface.


Method Summary
 void activate(java.util.StringTokenizer params)
          Tells the class implementing this interface any parameters that may have been supplied with the transformer definition.
 com.ibm.mq.MQMessage transform(MQeMsgObject msg, MQeMQBridgeQueue queue, com.ibm.mq.MQPutMessageOptions pmo)
          This version converts the given MQeMsgObject into a Websphere MQ message.
 MQeMsgObject transform(com.ibm.mq.MQMessage msg, java.lang.String remoteQMgrName, java.lang.String remoteQName)
          This version converts the given Websphere MQ message into an MQeMsgObject.
 

Method Detail

activate

public void activate(java.util.StringTokenizer params)
              throws java.lang.Exception

Tells the class implementing this interface any parameters that may have been supplied with the transformer definition.

Parameters:
params - StringTokenizer containing the transformer definition parameters.
Returns:
void
Throws:
java.lang.Exception - If the parameters are not correct, valid, or if there is a problem initialising the transformer.

transform

public MQeMsgObject transform(com.ibm.mq.MQMessage msg,
                              java.lang.String remoteQMgrName,
                              java.lang.String remoteQName)
                       throws java.lang.Exception
This version converts the given Websphere MQ message into an MQeMsgObject.

Parameters:
msg - The Websphere MQ Everyplace message that is to be transformed.
remoteQMgrName - The name of the destination WebSphere MQ Everyplace queue manager (obtained from the remote queue definition on Websphere MQ).
remoteQName - The name of the destination WebSphere MQ Everyplace queue (obtained from the remote queue definition on Websphere MQ).
Returns:
The transformed message in the form of an MQeMsgObject.
Throws:
java.lang.Exception - If any of the parameters are invalid, if the message is in a format that this transformer does not understand, Or if there is a problem when the transformation is taking place.

transform

public com.ibm.mq.MQMessage transform(MQeMsgObject msg,
                                      MQeMQBridgeQueue queue,
                                      com.ibm.mq.MQPutMessageOptions pmo)
                               throws java.lang.Exception
This version converts the given MQeMsgObject into a Websphere MQ message.

Parameters:
msg - The Websphere WebSphere MQ Everyplace message that is to be transformed.
queue - A reference to the bridge queue that accepted the message
pmo - A reference to a blank MQPutMessageOptions object that can be modified by the transformer. This parameter enables the user to specify any context options that are needed to put the new WebSphere MQ Everyplace message to Websphere MQ.
Returns:
The transformed message in the form of a Websphere MQ message.
Throws:
java.lang.Exception - If any of the parameters are invalid, if the message is in a format that this transformer does not understand, Or if there is a problem when the transformation is taking place.

Websphere MQ Everyplace