org.mule.runtime.api.metadata

Interface MetadataService

public interface MetadataService

Provides access to the Metadata of any MetadataProvider and EntityMetadataProvider components in the application and the MetadataKey of the MetadataKeyProvider components, using it's Location It also provides access to the MetadataKey associated to a configuration through the operations and sources that belong to that configuration.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA_SERVICE_KEY Key under which the MetadataService can be found in the Registry

Method Summary

Modifier and Type	Method and Description
void	disposeCache(String id) Removes the MetadataCache with the specified id.
MetadataResult<MetadataKeysContainer>	getEntityKeys(Location location) Returns the list of entity types that can be queried in an EntityMetadataProvider component identified by the Location.
MetadataResult<TypeMetadataDescriptor>	getEntityMetadata(Location location, MetadataKey key) Resolves an entity TypeMetadataDescriptor for the EntityMetadataProvider component identified by the Location.
MetadataResult<MetadataKeysContainer>	getMetadataKeys(Location location) Returns the list of types that can be described by the TypeKeysResolver associated to the MetadataKeyProvider Component identified by the Location.
MetadataResult<ComponentMetadataDescriptor<OperationModel>>	getOperationMetadata(Location location) Resolves the ComponentMetadataDescriptor for the MetadataProvider Component identified by the Location using only the static types of its parameters, attributes and output.
MetadataResult<ComponentMetadataDescriptor<OperationModel>>	getOperationMetadata(Location location, MetadataKey key) Resolves the ComponentMetadataDescriptor for the MetadataProvider Component identified by the Location using both static and dynamic resolving of the parameters, attributes and output types.
MetadataResult<ComponentMetadataDescriptor<SourceModel>>	getSourceMetadata(Location location) Resolves the ComponentMetadataDescriptor for the MetadataProvider Component identified by the Location using only the static types of its parameters, attributes and output.
MetadataResult<ComponentMetadataDescriptor<SourceModel>>	getSourceMetadata(Location location, MetadataKey key) Resolves the ComponentMetadataDescriptor for the MetadataProvider Component identified by the Location using both static and dynamic resolving of the parameters, attributes and output types.

Field Detail

METADATA_SERVICE_KEY

static final String METADATA_SERVICE_KEY

Key under which the MetadataService can be found in the Registry

See Also:

Constant Field Values

Method Detail

getMetadataKeys

MetadataResult<MetadataKeysContainer> getMetadataKeys(Location location)

Returns the list of types that can be described by the TypeKeysResolver associated to the MetadataKeyProvider Component identified by the Location.

Parameters:

location - the location of the MetadataKeyProvider component to query for its available keys

Returns:

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

getOperationMetadata

MetadataResult<ComponentMetadataDescriptor<OperationModel>> getOperationMetadata(Location location)

Resolves the ComponentMetadataDescriptor for the MetadataProvider Component identified by the Location using only the static types of its parameters, attributes and output.

Parameters:

location - the location of the MetadataProvider component to type dynamically

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

getOperationMetadata

MetadataResult<ComponentMetadataDescriptor<OperationModel>> getOperationMetadata(Location location,
                                                                                 MetadataKey key)

Resolves the ComponentMetadataDescriptor for the MetadataProvider Component identified by the Location using both static and dynamic resolving of the parameters, attributes and output types.

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 types declaration.

When neither Content nor Output have dynamic types, then invoking this method is the same as invoking this#getOperationMetadata

Parameters:

location - the location of the MetadataProvider component to type dynamically

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

getSourceMetadata

MetadataResult<ComponentMetadataDescriptor<SourceModel>> getSourceMetadata(Location location)

Resolves the ComponentMetadataDescriptor for the MetadataProvider Component identified by the Location using only the static types of its parameters, attributes and output.

Parameters:

location - the location of the MetadataProvider component to type dynamically

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

getSourceMetadata

MetadataResult<ComponentMetadataDescriptor<SourceModel>> getSourceMetadata(Location location,
                                                                           MetadataKey key)

Resolves the ComponentMetadataDescriptor for the MetadataProvider Component identified by the Location using both static and dynamic resolving of the parameters, attributes and output types.

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 types declaration.

When neither Content nor Output have dynamic types, then invoking this method is the same as invoking this#getOperationMetadata

Parameters:

location - the location of the MetadataProvider component to type dynamically

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

disposeCache

void disposeCache(String id)

Removes the MetadataCache with the specified id.

Parameters:

id - the id of the cache to be removed

getEntityKeys

MetadataResult<MetadataKeysContainer> getEntityKeys(Location location)

Returns the list of entity types that can be queried in an EntityMetadataProvider component identified by the Location.

Parameters:

location - the location of the EntityMetadataProvider component to query for its available keys

Returns:

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

getEntityMetadata

MetadataResult<TypeMetadataDescriptor> getEntityMetadata(Location location,
                                                         MetadataKey key)

Resolves an entity TypeMetadataDescriptor for the EntityMetadataProvider component identified by the Location.

Parameters:

location - the location of the EntityMetadataProvider component to query for its available keys

key - MetadataKey representing an entity of the type which's structure has to be resolved

Returns:

a MetadataResult of TypeMetadataDescriptor type with a successful MetadataResult if the metadata is successfully retrieved and a failed MetadataResult when the metadata retrieval of the entity had a problem.