org.mule.runtime.core.transformer

Class AbstractTransformer

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.runtime.core.transformer.AbstractTransformer

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.meta.AnnotatedObject, org.mule.runtime.api.meta.NameableObject, org.mule.runtime.api.meta.NamedObject, MuleContextAware, Processor, ReactiveProcessor, Transformer

Direct Known Subclasses:

AbstractCompressionTransformer, AbstractDiscoverableTransformer, AbstractEncryptionTransformer, AbstractMessageTransformer, Base64Decoder, Base64Encoder, BeanToMap, ByteArrayToHexString, ByteArrayToSerializable, CursorIteratorProviderToIterator, CursorStreamProviderToInputStream, GetBeanProperty, HexStringToByteArray, InputStreamToByteArray, LocalDateToDate, MapLookup, MapToBean, NumberToString, ObjectArrayToString, ObjectToOutputHandler, ObjectToString, PropertyEditorTextToValueTransformer, PropertyEditorValueToTextTransformer, SerializableToByteArray, StringAppendTransformer, StringToBoolean, StringToCharsetTransformer, StringToEnum, StringToMediaTypeTransformer, StringToNumber, StringToObjectArray, XmlEntityDecoder, XmlEntityEncoder

public abstract class AbstractTransformer
extends org.mule.runtime.api.meta.AbstractAnnotatedObject
implements Transformer

AbstractTransformer is a base class for all transformers. Transformations transform one object into another.

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

ReactiveProcessor.ProcessingType

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
protected MuleContext	muleContext
protected String	name The name that identifies this transformer.
protected List<org.mule.runtime.api.metadata.DataType>	sourceTypes A list of supported Class types that the source payload passed into this transformer

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

LOCATION_KEY

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractTransformer() default constructor required for discovery

Method Summary

Modifier and Type	Method and Description
void	dispose() Template method where deriving classes can do any clean up any resources or state before the object is disposed.
protected abstract Object	doTransform(Object src, Charset enc)
protected String	generateTransformerName()
String	getName()
org.mule.runtime.api.metadata.DataType	getReturnDataType() Specifies the return type of the result after this transformer has been executed.
List<org.mule.runtime.api.metadata.DataType>	getSourceDataTypes() Returns an unmodifiable list of Source types registered on this transformer
void	initialise() Template method where deriving classes can do any initialisation after the properties have been set on this transformer
boolean	isAcceptNull() Does this transformer allow null input?
boolean	isAllowNullReturn()
protected boolean	isConsumed(Class<?> srcCls)
boolean	isIgnoreBadInput() By default, Mule will throw an exception if a transformer is invoked with a source object that is not compatible with the transformer.
boolean	isSourceDataTypeSupported(org.mule.runtime.api.metadata.DataType dataType) Determines if a particular source class can be handled by this transformer
boolean	isSourceDataTypeSupported(org.mule.runtime.api.metadata.DataType dataType, boolean exactMatch) Determines whether that data type passed in is supported by this transformer
Event	process(Event event) Invokes the MessageProcessor.
protected void	registerSourceType(org.mule.runtime.api.metadata.DataType dataType) Register a supported data type with this transformer.
protected Charset	resolveEncoding(Object src)
void	setAllowNullReturn(boolean allowNullReturn)
void	setIgnoreBadInput(boolean ignoreBadInput)
void	setMuleContext(MuleContext context)
void	setName(String string)
void	setReturnDataType(org.mule.runtime.api.metadata.DataType type) Sets the expected return type for the transformed data.
String	toString()
Object	transform(Object src) Transforms the supplied data and returns the result
Object	transform(Object src, Charset enc) Transforms the supplied data and returns the result
protected void	unregisterSourceType(org.mule.runtime.api.metadata.DataType dataType) Unregister a supported source type from this transformer

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mule.runtime.core.api.transformer.Transformer

getProcessingType

Methods inherited from interface org.mule.runtime.core.api.processor.Processor

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

muleContext

protected MuleContext muleContext

logger

protected final org.slf4j.Logger logger

name

protected String name

The name that identifies this transformer. If none is set the class name of the transformer is used

sourceTypes

protected final List<org.mule.runtime.api.metadata.DataType> sourceTypes

A list of supported Class types that the source payload passed into this transformer

Constructor Detail

AbstractTransformer

public AbstractTransformer()

default constructor required for discovery

Method Detail

process

public Event process(Event event)
              throws org.mule.runtime.api.exception.MuleException

Description copied from interface: Processor

Invokes the MessageProcessor.

Specified by:

process in interface Processor

Parameters:

event - MuleEvent to be processed

Returns:

optional response MuleEvent

Throws:

org.mule.runtime.api.exception.MuleException

registerSourceType

protected void registerSourceType(org.mule.runtime.api.metadata.DataType dataType)

Register a supported data type with this transformer. The will allow objects that match this data type to be transformed by this transformer.

Parameters:

dataType - the source type to allow

unregisterSourceType

protected void unregisterSourceType(org.mule.runtime.api.metadata.DataType dataType)

Unregister a supported source type from this transformer

Parameters:

dataType - the type to remove

getName

public String getName()

Specified by:

getName in interface org.mule.runtime.api.meta.NamedObject

Returns:

transformer name

setName

public void setName(String string)

Specified by:

setName in interface org.mule.runtime.api.meta.NameableObject

Parameters:

string -

setReturnDataType

public void setReturnDataType(org.mule.runtime.api.metadata.DataType type)

Description copied from interface: Transformer

Sets the expected return type for the transformed data. If the transformed data is not of this class type a TransformerException will be thrown.

Specified by:

setReturnDataType in interface Transformer

Parameters:

type - the expected return type for this transformer

getReturnDataType

public org.mule.runtime.api.metadata.DataType getReturnDataType()

Description copied from interface: Transformer

Specifies the return type of the result after this transformer has been executed. Mule will use this to validate the return type but also allow users to perform automatic transformations based on the source type of the object to transform and this return type.

Specified by:

getReturnDataType in interface Transformer

Returns:

the excepted return type for this transformer

isAllowNullReturn

public boolean isAllowNullReturn()

setAllowNullReturn

public void setAllowNullReturn(boolean allowNullReturn)

isSourceDataTypeSupported

public boolean isSourceDataTypeSupported(org.mule.runtime.api.metadata.DataType dataType)

Description copied from interface: Transformer

Determines if a particular source class can be handled by this transformer

Specified by:

isSourceDataTypeSupported in interface Transformer

Parameters:

dataType - The DataType to check for compatibility

Returns:

true if the transformer supports this type of class or false otherwise

isSourceDataTypeSupported

public boolean isSourceDataTypeSupported(org.mule.runtime.api.metadata.DataType dataType,
                                         boolean exactMatch)

Determines whether that data type passed in is supported by this transformer

Parameters:

dataType - the type to check against

exactMatch - if set to true, this method will look for an exact match to the data type, if false it will look for a compatible data type.

Returns:

true if the source type is supported by this transformer, false otherwise

transform

public final Object transform(Object src)
                       throws TransformerException

Description copied from interface: Transformer

Transforms the supplied data and returns the result

Specified by:

transform in interface Transformer

Parameters:

src - the data to transform

Returns:

the transformed data

Throws:

TransformerException - if a error occurs transforming the data or if the expected returnClass isn't the same as the transformed data

resolveEncoding

protected Charset resolveEncoding(Object src)

transform

public Object transform(Object src,
                        Charset enc)
                 throws TransformerException

Description copied from interface: Transformer

Transforms the supplied data and returns the result

Specified by:

transform in interface Transformer

Parameters:

src - the data to transform

enc - the encoding to use by this transformer. many transformations will not need encoding unless dealing with text so you only need to use this method if yo wish to customize the encoding

Returns:

the transformed data

Throws:

TransformerException - if a error occurs transforming the data or if the expected returnClass isn't the same as the transformed data

isConsumed

protected boolean isConsumed(Class<?> srcCls)

doTransform

protected abstract Object doTransform(Object src,
                                      Charset enc)
                               throws TransformerException

Throws:

TransformerException

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Template method where deriving classes can do any initialisation after the properties have been set on this transformer

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

dispose

public void dispose()

Template method where deriving classes can do any clean up any resources or state before the object is disposed.

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

generateTransformerName

protected String generateTransformerName()

getSourceDataTypes

public List<org.mule.runtime.api.metadata.DataType> getSourceDataTypes()

Description copied from interface: Transformer

Returns an unmodifiable list of Source types registered on this transformer

Specified by:

getSourceDataTypes in interface Transformer

Returns:

an unmodifiable list of Source types registered on this transformer

isIgnoreBadInput

public boolean isIgnoreBadInput()

Description copied from interface: Transformer

By default, Mule will throw an exception if a transformer is invoked with a source object that is not compatible with the transformer. Since transformers are often chained, it is useful to be able to ignore a transformer in the chain and move to the next one.

Specified by:

isIgnoreBadInput in interface Transformer

Returns:

true if the transformer can be ignored if the current source type is not supported, false if an exception should be throw due to an incompatible source type being passed in.

setIgnoreBadInput

public void setIgnoreBadInput(boolean ignoreBadInput)

toString

public String toString()

Overrides:

toString in class Object

isAcceptNull

public boolean isAcceptNull()

Description copied from interface: Transformer

Does this transformer allow null input?

Specified by:

isAcceptNull in interface Transformer

Returns:

true if this transformer can accept null input

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

Parameters:

context - the Mule node.