org.mule.providers.file
Class FileMessageAdapter

java.lang.Object
  org.mule.providers.AbstractMessageAdapter
      org.mule.providers.file.FileMessageAdapter

All Implemented Interfaces:

Serializable, org.mule.umo.provider.UMOMessageAdapter

Direct Known Subclasses:

FileContentsMessageAdapter

public class FileMessageAdapter

extends org.mule.providers.AbstractMessageAdapter

FileMessageAdapter provides a wrapper for a file reference. 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: 3167 $

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

FileMessageAdapter(Object message)

Method Summary

Object	getPayload()
byte[]	getPayloadAsBytes()
String	getPayloadAsString(String encoding) Converts the message implementation into a String representation
String	getUniqueId()
protected void	setMessage(File 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

FileMessageAdapter

public FileMessageAdapter(Object message)
                   throws org.mule.umo.MessagingException

Method Detail

getPayload

public Object getPayload()

getPayloadAsBytes

public byte[] getPayloadAsBytes()
                         throws Exception

Throws:

Exception

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

setMessage

protected void setMessage(File message)
                   throws org.mule.umo.MessagingException

Throws:

org.mule.umo.MessagingException

getUniqueId

public String getUniqueId()