org.mule.transformers
Class AbstractEventAwareTransformer

java.lang.Object
  extended by org.mule.transformers.AbstractTransformer
      extended by org.mule.transformers.AbstractEventAwareTransformer
All Implemented Interfaces:
Cloneable, Initialisable, UMOBaseTransformer, UMOTransformer
Direct Known Subclasses:
AbstractXStreamTransformer, HttpRequestToSoapRequest, MessagePropertiesTransformer, ObjectToHttpClientMethodRequest, ObjectToXmppPacket, RestRequestToCustomerRequest, ScriptTransformer, SerializableToByteArray, SetLendersAsRecipients, StringToEmailMessage, StringToXMLMessage, UMOMessageToHttpResponse, XmppPacketToObject

public abstract class AbstractEventAwareTransformer
extends AbstractTransformer

AbstractEventAwareTransformer is a transformer that has a reference to the current message. This message can be used obtains properties associated with the current message useful to the transform. Note that when part of a transform chain, the Message payload reflects the pre-transform message state, unless there is no current event for this thread, then the message will be a new MuleMessage with the src as its payload. Transformers should always work on the src object not the message payload.

See Also:
UMOMessage, MuleMessage

Field Summary
 
Fields inherited from class org.mule.transformers.AbstractTransformer
DEFAULT_TRUNCATE_LENGTH, endpoint, logger, name, nextTransformer, returnClass, sourceTypes
 
Constructor Summary
AbstractEventAwareTransformer()
           
 
Method Summary
 Object doTransform(Object src, String encoding)
           
protected  boolean requiresCurrentEvent()
           
abstract  Object transform(Object src, String encoding, UMOEventContext context)
           
 
Methods inherited from class org.mule.transformers.AbstractTransformer
checkReturnClass, clone, generateTransformerName, getEndpoint, getFinalReturnClass, getName, getNextTransformer, getReturnClass, initialise, isAcceptNull, isIgnoreBadInput, isSourceTypeSupported, isSourceTypeSupported, nextTransform, registerSourceType, setEndpoint, setIgnoreBadInput, setName, setNextTransformer, setReturnClass, toString, transform, unregisterSourceType
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractEventAwareTransformer

public AbstractEventAwareTransformer()
Method Detail

doTransform

public final Object doTransform(Object src,
                                String encoding)
                         throws TransformerException
Specified by:
doTransform in class AbstractTransformer
Throws:
TransformerException

transform

public abstract Object transform(Object src,
                                 String encoding,
                                 UMOEventContext context)
                          throws TransformerException
Throws:
TransformerException

requiresCurrentEvent

protected boolean requiresCurrentEvent()


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.