org.mule.runtime.deployment.model.internal.tooling

Class ToolingApplicationClassLoaderBuilder

java.lang.Object

org.mule.runtime.deployment.model.internal.AbstractArtifactClassLoaderBuilder<ToolingApplicationClassLoaderBuilder>

org.mule.runtime.deployment.model.internal.tooling.ToolingApplicationClassLoaderBuilder

public class ToolingApplicationClassLoaderBuilder
extends AbstractArtifactClassLoaderBuilder<ToolingApplicationClassLoaderBuilder>

ArtifactClassLoader builder for class loaders required by Application artifacts for Tooling. The main different between this kind of applications vs the ones deployed through the deployment service is that Tooling has to access the ArtifactClassLoader and it should be simple for Tooling to dispose resources, therefore a ToolingArtifactClassLoader is created by this builder.

Since:

4.0

Field Summary

Fields inherited from class org.mule.runtime.deployment.model.internal.AbstractArtifactClassLoaderBuilder

artifactDescriptor, artifactPluginClassLoaders, logger

Constructor Summary

Constructors

Constructor and Description
ToolingApplicationClassLoaderBuilder(DeployableArtifactClassLoaderFactory<ApplicationDescriptor> artifactClassLoaderFactory, RegionPluginClassLoadersFactory pluginClassLoadersFactory) Creates a new builder for creating Application artifacts.

Method Summary

Modifier and Type	Method and Description
ToolingArtifactClassLoader	build() Creates a new ArtifactClassLoader using the provided configuration.
protected ArtifactClassLoader	createArtifactClassLoader(String artifactId, RegionClassLoader regionClassLoader) Creates the class loader for the artifact being built.
protected RegionClassLoader	createRegionClassLoader(String artifactId, ArtifactDescriptor artifactDescriptor, ClassLoader parentClassLoader, ClassLoaderLookupPolicy parentLookupPolicy) Template method to build different implementations of a RegionClassLoader
static String	getApplicationId(String applicationName)
static String	getApplicationId(String applicationName, String domainId)
protected String	getArtifactId(ArtifactDescriptor artifactDescriptor)
protected ArtifactClassLoader	getParentClassLoader() Implementation must redefine this method and it should provide the root class loader which is going to be used as parent class loader for every other class loader created by this builder.
protected ClassLoaderLookupPolicy	getParentLookupPolicy(ArtifactClassLoader parentClassLoader)
ToolingApplicationClassLoaderBuilder	setDomainParentClassLoader(ArtifactClassLoader domainArtifactClassLoader)
ToolingApplicationClassLoaderBuilder	setParentClassLoader(ArtifactClassLoader parentClassLoader)

Methods inherited from class org.mule.runtime.deployment.model.internal.AbstractArtifactClassLoaderBuilder

addArtifactPluginDescriptors, setArtifactDescriptor, setArtifactId

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolingApplicationClassLoaderBuilder

public ToolingApplicationClassLoaderBuilder(DeployableArtifactClassLoaderFactory<ApplicationDescriptor> artifactClassLoaderFactory,
                                            RegionPluginClassLoadersFactory pluginClassLoadersFactory)

Creates a new builder for creating Application artifacts.

The domainRepository is used to locate the domain that this application belongs to and the artifactClassLoaderBuilder is used for building the common parts of artifacts.

Parameters:

artifactClassLoaderFactory - factory for the classloader specific to the artifact resource and classes

pluginClassLoadersFactory - creates the class loaders for the plugins included in the application's region. Non null

Method Detail

build

public ToolingArtifactClassLoader build()
                                 throws IOException

Creates a new ArtifactClassLoader using the provided configuration. It will create the proper class loader hierarchy and filters so application classes, resources, plugins and it's domain resources are resolve correctly.

Overrides:

build in class AbstractArtifactClassLoaderBuilder<ToolingApplicationClassLoaderBuilder>

Returns:

a MuleDeployableArtifactClassLoader created from the provided configuration.

Throws:

IOException - exception cause when it was not possible to access the file provided as dependencies

createArtifactClassLoader

protected ArtifactClassLoader createArtifactClassLoader(String artifactId,
                                                        RegionClassLoader regionClassLoader)

Description copied from class: AbstractArtifactClassLoaderBuilder

Creates the class loader for the artifact being built.

Specified by:

createArtifactClassLoader in class AbstractArtifactClassLoaderBuilder<ToolingApplicationClassLoaderBuilder>

Parameters:

artifactId - identifies the artifact being created. Non empty.

regionClassLoader - class loader containing the artifact and dependant class loaders. Non null.

Returns:

getArtifactId

protected String getArtifactId(ArtifactDescriptor artifactDescriptor)

Specified by:

getArtifactId in class AbstractArtifactClassLoaderBuilder<ToolingApplicationClassLoaderBuilder>

setParentClassLoader

public ToolingApplicationClassLoaderBuilder setParentClassLoader(ArtifactClassLoader parentClassLoader)

Parameters:

parentClassLoader - parent class loader for the artifact class loader that should have all the URLs needed from tooling side when loading the ExtensionModel. Among those, there will be mule-api, extensions-api, extensions-support and so on.

Returns:

the builder

setDomainParentClassLoader

public ToolingApplicationClassLoaderBuilder setDomainParentClassLoader(ArtifactClassLoader domainArtifactClassLoader)

Parameters:

domainArtifactClassLoader - domain parent class loader for the artifact class loader. It will check for plugins to define the parent lookup policy if a domain parent artifact class loader has been set.

Returns:

the builder

getParentLookupPolicy

protected ClassLoaderLookupPolicy getParentLookupPolicy(ArtifactClassLoader parentClassLoader)

Overrides:

getParentLookupPolicy in class AbstractArtifactClassLoaderBuilder<ToolingApplicationClassLoaderBuilder>

Parameters:

parentClassLoader - parent class loader for the creates artifact class loader

Returns:

the lookup policy to use on the created artifact class loader

getParentClassLoader

protected ArtifactClassLoader getParentClassLoader()

Description copied from class: AbstractArtifactClassLoaderBuilder

Implementation must redefine this method and it should provide the root class loader which is going to be used as parent class loader for every other class loader created by this builder.

Specified by:

getParentClassLoader in class AbstractArtifactClassLoaderBuilder<ToolingApplicationClassLoaderBuilder>

Returns:

the root class loader for all other class loaders

createRegionClassLoader

protected RegionClassLoader createRegionClassLoader(String artifactId,
                                                    ArtifactDescriptor artifactDescriptor,
                                                    ClassLoader parentClassLoader,
                                                    ClassLoaderLookupPolicy parentLookupPolicy)

Description copied from class: AbstractArtifactClassLoaderBuilder

Template method to build different implementations of a RegionClassLoader

Overrides:

createRegionClassLoader in class AbstractArtifactClassLoaderBuilder<ToolingApplicationClassLoaderBuilder>

Returns:

a new RegionClassLoader

getApplicationId

public static String getApplicationId(String applicationName)

Parameters:

applicationName - name of the application. Non empty.

Returns:

the unique identifier for the application in the container.

getApplicationId

public static String getApplicationId(String applicationName,
                                      String domainId)

Parameters:

applicationName - name of the application. Non empty.

Returns:

the unique identifier for the application in the container.