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

Class ToolingPluginClassLoaderBuilder

java.lang.Object

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

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

public class ToolingPluginClassLoaderBuilder
extends AbstractArtifactClassLoaderBuilder<ToolingPluginClassLoaderBuilder>

Given an ArtifactPluginDescriptor as a starting point, it will generate a ArtifactClassLoader capable of working with the plugin and any other plugins it relies on.

So, if we take HTTP as a sample which depends on Sockets, it will (a) generate a ClassLoader for HTTP, (b) its Socket dependency and (c) a RegionClassLoader as well.

This builder object will return a wrapper to the HTTP ArtifactClassLoader to allow further consumers of it to believe they have the actual HTTP, allowing them to DisposableClassLoader.dispose() properly.

Since:

4.0

Field Summary

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

artifactDescriptor, logger

Constructor Summary

Constructors

Constructor and Description
ToolingPluginClassLoaderBuilder(DeployableArtifactClassLoaderFactory artifactClassLoaderFactory, PluginDependenciesResolver pluginDependenciesResolver, ArtifactPluginDescriptor artifactPluginDescriptor, RegionPluginClassLoadersFactory pluginClassLoadersFactory)

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
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 static ArtifactClassLoader	getPluginArtifactClassLoader(ArtifactPluginDescriptor artifactPluginDescriptor, List<ArtifactClassLoader> artifactPluginClassLoaders)
ToolingPluginClassLoaderBuilder	setParentClassLoader(ArtifactClassLoader parentClassLoader)

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

addArtifactPluginDescriptors, getParentLookupPolicy, setArtifactDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolingPluginClassLoaderBuilder

public ToolingPluginClassLoaderBuilder(DeployableArtifactClassLoaderFactory artifactClassLoaderFactory,
                                       PluginDependenciesResolver pluginDependenciesResolver,
                                       ArtifactPluginDescriptor artifactPluginDescriptor,
                                       RegionPluginClassLoadersFactory pluginClassLoadersFactory)

Parameters:

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

artifactPluginDescriptor - desired plugin to generate an ArtifactClassLoader for.

pluginDependenciesResolver - resolver for the plugins on which the artifactPluginDescriptor declares it depends.

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

See Also:

build()

Method Detail

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

Parameters:

artifactId - identifies the artifact being created. Non empty.

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

Returns:

setParentClassLoader

public ToolingPluginClassLoaderBuilder 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

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

Returns:

the root class loader for all other class loaders

getArtifactId

protected String getArtifactId(ArtifactDescriptor artifactDescriptor)

Specified by:

getArtifactId in class AbstractArtifactClassLoaderBuilder<ToolingPluginClassLoaderBuilder>

build

public ToolingArtifactClassLoader build()

Description copied from class: AbstractArtifactClassLoaderBuilder

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.

Overrides:

build in class AbstractArtifactClassLoaderBuilder<ToolingPluginClassLoaderBuilder>

Returns:

a ArtifactClassLoader created from the provided configuration.

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

Returns:

a new RegionClassLoader

getPluginArtifactClassLoader

protected static ArtifactClassLoader getPluginArtifactClassLoader(ArtifactPluginDescriptor artifactPluginDescriptor,
                                                                  List<ArtifactClassLoader> artifactPluginClassLoaders)

Parameters:

artifactPluginDescriptor - to look for within the collection of ArtifactClassLoaders

artifactPluginClassLoaders - plugins class loaders to look for, at least one of them must contain the pluginDescriptor.

Returns:

the ArtifactClassLoader that was generated for the artifactPluginDescriptor

Throws:

PluginResolutionError - if the plugin wasn't found in the collection of artifactPluginClassLoaders