org.mule.tooling.client.api.metadata

Interface MetadataService

public interface MetadataService

Service for retrieving metadata. A MetadataService

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Feature<Action<Location>>	disposeMetadataCache() If supported by the ToolingRuntimeClient implementation will return a Feature to do the dispose of Metadata on both, the Mule Runtime side cache and the Tooling Client side cache, for the given location.
MetadataResult<MetadataKeysContainer>	getMetadataKeys(MetadataKeysRequest metadataKeysRequest) Returns a MetadataResult of MetadataKeysContainer described by MetadataKeysContainer.getKeys(String)} of the associated MetadataKeyProvider component identified by the given MetadataKeysRequest.
Feature<Action<Location>>	invalidateMetadataCacheKeys() If supported by the org.mule.tooling.client.api.ToolingRuntimeClient), the implementation will return a {@link Feature>} to invalidate entries related to metadata keys calculated for the component associated with the Location given.

Method Detail

getMetadataKeys

MetadataResult<MetadataKeysContainer> getMetadataKeys(MetadataKeysRequest metadataKeysRequest)
                                               throws ServiceUnavailableException

Returns a MetadataResult of MetadataKeysContainer described by MetadataKeysContainer.getKeys(String)} 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:

ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

ToolingException - if an unexpected error happens.

disposeMetadataCache

Feature<Action<Location>> disposeMetadataCache()

If supported by the ToolingRuntimeClient implementation will return a Feature to do the dispose of Metadata on both, the Mule Runtime side cache and the Tooling Client side cache, for the given location.

This should be called when external changes on remote system are made and metadata has to be recalculated from scratch. The location could be at component level or configuration, in any case all metadata resources in cache associated to the configuration referenced by the component will be disposed. If the Location corresponds to a configuration, then all metadata from all operations that reference that configuration will be invalidated.

Returns:

Feature to execute an Action for the location of the component to be cleared, could be a configuration or a component. Either one or the other all the metadata cache entries associated to the configuration would be disposed.

invalidateMetadataCacheKeys

Feature<Action<Location>> invalidateMetadataCacheKeys()

If supported by the org.mule.tooling.client.api.ToolingRuntimeClient), the implementation will return a {@link Feature>} to invalidate entries related to metadata keys calculated for the component associated with the Location given. This includes disposing all resources cached in the Mule Runtime cache and the metadata keys stored in the Tooling client's metadata cache.

This should be called when external changes on remote system are made and metadata keys have to be recalculated from scratch.

Unlike disposeMetadataCache(), where if the Location corresponds to a configuration, then all related operations are invalidated, this method only acts on the component associated with the given Location

Returns:

a Feature> that invalidates all metadata keys from the component related to the given Location if enabled.

Since:

4.2.2, 4.3.0