org.mule.tooling.agent

Interface RuntimeToolingService

All Known Implementing Classes:

RestAgentToolingService

public interface RuntimeToolingService

Provides tooling operations for applications. An application may be a Mule Application or a Domain.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
List<AgentTrackingNotificationResponse>	consumeMessageHistoryNotifications(String applicationName, int chunkSize) Consumes the message history notifications buffered by Mule Runtime for the given application.
default String	deployApplication(File appLocation, Map<String,String> deploymentProperties) Deploys an application to the Mule Runtime from the given appLocation that points to the exploded application content.
String	deployApplication(File appLocation, String domainName, Map<String,String> deploymentProperties) Deploys an application to the Mule Runtime from the given appLocation that points to the exploded application content.
String	deployApplication(InputStream inputStream, Map<String,String> deploymentProperties) Deploys an application to the Mule Runtime with the content of the application jar from the inputStream.
String	deployApplication(InputStream inputStream, String domainName, Map<String,String> deploymentProperties) Deploys an application to the Mule Runtime with the content of the application jar from the inputStream.
String	deployDomain(File domainLocation, Map<String,String> deploymentProperties) Deploys a domain to the Mule Runtime from the given domainLocation that points to the exploded domain content.
String	deployDomain(InputStream inputStream, Map<String,String> deploymentProperties) Deploys a domain to the Mule Runtime with the content of the application jar from the inputStream.
void	disableMessageHistory(String applicationName) Disables message history for the given application.
void	disposeApplication(String applicationId) Disposes the application for the given applicationId.
void	disposeApplicationMetadataCache(String applicationId, String hashKey) Disposes the metadata associated with the hashKey in the Metadata cache on Mule Runtime side.
void	disposeDomain(String domainId) Disposes the domain for the given domainId.
void	disposeDomainMetadataCache(String domainId, String hashKey) Disposes the metadata associated with the hashKey in the Metadata cache on Mule Runtime side.
void	enableMessageHistory(String applicationName) Enables an application for message history.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer>	getMetadataKeysApplication(String applicationId, String componentLocation, long readTimeout) Returns a MetadataResult of MetadataKey described by MetadataKeyProvider.getMetadataKeys() of the associated MetadataKeyProvider component identified by the given applicationId and componentLocation.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer>	getMetadataKeysDomain(String domainId, String componentLocation, long readTimeout) Returns a MetadataResult of MetadataKey described by MetadataKeyProvider.getMetadataKeys() of the associated MetadataKeyProvider component identified by the given domainId and componentLocation.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.operation.OperationModel>>	getOperationMetadata(String applicationId, String componentLocation, long readTimeout) Resolves the Metadata description for the operation message processor component identified by the given applicationId and componentLocaton.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.source.SourceModel>>	getSourceMetadata(String applicationId, String componentLocation, long readTimeout) Resolves the Metadata description for the source component of the given applicationId and componentLocation.
org.mule.runtime.api.value.ValueResult	getValuesApplication(String applicationId, String location, String providerName) Resolves the values for a component's value provider located in the given Location.
org.mule.runtime.api.value.ValueResult	getValuesDomain(String domainId, String location, String providerName) Resolves the values for a component's value provider located in the given Location.
boolean	isOperational()
com.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse	runDataWeaveApplication(String applicationId, com.mulesoft.agent.domain.tooling.dataweave.model.PreviewRequest request) Execute a dataWeave script in the context of an application.
com.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse	runDataWeaveDomain(String applicationId, com.mulesoft.agent.domain.tooling.dataweave.model.PreviewRequest request) Execute a dataWeave script in the context of an application.
void	setMuleVersion(String muleVersion)
void	setToolingApiUrl(URL url, long defaultConnectTimeout, long defaultReadTimeout, Optional<org.mule.tooling.client.api.configuration.ssl.SslConfiguration> sslConfiguration) Sets URL for the Remote Mule Runtime Agent Tooling API to configure the client.
org.mule.tooling.client.api.connectivity.ConnectionValidationResult	testConnection(List<com.mulesoft.agent.domain.tooling.BundleDescriptor> dependencies, org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration, String componentId, long readTimeout) Does connection testing from a temporary application with the given configuration and extensions for the componentId.
org.mule.tooling.client.api.connectivity.ConnectionValidationResult	testConnectionApplication(String applicationId, String componentId, long readTimeout) Does connection testing over the componentId given for the application with the applicationId identifier.
org.mule.tooling.client.api.connectivity.ConnectionValidationResult	testConnectionDomain(String domainId, String componentId, long readTimeout) Does connection testing over the componentId given for the domain with the domainId identifier.

Method Detail

setToolingApiUrl

void setToolingApiUrl(URL url,
                      long defaultConnectTimeout,
                      long defaultReadTimeout,
                      Optional<org.mule.tooling.client.api.configuration.ssl.SslConfiguration> sslConfiguration)

Sets URL for the Remote Mule Runtime Agent Tooling API to configure the client.

Parameters:

url - URL to the base URL for the Mule Runtime Agent.

defaultConnectTimeout - default connection timeout for REST client.

defaultReadTimeout - default read timeout for REST client.

sslConfiguration - Optional SslConfiguration for the Mule Runtime Agent.

Throws:

IllegalStateException - if a baseUrl was already set.

setMuleVersion

void setMuleVersion(String muleVersion)

Parameters:

muleVersion - defines the API version to be called.

isOperational

boolean isOperational()

Returns:

true if the remote tooling service is operational and ready to be used.

deployApplication

String deployApplication(File appLocation,
                         String domainName,
                         Map<String,String> deploymentProperties)
                  throws org.mule.tooling.client.api.exception.DeploymentException,
                         org.mule.tooling.client.api.exception.ServiceUnavailableException

Deploys an application to the Mule Runtime from the given appLocation that points to the exploded application content.

The application content is copied from the specified location, be aware that the original files are not modified or watched later.

Parameters:

appLocation - File to the application exploded content.

domainName - String to the domain name to be linked to when deploying this application. Can be null.

Returns:

String application identifier for the application deployed.

Throws:

org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the application.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

deployApplication

default String deployApplication(File appLocation,
                                 Map<String,String> deploymentProperties)
                          throws org.mule.tooling.client.api.exception.DeploymentException,
                                 org.mule.tooling.client.api.exception.ServiceUnavailableException

Deploys an application to the Mule Runtime from the given appLocation that points to the exploded application content.

The application content is copied from the specified location, be aware that the original files are not modified or watched later.

Parameters:

appLocation - File to the application exploded content.

Returns:

String application identifier for the application deployed.

Throws:

org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the application.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

deployDomain

String deployDomain(File domainLocation,
                    Map<String,String> deploymentProperties)
             throws org.mule.tooling.client.api.exception.DeploymentException,
                    org.mule.tooling.client.api.exception.ServiceUnavailableException

Deploys a domain to the Mule Runtime from the given domainLocation that points to the exploded domain content.

The domain content is copied from the specified location, be aware that the original files are not modified or watched later.

Parameters:

domainLocation - File to the domain exploded content.

Returns:

String application identifier for the domain deployed.

Throws:

org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the domain.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

deployApplication

String deployApplication(InputStream inputStream,
                         Map<String,String> deploymentProperties)
                  throws org.mule.tooling.client.api.exception.DeploymentException,
                         org.mule.tooling.client.api.exception.ServiceUnavailableException

Deploys an application to the Mule Runtime with the content of the application jar from the inputStream.

Parameters:

inputStream - InputStream with the content of the application jar file.

Returns:

String application identifier for the application deployed.

Throws:

org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the application.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

deployApplication

String deployApplication(InputStream inputStream,
                         String domainName,
                         Map<String,String> deploymentProperties)
                  throws org.mule.tooling.client.api.exception.DeploymentException,
                         org.mule.tooling.client.api.exception.ServiceUnavailableException

Deploys an application to the Mule Runtime with the content of the application jar from the inputStream.

Parameters:

inputStream - InputStream with the content of the application jar file.

domainName - String to the domain name to be linked to when deploying this application. Can be null.

Returns:

String application identifier for the application deployed.

Throws:

org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the application.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

deployDomain

String deployDomain(InputStream inputStream,
                    Map<String,String> deploymentProperties)
             throws org.mule.tooling.client.api.exception.DeploymentException,
                    org.mule.tooling.client.api.exception.ServiceUnavailableException

Deploys a domain to the Mule Runtime with the content of the application jar from the inputStream.

Parameters:

inputStream - InputStream with the content of the domain jar file.

Returns:

String application identifier for the domain deployed.

Throws:

org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the domain.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

disposeApplication

void disposeApplication(String applicationId)
                 throws org.mule.tooling.client.api.exception.ServiceUnavailableException

Disposes the application for the given applicationId.

Parameters:

applicationId - String identifies the application to be disposed.

Throws:

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

disposeDomain

void disposeDomain(String domainId)
            throws org.mule.tooling.client.api.exception.ServiceUnavailableException

Disposes the domain for the given domainId.

Parameters:

domainId - String identifies the domain to be disposed.

Throws:

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

testConnectionApplication

org.mule.tooling.client.api.connectivity.ConnectionValidationResult testConnectionApplication(String applicationId,
                                                                                              String componentId,
                                                                                              long readTimeout)
                                                                                       throws org.mule.tooling.client.api.exception.NoSuchApplicationException,
                                                                                              org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException,
                                                                                              org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException,
                                                                                              org.mule.tooling.client.api.exception.ServiceUnavailableException

Does connection testing over the componentId given for the application with the applicationId identifier.

Parameters:

applicationId - String identifies the application to be tested.

componentId - String identifies the component to be tested.

readTimeout - read timeout in milliseconds

Returns:

ConnectionValidationResult with the result of the test.

Throws:

org.mule.tooling.client.api.exception.NoSuchApplicationException - if the application is not deployed or it was evicted by the the service (free resources).

org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException - when it's not possible to do connectivity testing over the mule component.

org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException - when the object to use to do connectivity does not exists.

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

testConnectionDomain

org.mule.tooling.client.api.connectivity.ConnectionValidationResult testConnectionDomain(String domainId,
                                                                                         String componentId,
                                                                                         long readTimeout)
                                                                                  throws org.mule.tooling.client.api.exception.NoSuchApplicationException,
                                                                                         org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException,
                                                                                         org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException,
                                                                                         org.mule.tooling.client.api.exception.ServiceUnavailableException

Does connection testing over the componentId given for the domain with the domainId identifier.

Parameters:

domainId - String identifies the domain to be tested.

componentId - String identifies the component to be tested.

readTimeout - read timeout in milliseconds

Returns:

ConnectionValidationResult with the result of the test.

Throws:

org.mule.tooling.client.api.exception.NoSuchApplicationException - if the domain is not deployed or it was evicted by the the service (free resources).

org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException - when it's not possible to do connectivity testing over the mule component.

org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException - when the object to use to do connectivity does not exists.

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

testConnection

org.mule.tooling.client.api.connectivity.ConnectionValidationResult testConnection(List<com.mulesoft.agent.domain.tooling.BundleDescriptor> dependencies,
                                                                                   org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration,
                                                                                   String componentId,
                                                                                   long readTimeout)
                                                                            throws org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException,
                                                                                   org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException,
                                                                                   org.mule.tooling.client.api.exception.ServiceUnavailableException

Does connection testing from a temporary application with the given configuration and extensions for the componentId.

Parameters:

dependencies - BundleDescriptor's libraries to be used by the application.

artifactDeclaration - ArtifactDeclaration defines the application configuration.

componentId - String identifies the component to be tested.

readTimeout - read timeout in milliseconds

Returns:

ConnectionValidationResult with the result of the test.

Throws:

org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException - when it's not possible to do connectivity testing over the mule component.

ConnectivityTestingObjectNotFoundException} - when the object to use to do connectivity does not exists.

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException

getMetadataKeysApplication

org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> getMetadataKeysApplication(String applicationId,
                                                                                                                                       String componentLocation,
                                                                                                                                       long readTimeout)
                                                                                                                                throws org.mule.tooling.client.api.exception.ServiceUnavailableException

Returns a MetadataResult of MetadataKey described by MetadataKeyProvider.getMetadataKeys() of the associated MetadataKeyProvider component identified by the given applicationId and componentLocation.

Parameters:

applicationId - String identifies the application.

componentLocation - the location path of the MetadataKeyProvider component inside the flow.

readTimeout - read timeout in milliseconds

Returns:

Successful MetadataResult if the keys are successfully resolved Failure. MetadataResult if there is an error while resolving the keys.

Throws:

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

getMetadataKeysDomain

org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> getMetadataKeysDomain(String domainId,
                                                                                                                                  String componentLocation,
                                                                                                                                  long readTimeout)
                                                                                                                           throws org.mule.tooling.client.api.exception.ServiceUnavailableException

Returns a MetadataResult of MetadataKey described by MetadataKeyProvider.getMetadataKeys() of the associated MetadataKeyProvider component identified by the given domainId and componentLocation.

Parameters:

domainId - String identifies the domain.

componentLocation - the location path of the MetadataKeyProvider component inside the flow.

readTimeout - read timeout in milliseconds

Returns:

Successful MetadataResult if the keys are successfully resolved Failure. MetadataResult if there is an error while resolving the keys.

Throws:

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

getOperationMetadata

org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.operation.OperationModel>> getOperationMetadata(String applicationId,
                                                                                                                                                                                                            String componentLocation,
                                                                                                                                                                                                            long readTimeout)
                                                                                                                                                                                                     throws org.mule.tooling.client.api.exception.ServiceUnavailableException

Resolves the Metadata description for the operation message processor component identified by the given applicationId and componentLocaton.

Parameters:

applicationId - String identifies the application.

componentLocation - the location path of the operation message processor component inside the flow.

readTimeout - read timeout in milliseconds

Returns:

An ComponentMetadataDescriptor with the Metadata representation of the Component. Successful MetadataResult if the Metadata is successfully retrieved. Failure MetadataResult when the Metadata retrieval of any element fails for any reason

Throws:

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

getSourceMetadata

org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.source.SourceModel>> getSourceMetadata(String applicationId,
                                                                                                                                                                                                   String componentLocation,
                                                                                                                                                                                                   long readTimeout)
                                                                                                                                                                                            throws org.mule.tooling.client.api.exception.ServiceUnavailableException

Resolves the Metadata description for the source component of the given applicationId and componentLocation.

Parameters:

applicationId - String identifies the application.

componentLocation - the location of the component to be queried as MetadataKeyProvider component.

readTimeout - read timeout in milliseconds

Returns:

An ComponentMetadataDescriptor with the Metadata representation of the Component. Successful MetadataResult if the Metadata is successfully retrieved. Failure MetadataResult when the Metadata retrieval of any element fails for any reason

Throws:

org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.

org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.

disposeApplicationMetadataCache

void disposeApplicationMetadataCache(String applicationId,
                                     String hashKey)

Disposes the metadata associated with the hashKey in the Metadata cache on Mule Runtime side.

Parameters:

applicationId - String identifies the application.

hashKey - could be generated for a component or just for a particular component.

disposeDomainMetadataCache

void disposeDomainMetadataCache(String domainId,
                                String hashKey)

Disposes the metadata associated with the hashKey in the Metadata cache on Mule Runtime side.

Parameters:

domainId - String identifies the domain.

hashKey - could be generated for a component or just for a particular component.

enableMessageHistory

void enableMessageHistory(String applicationName)
                   throws org.mule.tooling.client.api.exception.NoSuchApplicationException

Enables an application for message history.

Parameters:

applicationName - the name of the application to be used when deploying it.

Throws:

org.mule.tooling.client.api.exception.NoSuchApplicationException - if the application to be enable for message history is not already deployed.

disableMessageHistory

void disableMessageHistory(String applicationName)

Disables message history for the given application.

Parameters:

applicationName - the name of the application to be disabled.

consumeMessageHistoryNotifications

List<AgentTrackingNotificationResponse> consumeMessageHistoryNotifications(String applicationName,
                                                                           int chunkSize)

Consumes the message history notifications buffered by Mule Runtime for the given application.

Parameters:

applicationName - the name of the application to get its message history notifications.

chunkSize - the maximum number of notifications to be consumed by this request.

Returns:

List of AgentTrackingNotification collected by the remote service at this moment.

runDataWeaveApplication

com.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse runDataWeaveApplication(String applicationId,
                                                                                          com.mulesoft.agent.domain.tooling.dataweave.model.PreviewRequest request)

Execute a dataWeave script in the context of an application.

Parameters:

applicationId - application that provides context

request - parameters for running preview

Returns:

a wrapper that describes execution result or error details if execution failed.

runDataWeaveDomain

com.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse runDataWeaveDomain(String applicationId,
                                                                                     com.mulesoft.agent.domain.tooling.dataweave.model.PreviewRequest request)

Execute a dataWeave script in the context of an application.

Parameters:

applicationId - application that provides context

request - parameters for running preview

Returns:

a wrapper that describes execution result or error details if execution failed.

getValuesApplication

org.mule.runtime.api.value.ValueResult getValuesApplication(String applicationId,
                                                            String location,
                                                            String providerName)

Resolves the values for a component's value provider located in the given Location.

Parameters:

location - The Location where the configuration can be found.

providerName - The name of the value provider to resolve the values.

Returns:

the result of the resolving of the values.

See Also:

ValueResult

getValuesDomain

org.mule.runtime.api.value.ValueResult getValuesDomain(String domainId,
                                                       String location,
                                                       String providerName)

Resolves the values for a component's value provider located in the given Location.

Parameters:

location - The Location where the configuration can be found.

providerName - The name of the value provider to resolve the values.

Returns:

the result of the resolving of the values.

See Also:

ValueResult