org.mule.providers.file
Class FileContentsMessageAdapter

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

public class FileContentsMessageAdapter
extends AbstractMessageAdapter

FileMessageAdapter provides a wrapper for a message. Users can obtain the contents of the message through the payload property and can get the filename and directory in the properties using PROPERTY_FILENAME and PROPERTY_DIRECTORY

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

Field Summary
 
Fields inherited from class org.mule.providers.AbstractMessageAdapter
exceptionPayload, properties
 
Constructor Summary
FileContentsMessageAdapter(java.lang.Object message)
           
 
Method Summary
 java.io.File getFile()
           
 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

FileContentsMessageAdapter

public FileContentsMessageAdapter(java.lang.Object message)
                           throws MessagingException
Method Detail

getPayload

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

getPayloadAsBytes

public byte[] getPayloadAsBytes()
                         throws java.lang.Exception
Description copied from interface: UMOMessageAdapter
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

getPayloadAsString

public java.lang.String getPayloadAsString()
                                    throws java.lang.Exception
Description copied from interface: UMOMessageAdapter
Converts the message implementation into a String representation

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

getFile

public java.io.File getFile()

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.