org.mule.runtime.deployment.model.internal

Class AbstractArtifactClassLoaderBuilder<T extends AbstractArtifactClassLoaderBuilder>

java.lang.Object

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

Type Parameters:

T - the type of the filer.

Direct Known Subclasses:

ApplicationClassLoaderBuilder, ToolingPluginClassLoaderBuilder

public abstract class AbstractArtifactClassLoaderBuilder<T extends AbstractArtifactClassLoaderBuilder>
extends Object

Base class for all artifacts class loader filters.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description

AbstractArtifactClassLoaderBuilder(DeployableArtifactClassLoaderFactory artifactClassLoaderFactory, ArtifactPluginRepository artifactPluginRepository, ArtifactClassLoaderFactory<ArtifactPluginDescriptor> artifactPluginClassLoaderFactory, ArtifactDescriptorFactory<ArtifactPluginDescriptor> artifactDescriptorFactory, DependenciesProvider dependenciesProvider) Creates an AbstractArtifactClassLoaderBuilder.

Method Summary

Modifier and Type	Method and Description
T	addArtifactPluginDescriptors(ArtifactPluginDescriptor... artifactPluginDescriptors)
ArtifactClassLoader	build() Creates a new ArtifactClassLoader using the provided configuration.
protected abstract String	getArtifactId(ArtifactDescriptor artifactDescriptor)
static String	getArtifactPluginId(String parentArtifactId, String pluginName)
protected abstract 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.
T	setArtifactDescriptor(ArtifactDescriptor artifactDescriptor)
T	setArtifactId(String artifactId)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractArtifactClassLoaderBuilder

public AbstractArtifactClassLoaderBuilder(DeployableArtifactClassLoaderFactory artifactClassLoaderFactory,
                                          ArtifactPluginRepository artifactPluginRepository,
                                          ArtifactClassLoaderFactory<ArtifactPluginDescriptor> artifactPluginClassLoaderFactory,
                                          ArtifactDescriptorFactory<ArtifactPluginDescriptor> artifactDescriptorFactory,
                                          DependenciesProvider dependenciesProvider)

Creates an AbstractArtifactClassLoaderBuilder.

Parameters:

artifactClassLoaderFactory - factory for the classloader specific to the artifact resource and classes. Must be not null.

artifactPluginRepository - repository of plugins contained by the runtime. Must be not null.

artifactPluginClassLoaderFactory - factory to create class loaders for each used plugin. Non be not null.

artifactDescriptorFactory - factory to create ArtifactPluginDescriptor when there's a missing dependency to resolve

dependenciesProvider - resolver for missing dependencies.

Method Detail

getParentClassLoader

protected abstract 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.

Returns:

the root class loader for all other class loaders

setArtifactId

public T setArtifactId(String artifactId)

Parameters:

artifactId - unique identifier for this artifact. For instance, for Applications, it can be the app name. Must be not null.

Returns:

the builder

addArtifactPluginDescriptors

public T addArtifactPluginDescriptors(ArtifactPluginDescriptor... artifactPluginDescriptors)

Parameters:

artifactPluginDescriptors - set of plugins descriptors that will be used by the application.

Returns:

the builder

setArtifactDescriptor

public T setArtifactDescriptor(ArtifactDescriptor artifactDescriptor)

Parameters:

artifactDescriptor - the descriptor of the artifact for which the class loader is going to be created.

Returns:

the builder

build

public ArtifactClassLoader build()
                          throws IOException

Creates a new ArtifactClassLoader using the provided configuration. It will create the proper class loader hierarchy and filters the artifact resources and plugins classes and resources are resolve correctly.

Returns:

a ArtifactClassLoader created from the provided configuration.

Throws:

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

getArtifactId

protected abstract String getArtifactId(ArtifactDescriptor artifactDescriptor)

getArtifactPluginId

public static String getArtifactPluginId(String parentArtifactId,
                                         String pluginName)

Parameters:

parentArtifactId - identifier of the artifact that owns the plugin. Non empty.

pluginName - name of the plugin. Non empty.

Returns:

the unique identifier for the plugin inside the parent artifact.