org.mule.tooling.client.api

Interface ToolingRuntimeClient

public interface ToolingRuntimeClient

Provides tooling services for Mule Runtime.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ToolingRuntimeClient.Builder

Method Summary

Modifier and Type	Method and Description
ArtifactSerializationService	artifactSerializationService() Returns a ArtifactSerializationService to allow serialize and deserialze a Mule artifact declaration.
DslSyntaxResolverService	dslSyntaxResolverService() Returns an DslSyntaxResolverService that allows to resolve the DslElementSyntax of an extension components
ExtensionModelService	extensionModelService() Returns a ExtensionModelService to allow retrieving the ExtensionModel of a plugin.
ToolingArtifact	fetchToolingArtifact(String id) Fetches a ToolingArtifact already created to resolve operations over an application.
ExtensionIconsService	iconsService() Returns a ExtensionIconsService that allows to retrieve the icons for a given Extension.
MessageHistoryService	messageHistoryService() Returns a MessageHistoryService to do try it over an application.
ToolingArtifact	newToolingArtifact(URL applicationUrlContent, Map<String,String> toolingArtifactProperties) Creates a ToolingArtifact for the application from the URL of the application content.

Method Detail

newToolingArtifact

ToolingArtifact newToolingArtifact(URL applicationUrlContent,
                                   Map<String,String> toolingArtifactProperties)

Creates a ToolingArtifact for the application from the URL of the application content. It can be a file protocol pointing to a the expanded content of the application jar or a remote location pointing to the jar file where it would be read.

It is expected that users of this API should handle the packaging for the application content, therefore if ToolingArtifacts are created per request keeping the same applicationUrlContent when there is no need to package again would avoid wasting time on packaging when not needed.

Parameters:

applicationUrlContent - URL for the application content.

toolingArtifactProperties - Map of properties for the ToolingArtifact. Useful when need to keep context for tracking ToolingArtifacts, for instance: projectId to associated these ToolingArtifact to a project and when fetching Metadata from MetadataCache get the projectId.

Returns:

a ToolingArtifact.

fetchToolingArtifact

ToolingArtifact fetchToolingArtifact(String id)
                              throws ToolingArtifactNotFoundException

Fetches a ToolingArtifact already created to resolve operations over an application.

Parameters:

id - the identifier for the ToolingArtifact to be recovered.

Returns:

a ToolingArtifact

Throws:

ToolingArtifactNotFoundException - if the ToolingArtifact is no longer present.

extensionModelService

ExtensionModelService extensionModelService()

Returns a ExtensionModelService to allow retrieving the ExtensionModel of a plugin.

Returns:

a ExtensionModelService

artifactSerializationService

ArtifactSerializationService artifactSerializationService()

Returns a ArtifactSerializationService to allow serialize and deserialze a Mule artifact declaration.

Returns:

a ArtifactSerializationService

dslSyntaxResolverService

DslSyntaxResolverService dslSyntaxResolverService()

Returns an DslSyntaxResolverService that allows to resolve the DslElementSyntax of an extension components

Returns:

a DslSyntaxResolverService

messageHistoryService

MessageHistoryService messageHistoryService()

Returns a MessageHistoryService to do try it over an application.

Returns:

a MessageHistoryService

iconsService

ExtensionIconsService iconsService()

Returns a ExtensionIconsService that allows to retrieve the icons for a given Extension.

Returns:

a ExtensionIconsService

Since:

1.1