org.mule.tooling.client.internal

Interface MetadataProvider

All Known Implementing Classes:

InternalApplicationMetadataProvider, InternalDomainMetadataProvider

public interface MetadataProvider

Provides metadata resolution.

This is an internal service and should not be used by clients due to it may change later.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetadataProvider.MetadataRequest Request entity for retrieving ComponentMetadataDescriptor for a ToolingArtifact.

Method Summary

Modifier and Type	Method and Description
void	disposeMetadataCache(String hashKey) Dispose cache entries Metadata cache on Mule Runtime side for the given hashKey, if the entry doesn't match exactly to a entry in the key, it will dispose those entries that start with the hashKey given.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer>	getMetadataKeys(org.mule.tooling.client.api.metadata.MetadataKeysRequest metadataKeysRequest) Returns a MetadataResult of MetadataKeysContainer described by MetadataKeyProvider.getMetadataKeys() of the associated MetadataKeyProvider component identified by the given MetadataKeysRequest.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.operation.OperationModel>>	getOperationMetadata(MetadataProvider.MetadataRequest metadataRequest) Resolves the Metadata description for the operation message processor component identified by the request.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.source.SourceModel>>	getSourceMetadata(MetadataProvider.MetadataRequest metadataRequest) Resolves the Metadata description for the operation message processor component identified by the request.

Method Detail

getMetadataKeys

org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> getMetadataKeys(org.mule.tooling.client.api.metadata.MetadataKeysRequest metadataKeysRequest)

Returns a MetadataResult of MetadataKeysContainer described by MetadataKeyProvider.getMetadataKeys() of the associated MetadataKeyProvider component identified by the given MetadataKeysRequest.

Parameters:

metadataKeysRequest - request to get the MetadataKeysContainer.

Returns:

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

Throws:

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

getSourceMetadata

org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.source.SourceModel>> getSourceMetadata(MetadataProvider.MetadataRequest metadataRequest)

Resolves the Metadata description for the operation message processor component identified by the request.

Parameters:

metadataRequest - request to get the ComponentMetadataDescriptor.

Returns:

A ComponentMetadataDescriptor containing a SourceModel with its types resolved and MetadataAttributes that provides information about the metadata resolution process.

Throws:

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

getOperationMetadata

org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.operation.OperationModel>> getOperationMetadata(MetadataProvider.MetadataRequest metadataRequest)

Resolves the Metadata description for the operation message processor component identified by the request.

Parameters:

metadataRequest - request to get the ComponentMetadataDescriptor.

Returns:

A ComponentMetadataDescriptor containing a OperationModel with its types resolved and MetadataAttributes that provides information about the metadata resolution process.

Throws:

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

disposeMetadataCache

void disposeMetadataCache(String hashKey)

Dispose cache entries Metadata cache on Mule Runtime side for the given hashKey, if the entry doesn't match exactly to a entry in the key, it will dispose those entries that start with the hashKey given. Case for global elements.

Parameters:

hashKey - the key to be disposed.