org.mule.runtime.module.tooling.internal

Class DefaultToolingService

java.lang.Object

org.mule.runtime.module.tooling.internal.DefaultToolingService

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Stoppable, ToolingService

@NoImplement
public class DefaultToolingService
extends Object
implements ToolingService

Default implementation of ToolingService.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultToolingService.DomainMavenReactorResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Fields inherited from interface org.mule.runtime.module.tooling.api.ToolingService

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

Constructor Summary

Constructors

Constructor and Description

DefaultToolingService(org.mule.runtime.module.deployment.impl.internal.domain.DomainRepository domainRepository, org.mule.runtime.module.deployment.impl.internal.domain.DefaultDomainFactory domainFactory, org.mule.runtime.module.deployment.impl.internal.application.DefaultApplicationFactory applicationFactory, org.mule.runtime.module.deployment.impl.internal.artifact.AbstractDeployableDescriptorFactory<org.mule.runtime.api.deployment.meta.MuleApplicationModel,org.mule.runtime.deployment.model.api.application.ApplicationDescriptor> applicationDescriptorFactory)

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.deployment.model.api.application.Application	createApplication(byte[] appContent) Creates an application but from the content byte[], see ToolingService.createApplication(File) for more details.
org.mule.runtime.deployment.model.api.application.Application	createApplication(byte[] appContent, Optional<Properties> deploymentProperties) Creates an application but from the content byte[], see ToolingService.createApplication(File, Optional) for more details.
org.mule.runtime.deployment.model.api.application.Application	createApplication(File applicationLocation) Creates an Application from a set of resources.
org.mule.runtime.deployment.model.api.application.Application	createApplication(File applicationLocation, Optional<Properties> deploymentProperties) Creates an Application from a set of resources.
org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder	createArtifactModelBuilder(File artifactFolder, org.mule.runtime.module.artifact.api.descriptor.AbstractArtifactDescriptorFactory<org.mule.runtime.api.deployment.meta.MuleApplicationModel,org.mule.runtime.deployment.model.api.application.ApplicationDescriptor> applicationDescriptorFactory) Creates a MuleApplicationModel.MuleApplicationModelBuilder for the application from its artifact folder.
org.mule.runtime.deployment.model.api.domain.Domain	createDomain(byte[] domainContent) Creates a domain but from the content byte[], see ToolingService.createDomain(File) for more details.
org.mule.runtime.deployment.model.api.domain.Domain	createDomain(byte[] domainContent, Optional<Properties> deploymentProperties) Creates a domain but from the content byte[], see ToolingService.createDomain(File) for more details.
org.mule.runtime.deployment.model.api.domain.Domain	createDomain(File domainLocation) Creates a Domain from a set of resources.
org.mule.runtime.deployment.model.api.domain.Domain	createDomain(File domainLocation, Optional<Properties> deploymentProperties) Creates a Domain from a set of resources.
String	getUniqueIdString(String type) Generates a unique id for an artifact (domain or application).
void	initialise()
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
DeclarationSessionBuilder	newDeclarationSessionBuilder() Provides a DeclarationSessionBuilder to create a DeclarationSession by providing required configuration elements.
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final transient org.slf4j.Logger logger

Constructor Detail

DefaultToolingService

public DefaultToolingService(org.mule.runtime.module.deployment.impl.internal.domain.DomainRepository domainRepository,
                             org.mule.runtime.module.deployment.impl.internal.domain.DefaultDomainFactory domainFactory,
                             org.mule.runtime.module.deployment.impl.internal.application.DefaultApplicationFactory applicationFactory,
                             org.mule.runtime.module.deployment.impl.internal.artifact.AbstractDeployableDescriptorFactory<org.mule.runtime.api.deployment.meta.MuleApplicationModel,org.mule.runtime.deployment.model.api.application.ApplicationDescriptor> applicationDescriptorFactory)

Parameters:

domainRepository - DomainRepository to look up for already deployed domains.

domainFactory - factory for creating the Domain

applicationFactory - factory for creating the Application

applicationDescriptorFactory - AbstractDeployableDescriptorFactory to load the application descriptor.

Method Detail

newConnectivityTestingServiceBuilder

public 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

Specified by:

newConnectivityTestingServiceBuilder in interface ToolingService

Returns:

a builder to create a ConnectivityTestingService

newDeclarationSessionBuilder

public DeclarationSessionBuilder newDeclarationSessionBuilder()

Description copied from interface: ToolingService

Provides a DeclarationSessionBuilder to create a DeclarationSession by providing required configuration elements.

Specified by:

newDeclarationSessionBuilder in interface ToolingService

Returns:

a builder to create a DeclarationSession

createApplication

public org.mule.runtime.deployment.model.api.application.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.

Specified by:

createApplication in interface ToolingService

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

public org.mule.runtime.deployment.model.api.application.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.

Specified by:

createApplication in interface ToolingService

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 the application.

Returns:

the created application.

Throws:

IOException

createArtifactModelBuilder

public org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder createArtifactModelBuilder(File artifactFolder,
                                                                                                                        org.mule.runtime.module.artifact.api.descriptor.AbstractArtifactDescriptorFactory<org.mule.runtime.api.deployment.meta.MuleApplicationModel,org.mule.runtime.deployment.model.api.application.ApplicationDescriptor> applicationDescriptorFactory)

Creates a MuleApplicationModel.MuleApplicationModelBuilder for the application from its artifact folder.

Parameters:

artifactFolder - location of the application root folder.

Returns:

a MuleApplicationModel.MuleApplicationModelBuilder.

createApplication

public org.mule.runtime.deployment.model.api.application.Application createApplication(byte[] appContent)
                                                                                throws IOException

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

Specified by:

createApplication in interface ToolingService

Parameters:

appContent - the content of the application.

Returns:

the created application.

Throws:

IOException

createApplication

public org.mule.runtime.deployment.model.api.application.Application createApplication(byte[] appContent,
                                                                                       Optional<Properties> deploymentProperties)
                                                                                throws IOException

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

Specified by:

createApplication in interface ToolingService

Parameters:

appContent - the content of the application.

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

Returns:

the created application.

Throws:

IOException

createDomain

public org.mule.runtime.deployment.model.api.domain.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.

Specified by:

createDomain in interface ToolingService

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

public org.mule.runtime.deployment.model.api.domain.Domain createDomain(File domainLocation,
                                                                        Optional<Properties> deploymentProperties)
                                                                 throws IOException

Description copied from interface: ToolingService

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.

Specified by:

createDomain in interface ToolingService

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.

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

Returns:

the created domain.

Throws:

IOException

createDomain

public org.mule.runtime.deployment.model.api.domain.Domain createDomain(byte[] domainContent)
                                                                 throws IOException

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

Specified by:

createDomain in interface ToolingService

Parameters:

domainContent - the content of the domain.

Returns:

the created domain.

Throws:

IOException

createDomain

public org.mule.runtime.deployment.model.api.domain.Domain createDomain(byte[] domainContent,
                                                                        Optional<Properties> deploymentProperties)
                                                                 throws IOException

Description copied from interface: ToolingService

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

Specified by:

createDomain in interface ToolingService

Parameters:

domainContent - the content of the domain.

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

Returns:

the created domain.

Throws:

IOException

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Specified by:

initialise in interface ToolingService

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Specified by:

stop in interface ToolingService

Throws:

org.mule.runtime.api.exception.MuleException

getUniqueIdString

public String getUniqueIdString(String type)

Generates a unique id for an artifact (domain or application).

Returns:

String a uniqueId