org.mule.providers.vm
Class VMMessageAdapter

java.lang.Object
  extended byorg.mule.providers.AbstractMessageAdapter
      extended byorg.mule.providers.vm.VMMessageAdapter
All Implemented Interfaces:
java.io.Serializable, UMOMessageAdapter

public class VMMessageAdapter
extends AbstractMessageAdapter

VMMessageAdapter provides a common abstraction of Mule Event message. The message adapter allows a Mule event to be read and manipulated like any other object data type from any external system that has a Mule endpoint implementation.

Version:
$Revision: 1.2 $
Author:
Ross Mason
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.mule.providers.AbstractMessageAdapter
exceptionPayload, properties
 
Constructor Summary
VMMessageAdapter(UMOMessage message)
           
 
Method Summary
 java.lang.Object getPayload()
           
 byte[] getPayloadAsBytes()
          Converts the message implementation into a String representation
 java.lang.String getPayloadAsString()
          Converts the message implementation into a String representation
 java.lang.String getUniqueId()
          gets the unique identifier for the message.
 
Methods inherited from class org.mule.providers.AbstractMessageAdapter
getBooleanProperty, getCorrelationGroupSize, getCorrelationId, getCorrelationSequence, getDoubleProperty, getExceptionPayload, getIntProperty, getLongProperty, getProperty, getProperty, getPropertyNames, getReplyTo, removeProperty, setBooleanProperty, setCorrelationGroupSize, setCorrelationId, setCorrelationSequence, setDoubleProperty, setExceptionPayload, setIntProperty, setLongProperty, setProperty, setReplyTo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VMMessageAdapter

public VMMessageAdapter(UMOMessage message)
                 throws MessageTypeNotSupportedException
Method Detail

getPayloadAsString

public java.lang.String getPayloadAsString()
                                    throws java.lang.Exception
Converts the message implementation into a String representation

Returns:
String representation of the message
Throws:
java.lang.Exception - Implemetation may throw an endpoint specific exception

getPayloadAsBytes

public byte[] getPayloadAsBytes()
                         throws java.lang.Exception
Converts the message implementation into a String representation

Returns:
String representation of the message
Throws:
java.lang.Exception - Implemetation may throw an endpoint specific exception

getPayload

public java.lang.Object getPayload()
Returns:
the current message

getUniqueId

public java.lang.String getUniqueId()
                             throws UniqueIdNotSupportedException
Description copied from interface: UMOMessageAdapter
gets the unique identifier for the message. It's up to the implementation to ensure a unique id

Specified by:
getUniqueId in interface UMOMessageAdapter
Overrides:
getUniqueId in class AbstractMessageAdapter
Throws:
UniqueIdNotSupportedException


Copyright © 2003-2005 SymphonySoft Limited. All Rights Reserved.