org.mule.runtime.module.tooling.api

Interface ToolingService

All Superinterfaces:

Initialisable, Stoppable

@NoImplement
public interface ToolingService
extends Initialisable, Stoppable

Set of services used by tooling to exercise some mule configuration like doing connectivity testing.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEPLOYMENT_DOMAIN_NAME_REF

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Method Summary

Modifier and Type	Method and Description
default Application	createApplication(byte[] appContent) Creates an application but from the content byte[], see createApplication(File) for more details.
default Application	createApplication(byte[] appContent, Optional<Properties> deploymentProperties) Creates an application but from the content byte[], see createApplication(File, Optional) for more details.
Application	createApplication(File applicationLocation) Creates an Application from a set of resources.
default Application	createApplication(File applicationLocation, Optional<Properties> deploymentProperties) Creates an Application from a set of resources.
default Domain	createDomain(byte[] domainContent) Creates a domain but from the content byte[], see createDomain(File) for more details.
default Domain	createDomain(File domainLocation) Creates a Domain from a set of resources.
default void	initialise() Method used to perform any initialisation work.
ConnectivityTestingServiceBuilder	newConnectivityTestingServiceBuilder() Provides a service to create a connectivity testing service using a builder which can be used to configured resources of a dynamically created artifact
default void	stop()

Field Detail

DEPLOYMENT_DOMAIN_NAME_REF

static final String DEPLOYMENT_DOMAIN_NAME_REF

See Also:

Constant Field Values

Method Detail

newConnectivityTestingServiceBuilder

ConnectivityTestingServiceBuilder newConnectivityTestingServiceBuilder()

Provides a service to create a connectivity testing service using a builder which can be used to configured resources of a dynamically created artifact

Returns:

a builder to create a ConnectivityTestingService

createApplication

Application createApplication(File applicationLocation)
                       throws IOException

Creates an Application from a set of resources.

The created application will be created lazily meaning that the application resources will be created based on the different request made to the application.

Only requested components will be executed. All sources for flows will be stop unless they are requested to be started by the client.

If a domain dependency is defined for the application it will be deployed. Both domain and application will be deployed using a random unique identifier allowing to get multiple deployments of both application and domain. Be aware that resources (ports, file system, etc) are shared so in those cases where resources are needed by the application or domain a deployment exception could happen.

The application will be deployed using MuleDeploymentProperties.MULE_MUTE_APP_LOGS_DEPLOYMENT_PROPERTY so the application logs are muted.

Parameters:

applicationLocation - location of the application content. The application content may be a folder holding an exploded structure for an application or may be a zip file containing the resources of the application.

Returns:

the created application.

Throws:

IOException

createApplication

default Application createApplication(File applicationLocation,
                                      Optional<Properties> deploymentProperties)
                               throws IOException

Creates an Application from a set of resources.

The created application will be created lazily meaning that the application resources will be created based on the different request made to the application.

Only requested components will be executed. All sources for flows will be stop unless they are requested to be started by the client.

If a domain dependency is defined for the application it will be deployed. Both domain and application will be deployed using a random unique identifier allowing to get multiple deployments of both application and domain. Be aware that resources (ports, file system, etc) are shared so in those cases where resources are needed by the application or domain a deployment exception could happen.

The application will be deployed using MuleDeploymentProperties.MULE_MUTE_APP_LOGS_DEPLOYMENT_PROPERTY so the application logs are muted.

Parameters:

applicationLocation - location of the application content. The application content may be a folder holding an exploded structure for an application or may be a zip file containing the resources of the application.

deploymentProperties - defines the deployment properties to be used when deploying these application.

Returns:

the created application.

Throws:

IOException

createApplication

default Application createApplication(byte[] appContent)
                               throws IOException

Creates an application but from the content byte[], see createApplication(File) for more details.

Parameters:

appContent - the content of the application.

Returns:

the created application.

Throws:

IOException

createApplication

default Application createApplication(byte[] appContent,
                                      Optional<Properties> deploymentProperties)
                               throws IOException

Creates an application but from the content byte[], see createApplication(File, Optional) for more details.

Parameters:

appContent - the content of the application.

deploymentProperties - defines the deployment properties to be used when deploying these application.

Returns:

the created application.

Throws:

IOException

createDomain

default Domain createDomain(File domainLocation)
                     throws IOException

Creates a Domain from a set of resources.

The created domain will be created lazily meaning that the domain resources will be created based on the different request made to the domain.

Only requested components will be executed. All sources for flows will be stop unless they are requested to be started by the client.

Be aware that resources (ports, file system, etc) are shared so in those cases where resources are needed by the domain a deployment exception could happen.

The domain will be deployed using MuleDeploymentProperties.MULE_MUTE_APP_LOGS_DEPLOYMENT_PROPERTY so the domain logs are muted.

Parameters:

domainLocation - location of the domain content. The domain content may be a folder holding an exploded structure for an domain or may be a jar file containing the resources of the domain.

Returns:

the created domain.

Throws:

IOException

createDomain

default Domain createDomain(byte[] domainContent)
                     throws IOException

Creates a domain but from the content byte[], see createDomain(File) for more details.

Parameters:

domainContent - the content of the domain.

Returns:

the created domain.

Throws:

IOException

initialise

default void initialise()
                 throws InitialisationException

Description copied from interface: Initialisable

Method used to perform any initialisation work. If a fatal error occurs during initialisation an InitialisationException should be thrown.

In case that the Initialisable.initialise() method execution fails then mule will call the Disposable.dispose() method if the class also implements Disposable allowing the object to dispose any allocated resource during Initialisable.initialise()

Specified by:

initialise in interface Initialisable

Throws:

InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

See Also:

Disposable

stop

default void stop()
           throws MuleException

Specified by:

stop in interface Stoppable

Throws:

MuleException