public interface ToolingRuntimeClient
| Modifier and Type | Interface and Description |
|---|---|
static interface |
ToolingRuntimeClient.Builder |
| 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 artifact. |
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. |
Feature<DeclarationSession.Builder> |
newDeclarationSessionBuilder()
Allows to create a
DeclarationSession to resolver services over a partial artifact declaration. |
ToolingArtifact |
newToolingArtifact(URL artifactUrlContent,
Map<String,String> toolingArtifactProperties)
Creates a
ToolingArtifact for an artifact (domain or application) from the URL of the content. |
default ToolingArtifact |
newToolingArtifact(URL artifactUrlContent,
Map<String,String> toolingArtifactProperties,
String parentId)
Creates a
ToolingArtifact for a Mule application from the URL of the content. |
ToolingArtifact newToolingArtifact(URL artifactUrlContent, Map<String,String> toolingArtifactProperties)
ToolingArtifact for an artifact (domain or application) from the URL of the content. It can be a file
protocol pointing to a the expanded content of the artifact 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 artifact content, therefore if
ToolingArtifacts are created per request keeping the same artifactUrlContent when there is no need to
package again would avoid wasting time on packaging when not needed.
In case of a Mule application that declares a domain dependency a ToolingArtifact.getParent() would be created for
the domain dependency and it is expected as with Mule plugins that the artifact can be resolved with the given
MavenConfiguration configured. The parent ToolingArtifact lifecycle will be attached to this
ToolingArtifact so whenever this one is disposed the parent will be disposed and there is no need to be disposed by
clients.
In addition to that, the ToolingArtifact for the Mule application will allows to run services against the components
from the application, if a request needs to be made for the Mule domain the ToolingArtifact.getParent() should be
used instead.artifactUrlContent - 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.ToolingArtifact.default ToolingArtifact newToolingArtifact(URL artifactUrlContent, Map<String,String> toolingArtifactProperties, String parentId)
ToolingArtifact for a Mule application from the URL of the content. This method allows to create a
ToolingArtifact with a reference to another ToolingArtifact for a Mule domain. The referenced
ToolingArtifact should not have been disposed.artifactUrlContent - URL for the artifact 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.parentId - ToolingArtifact parent identifier, mostly used when the ToolingArtifact to
be created is a Mule application so the parent would be a ToolingArtifact for the
Mule domain. If the parentId references to another application an
IllegalArgumentException would be thrown. The ToolingArtifact for the
parentId has to exists and should not have been disposed.ToolingArtifact parent. Use these when the ToolingArtifact to be created represents a Mule
application and there is already a ToolingArtifact created for the domain that the application depends on.ToolingArtifact fetchToolingArtifact(String id) throws ToolingArtifactNotFoundException
ToolingArtifact already created to resolve operations over an artifact.id - the identifier for the ToolingArtifact to be recovered.ToolingArtifactToolingArtifactNotFoundException - if the ToolingArtifact is no longer present.ExtensionModelService extensionModelService()
ExtensionModelService to allow retrieving the
ExtensionModel of a plugin.ExtensionModelServiceArtifactSerializationService artifactSerializationService()
ArtifactSerializationService to allow serialize and deserialze a Mule artifact declaration.ArtifactSerializationServiceDslSyntaxResolverService dslSyntaxResolverService()
DslSyntaxResolverService that allows to resolve the DslElementSyntax of an extension componentsDslSyntaxResolverServiceMessageHistoryService messageHistoryService()
MessageHistoryService to do try it over an application.MessageHistoryServiceExtensionIconsService iconsService()
ExtensionIconsService that allows to retrieve the icons for a given Extension.ExtensionIconsServiceFeature<DeclarationSession.Builder> newDeclarationSessionBuilder()
DeclarationSession to resolver services over a partial artifact declaration.Feature for a DeclarationSession.Builder.Copyright © 2023 MuleSoft, Inc.. All rights reserved.