org.mule.runtime.api.deployment.meta

Class MuleDeployableModel

java.lang.Object

org.mule.runtime.api.deployment.meta.AbstractMuleArtifactModel

org.mule.runtime.api.deployment.meta.MuleDeployableModel

Direct Known Subclasses:

MuleApplicationModel, MuleDomainModel

@NoExtend
public abstract class MuleDeployableModel
extends AbstractMuleArtifactModel

Base class for defining models for deployable artifacts.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MuleDeployableModel.MuleDeployableModelBuilder<T extends AbstractMuleArtifactModelBuilder,M extends MuleDeployableModel> A builder to create instances of MuleDeployableModel.MuleDeployableModelBuilder.

Field Summary

Fields inherited from class org.mule.runtime.api.deployment.meta.AbstractMuleArtifactModel

BUNDLE_DESCRIPTOR_LOADER, CLASS_LOADER_MODEL_LOADER_DESCRIPTOR, ID, MIN_MULE_VERSION, NAME, REQUIRED_PRODUCT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MuleDeployableModel(String name, String minMuleVersion, Product product, MuleArtifactLoaderDescriptor classLoaderModelLoaderDescriptor, MuleArtifactLoaderDescriptor bundleDescriptorLoader, Set<String> configs, Optional<Boolean> redeploymentEnabled, List<String> secureProperties, String logConfigFile) Creates a new model

Method Summary

Modifier and Type	Method and Description
Set<String>	getConfigs()
String	getLogConfigFile()
List<String>	getSecureProperties()
boolean	isRedeploymentEnabled()

Methods inherited from class org.mule.runtime.api.deployment.meta.AbstractMuleArtifactModel

getBundleDescriptorLoader, getClassLoaderModelLoaderDescriptor, getMinMuleVersion, getName, getRequiredProduct, validateModel

Methods inherited from class java.lang.Object

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

Constructor Detail

MuleDeployableModel

protected MuleDeployableModel(String name,
                              String minMuleVersion,
                              Product product,
                              MuleArtifactLoaderDescriptor classLoaderModelLoaderDescriptor,
                              MuleArtifactLoaderDescriptor bundleDescriptorLoader,
                              Set<String> configs,
                              Optional<Boolean> redeploymentEnabled,
                              List<String> secureProperties,
                              String logConfigFile)

Creates a new model

Parameters:

name - name of the artifact

minMuleVersion - minimum Mule Runtime version that requires to work correctly.

product - the target product for this artifact

classLoaderModelLoaderDescriptor - describes how to create the class loader for the artifact.

bundleDescriptorLoader - indicates how to load the bundle descriptor.

configs - the application configuration files

redeploymentEnabled - indicates if the artifact can be redeployed or not

secureProperties - the list of properties names that must be handled as secrets. Those properties names won't be shown in the runtime manager UI when looking at the deployment configuration of the artifact.

logConfigFile - the location of the file to use as the log4j configuration for this artifact instead of the default. May be null.

Method Detail

getConfigs

public Set<String> getConfigs()

Returns:

the application configuration files

isRedeploymentEnabled

public boolean isRedeploymentEnabled()

Returns:

true if the application supports redeployment by changing a configuration file.

getSecureProperties

public List<String> getSecureProperties()

Returns:

the list of properties names that must be handled as secrets. Those properties names won't be shown in the runtime manager UI when looking at the deployment configuration of the artifact.

getLogConfigFile

public String getLogConfigFile()

Returns:

the location of the file to use as the log4j configuration for this artifact instead of the default. May be null.