org.mule.runtime.api.metadata

Interface MetadataProvider<T extends ComponentModel>

@NoImplement
public interface MetadataProvider<T extends ComponentModel>

This interface allows a Component that processes a Message 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<InputMetadataDescriptor>	getInputMetadata(MetadataKey key) Resolves the dynamic MetadataType for the current component parameters with the given key.
MetadataResult<ComponentMetadataDescriptor<T>>	getMetadata() Resolves the ComponentMetadataDescriptor for the current component using only the static types of the Component's parameters, attributes and output.
MetadataResult<ComponentMetadataDescriptor<T>>	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<OutputMetadataDescriptor>	getOutputMetadata(MetadataKey key) Resolves the dynamic MetadataType for the current component output and attrubutes with the given key.

Method Detail

getMetadata

MetadataResult<ComponentMetadataDescriptor<T>> 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<T>> 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 InputTypeResolver or OutputTypeResolver 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

getInputMetadata

MetadataResult<InputMetadataDescriptor> getInputMetadata(MetadataKey key)
                                                  throws MetadataResolvingException

Resolves the dynamic MetadataType for the current component parameters with the given key.

Parameters:

key - MetadataKey of the type which's structure has to be resolved.

Returns:

A MetadataType of InputMetadataDescriptor. Successful MetadataResult if the Metadata is successfully retrieved Failure MetadataResult when the Metadata retrieval fails for any reason

Throws:

MetadataResolvingException - if an error occurs while creating the MetadataContext

Since:

1.4

getOutputMetadata

MetadataResult<OutputMetadataDescriptor> getOutputMetadata(MetadataKey key)
                                                    throws MetadataResolvingException

Resolves the dynamic MetadataType for the current component output and attrubutes with the given key.

Parameters:

key - MetadataKey of the type which's structure has to be resolved.

Returns:

A MetadataType of OutputMetadataDescriptor. Successful MetadataResult if the Metadata is successfully retrieved Failure MetadataResult when the Metadata retrieval fails for any reason

Throws:

MetadataResolvingException - if an error occurs while creating the MetadataContext

Since:

1.4