org.mule.providers.vm
Class VMMessageAdapter

java.lang.Object
  extended byorg.mule.providers.AbstractMessageAdapter
      extended byorg.mule.providers.vm.VMMessageAdapter
All Implemented Interfaces:
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: 3798 $
Author:
Ross Mason
See Also:
Serialized Form

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

Constructor Detail

VMMessageAdapter

public VMMessageAdapter(UMOMessage message)
                 throws MessageTypeNotSupportedException
Method Detail

getPayloadAsString

public String getPayloadAsString(String encoding)
                          throws Exception
Converts the message implementation into a String representation

Parameters:
encoding - The encoding to use when transforming the message (if necessary). The parameter is used when converting from a byte array
Returns:
String representation of the message payload
Throws:
Exception - Implementation may throw an endpoint specific exception

getPayloadAsBytes

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

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

getPayload

public Object getPayload()
Returns:
the current message

getUniqueId

public String getUniqueId()
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


Copyright © 2003-2006 MuleSource Inc.. All Rights Reserved.