org.mule.tooling.client.api.artifact

Interface ToolingArtifact

All Superinterfaces:

Disposable

public interface ToolingArtifact
extends Disposable

Provides tooling operations for a Mule Artifact.

Be aware that this class is not thread safe, due to it keeps state of the application deployed on Mule Runtime and all the services that rely on it cannot be invoked in parallel as they use the same application deployed on Mule Runtime side and the application is lazily initialized and cannot handle requests in parallel. The only scenario where the same ToolingArtifact could be used in parallel is whenever resolving MetadataKeys or ValueProviders for the same component location. If there is a case where clients need to resolve different operations in parallel it is recommended to work with multiple instances of this class for the same application content. Please consider that a ToolingArtifact also has in memory resources such as the application ClassLoader, ExtensionModels.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
ComponentLocationService	componentLocationService()
ConnectivityTestingService	connectivityTestingService() Returns a ConnectivityTestingService to allow testing connections over the ToolingArtifact configuration.
DataSenseService	dataSenseService() Returns a DataSenseService to resolve data sense operations over the ToolingArtifact.
DataWeaveService	dataWeaveService() Returns a DataWeaveService to run a DataWeave script over an application context.
ArtifactAst	getArtifactAst() Returns the ArtifactAst representation for the underlying artifact.
String	getId()
default Optional<ToolingArtifact>	getParent()
Map<String,String>	getProperties()
Feature<ResourceLoader>	getResourceLoader() Provides a ResourceLoader that supports to access resources inside the artifact with the same class loading filtering rules that Mule Runtime has.
MetadataService	metadataService() Returns a MetadataService to allow retrieving metadata over the ToolingArtifact configuration elements.
Feature<SampleDataService>	sampleDataService() Returns a ValueProviderService to be able to resolve values for a given Value Provider.
ValueProviderService	valueProviderService() Returns a ValueProviderService to be able to resolve values for a given Value Provider.

Methods inherited from interface org.mule.tooling.client.api.Disposable

dispose

Method Detail

getId

String getId()

Returns:

an the identifier for this ToolingArtifact in order to allow be fetched later.

getProperties

Map<String,String> getProperties()

Returns:

Map of properties defined for this ToolingArtifact.

Since:

1.1

getParent

default Optional<ToolingArtifact> getParent()

Returns:

ToolingArtifact representing the parent, as a ToolingArtifact represents a Mule domain or application on those cases where this ToolingArtifact represents a Mule domain no parent will be set or if the application has not declared a domain dependency (default one will be used). In those cases where the ToolingArtifact has been created for a Mule application and set the reference to the parent ToolingArtifact that value will be returned here.

In addition to that if the ToolingArtifact has been created without the parent reference but declares a domain dependency a ToolingArtifact will be created for the domain discovered.

connectivityTestingService

ConnectivityTestingService connectivityTestingService()

Returns a ConnectivityTestingService to allow testing connections over the ToolingArtifact configuration.

Returns:

a ConnectivityTestingService

metadataService

MetadataService metadataService()

Returns a MetadataService to allow retrieving metadata over the ToolingArtifact configuration elements.

Returns:

a MetadataService

dataSenseService

DataSenseService dataSenseService()

Returns a DataSenseService to resolve data sense operations over the ToolingArtifact.

Returns:

a DataSenseService

dataWeaveService

DataWeaveService dataWeaveService()

Returns a DataWeaveService to run a DataWeave script over an application context.

Returns:

a DataWeaveService

valueProviderService

ValueProviderService valueProviderService()

Returns a ValueProviderService to be able to resolve values for a given Value Provider.

Returns:

a ValueProviderService

sampleDataService

Feature<SampleDataService> sampleDataService()

Returns a ValueProviderService to be able to resolve values for a given Value Provider.

Returns:

a ValueProviderService

getResourceLoader

Feature<ResourceLoader> getResourceLoader()

Provides a ResourceLoader that supports to access resources inside the artifact with the same class loading filtering rules that Mule Runtime has.

Returns:

a Feature for the ResourceLoader to access resources inside the artifact.

componentLocationService

ComponentLocationService componentLocationService()

getArtifactAst

ArtifactAst getArtifactAst()

Returns the ArtifactAst representation for the underlying artifact.

Returns:

the ArtifactAst representation for the underlying artifact.

Since:

1.4