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>	consumeTryItNotifications(String applicationName, int chunkSize) Consumes the TryIt notifications buffered by Mule Runtime for the given application.
String	deployApplication(File appLocation) Deploys an application to the Mule Runtime from the given appLocation that points to the exploded application content.
String	deployApplication(InputStream inputStream) Deploys an application to the Mule Runtime with the content of the application zipped from the inputStream.
void	disableTryIt(String applicationName) Disables TryIt for the given application.
void	disposeApplication(String applicationId) Disposes the application for the given applicationId.
void	enableTryIt(String applicationName) Enables an application for TryIt.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer>	getMetadataKeys(String applicationId, String componentLocation) 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.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.operation.OperationModel>>	getOperationMetadata(String applicationId, String componentLocation) 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) Resolves the Metadata description for the source component of the given applicationId and componentLocation.
boolean	isOperational()
com.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse	runDataWeave(String applicationId, com.mulesoft.agent.domain.tooling.dataweave.model.PreviewRequest request) Execute a dataWeave script in the context of an application.
void	setToolingApiUrl(URL url, int defaultConnectTimeout, int defaultReadTimeout, Optional<SSLContext> sslContext) 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.api.app.declaration.ArtifactDeclaration artifactDeclaration, String componentId) Does connection testing from a temporary application with the given configuration and extensions for the componentId.
org.mule.tooling.client.api.connectivity.ConnectionValidationResult	testConnection(String applicationId, String componentId) Does connection testing over the componentId given for the application with the applicationId identifier.

Method Detail

setToolingApiUrl

void setToolingApiUrl(URL url,
                      int defaultConnectTimeout,
                      int defaultReadTimeout,
                      Optional<SSLContext> sslContext)

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.

sslContext - Optional SSLContext for the Mule Runtime Agent.

Throws:

IllegalStateException - if a baseUrl was already set.

isOperational

boolean isOperational()

Returns:

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

deployApplication

String deployApplication(File appLocation)
                  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.

deployApplication

String deployApplication(InputStream inputStream)
                  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 zipped from the inputStream.

Parameters:

inputStream - InputStream with the content of the application zip 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.

disposeApplication

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

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.

testConnection

org.mule.tooling.client.api.connectivity.ConnectionValidationResult testConnection(String applicationId,
                                                                                   String componentId)
                                                                            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,
                                                                                   org.mule.tooling.client.api.exception.ToolingException

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.

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.

testConnection

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

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.

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

getMetadataKeys

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

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.

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)
                                                                                                                                                                                                     throws org.mule.tooling.client.api.exception.ServiceUnavailableException,
                                                                                                                                                                                                            org.mule.tooling.client.api.exception.ToolingException

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.

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)
                                                                                                                                                                                            throws org.mule.tooling.client.api.exception.ServiceUnavailableException,
                                                                                                                                                                                                   org.mule.tooling.client.api.exception.ToolingException

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.

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.

enableTryIt

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

Enables an application for TryIt.

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 try it is not already deployed.

disableTryIt

void disableTryIt(String applicationName)

Disables TryIt for the given application.

Parameters:

applicationName - the name of the application to be disabled.

consumeTryItNotifications

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

Consumes the TryIt notifications buffered by Mule Runtime for the given application.

Parameters:

applicationName - the name of the application to get its TryIt 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.

runDataWeave

com.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse runDataWeave(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.