org.mule.test.runner.classloader

Class IsolatedClassLoaderFactory

java.lang.Object

org.mule.test.runner.classloader.IsolatedClassLoaderFactory

public class IsolatedClassLoaderFactory
extends Object

Factory that creates a class loader hierarchy to emulate the one used in a mule standalone container.

The class loaders created have the following hierarchy:

• Container: all the provided scope dependencies plus their dependencies (non test dependencies) and java
• Plugins (optional): for each plugin a class loader will be created with all the compile scope dependencies and their transitive dependencies (only the ones with scope compile)
• Application: all the test scope dependencies and their dependencies if they are not defined to be excluded, plus their transitive dependencies (again if they are not excluded).

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
IsolatedClassLoaderFactory()

Method Summary

Modifier and Type	Method and Description
protected org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader	createApplicationArtifactClassLoader(ClassLoader parent, org.mule.runtime.module.artifact.api.classloader.ClassLoaderLookupPolicy childClassLoaderLookupPolicy, ArtifactsUrlClassification artifactsUrlClassification, List<org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader> pluginsArtifactClassLoaders) Creates an ArtifactClassLoader for the application.
ArtifactClassLoaderHolder	createArtifactClassLoader(List<String> extraBootPackages, Set<String> extraPrivilegedArtifacts, ArtifactsUrlClassification artifactsUrlClassification) Creates a ArtifactClassLoaderHolder containing the container, plugins and application ArtifactClassLoaders
protected org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader	createContainerArtifactClassLoader(TestContainerClassLoaderFactory testContainerClassLoaderFactory, ArtifactsUrlClassification artifactsUrlClassification) Creates an ArtifactClassLoader for the container.
protected org.mule.runtime.module.artifact.api.classloader.MuleArtifactClassLoader	createLauncherArtifactClassLoader() Creates the launcher application class loader to delegate from container class loader.
protected List<org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader>	createServiceClassLoaders(ClassLoader parent, org.mule.runtime.module.artifact.api.classloader.ClassLoaderLookupPolicy childClassLoaderLookupPolicy, ArtifactsUrlClassification artifactsUrlClassification) For each service defined in the classification it creates an ArtifactClassLoader wit the name defined in classification.
protected void	logClassLoaderUrls(String classLoaderName, List<URL> urls) Logs the List of URLs for the classLoaderName

Methods inherited from class java.lang.Object

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

Constructor Detail

IsolatedClassLoaderFactory

public IsolatedClassLoaderFactory()

Method Detail

createArtifactClassLoader

public ArtifactClassLoaderHolder createArtifactClassLoader(List<String> extraBootPackages,
                                                           Set<String> extraPrivilegedArtifacts,
                                                           ArtifactsUrlClassification artifactsUrlClassification)

Creates a ArtifactClassLoaderHolder containing the container, plugins and application ArtifactClassLoaders

Parameters:

extraBootPackages - List of Strings of extra boot packages to be appended to the container ClassLoader

extraPrivilegedArtifacts - List of Strings of extra privileged artifacts. Each value needs to have the form groupId:versionId.

artifactsUrlClassification - the ArtifactsUrlClassification that defines the different URLs for each ClassLoader

Returns:

a ArtifactClassLoaderHolder that would be used to run the test

createServiceClassLoaders

protected List<org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader> createServiceClassLoaders(ClassLoader parent,
                                                                                                               org.mule.runtime.module.artifact.api.classloader.ClassLoaderLookupPolicy childClassLoaderLookupPolicy,
                                                                                                               ArtifactsUrlClassification artifactsUrlClassification)

For each service defined in the classification it creates an ArtifactClassLoader wit the name defined in classification.

Parameters:

parent - the parent class loader to be assigned to the new one created here

childClassLoaderLookupPolicy - look policy to be used

artifactsUrlClassification - the url classifications to get service URLs

Returns:

a list of ArtifactClassLoader for service class loaders

createContainerArtifactClassLoader

protected org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader createContainerArtifactClassLoader(TestContainerClassLoaderFactory testContainerClassLoaderFactory,
                                                                                                                  ArtifactsUrlClassification artifactsUrlClassification)

Creates an ArtifactClassLoader for the container. The difference between a mule container ArtifactClassLoader in standalone mode and this one is that it has to be aware that the parent class loader has all the URLs loaded in launcher app class loader so it has to create a particular look policy to resolve classes as CHILD_FIRST.

In order to do that a FilteringArtifactClassLoader resolve is created with and empty look policy (meaning that CHILD_FIRST strategy will be used) for the URLs that are going to be exposed from the container class loader. This would be the parent class loader for the container so instead of going directly the launcher application class loader that has access to the whole classpath this filtering class loader will resolve only the classes for the URLs defined to be in the container.

Parameters:

testContainerClassLoaderFactory - TestContainerClassLoaderFactory that has the logic to create a container class loader

artifactsUrlClassification - the classifications to get plugins URLs

Returns:

an ArtifactClassLoader for the container

createLauncherArtifactClassLoader

protected org.mule.runtime.module.artifact.api.classloader.MuleArtifactClassLoader createLauncherArtifactClassLoader()

Creates the launcher application class loader to delegate from container class loader.

Returns:

an ArtifactClassLoader for the launcher, parent of container

createApplicationArtifactClassLoader

protected org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader createApplicationArtifactClassLoader(ClassLoader parent,
                                                                                                                    org.mule.runtime.module.artifact.api.classloader.ClassLoaderLookupPolicy childClassLoaderLookupPolicy,
                                                                                                                    ArtifactsUrlClassification artifactsUrlClassification,
                                                                                                                    List<org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader> pluginsArtifactClassLoaders)

Creates an ArtifactClassLoader for the application.

Parameters:

parent - the parent class loader to be assigned to the new one created here

childClassLoaderLookupPolicy - look policy to be used

artifactsUrlClassification - the url classifications to get plugins urls

pluginsArtifactClassLoaders - the classloaders of the plugins used by the application

Returns:

the ArtifactClassLoader to be used for running the test

logClassLoaderUrls

protected void logClassLoaderUrls(String classLoaderName,
                                  List<URL> urls)

Logs the List of URLs for the classLoaderName

Parameters:

classLoaderName - the name of the ClassLoader to be logged

urls - List of URLs that are going to be used for the ClassLoader