org.mule.functional.junit4

Class TestLegacyMessageUtils

java.lang.Object

org.mule.functional.junit4.TestLegacyMessageUtils

Deprecated.

tests should not access properties, attachments or exception payload using the old API.

@Deprecated
public class TestLegacyMessageUtils
extends Object

Provides utility methods to work with the legacy message API for testing purposes only

Method Summary

Modifier and Type	Method and Description
static org.mule.runtime.core.api.message.ExceptionPayload	getExceptionPayload(org.mule.runtime.api.message.Message message) Deprecated. If an error occurred during the processing of this message this will return a ErrorPayload that contains the root exception and Mule error code, plus any other related info
static <T extends Serializable> T	getInboundProperty(org.mule.runtime.api.message.Message message, String name) Deprecated. Gets an inbound property from the message.
static <T extends Serializable> T	getOutboundProperty(org.mule.runtime.api.message.Message message, String name) Deprecated. Gets an outbound property from the message.
static <T extends Serializable> T	getOutboundProperty(org.mule.runtime.api.message.Message message, String name, T defaultValue) Deprecated. Gets an outbound property from the message and provides a default value if the property is not present on the message in the scope specified.
static org.mule.runtime.api.metadata.DataType	getOutboundPropertyDataType(org.mule.runtime.api.message.Message message, String name) Deprecated. Gets an outbound property data type from the message.

Methods inherited from class java.lang.Object

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

Method Detail

getOutboundProperty

public static <T extends Serializable> T getOutboundProperty(org.mule.runtime.api.message.Message message,
                                                             String name)

Deprecated.

Gets an outbound property from the message.

Parameters:

message - message used to obtain the data from. Must be a InternalMessage

name - the name or key of the property. This must be non-null.

Returns:

the property value or null if the property does not exist in the specified scope

Throws:

{@link - IllegalStateException} if there is any problem accessing the legacy message API using reflection

getOutboundProperty

public static <T extends Serializable> T getOutboundProperty(org.mule.runtime.api.message.Message message,
                                                             String name,
                                                             T defaultValue)

Deprecated.

Gets an outbound property from the message and provides a default value if the property is not present on the message in the scope specified. The method will also type check against the default value to ensure that the value is of the correct type. If null is used for the default value no type checking is done.

Type Parameters:

T - the defaultValue type ,this is used to validate the property value type

Parameters:

message - message used to obtain the data from. Must be a InternalMessage

name - the name or key of the property. This must be non-null.

defaultValue - the value to return if the property is not in the scope provided. Can be null

Returns:

the property value or the defaultValue if the property does not exist in the specified scope

Throws:

IllegalArgumentException - if the value for the property key is not assignable from the defaultValue type

{@link - IllegalStateException} if there is any problem accessing the legacy message API using reflection

getOutboundPropertyDataType

public static org.mule.runtime.api.metadata.DataType getOutboundPropertyDataType(org.mule.runtime.api.message.Message message,
                                                                                 String name)

Deprecated.

Gets an outbound property data type from the message.

Parameters:

message - message used to obtain the data from. Must be a InternalMessage

name - the name or key of the property. This must be non-null.

Returns:

the property data type or null if the property does not exist in the specified scope

Throws:

{@link - IllegalStateException} if there is any problem accessing the legacy message API using reflection

getInboundProperty

public static <T extends Serializable> T getInboundProperty(org.mule.runtime.api.message.Message message,
                                                            String name)

Deprecated.

Gets an inbound property from the message.

Parameters:

message - message used to obtain the data from. Must be a InternalMessage

name - the name or key of the property. This must be non-null.

Returns:

the property value or null if the property does not exist in the specified scope

Throws:

{@link - IllegalStateException} if there is any problem accessing the legacy message API using reflection

getExceptionPayload

public static org.mule.runtime.core.api.message.ExceptionPayload getExceptionPayload(org.mule.runtime.api.message.Message message)

Deprecated.

If an error occurred during the processing of this message this will return a ErrorPayload that contains the root exception and Mule error code, plus any other related info

Parameters:

message - message used to obtain the data from. Must be a InternalMessage

Returns:

The exception payload (if any) attached to this message

Throws:

{@link - IllegalStateException} if there is any problem accessing the legacy message API using reflection