org.mule.runtime.api.metadata

Interface MetadataAware

public interface MetadataAware

This interface allows a Component that processes a MuleMessage to expose its metadata descriptor, containing all the MetadataType information associated to the Component's input and output elements

Since:

1.0

Method Summary

Modifier and Type	Method and Description
MetadataResult<ComponentMetadataDescriptor>	getMetadata() Resolves the ComponentMetadataDescriptor for the current component using only the static types of the Component's parameters, attributes and output.
MetadataResult<ComponentMetadataDescriptor>	getMetadata(MetadataKey key) Resolves the ComponentMetadataDescriptor for the current component using both static and dynamic resolving of the Component's parameters, attributes and output.
MetadataResult<Set<MetadataKey>>	getMetadataKeys() Returns the list of types that can be described, by the MetadataKeysResolver associated to this Component

Method Detail

getMetadataKeys

MetadataResult<Set<MetadataKey>> getMetadataKeys()
                                          throws MetadataResolvingException

Returns the list of types that can be described, by the MetadataKeysResolver associated to this Component

Returns:

Successful MetadataResult if the keys are successfully resolved Failure MetadataResult if there is an error while retrieving the keys

Throws:

MetadataResolvingException - if an error occurs while creating the MetadataContext

getMetadata

MetadataResult<ComponentMetadataDescriptor> getMetadata()
                                                 throws MetadataResolvingException

Resolves the ComponentMetadataDescriptor for the current component using only the static types of the Component's parameters, attributes and output.

Returns:

An ComponentMetadataDescriptor with the Static Metadata representation of the Component. Successful MetadataResult if the Metadata is successfully retrieved Failure MetadataResult when the Metadata retrieval of any element fails for any reason

Throws:

MetadataResolvingException - if an error occurs while creating the MetadataContext

getMetadata

MetadataResult<ComponentMetadataDescriptor> getMetadata(MetadataKey key)
                                                 throws MetadataResolvingException

Resolves the ComponentMetadataDescriptor for the current component using both static and dynamic resolving of the Component's parameters, attributes and output.

If the component has a MetadataContentResolver or MetadataOutputResolver associated that can be used to resolve the Dynamic MetadataType for the Content or Output, then the ComponentMetadataDescriptor will contain those Dynamic types instead of the static type declaration.

When neither Content nor Output have Dynamic types, then invoking this method is the same as invoking getMetadata()

Parameters:

key - MetadataKey of the type which's structure has to be resolved, used both for input and output types

Returns:

a MetadataResult of ComponentMetadataDescriptor type with Successful MetadataResult if the Metadata is successfully retrieved and a Failed MetadataResult when the Metadata retrieval of any element fails for any reason

Throws:

MetadataResolvingException - if an error occurs while creating the MetadataContext