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

Class DeployableProjectModel

java.lang.Object

org.mule.runtime.module.artifact.activation.api.deployable.DeployableProjectModel

public final class DeployableProjectModel
extends Object

Represents the structure of a project, providing what is needed in order to create its ArtifactDescriptor with a DeployableArtifactDescriptorFactory.

Since:

4.5

Constructor Summary

Constructors

Constructor and Description

DeployableProjectModel(List<String> packages, List<String> resources, List<Path> resourcesPath, BundleDescriptor descriptor, Supplier<org.mule.runtime.api.deployment.meta.MuleDeployableModel> deployableModelSupplier, File projectFolder, List<BundleDependency> dependencies, Set<BundleDescriptor> sharedLibraries, Map<BundleDescriptor,List<BundleDependency>> additionalPluginDependencies) Creates a new instance with the provided parameters.

Method Summary

Modifier and Type	Method and Description
Map<BundleDescriptor,List<BundleDependency>>	getAdditionalPluginDependencies() These are dependencies that are added for each plugins.
List<BundleDependency>	getDependencies() These are the dependencies of the modeled project, regardless of the classifier.
org.mule.runtime.api.deployment.meta.MuleDeployableModel	getDeployableModel() Mule projects contain additional model information within the project itself (i.e.: mule-artifact.json file).
BundleDescriptor	getDescriptor() This contains the GAV of the modeled project.
List<String>	getPackages() These are the packages containing java classes in the modeled project.
File	getProjectFolder() This folder will be used to create the classloader for the deployable project.
List<String>	getResources() These are the resources in the modeled project.
List<Path>	getResourcesPath() These are the paths to the resources folders in the modeled project.
Set<BundleDescriptor>	getSharedLibraries() These are the descriptors of the dependencies of the modeled project that are visible to the plugins of this project.
void	validate() Performs a validation of consistency of the model fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployableProjectModel

public DeployableProjectModel(List<String> packages,
                              List<String> resources,
                              List<Path> resourcesPath,
                              BundleDescriptor descriptor,
                              Supplier<org.mule.runtime.api.deployment.meta.MuleDeployableModel> deployableModelSupplier,
                              File projectFolder,
                              List<BundleDependency> dependencies,
                              Set<BundleDescriptor> sharedLibraries,
                              Map<BundleDescriptor,List<BundleDependency>> additionalPluginDependencies)

Creates a new instance with the provided parameters.

Parameters:

packages - See getPackages()

resources - See getResources()

resourcesPath - See getResourcesPath()

descriptor - See getDescriptor()

deployableModelSupplier - See getDeployableModel()

projectFolder - See getProjectFolder()

dependencies - See getDependencies()

sharedLibraries - See getSharedLibraries()

additionalPluginDependencies - See additionalPluginDependencies

Method Detail

validate

public void validate()
              throws ArtifactActivationException

Performs a validation of consistency of the model fields. If any validation fails, an ArtifactActivationException is thrown indicating the situation that caused it.

Throws:

ArtifactActivationException - if there are consistency problems with the model fields.

getPackages

public List<String> getPackages()

These are the packages containing java classes in the modeled project.

This does not take into account the java packages of this project's dependencies.

Returns:

the java packages of the project.

getResources

public List<String> getResources()

These are the resources in the modeled project. These resources are located in one of the folders of resourcesPath.

This does not take into account the resources of this project's dependencies.

Returns:

the resources of the project.

getResourcesPath

public List<Path> getResourcesPath()

These are the paths to the resources folders in the modeled project.

Returns:

the resources of the project.

getDescriptor

public BundleDescriptor getDescriptor()

This contains the GAV of the modeled project.

Returns:

the descriptor of the artifact for this project.

getDeployableModel

public org.mule.runtime.api.deployment.meta.MuleDeployableModel getDeployableModel()

Mule projects contain additional model information within the project itself (i.e.: mule-artifact.json file). Calling this getter will trigger the loading of that additional data from within the project.

Returns:

the additional model information from this project.

getProjectFolder

public File getProjectFolder()

This folder will be used to create the classloader for the deployable project.

Temporary files related to this project will also be created within this directory.

Returns:

the folder where this deployable project is located.

getDependencies

public List<BundleDependency> getDependencies()

These are the dependencies of the modeled project, regardless of the classifier.

Returns:

the dependencies of the artifact for this project

getSharedLibraries

public Set<BundleDescriptor> getSharedLibraries()

These are the descriptors of the dependencies of the modeled project that are visible to the plugins of this project.

Elements contained in this set must exist in the BundleDependency.getDescriptor() of the dependencies.

Returns:

the shared libraries of the artifact for this project.

getAdditionalPluginDependencies

public Map<BundleDescriptor,List<BundleDependency>> getAdditionalPluginDependencies()

These are dependencies that are added for each plugins.

In each entry of this map, the dependencies in the value will be added to the plugin represented by the key.

Keys of this map must exist in the BundleDependency.getDescriptor() of the dependencies.

Returns:

the additional dependencies for the plugins of this project.