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

Class AbstractMavenClassLoaderModelLoader

java.lang.Object

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

All Implemented Interfaces:

ClassLoaderModelLoader, DescriptorLoader<ClassLoaderModel>

Direct Known Subclasses:

DeployableMavenClassLoaderModelLoader, PluginMavenClassLoaderModelLoader

public abstract class AbstractMavenClassLoaderModelLoader
extends Object
implements ClassLoaderModelLoader

Abstract implementation of ClassLoaderModelLoader that resolves the dependencies for all the mule artifacts and create the ClassLoaderModel. 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	CLASSLOADER_MODEL_JSON_DESCRIPTOR
static String	CLASSLOADER_MODEL_JSON_DESCRIPTOR_LOCATION
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractMavenClassLoaderModelLoader(org.mule.maven.client.api.MavenClient mavenClient, org.mule.maven.client.api.LocalRepositorySupplierFactory localRepositorySupplierFactory)

Method Summary

Modifier and Type	Method and Description
protected void	addArtifactSpecificClassloaderConfiguration(File artifactFile, ClassLoaderModel.ClassLoaderModelBuilder classLoaderModelBuilder, Set<BundleDependency> dependencies) Template method to add artifact specific configuration to the ClassLoaderModel.ClassLoaderModelBuilder
protected BundleDependency	convertBundleDependency(org.mule.maven.client.api.model.BundleDependency mavenClientDependency)
protected boolean	enabledTestDependencies() Template method to enable/disable test dependencies as part of the artifact classpath.
protected File	getClassLoaderModelDescriptor(File artifactFile)
String	getId()
ClassLoaderModel	load(File artifactFile) Loads the ClassLoaderModel from an artifact with the provided maven pom model.
ClassLoaderModel	load(File artifactFile, Map<String,Object> attributes, ArtifactType artifactType) Given an artifact location, it will resolve its dependencies on a Maven based mechanism.
protected org.apache.maven.model.Model	loadPomModel(File artifactFile) Template method to get the unresolved pom model from the artifact file
protected void	loadUrls(File artifactFile, ClassLoaderModel.ClassLoaderModelBuilder classLoaderModelBuilder, Set<BundleDependency> dependencies) Loads the URLs of the class loader for this artifact.

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_DESCRIPTOR_LOCATION

public static final String CLASSLOADER_MODEL_JSON_DESCRIPTOR_LOCATION

logger

protected final org.slf4j.Logger logger

Constructor Detail

AbstractMavenClassLoaderModelLoader

public AbstractMavenClassLoaderModelLoader(org.mule.maven.client.api.MavenClient mavenClient,
                                           org.mule.maven.client.api.LocalRepositorySupplierFactory localRepositorySupplierFactory)

Method Detail

getId

public String getId()

Specified by:

getId in interface DescriptorLoader<ClassLoaderModel>

load

public final ClassLoaderModel 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 ClassLoaderModel, 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 ClassLoaderModel which packages and/or resources has to export, consuming the attributes from the MuleArtifactLoaderDescriptor.getAttributes() map.

Specified by:

load in interface DescriptorLoader<ClassLoaderModel>

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 ClassLoaderModel loaded with all its dependencies and URLs.

Throws:

InvalidDescriptorLoaderException

getClassLoaderModelDescriptor

protected File getClassLoaderModelDescriptor(File artifactFile)

convertBundleDependency

protected BundleDependency convertBundleDependency(org.mule.maven.client.api.model.BundleDependency mavenClientDependency)

load

public final ClassLoaderModel load(File artifactFile)
                            throws InvalidDescriptorLoaderException

Loads the ClassLoaderModel from an artifact with the provided maven pom model.

Parameters:

artifactFile - the artifact folder

Returns:

a ClassLoaderModel loaded with all its dependencies and URLs.

Throws:

InvalidDescriptorLoaderException

loadPomModel

protected org.apache.maven.model.Model loadPomModel(File artifactFile)

Template method to get the unresolved pom model from the artifact file

Parameters:

artifactFile - the artifact file

Returns:

the pom model

loadUrls

protected void loadUrls(File artifactFile,
                        ClassLoaderModel.ClassLoaderModelBuilder classLoaderModelBuilder,
                        Set<BundleDependency> dependencies)

Loads the URLs of the class loader for this artifact.

It let's implementations to add artifact specific URLs by letting them override addArtifactSpecificClassloaderConfiguration(File, ClassLoaderModel.ClassLoaderModelBuilder, Set)

Parameters:

artifactFile - the artifact file for which the ClassLoaderModel is being generated.

classLoaderModelBuilder - the builder of the ClassLoaderModel

dependencies - the dependencies resolved for this artifact.

enabledTestDependencies

protected boolean enabledTestDependencies()

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 void addArtifactSpecificClassloaderConfiguration(File artifactFile,
                                                           ClassLoaderModel.ClassLoaderModelBuilder classLoaderModelBuilder,
                                                           Set<BundleDependency> dependencies)

Template method to add artifact specific configuration to the ClassLoaderModel.ClassLoaderModelBuilder

Parameters:

artifactFile - the artifact file from which the classloader model is generated.

classLoaderModelBuilder - the builder used to generate ClassLoaderModel of the artifact.

dependencies - the set of dependencies of the artifact.