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

Class ClassLoaderConfiguration.ClassLoaderConfigurationBuilder

java.lang.Object

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

Enclosing class:

ClassLoaderConfiguration

public static class ClassLoaderConfiguration.ClassLoaderConfigurationBuilder
extends Object

Builds a ClassLoaderConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<BundleDependency>	dependencies

Constructor Summary

Constructors

Constructor and Description
ClassLoaderConfigurationBuilder() Creates an empty builder.
ClassLoaderConfigurationBuilder(ClassLoaderConfiguration source) Creates a builder initialized with a ClassLoaderConfiguration's state

Method Summary

Modifier and Type	Method and Description
ClassLoaderConfiguration	build() Creates a ClassLoaderConfiguration with the current configuration.
ClassLoaderConfiguration.ClassLoaderConfigurationBuilder	containing(List<URL> urls) Adds URLs to the configuration.
ClassLoaderConfiguration.ClassLoaderConfigurationBuilder	containing(URL url) Adds an URL to the configuration.
ClassLoaderConfiguration.ClassLoaderConfigurationBuilder	dependingOn(Set<BundleDependency> dependencies) Indicates which dependencies are required for this configuration.
protected ClassLoaderConfiguration	doBuild() Builds the configuration.
ClassLoaderConfiguration.ClassLoaderConfigurationBuilder	exportingPackages(Set<String> packages) Indicates which package are exported on the configuration.
ClassLoaderConfiguration.ClassLoaderConfigurationBuilder	exportingPrivilegedPackages(Set<String> packages, Set<String> artifactIds) Indicates which Java packages are exported as privileged API on the configuration.
ClassLoaderConfiguration.ClassLoaderConfigurationBuilder	exportingResources(Set<String> resources) Indicates which resource are exported on the configuration.
protected Boolean	getIncludeTestDependencies()
protected Set<String>	getLocalPackages()
protected Set<String>	getLocalResources()
protected Set<String>	getPackages()
protected Set<String>	getPrivilegedArtifacts()
protected Set<String>	getPrivilegedExportedPackages()
protected Set<String>	getResources()
protected List<URL>	getUrls()
ClassLoaderConfiguration.ClassLoaderConfigurationBuilder	includeTestDependencies(boolean includeTestDependencies) Sets this configuration to include test dependencies on class loader URL resolution.
ClassLoaderConfiguration.ClassLoaderConfigurationBuilder	withLocalPackages(Set<String> packages) Indicates which Java packages are loaded from the artifact itself, even if some other artifact in the region exports it.
ClassLoaderConfiguration.ClassLoaderConfigurationBuilder	withLocalResources(Set<String> resources) Indicates which resources are loaded from the artifact itself, even if some other artifact in the region exports it.

Methods inherited from class java.lang.Object

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

Field Detail

dependencies

protected Set<BundleDependency> dependencies

Constructor Detail

ClassLoaderConfigurationBuilder

public ClassLoaderConfigurationBuilder()

Creates an empty builder.

ClassLoaderConfigurationBuilder

public ClassLoaderConfigurationBuilder(ClassLoaderConfiguration source)

Creates a builder initialized with a ClassLoaderConfiguration's state

Parameters:

source - used to initialize the created object. Non-null.

Method Detail

exportingPackages

public ClassLoaderConfiguration.ClassLoaderConfigurationBuilder exportingPackages(Set<String> packages)

Indicates which package are exported on the configuration.

Parameters:

packages - packages to export. Non-null.

Returns:

same builder instance.

exportingResources

public ClassLoaderConfiguration.ClassLoaderConfigurationBuilder exportingResources(Set<String> resources)

Indicates which resource are exported on the configuration.

Parameters:

resources - resources to export. Non-null.

Returns:

same builder instance.

withLocalPackages

public ClassLoaderConfiguration.ClassLoaderConfigurationBuilder withLocalPackages(Set<String> packages)

Indicates which Java packages are loaded from the artifact itself, even if some other artifact in the region exports it.

The reason to use this is a that if a plugin internally uses a certain version of a lib, providing certain packages, another plugin exporting some of those packages must not modify the inner implementation used by the first plugin.

Parameters:

packages - packages to not import. Non-null.

Returns:

same builder instance.

withLocalResources

public ClassLoaderConfiguration.ClassLoaderConfigurationBuilder withLocalResources(Set<String> resources)

Indicates which resources are loaded from the artifact itself, even if some other artifact in the region exports it.

The reason to use this is a that if a plugin internally uses a certain version of a lib, providing certain packages, another plugin exporting some of those packages must not modify the inner implementation used by the first plugin.

Parameters:

resources - resources to not import. Non-null.

Returns:

same builder instance.

exportingPrivilegedPackages

public ClassLoaderConfiguration.ClassLoaderConfigurationBuilder exportingPrivilegedPackages(Set<String> packages,
                                                                                            Set<String> artifactIds)

Indicates which Java packages are exported as privileged API on the configuration.

Parameters:

packages - Java packages names to export. Non-null.

artifactIds - artifact IDs that have access to the privileged API. No null.

Returns:

same builder instance.

dependingOn

public ClassLoaderConfiguration.ClassLoaderConfigurationBuilder dependingOn(Set<BundleDependency> dependencies)

Indicates which dependencies are required for this configuration.

Parameters:

dependencies - dependencies on which the configuration depends on. Non-null.

Returns:

same builder instance.

containing

public ClassLoaderConfiguration.ClassLoaderConfigurationBuilder containing(URL url)

Adds an URL to the configuration.

Parameters:

url - indicates which resource to add. Non-null.

Returns:

same builder instance.

containing

public ClassLoaderConfiguration.ClassLoaderConfigurationBuilder containing(List<URL> urls)

Adds URLs to the configuration.

Parameters:

urls - indicates which resources to add. Non-null.

Returns:

same builder instance.

includeTestDependencies

public ClassLoaderConfiguration.ClassLoaderConfigurationBuilder includeTestDependencies(boolean includeTestDependencies)

Sets this configuration to include test dependencies on class loader URL resolution.

Parameters:

includeTestDependencies - true to include test dependencies.

Returns:

same builder instance.

getPackages

protected Set<String> getPackages()

getResources

protected Set<String> getResources()

getLocalPackages

protected Set<String> getLocalPackages()

getLocalResources

protected Set<String> getLocalResources()

getUrls

protected List<URL> getUrls()

getPrivilegedExportedPackages

protected Set<String> getPrivilegedExportedPackages()

getPrivilegedArtifacts

protected Set<String> getPrivilegedArtifacts()

getIncludeTestDependencies

protected Boolean getIncludeTestDependencies()

build

public ClassLoaderConfiguration build()

Creates a ClassLoaderConfiguration with the current configuration.

Returns:

a non-null ClassLoaderConfiguration.

doBuild

protected ClassLoaderConfiguration doBuild()

Builds the configuration.