org.mule.runtime.module.artifact.api.descriptor

Class ClassLoaderConfiguration

java.lang.Object

org.mule.runtime.module.artifact.api.descriptor.ClassLoaderConfiguration

@NoExtend
public class ClassLoaderConfiguration
extends Object

Contains all the information needed to create a ClassLoader for a Mule artifact.

Since:

4.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassLoaderConfiguration.ClassLoaderConfigurationBuilder Builds a ClassLoaderConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static ClassLoaderConfiguration	NULL_CLASSLOADER_CONFIGURATION Defines a ClassLoaderConfiguration with empty configuration

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClassLoaderConfiguration(URL[] urls, Set<String> exportedPackages, Set<String> exportedResources, Set<String> localPackages, Set<String> localResources, Set<BundleDependency> dependencies, Set<String> privilegedExportedPackages, Set<String> privilegedArtifacts, boolean includeTestDependencies)

Method Summary

Modifier and Type	Method and Description
Set<BundleDependency>	getDependencies()
Set<String>	getExportedPackages()
Set<String>	getExportedResources()
Set<String>	getLocalPackages()
Set<String>	getLocalResources()
Set<String>	getPrivilegedArtifacts()
Set<String>	getPrivilegedExportedPackages()
URL[]	getUrls()
boolean	isIncludeTestDependencies()

Methods inherited from class java.lang.Object

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

Field Detail

NULL_CLASSLOADER_CONFIGURATION

public static final ClassLoaderConfiguration NULL_CLASSLOADER_CONFIGURATION

Defines a ClassLoaderConfiguration with empty configuration

Constructor Detail

ClassLoaderConfiguration

protected ClassLoaderConfiguration(URL[] urls,
                                   Set<String> exportedPackages,
                                   Set<String> exportedResources,
                                   Set<String> localPackages,
                                   Set<String> localResources,
                                   Set<BundleDependency> dependencies,
                                   Set<String> privilegedExportedPackages,
                                   Set<String> privilegedArtifacts,
                                   boolean includeTestDependencies)

Method Detail

getUrls

public URL[] getUrls()

Returns:

the URLs to use on the ClassLoader. Non-null.

getExportedPackages

public Set<String> getExportedPackages()

Returns:

the class packages to be exported on the ClassLoader. Non-null.

getExportedResources

public Set<String> getExportedResources()

Returns:

the resources to be exported on the ClassLoader. Non-null.

getLocalPackages

public Set<String> getLocalPackages()

Returns:

the Java packages to be loaded from the artifact itself, even if some other artifact in the region exports it. Non null

getLocalResources

public Set<String> getLocalResources()

Returns:

the resources to be loaded from the artifact itself, even if some other artifact in the region exports it. Non-null.

getDependencies

public Set<BundleDependency> getDependencies()

Returns:

the artifact dependencies required to create the ClassLoader. Non-null.

getPrivilegedExportedPackages

public Set<String> getPrivilegedExportedPackages()

Returns:

the Java package names to be exported as privileged API on the ClassLoader. Non-null.

getPrivilegedArtifacts

public Set<String> getPrivilegedArtifacts()

Returns:

the artifact IDs that have access to the privileged API defined on the ClassLoader. Each artifact is defined using Maven's groupId:artifactId. Non-null.

isIncludeTestDependencies

public boolean isIncludeTestDependencies()

Returns:

true if the configuration should include test scope dependencies when resolving the class loader urls for the artifact.