org.mule.runtime.core.internal.message

Interface MessageProperties

All Known Subinterfaces:

InternalMessage

Deprecated.

Transport infrastructure is deprecated. Use Attributes instead.

@Deprecated
public interface MessageProperties

Use to obtain message properties defined in two scopes, inbound and outbound.

Method Summary

Modifier and Type	Method and Description
<T extends Serializable> T	getInboundProperty(String name) Deprecated. Gets an inbound property from the message.
<T extends Serializable> T	getInboundProperty(String name, T defaultValue) Deprecated. Gets an inbound property from the message and provides a default value if the property is not present on the message in the scope specified.
org.mule.runtime.api.metadata.DataType	getInboundPropertyDataType(String name) Deprecated. Gets an inbound property data type from the message.
Set<String>	getInboundPropertyNames() Deprecated. Gets all inbound property names.
<T extends Serializable> T	getOutboundProperty(String name) Deprecated. Gets an outbound property from the message.
<T extends Serializable> T	getOutboundProperty(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.
org.mule.runtime.api.metadata.DataType	getOutboundPropertyDataType(String name) Deprecated. Gets an outbound property data type from the message.
Set<String>	getOutboundPropertyNames() Deprecated. Gets all outbound property names.

Method Detail

getOutboundProperty

<T extends Serializable> T getOutboundProperty(String name)

Deprecated.

Gets an outbound property from the message.

Parameters:

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

getOutboundProperty

<T extends Serializable> T getOutboundProperty(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:

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

getOutboundPropertyDataType

org.mule.runtime.api.metadata.DataType getOutboundPropertyDataType(String name)

Deprecated.

Gets an outbound property data type from the message.

Parameters:

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

getOutboundPropertyNames

Set<String> getOutboundPropertyNames()

Deprecated.

Gets all outbound property names.

Returns:

all outbound property keys of this message

getInboundProperty

<T extends Serializable> T getInboundProperty(String name)

Deprecated.

Gets an inbound property from the message.

Parameters:

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

getInboundProperty

<T extends Serializable> T getInboundProperty(String name,
                                              T defaultValue)

Deprecated.

Gets an inbound 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:

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

getInboundPropertyDataType

org.mule.runtime.api.metadata.DataType getInboundPropertyDataType(String name)

Deprecated.

Gets an inbound property data type from the message.

Parameters:

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

getInboundPropertyNames

Set<String> getInboundPropertyNames()

Deprecated.

Gets all inbound property names.

Returns:

all inbound property keys on this message.