org.mule.runtime.deployment.model.internal.application

Class ApplicationClassLoaderBuilder

java.lang.Object

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

org.mule.runtime.deployment.model.internal.application.ApplicationClassLoaderBuilder

public class ApplicationClassLoaderBuilder
extends AbstractArtifactClassLoaderBuilder<ApplicationClassLoaderBuilder>

ArtifactClassLoader builder for class loaders required by Application artifacts

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
ApplicationClassLoaderBuilder(DeployableArtifactClassLoaderFactory<ApplicationDescriptor> artifactClassLoaderFactory, RegionPluginClassLoadersFactory pluginClassLoadersFactory) Creates a new builder for creating Application artifacts.

Method Summary

Modifier and Type	Method and Description
MuleDeployableArtifactClassLoader	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.
static String	getApplicationId(String domainId, String applicationId)
protected String	getArtifactId(ArtifactDescriptor artifactDescriptor)
protected DomainDescriptor	getDomainDescriptor()
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)
ApplicationClassLoaderBuilder	setDomain(Domain domain)

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

addArtifactPluginDescriptors, createRegionClassLoader, setArtifactDescriptor, setArtifactId

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationClassLoaderBuilder

public ApplicationClassLoaderBuilder(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 MuleDeployableArtifactClassLoader 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<ApplicationClassLoaderBuilder>

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<ApplicationClassLoaderBuilder>

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<ApplicationClassLoaderBuilder>

getParentClassLoader

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.

Specified by:

getParentClassLoader in class AbstractArtifactClassLoaderBuilder<ApplicationClassLoaderBuilder>

Returns:

the root class loader for all other class loaders

getDomainDescriptor

protected DomainDescriptor getDomainDescriptor()

setDomain

public ApplicationClassLoaderBuilder setDomain(Domain domain)

Parameters:

domain - the domain artifact to which the application that is going to use this classloader belongs.

Returns:

the builder

getApplicationId

public static String getApplicationId(String domainId,
                                      String applicationId)

Parameters:

domainId - name of the domain where the application is deployed. Non empty.

applicationId - id of the application. Non empty.

Returns:

the unique identifier for the application in the container.

getParentLookupPolicy

protected ClassLoaderLookupPolicy getParentLookupPolicy(ArtifactClassLoader parentClassLoader)

Overrides:

getParentLookupPolicy in class AbstractArtifactClassLoaderBuilder<ApplicationClassLoaderBuilder>

Parameters:

parentClassLoader - parent class loader for the creates artifact class loader

Returns:

the lookup policy to use on the created artifact class loader