org.mule.runtime.core.api

Class TransformationService

java.lang.Object

org.mule.runtime.core.api.TransformationService

public class TransformationService
extends Object

Provides the same operations previously exposed by Message but decoupled from Message. TODO Redefine this interface as part of Mule 4.0 transformation improvements (MULE-9141)

Constructor Summary

Constructors

Constructor and Description
TransformationService(MuleContext muleContext)

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.message.Message	applyTransformers(org.mule.runtime.api.message.Message message, Event event, List<? extends Transformer> transformers) Applies a list of transformers returning the result of the transformation as a new message instance.
org.mule.runtime.api.message.Message	applyTransformers(org.mule.runtime.api.message.Message message, Event event, Transformer... transformers) Applies a list of transformers returning the result of the transformation as a new message instance.
String	getPayloadForLogging(org.mule.runtime.api.message.Message message) Obtains a String representation of the message payload for logging without throwing exception.
String	getPayloadForLogging(org.mule.runtime.api.message.Message message, Charset encoding) Obtains a String representation of the message payload for logging without throwing exception.
protected Charset	resolveEncoding(org.mule.runtime.api.message.Message message)
org.mule.runtime.api.message.Message	transform(org.mule.runtime.api.message.Message message, org.mule.runtime.api.metadata.DataType outputDataType) Attempts to obtain the payload of this message with the desired Class type.
Object	transform(Object value, org.mule.runtime.api.metadata.DataType valueDataType, org.mule.runtime.api.metadata.DataType expectedDataType) Given a value) it will try to transform it to the expected type defined in the {@code expectedDataType}

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformationService

@Inject
public TransformationService(MuleContext muleContext)

Method Detail

transform

public Object transform(Object value,
                        org.mule.runtime.api.metadata.DataType valueDataType,
                        org.mule.runtime.api.metadata.DataType expectedDataType)
                 throws MessagingException,
                        MessageTransformerException,
                        TransformerException

Given a value) it will try to transform it to the expected type defined in the {@code expectedDataType}

Parameters:

value - the value to transform

valueDataType - the value's DataType

expectedDataType - the expected type's DataType

event - the event to perform the transformation

Returns:

the transformed value

Throws:

MessagingException - If could not be able to find a proper transformer do obtain the desired type

MessageTransformerException - If a problem occurs transforming the value

TransformerException - If a problem occurs transforming the value

applyTransformers

public org.mule.runtime.api.message.Message applyTransformers(org.mule.runtime.api.message.Message message,
                                                              Event event,
                                                              List<? extends Transformer> transformers)
                                                       throws org.mule.runtime.api.exception.MuleException

Applies a list of transformers returning the result of the transformation as a new message instance. If the list of transformers is empty or transformation would be redundant then the same message instances will be returned.

Parameters:

message -

event - the event being processed

transformers - the transformers to apply to the message payload

Returns:

the result of transformation

Throws:

TransformerException - if a transformation error occurs or one or more of the transformers passed in a are incompatible with the message payload

org.mule.runtime.api.exception.MuleException

applyTransformers

public org.mule.runtime.api.message.Message applyTransformers(org.mule.runtime.api.message.Message message,
                                                              Event event,
                                                              Transformer... transformers)
                                                       throws org.mule.runtime.api.exception.MuleException

Applies a list of transformers returning the result of the transformation as a new message instance. If the list of transformers is empty or transformation would be redundant then the same message instances will be returned.

Parameters:

message -

event - the event being processed

transformers - the transformers to apply to the message payload

Returns:

the result of transformation

Throws:

TransformerException - if a transformation error occurs or one or more of the transformers passed in a are incompatible with the message payload

org.mule.runtime.api.exception.MuleException

transform

public org.mule.runtime.api.message.Message transform(org.mule.runtime.api.message.Message message,
                                                      org.mule.runtime.api.metadata.DataType outputDataType)
                                               throws TransformerException

Attempts to obtain the payload of this message with the desired Class type. This will try and resolve a transformer that can do this transformation. If a transformer cannot be found an exception is thrown. Any transformers added to the registry will be checked for compatibility

If the existing payload is consumable (i.e. can't be read twice) then the existing payload of the message will be replaced with a byte[] representation as part of this operations.

Parameters:

message -

outputDataType - the desired return type

Returns:

The converted payload of this message. Note that this method will not alter the payload of this message *unless* the payload is an InputStream in which case the stream will be read and the payload will become the fully read stream.

Throws:

TransformerException - if a transformer cannot be found or there is an error during transformation of the payload

getPayloadForLogging

public String getPayloadForLogging(org.mule.runtime.api.message.Message message)

Obtains a String representation of the message payload for logging without throwing exception.

If the existing payload is consumable (i.e. can't be read twice) then the existing payload of the message will be replaced with a byte[] representation as part of this operations.

Parameters:

message -

Returns:

message payload as object

resolveEncoding

protected Charset resolveEncoding(org.mule.runtime.api.message.Message message)

getPayloadForLogging

public String getPayloadForLogging(org.mule.runtime.api.message.Message message,
                                   Charset encoding)

Obtains a String representation of the message payload for logging without throwing exception. If encoding is required it will use the encoding set on the message.

If the existing payload is consumable (i.e. can't be read twice) or an exception occurs during transformation then the an exception won't be thrown but rather a description of the payload type will be returned.

Returns:

message payload as a String or message with the payload type if payload can't be converted to a String