org.mule.runtime.deployment.model.api.plugin

Class ArtifactPluginDescriptor

java.lang.Object

org.mule.runtime.module.artifact.api.descriptor.ArtifactDescriptor

org.mule.runtime.deployment.model.api.DeployableArtifactDescriptor

org.mule.runtime.deployment.model.api.plugin.ArtifactPluginDescriptor

public final class ArtifactPluginDescriptor
extends DeployableArtifactDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_BUNDLE_TYPE
static String	MULE_ARTIFACT_PATH_INSIDE_JAR Target path as URL for any files used at deployment time or when generating the ExtensionModel
static String	MULE_AUTO_GENERATED_ARTIFACT_PATH_INSIDE_JAR
static String	MULE_PLUGIN_CLASSIFIER
static String	MULE_PLUGIN_POM

Fields inherited from class org.mule.runtime.deployment.model.api.DeployableArtifactDescriptor

DEFAULT_DEPLOY_PROPERTIES_RESOURCE, PROPERTY_CONFIG_RESOURCES, PROPERTY_REDEPLOYMENT_ENABLED

Fields inherited from class org.mule.runtime.module.artifact.api.descriptor.ArtifactDescriptor

MULE_ARTIFACT_FOLDER, MULE_ARTIFACT_JSON_DESCRIPTOR, MULE_ARTIFACT_JSON_DESCRIPTOR_LOCATION

Constructor Summary

Constructors

Constructor and Description
ArtifactPluginDescriptor(String name) Creates a new artifact plugin descriptor
ArtifactPluginDescriptor(String name, Optional<Properties> deploymentProperties) Creates a new artifact plugin descriptor

Method Summary

Modifier and Type	Method and Description
Optional<LoaderDescriber>	getExtensionModelDescriptorProperty()
Optional<org.mule.runtime.api.deployment.meta.LicenseModel>	getLicenseModel()
void	setExtensionModelDescriptorProperty(LoaderDescriber extensionModelLoaderDescriber) Takes a LoaderDescriber that should contain the values used to properly initialize an ExtensionModel
void	setLicenseModel(org.mule.runtime.api.deployment.meta.LicenseModel licenseModel)

Methods inherited from class org.mule.runtime.deployment.model.api.DeployableArtifactDescriptor

getArtifactLocation, getConfigResources, getDataFolderName, getDefaultConfigResources, getDescriptorFile, getPlugins, isRedeploymentEnabled, setArtifactLocation, setConfigResources, setPlugins, setRedeploymentEnabled

Methods inherited from class org.mule.runtime.module.artifact.api.descriptor.ArtifactDescriptor

getBundleDescriptor, getClassLoaderModel, getDeploymentProperties, getMinMuleVersion, getName, getRequiredProduct, getRootFolder, setBundleDescriptor, setClassLoaderModel, setMinMuleVersion, setRequiredProduct, setRootFolder, toString

Methods inherited from class java.lang.Object

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

Field Detail

MULE_PLUGIN_CLASSIFIER

public static final String MULE_PLUGIN_CLASSIFIER

See Also:

Constant Field Values

EXTENSION_BUNDLE_TYPE

public static final String EXTENSION_BUNDLE_TYPE

See Also:

Constant Field Values

MULE_ARTIFACT_PATH_INSIDE_JAR

public static final String MULE_ARTIFACT_PATH_INSIDE_JAR

Target path as URL for any files used at deployment time or when generating the ExtensionModel

See Also:

Constant Field Values

MULE_AUTO_GENERATED_ARTIFACT_PATH_INSIDE_JAR

public static final String MULE_AUTO_GENERATED_ARTIFACT_PATH_INSIDE_JAR

See Also:

Constant Field Values

MULE_PLUGIN_POM

public static final String MULE_PLUGIN_POM

See Also:

Constant Field Values

Constructor Detail

ArtifactPluginDescriptor

public ArtifactPluginDescriptor(String name)

Creates a new artifact plugin descriptor

Parameters:

name - artifact plugin name. Non empty.

ArtifactPluginDescriptor

public ArtifactPluginDescriptor(String name,
                                Optional<Properties> deploymentProperties)

Creates a new artifact plugin descriptor

Parameters:

name - artifact plugin name. Non empty.

deploymentProperties - deployment properties provided for the plugin

Method Detail

getExtensionModelDescriptorProperty

public Optional<LoaderDescriber> getExtensionModelDescriptorProperty()

Returns:

the LoaderDescriber that will contain all mandatory values to generate an ExtensionModel from it.

setExtensionModelDescriptorProperty

public void setExtensionModelDescriptorProperty(LoaderDescriber extensionModelLoaderDescriber)

Takes a LoaderDescriber that should contain the values used to properly initialize an ExtensionModel

Parameters:

extensionModelLoaderDescriber - the LoaderDescriber with the values

getLicenseModel

public Optional<org.mule.runtime.api.deployment.meta.LicenseModel> getLicenseModel()

Returns:

the license requirements for this plugin. Empty if there are not license requirements.

setLicenseModel

public void setLicenseModel(org.mule.runtime.api.deployment.meta.LicenseModel licenseModel)

Parameters:

licenseModel - the license requirements for this plugin.