org.mule.runtime.module.deployment.impl.internal.maven

Class AbstractMavenClassLoaderConfigurationLoader

java.lang.Object

org.mule.runtime.module.deployment.impl.internal.maven.AbstractMavenClassLoaderConfigurationLoader

All Implemented Interfaces:

ClassLoaderConfigurationLoader, DescriptorLoader<ClassLoaderConfiguration>

Direct Known Subclasses:

DeployableMavenClassLoaderConfigurationLoader, PluginMavenClassLoaderConfigurationLoader

public abstract class AbstractMavenClassLoaderConfigurationLoader
extends Object
implements ClassLoaderConfigurationLoader

Abstract implementation of ClassLoaderConfigurationLoader that resolves the dependencies for all the mule artifacts and create the ClassLoaderConfiguration. It lets the implementations of this class to add artifact's specific class loader URLs

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_LOADER_MODEL_VERSION_120
static String	CLASSLOADER_MODEL_JSON_DESCRIPTOR
static String	CLASSLOADER_MODEL_JSON_DESCRIPTOR_LOCATION
static String	CLASSLOADER_MODEL_JSON_PATCH_DESCRIPTOR
static String	CLASSLOADER_MODEL_JSON_PATCH_DESCRIPTOR_LOCATION
static String	CLASSLOADER_MODEL_MAVEN_REACTOR_RESOLVER
protected org.slf4j.Logger	LOGGER
static String	MULE_ARTIFACT_PATCH_JSON_FILE_NAME
static String	MULE_ARTIFACT_PATCHES_LOCATION

Constructor Summary

Constructors

Constructor and Description
AbstractMavenClassLoaderConfigurationLoader(Optional<org.mule.maven.client.api.MavenClient> mavenClient)
AbstractMavenClassLoaderConfigurationLoader(Optional<org.mule.maven.client.api.MavenClient> mavenClient, Supplier<JarExplorer> jarExplorerFactory)

Method Summary

Modifier and Type	Method and Description
protected List<URL>	addArtifactSpecificClassloaderConfiguration(ArtifactClassLoaderConfigurationBuilder classLoaderConfigurationBuilder) Template method to add artifact specific configuration to the ClassLoaderConfiguration.ClassLoaderConfigurationBuilder
protected ClassLoaderConfiguration	createClassLoaderConfiguration(File artifactFile, Map<String,Object> attributes, ArtifactType artifactType)
protected ClassLoaderConfiguration	createHeavyPackageClassLoaderConfiguration(File artifactFile, File classLoaderModelDescriptor, Map<String,Object> attributes, Optional<File> deployableArtifactRepositoryFolder)
protected ClassLoaderConfiguration	createHeavyPackageClassLoaderConfiguration(File artifactFile, Map<String,Object> attributes, Optional<File> deployableArtifactRepositoryFolder, org.mule.tools.api.classloader.model.ClassLoaderModel packagerClassLoaderModel)
protected ClassLoaderConfiguration	createLightPackageClassLoaderConfiguration(File artifactFile, Map<String,Object> attributes, ArtifactType artifactType, org.mule.maven.client.api.MavenClient mavenClient)
protected File	getClassLoaderModelDescriptor(File artifactFile)
protected File	getClassLoaderModelPatchDescriptor(File artifactFile)
String	getId()
protected Optional<File>	getLocalMavenRepo(File artifactFile, org.mule.maven.client.api.MavenClient mavenClient)
protected abstract org.mule.tools.api.classloader.model.ClassLoaderModel	getPackagerClassLoaderModel(File classLoaderModelDescriptor) Template method to deserialize a classloader-model.json into the expected ClassLoaderModel implementation
protected abstract boolean	includeProvidedDependencies(ArtifactType artifactType)
protected boolean	includeTestDependencies(Map<String,Object> attributes) Template method to enable/disable test dependencies as part of the artifact classpath.
protected boolean	isHeavyPackage(File artifactFile, Map<String,Object> attributes)
ClassLoaderConfiguration	load(File artifactFile, Map<String,Object> attributes, ArtifactType artifactType) Given an artifact location, it will resolve its dependencies on a Maven based mechanism.
protected abstract HeavyweightClassLoaderConfigurationBuilder	newHeavyWeightClassLoaderConfigurationBuilder(File artifactFile, BundleDescriptor artifactBundleDescriptor, org.mule.tools.api.classloader.model.ClassLoaderModel packagerClassLoaderModel, Map<String,Object> attributes)
protected abstract LightweightClassLoaderConfigurationBuilder	newLightweightClassLoaderConfigurationBuilder(File artifactFile, BundleDescriptor bundleDescriptor, org.mule.maven.client.api.MavenClient mavenClient, Map<String,Object> attributes, List<BundleDependency> nonProvidedDependencies)
protected void	populateLocalPackages(org.mule.runtime.module.deployment.impl.internal.maven.ArtifactAttributes artifactAttributes, ArtifactClassLoaderConfigurationBuilder classLoaderConfigurationBuilder)
protected List<BundleDependency>	resolveArtifactDependencies(File artifactFile, Map<String,Object> attributes, ArtifactType artifactType, org.mule.maven.client.api.MavenClient mavenClient)
protected boolean	validateMuleRuntimeSharedLibrary(String groupId, String artifactId, String artifactFileName)

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.api.descriptor.DescriptorLoader

supportsArtifactType

Field Detail

CLASSLOADER_MODEL_JSON_DESCRIPTOR

public static final String CLASSLOADER_MODEL_JSON_DESCRIPTOR

See Also:

Constant Field Values

CLASSLOADER_MODEL_JSON_PATCH_DESCRIPTOR

public static final String CLASSLOADER_MODEL_JSON_PATCH_DESCRIPTOR

See Also:

Constant Field Values

CLASSLOADER_MODEL_JSON_DESCRIPTOR_LOCATION

public static final String CLASSLOADER_MODEL_JSON_DESCRIPTOR_LOCATION

CLASSLOADER_MODEL_JSON_PATCH_DESCRIPTOR_LOCATION

public static final String CLASSLOADER_MODEL_JSON_PATCH_DESCRIPTOR_LOCATION

MULE_ARTIFACT_PATCHES_LOCATION

public static final String MULE_ARTIFACT_PATCHES_LOCATION

MULE_ARTIFACT_PATCH_JSON_FILE_NAME

public static final String MULE_ARTIFACT_PATCH_JSON_FILE_NAME

See Also:

Constant Field Values

CLASSLOADER_MODEL_MAVEN_REACTOR_RESOLVER

public static final String CLASSLOADER_MODEL_MAVEN_REACTOR_RESOLVER

See Also:

Constant Field Values

CLASS_LOADER_MODEL_VERSION_120

public static final String CLASS_LOADER_MODEL_VERSION_120

See Also:

Constant Field Values

LOGGER

protected final org.slf4j.Logger LOGGER

Constructor Detail

AbstractMavenClassLoaderConfigurationLoader

public AbstractMavenClassLoaderConfigurationLoader(Optional<org.mule.maven.client.api.MavenClient> mavenClient)

AbstractMavenClassLoaderConfigurationLoader

public AbstractMavenClassLoaderConfigurationLoader(Optional<org.mule.maven.client.api.MavenClient> mavenClient,
                                                   Supplier<JarExplorer> jarExplorerFactory)

Method Detail

getId

public String getId()

Specified by:

getId in interface DescriptorLoader<ClassLoaderConfiguration>

load

public final ClassLoaderConfiguration load(File artifactFile,
                                           Map<String,Object> attributes,
                                           ArtifactType artifactType)
                                    throws InvalidDescriptorLoaderException

Given an artifact location, it will resolve its dependencies on a Maven based mechanism. It will assume there's a repository folder to look for the artifacts in it (which includes both JAR files as well as POM ones).

It takes care of the transitive compile and runtime dependencies, from which will take the URLs to add them to the resulting ClassLoaderConfiguration, and it will also consume all Mule plugin dependencies so that further validations can check whether or not all plugins are loaded in memory before running an application.

Finally, it will also tell the resulting ClassLoaderConfiguration which packages and/or resources has to export, consuming the attributes from the MuleArtifactLoaderDescriptor.getAttributes() map.

Specified by:

load in interface DescriptorLoader<ClassLoaderConfiguration>

Parameters:

artifactFile - File where the current plugin to work with.

attributes - a set of attributes to work with, where the current implementation of this class will look for ArtifactDescriptorConstants.EXPORTED_PACKAGES and ArtifactDescriptorConstants.EXPORTED_RESOURCES

Returns:

a ClassLoaderConfiguration loaded with all its dependencies and URLs.

Throws:

InvalidDescriptorLoaderException

createClassLoaderConfiguration

protected final ClassLoaderConfiguration createClassLoaderConfiguration(File artifactFile,
                                                                        Map<String,Object> attributes,
                                                                        ArtifactType artifactType)
                                                                 throws InvalidDescriptorLoaderException

Throws:

InvalidDescriptorLoaderException

createHeavyPackageClassLoaderConfiguration

protected ClassLoaderConfiguration createHeavyPackageClassLoaderConfiguration(File artifactFile,
                                                                              File classLoaderModelDescriptor,
                                                                              Map<String,Object> attributes,
                                                                              Optional<File> deployableArtifactRepositoryFolder)

createHeavyPackageClassLoaderConfiguration

protected ClassLoaderConfiguration createHeavyPackageClassLoaderConfiguration(File artifactFile,
                                                                              Map<String,Object> attributes,
                                                                              Optional<File> deployableArtifactRepositoryFolder,
                                                                              org.mule.tools.api.classloader.model.ClassLoaderModel packagerClassLoaderModel)

getPackagerClassLoaderModel

protected abstract org.mule.tools.api.classloader.model.ClassLoaderModel getPackagerClassLoaderModel(File classLoaderModelDescriptor)

Template method to deserialize a classloader-model.json into the expected ClassLoaderModel implementation

Parameters:

classLoaderModelDescriptor -

Returns:

a ClassLoaderModel

isHeavyPackage

protected boolean isHeavyPackage(File artifactFile,
                                 Map<String,Object> attributes)

getClassLoaderModelDescriptor

protected File getClassLoaderModelDescriptor(File artifactFile)

getClassLoaderModelPatchDescriptor

protected File getClassLoaderModelPatchDescriptor(File artifactFile)

resolveArtifactDependencies

protected List<BundleDependency> resolveArtifactDependencies(File artifactFile,
                                                             Map<String,Object> attributes,
                                                             ArtifactType artifactType,
                                                             org.mule.maven.client.api.MavenClient mavenClient)

getLocalMavenRepo

protected final Optional<File> getLocalMavenRepo(File artifactFile,
                                                 org.mule.maven.client.api.MavenClient mavenClient)

createLightPackageClassLoaderConfiguration

protected ClassLoaderConfiguration createLightPackageClassLoaderConfiguration(File artifactFile,
                                                                              Map<String,Object> attributes,
                                                                              ArtifactType artifactType,
                                                                              org.mule.maven.client.api.MavenClient mavenClient)

newLightweightClassLoaderConfigurationBuilder

protected abstract LightweightClassLoaderConfigurationBuilder newLightweightClassLoaderConfigurationBuilder(File artifactFile,
                                                                                                            BundleDescriptor bundleDescriptor,
                                                                                                            org.mule.maven.client.api.MavenClient mavenClient,
                                                                                                            Map<String,Object> attributes,
                                                                                                            List<BundleDependency> nonProvidedDependencies)

newHeavyWeightClassLoaderConfigurationBuilder

protected abstract HeavyweightClassLoaderConfigurationBuilder newHeavyWeightClassLoaderConfigurationBuilder(File artifactFile,
                                                                                                            BundleDescriptor artifactBundleDescriptor,
                                                                                                            org.mule.tools.api.classloader.model.ClassLoaderModel packagerClassLoaderModel,
                                                                                                            Map<String,Object> attributes)

populateLocalPackages

protected void populateLocalPackages(org.mule.runtime.module.deployment.impl.internal.maven.ArtifactAttributes artifactAttributes,
                                     ArtifactClassLoaderConfigurationBuilder classLoaderConfigurationBuilder)

includeProvidedDependencies

protected abstract boolean includeProvidedDependencies(ArtifactType artifactType)

validateMuleRuntimeSharedLibrary

protected final boolean validateMuleRuntimeSharedLibrary(String groupId,
                                                         String artifactId,
                                                         String artifactFileName)

includeTestDependencies

protected boolean includeTestDependencies(Map<String,Object> attributes)

Template method to enable/disable test dependencies as part of the artifact classpath.

Returns:

true if test dependencies must be part of the artifact classpath, false otherwise.

addArtifactSpecificClassloaderConfiguration

protected List<URL> addArtifactSpecificClassloaderConfiguration(ArtifactClassLoaderConfigurationBuilder classLoaderConfigurationBuilder)

Template method to add artifact specific configuration to the ClassLoaderConfiguration.ClassLoaderConfigurationBuilder

Parameters:

classLoaderConfigurationBuilder - the builder used to generate ClassLoaderConfiguration of the artifact.