org.mule.runtime.module.artifact.activation.internal.classloader

Class DefaultArtifactClassLoaderResolver

java.lang.Object

org.mule.runtime.module.artifact.activation.internal.classloader.DefaultArtifactClassLoaderResolver

All Implemented Interfaces:

ArtifactClassLoaderResolver

public class DefaultArtifactClassLoaderResolver
extends Object
implements ArtifactClassLoaderResolver

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_CLASSLOADER_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
DefaultArtifactClassLoaderResolver(ArtifactClassLoader containerClassLoader, ModuleRepository moduleRepository, NativeLibraryFinderFactory nativeLibraryFinderFactory)

Method Summary

Modifier and Type	Method and Description
MuleDeployableArtifactClassLoader	createApplicationClassLoader(ApplicationDescriptor descriptor) Creates a class loader for an application.
MuleDeployableArtifactClassLoader	createApplicationClassLoader(ApplicationDescriptor descriptor, PluginClassLoaderResolver pluginClassLoaderResolver) Creates a class loader for an application.
MuleDeployableArtifactClassLoader	createApplicationClassLoader(ApplicationDescriptor descriptor, PluginClassLoaderResolver pluginClassLoaderResolver, List<URL> additionalClassloaderUrls) Creates a class loader for an application.
MuleDeployableArtifactClassLoader	createApplicationClassLoader(ApplicationDescriptor descriptor, Supplier<ArtifactClassLoader> domainClassLoader) Creates a class loader for an application.
MuleDeployableArtifactClassLoader	createApplicationClassLoader(ApplicationDescriptor descriptor, Supplier<ArtifactClassLoader> domainClassLoader, PluginClassLoaderResolver pluginClassLoaderResolver) Creates a class loader for an application.
MuleDeployableArtifactClassLoader	createApplicationClassLoader(ApplicationDescriptor descriptor, Supplier<ArtifactClassLoader> domainClassLoader, PluginClassLoaderResolver pluginClassLoaderResolver, List<URL> additionalClassloaderUrls) Creates a class loader for an application.
MuleDeployableArtifactClassLoader	createDomainClassLoader(DomainDescriptor descriptor) Creates a class loader for a domain.
MuleDeployableArtifactClassLoader	createDomainClassLoader(DomainDescriptor descriptor, PluginClassLoaderResolver pluginClassLoaderResolver) Creates a class loader for a domain.
MuleArtifactClassLoader	createMulePluginClassLoader(MuleDeployableArtifactClassLoader ownerArtifactClassLoader, ArtifactPluginDescriptor descriptor, PluginDescriptorResolver pluginDescriptorResolver) Creates a class loader for a plugin.
MuleArtifactClassLoader	createMulePluginClassLoader(MuleDeployableArtifactClassLoader ownerArtifactClassLoader, ArtifactPluginDescriptor descriptor, PluginDescriptorResolver pluginDescriptorResolver, PluginClassLoaderResolver pluginClassLoaderResolver) Creates a class loader for a plugin.
protected ClassLoaderLookupPolicy	createPluginLookupPolicy(ArtifactPluginDescriptor descriptor, MuleDeployableArtifactClassLoader ownerArtifactClassLoader, PluginDescriptorResolver pluginDescriptorResolver, PluginClassLoaderResolver pluginClassLoaderResolver)
static String	getApplicationId(String domainId, String applicationId)
static String	getDomainId(String domainName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.module.artifact.activation.api.classloader.ArtifactClassLoaderResolver

classLoaderResolver, defaultClassLoaderResolver

Field Detail

PLUGIN_CLASSLOADER_IDENTIFIER

public static final String PLUGIN_CLASSLOADER_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

DefaultArtifactClassLoaderResolver

public DefaultArtifactClassLoaderResolver(ArtifactClassLoader containerClassLoader,
                                          ModuleRepository moduleRepository,
                                          NativeLibraryFinderFactory nativeLibraryFinderFactory)

Method Detail

createDomainClassLoader

public MuleDeployableArtifactClassLoader createDomainClassLoader(DomainDescriptor descriptor)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for a domain. This will create the class loader itself and all of its internal required state: regionClassLoader, classLoaders for plugins.

The given descriptor must have its dependencies' exported packages sanitized (i.e. dependencies must not have packages that are already exported by their transitive dependencies nor any other dependency).

Specified by:

createDomainClassLoader in interface ArtifactClassLoaderResolver

Parameters:

descriptor - the descriptor of the domain to generate a class loader for.

Returns:

a class loader for a domain.

createDomainClassLoader

public MuleDeployableArtifactClassLoader createDomainClassLoader(DomainDescriptor descriptor,
                                                                 PluginClassLoaderResolver pluginClassLoaderResolver)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for a domain. This will create the class loader itself and all of its internal required state: regionClassLoader, classLoaders for plugins.

The given descriptor must have its dependencies' exported packages sanitized (i.e. dependencies must not have packages that are already exported by their transitive dependencies nor any other dependency).

Specified by:

createDomainClassLoader in interface ArtifactClassLoaderResolver

Parameters:

descriptor - the descriptor of the domain to generate a class loader for.

pluginClassLoaderResolver - allows the user to provide a class loader for the given plugin, otherwise it will be created.

Returns:

a class loader for a domain.

getDomainId

public static String getDomainId(String domainName)

Parameters:

domainName - name of the domain. Non empty.

Returns:

the unique identifier for the domain in the container.

createApplicationClassLoader

public MuleDeployableArtifactClassLoader createApplicationClassLoader(ApplicationDescriptor descriptor)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for an application. This will create the class loader itself and all of its internal required state: regionClassLoader, classLoaders for plugins.

The given descriptor must have its dependencies' exported packages sanitized (i.e. dependencies must not have packages that are already exported by their transitive dependencies nor any other dependency).

Specified by:

createApplicationClassLoader in interface ArtifactClassLoaderResolver

Parameters:

descriptor - the descriptor of the application to generate a class loader for.

Returns:

a class loader for an application.

createApplicationClassLoader

public MuleDeployableArtifactClassLoader createApplicationClassLoader(ApplicationDescriptor descriptor,
                                                                      PluginClassLoaderResolver pluginClassLoaderResolver)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for an application. This will create the class loader itself and all of its internal required state: regionClassLoader, classLoaders for plugins.

The given descriptor must have its dependencies' exported packages sanitized (i.e. dependencies must not have packages that are already exported by their transitive dependencies nor any other dependency).

Specified by:

createApplicationClassLoader in interface ArtifactClassLoaderResolver

Parameters:

descriptor - the descriptor of the application to generate a class loader for.

pluginClassLoaderResolver - allows the user to provide a class loader for the given plugin, otherwise it will be created.

Returns:

a class loader for an application.

createApplicationClassLoader

public MuleDeployableArtifactClassLoader createApplicationClassLoader(ApplicationDescriptor descriptor,
                                                                      PluginClassLoaderResolver pluginClassLoaderResolver,
                                                                      List<URL> additionalClassloaderUrls)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for an application. This will create the class loader itself and all of its internal required state: regionClassLoader, classLoaders for plugins.

The given descriptor must have its dependencies' exported packages sanitized (i.e. dependencies must not have packages that are already exported by their transitive dependencies nor any other dependency).

Specified by:

createApplicationClassLoader in interface ArtifactClassLoaderResolver

Parameters:

descriptor - the descriptor of the application to generate a class loader for.

pluginClassLoaderResolver - allows the user to provide a class loader for the given plugin, otherwise it will be created.

additionalClassloaderUrls - a list of URL pointing to additional resources and classes

Returns:

a class loader for an application.

createApplicationClassLoader

public MuleDeployableArtifactClassLoader createApplicationClassLoader(ApplicationDescriptor descriptor,
                                                                      Supplier<ArtifactClassLoader> domainClassLoader)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for an application. This will create the class loader itself and all of its internal required state: regionClassLoader, classLoaders for plugins.

The given descriptor must have its dependencies' exported packages sanitized (i.e. dependencies must not have packages that are already exported by their transitive dependencies nor any other dependency).

Specified by:

createApplicationClassLoader in interface ArtifactClassLoaderResolver

Parameters:

descriptor - the descriptor of the application to generate a class loader for.

domainClassLoader - the class loader of the domain the application belongs to.

Returns:

a class loader for an application.

createApplicationClassLoader

public MuleDeployableArtifactClassLoader createApplicationClassLoader(ApplicationDescriptor descriptor,
                                                                      Supplier<ArtifactClassLoader> domainClassLoader,
                                                                      PluginClassLoaderResolver pluginClassLoaderResolver)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for an application. This will create the class loader itself and all of its internal required state: regionClassLoader, classLoaders for plugins.

The given descriptor must have its dependencies' exported packages sanitized (i.e. dependencies must not have packages that are already exported by their transitive dependencies nor any other dependency).

Specified by:

createApplicationClassLoader in interface ArtifactClassLoaderResolver

Parameters:

descriptor - the descriptor of the application to generate a class loader for.

domainClassLoader - the class loader of the domain the application belongs to.

pluginClassLoaderResolver - allows the user to provide a class loader for the given plugin, otherwise it will be created.

Returns:

a class loader for an application.

createApplicationClassLoader

public MuleDeployableArtifactClassLoader createApplicationClassLoader(ApplicationDescriptor descriptor,
                                                                      Supplier<ArtifactClassLoader> domainClassLoader,
                                                                      PluginClassLoaderResolver pluginClassLoaderResolver,
                                                                      List<URL> additionalClassloaderUrls)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for an application. This will create the class loader itself and all of its internal required state: regionClassLoader, classLoaders for plugins.

The given descriptor must have its dependencies' exported packages sanitized (i.e. dependencies must not have packages that are already exported by their transitive dependencies nor any other dependency).

Specified by:

createApplicationClassLoader in interface ArtifactClassLoaderResolver

Parameters:

descriptor - the descriptor of the application to generate a class loader for.

domainClassLoader - the class loader of the domain the application belongs to.

pluginClassLoaderResolver - allows the user to provide a class loader for the given plugin, otherwise it will be created.

additionalClassloaderUrls - a list of URL pointing to additional resources and classes

Returns:

a class loader for an application.

getApplicationId

public static String getApplicationId(String domainId,
                                      String applicationId)

Parameters:

domainId - name of the domain where the application is deployed. Non empty.

applicationId - id of the application. Non empty.

Returns:

the unique identifier for the application in the container.

createMulePluginClassLoader

public MuleArtifactClassLoader createMulePluginClassLoader(MuleDeployableArtifactClassLoader ownerArtifactClassLoader,
                                                           ArtifactPluginDescriptor descriptor,
                                                           PluginDescriptorResolver pluginDescriptorResolver)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for a plugin.

The class loader for a plugin is based on the class loader of its owner artifact for some scenarios regarding exported packages/resources. For that reason, a class loader for a plugin in one application may be different from the same plugin in another application.

Specified by:

createMulePluginClassLoader in interface ArtifactClassLoaderResolver

Parameters:

ownerArtifactClassLoader - the class loader for the artifact that has the plugin dependency for the target class loader.

descriptor - the descriptor of the plugin to generate a class loader for.

pluginDescriptorResolver - a wrapper function around the logic to extract an ArtifactPluginDescriptor from the jar described by the BundleDescriptor. The function must return Optional.empty() if the plugin represented by the BundleDescriptor is not a dependency of the artifact for ownerArtifactClassLoader.

Returns:

a classloader for a plugin within a given application or domain.

createMulePluginClassLoader

public MuleArtifactClassLoader createMulePluginClassLoader(MuleDeployableArtifactClassLoader ownerArtifactClassLoader,
                                                           ArtifactPluginDescriptor descriptor,
                                                           PluginDescriptorResolver pluginDescriptorResolver,
                                                           PluginClassLoaderResolver pluginClassLoaderResolver)

Description copied from interface: ArtifactClassLoaderResolver

Creates a class loader for a plugin.

The class loader for a plugin is based on the class loader of its owner artifact for some scenarios regarding exported packages/resources. For that reason, a class loader for a plugin in one application may be different from the same plugin in another application.

Specified by:

createMulePluginClassLoader in interface ArtifactClassLoaderResolver

Parameters:

ownerArtifactClassLoader - the class loader for the artifact that has the plugin dependency for the target class loader.

descriptor - the descriptor of the plugin to generate a class loader for.

pluginDescriptorResolver - a wrapper function around the logic to extract an ArtifactPluginDescriptor from the jar described by the BundleDescriptor. The function must return Optional.empty() if the plugin represented by the BundleDescriptor is not a dependency of the artifact for ownerArtifactClassLoader.

pluginClassLoaderResolver - allows the user to provide a class loader for the given dependency plugin, otherwise it will be obtained from the owner artifact class loaders.

Returns:

a classloader for a plugin within a given application or domain.

createPluginLookupPolicy

protected ClassLoaderLookupPolicy createPluginLookupPolicy(ArtifactPluginDescriptor descriptor,
                                                           MuleDeployableArtifactClassLoader ownerArtifactClassLoader,
                                                           PluginDescriptorResolver pluginDescriptorResolver,
                                                           PluginClassLoaderResolver pluginClassLoaderResolver)