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
MetadataResult<MetadataKeysContainer>	getMetadataKeys(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.MetadataKeysContainer>	internalMetadataKeys(MetadataKeysRequest metadataKeysRequest) Deprecated.

Method Detail

getMetadataKeys

MetadataResult<MetadataKeysContainer> getMetadataKeys(MetadataKeysRequest metadataKeysRequest)
                                               throws ServiceUnavailableException,
                                                      ToolingException

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:

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

ToolingException - if an unexpected error happens.

internalMetadataKeys

@Deprecated
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> internalMetadataKeys(MetadataKeysRequest metadataKeysRequest)
                                                                                                                                      throws ServiceUnavailableException,
                                                                                                                                             ToolingException

Deprecated.

Returns:

mule-api MetadataResult while the API is being modified to decouple usage of mule-api.

Throws:

ServiceUnavailableException

ToolingException