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

Interface ArtifactClassLoaderResolver

All Known Implementing Classes:

DefaultArtifactClassLoaderResolver

@NoImplement
public interface ArtifactClassLoaderResolver

Provides a way to create classLoaders for different artifact types.

Since:

4.5

Method Summary

Modifier and Type	Method and Description
static ArtifactClassLoaderResolver	classLoaderResolver(ModuleRepository moduleRepository, Function<String,File> tempFolderChildFunction)
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, 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	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.
static ArtifactClassLoaderResolver	defaultClassLoaderResolver()

Method Detail

defaultClassLoaderResolver

static ArtifactClassLoaderResolver defaultClassLoaderResolver()

classLoaderResolver

static ArtifactClassLoaderResolver classLoaderResolver(ModuleRepository moduleRepository,
                                                       Function<String,File> tempFolderChildFunction)

createDomainClassLoader

MuleDeployableArtifactClassLoader createDomainClassLoader(DomainDescriptor descriptor)

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).

Parameters:

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

Returns:

a class loader for a domain.

createDomainClassLoader

MuleDeployableArtifactClassLoader createDomainClassLoader(DomainDescriptor descriptor,
                                                          PluginClassLoaderResolver pluginClassLoaderResolver)

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).

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.

createApplicationClassLoader

MuleDeployableArtifactClassLoader createApplicationClassLoader(ApplicationDescriptor descriptor)

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).

Parameters:

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

Returns:

a class loader for an application.

createApplicationClassLoader

MuleDeployableArtifactClassLoader createApplicationClassLoader(ApplicationDescriptor descriptor,
                                                               PluginClassLoaderResolver pluginClassLoaderResolver)

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).

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

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

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).

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

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

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).

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.

createMulePluginClassLoader

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

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.

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

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

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.

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.