org.mule.transformers.simple
Class MessagePropertiesTransformer

java.lang.Object
  extended byorg.mule.transformers.AbstractTransformer
      extended byorg.mule.transformers.AbstractEventAwareTransformer
          extended byorg.mule.transformers.simple.MessagePropertiesTransformer
All Implemented Interfaces:
Cloneable, Initialisable, UMOBaseTransformer, UMOTransformer

public class MessagePropertiesTransformer
extends AbstractEventAwareTransformer

A configurable message transformer that allows users to add, overwrite and delete properties on the current message. Users can set a List of 'deleteProperties' names to remove from the message and can also set a Map of 'addProperties' that will be added to the message and possibly overwrite existing properties with the same name.

If #overwrite is set to false, and a property exists on the message (even if the value is null, it will be left intact. The transformer then acts as a more gentle 'enricher'. The default setting is true.


Field Summary
 
Fields inherited from class org.mule.transformers.AbstractTransformer
DEFAULT_TRUNCATE_LENGTH, endpoint, logger, name, nextTransformer, returnClass, sourceTypes
 
Constructor Summary
MessagePropertiesTransformer()
           
 
Method Summary
 Object clone()
           
 Map getAddProperties()
           
 List getDeleteProperties()
           
 boolean isOverwrite()
           
 void setAddProperties(Map addProperties)
           
 void setDeleteProperties(List deleteProperties)
           
 void setOverwrite(boolean overwrite)
           
 Object transform(Object src, String encoding, UMOEventContext context)
           
 
Methods inherited from class org.mule.transformers.AbstractEventAwareTransformer
doTransform, requiresCurrentEvent
 
Methods inherited from class org.mule.transformers.AbstractTransformer
checkReturnClass, 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

MessagePropertiesTransformer

public MessagePropertiesTransformer()
Method Detail

clone

public Object clone()
             throws CloneNotSupportedException
Specified by:
clone in interface UMOBaseTransformer
Overrides:
clone in class AbstractTransformer
Throws:
CloneNotSupportedException

transform

public Object transform(Object src,
                        String encoding,
                        UMOEventContext context)
                 throws TransformerException
Specified by:
transform in class AbstractEventAwareTransformer
Throws:
TransformerException

getDeleteProperties

public List getDeleteProperties()

setDeleteProperties

public void setDeleteProperties(List deleteProperties)

getAddProperties

public Map getAddProperties()

setAddProperties

public void setAddProperties(Map addProperties)

isOverwrite

public boolean isOverwrite()

setOverwrite

public void setOverwrite(boolean overwrite)


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