org.mule.test.runner.api

Class ArtifactIsolatedClassLoaderBuilder

java.lang.Object

org.mule.test.runner.api.ArtifactIsolatedClassLoaderBuilder

public class ArtifactIsolatedClassLoaderBuilder
extends Object

Builds a class loading model that mimics the class loading model used in a standalone container. Useful for running applications or tests in a lightweight environment with isolation.

The builder could be set with different extension points:

• ClassPathUrlProvider: defines the initial classpath to be classified, it consists in a List of URL's
• ClassPathClassifier: classifies the classpath URLs and builds the List or URLs for each ClassLoader

The object built by this builder is a ArtifactClassLoaderHolder that references the ArtifactClassLoader for the application, plugins and container.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
ArtifactIsolatedClassLoaderBuilder()

Method Summary

Modifier and Type	Method and Description
ArtifactClassLoaderHolder	build() Builds the ArtifactClassLoaderHolder with the ArtifactClassLoaders for application, plugins and container.
ArtifactIsolatedClassLoaderBuilder	setApplicationUrls(List<URL> applicationUrls) Sets a List of URLs to be appended to the application ArtifactClassLoader in addition to the ones classified.
ArtifactIsolatedClassLoaderBuilder	setClassPathClassifier(ClassPathClassifier classPathClassifier) Sets the ClassPathClassifier implementation to be used by the builder.
ArtifactIsolatedClassLoaderBuilder	setClassPathUrlProvider(ClassPathUrlProvider classPathUrlProvider) Sets the ClassPathUrlProvider implementation to be used by the builder.
ArtifactIsolatedClassLoaderBuilder	setExcludedArtifacts(List<String> excludedArtifacts) Sets the Maven artifacts to be excluded from artifact class loaders created here due to they are going to be added as boot packages.
ArtifactIsolatedClassLoaderBuilder	setExportPluginClasses(List<Class> exportPluginClasses) Sets the List of Classes to be exported by rootArtifact (if it is a Mule plugin) in addition to their APIs, for testing purposes only.
ArtifactIsolatedClassLoaderBuilder	setExtensionMetadataGeneration(boolean extensionMetadataGenerationEnabled) Sets to true if while building the a plugin ArtifactClassLoader for an Extension the metadata should be generated.
ArtifactIsolatedClassLoaderBuilder	setExtraBootPackages(List<String> extraBootPackages) Sets the List of Strings containing the extra boot packages defined to be appended to the container in addition to the pre-defined ones.
ArtifactIsolatedClassLoaderBuilder	setPluginCoordinates(List<String> pluginCoordinates) Sets the List of Maven coordinates in format <groupId>:<artifactId> in order to create plugin ArtifactClassLoaders
ArtifactIsolatedClassLoaderBuilder	setPluginResourcesFolder(File pluginResourcesFolder) Sets the File where resources for classification will be created.
ArtifactIsolatedClassLoaderBuilder	setProvidedExclusions(List<String> providedExclusions) Sets Maven artifacts to be excluded from the provided scope direct dependencies of the rootArtifact.
ArtifactIsolatedClassLoaderBuilder	setProvidedInclusions(List<String> providedInclusions) Sets Maven artifacts to be explicitly included from the provided scope direct dependencies of the rootArtifact.
ArtifactIsolatedClassLoaderBuilder	setRootArtifactClassesFolder(File rootArtifactClassesFolder) Sets the File rootArtifactClassesFolder to be used by the classification process.
ArtifactIsolatedClassLoaderBuilder	setSharedPluginLibCoordinates(List<String> sharedPluginLibCoordinates) Sets the List of Maven coordinates in format <groupId>:<artifactId> in order to be added to the sharedLib ArtifactClassLoader
ArtifactIsolatedClassLoaderBuilder	setTestExclusions(List<String> testExclusions) Sets the List of exclusion Maven coordinates to be excluded from test dependencies of rootArtifact.
ArtifactIsolatedClassLoaderBuilder	setTestInclusions(List<String> testInclusions) Sets the List of inclusion Maven coordinates to be included from test dependencies of rootArtifact.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactIsolatedClassLoaderBuilder

public ArtifactIsolatedClassLoaderBuilder()

Method Detail

setPluginCoordinates

public ArtifactIsolatedClassLoaderBuilder setPluginCoordinates(List<String> pluginCoordinates)

Sets the List of Maven coordinates in format <groupId>:<artifactId> in order to create plugin ArtifactClassLoaders

Parameters:

pluginCoordinates - List of Maven coordinates in format <groupId>:<artifactId>

Returns:

this

setSharedPluginLibCoordinates

public ArtifactIsolatedClassLoaderBuilder setSharedPluginLibCoordinates(List<String> sharedPluginLibCoordinates)

Sets the List of Maven coordinates in format <groupId>:<artifactId> in order to be added to the sharedLib ArtifactClassLoader

Parameters:

sharedPluginLibCoordinates - List of Maven coordinates in format <groupId>:<artifactId>

Returns:

this

setClassPathClassifier

public ArtifactIsolatedClassLoaderBuilder setClassPathClassifier(ClassPathClassifier classPathClassifier)

Sets the ClassPathClassifier implementation to be used by the builder.

Parameters:

classPathClassifier - ClassPathClassifier implementation to be used by the builder.

Returns:

this

setClassPathUrlProvider

public ArtifactIsolatedClassLoaderBuilder setClassPathUrlProvider(ClassPathUrlProvider classPathUrlProvider)

Sets the ClassPathUrlProvider implementation to be used by the builder.

Parameters:

classPathUrlProvider - ClassPathUrlProvider implementation to be used by the builder.

Returns:

this

setRootArtifactClassesFolder

public ArtifactIsolatedClassLoaderBuilder setRootArtifactClassesFolder(File rootArtifactClassesFolder)

Sets the File rootArtifactClassesFolder to be used by the classification process.

Parameters:

rootArtifactClassesFolder - File rootArtifactClassesFolder to be used by the classification process.

Returns:

this

setPluginResourcesFolder

public ArtifactIsolatedClassLoaderBuilder setPluginResourcesFolder(File pluginResourcesFolder)

Sets the File where resources for classification will be created.

Parameters:

pluginResourcesFolder - File where resources for classification will be created.

Returns:

this

setExcludedArtifacts

public ArtifactIsolatedClassLoaderBuilder setExcludedArtifacts(List<String> excludedArtifacts)

Sets the Maven artifacts to be excluded from artifact class loaders created here due to they are going to be added as boot packages. In format [groupId]:[artifactId]:[extension]:[classifier]:[version].

Parameters:

excludedArtifacts - Maven artifacts to be excluded from artifact class loaders created here due to they are going to be added as boot packages. In format [groupId]:[artifactId]:[extension]:[classifier]:[version].

Returns:

this

setExtraBootPackages

public ArtifactIsolatedClassLoaderBuilder setExtraBootPackages(List<String> extraBootPackages)

Sets the List of Strings containing the extra boot packages defined to be appended to the container in addition to the pre-defined ones.

Parameters:

extraBootPackages - List of Strings containing the extra boot packages defined to be appended to the container in addition to the pre-defined ones.

Returns:

this

setProvidedExclusions

public ArtifactIsolatedClassLoaderBuilder setProvidedExclusions(List<String> providedExclusions)

Sets Maven artifacts to be excluded from the provided scope direct dependencies of the rootArtifact. In format [groupId]:[artifactId]:[extension]:[classifier]:[version].

setPluginCoordinates(List) Maven artifacts if declared will be considered to be excluded from being added as provided due to they are going to be added to its class loaders.

Parameters:

providedExclusions - Maven artifacts to be excluded from the provided scope direct dependencies of the rootArtifact. In format [groupId]:[artifactId]:[extension]:[classifier]:[version].

Returns:

this

setProvidedInclusions

public ArtifactIsolatedClassLoaderBuilder setProvidedInclusions(List<String> providedInclusions)

Sets Maven artifacts to be explicitly included from the provided scope direct dependencies of the rootArtifact. In format [groupId]:[artifactId]:[extension]:[classifier]:[version].

This artifacts have to be declared as provided scope in rootArtifact direct dependencies and no matter if they were excluded or not from setProvidedExclusions(List) and setPluginCoordinates(List). Meaning that the same artifact could ended up being added to the container class loader and as plugin.

Parameters:

providedInclusions -

Returns:

this

setTestExclusions

public ArtifactIsolatedClassLoaderBuilder setTestExclusions(List<String> testExclusions)

Sets the List of exclusion Maven coordinates to be excluded from test dependencies of rootArtifact. In format [groupId]:[artifactId]:[extension]:[classifier]:[version].

Parameters:

testExclusions - List of exclusion Maven coordinates to be excluded from test dependencies of rootArtifact. In format [groupId]:[artifactId]:[extension]:[classifier]:[version].

Returns:

this

setTestInclusions

public ArtifactIsolatedClassLoaderBuilder setTestInclusions(List<String> testInclusions)

Sets the List of inclusion Maven coordinates to be included from test dependencies of rootArtifact. In format [groupId]:[artifactId]:[extension]:[classifier]:[version].

Parameters:

testInclusions - List of inclusion Maven coordinates to be excluded from test dependencies of rootArtifact. In format [groupId]:[artifactId]:[extension]:[classifier]:[version].

Returns:

this

setExportPluginClasses

public ArtifactIsolatedClassLoaderBuilder setExportPluginClasses(List<Class> exportPluginClasses)

Sets the List of Classes to be exported by rootArtifact (if it is a Mule plugin) in addition to their APIs, for testing purposes only.

Parameters:

exportPluginClasses - of Classes to be exported by rootArtifact (if it is a Mule plugin) in addition to their APIs, for testing purposes only.

Returns:

this

setExtensionMetadataGeneration

public ArtifactIsolatedClassLoaderBuilder setExtensionMetadataGeneration(boolean extensionMetadataGenerationEnabled)

Sets to true if while building the a plugin ArtifactClassLoader for an Extension the metadata should be generated.

Parameters:

extensionMetadataGenerationEnabled - boolean to enable Extension metadata generation.

Returns:

this

setApplicationUrls

public ArtifactIsolatedClassLoaderBuilder setApplicationUrls(List<URL> applicationUrls)

Sets a List of URLs to be appended to the application ArtifactClassLoader in addition to the ones classified.

Parameters:

{@link - List} of URLs to be appended to the application ArtifactClassLoader in addition to the ones classified.

Returns:

this

build

public ArtifactClassLoaderHolder build()

Builds the ArtifactClassLoaderHolder with the ArtifactClassLoaders for application, plugins and container.

Returns:

a ArtifactClassLoaderHolder as output of the classification process.

Throws:

{@link - IOException} if there was an error while creating the classification context

{@link - NullPointerException} if any of the required attributes is not set to this builder