public interface DeploymentPlanBean
Modifier and Type | Method and Description |
---|---|
VariableAssignmentBean |
assignVariable(VariableBean var,
ModuleDescriptorBean desc,
DescriptorBean bean,
String prop)
Create new variable assignment from existing variable.
|
ModuleOverrideBean |
createModuleOverride() |
void |
destroyModuleOverride(ModuleOverrideBean moduleOverride) |
ModuleDescriptorBean |
findModuleDescriptor(String name,
String uri)
Get descriptor for module in plan.
|
ModuleOverrideBean |
findModuleOverride(String name)
Get descriptor overrides for any module in plan.
|
VariableBean |
findOrCreateVariable(ModuleDescriptorBean desc,
DescriptorBean bean,
String prop) |
VariableBean |
findOrCreateVariable(ModuleDescriptorBean desc,
DescriptorBean bean,
String prop,
boolean planBased) |
VariableBean |
findOrCreateVariable(ModuleDescriptorBean desc,
DescriptorBean bean,
String prop,
boolean planBased,
Object oldKeyValue) |
ModuleOverrideBean |
findRootModule()
A plan can have at most one ModuleOverride that represents the root module of the application.
|
VariableBean |
findVariable(ModuleDescriptorBean desc,
DescriptorBean bean,
String prop) |
VariableAssignmentBean |
findVariableAssignment(ModuleDescriptorBean desc,
DescriptorBean bean,
String prop) |
VariableAssignmentBean[] |
findVariableAssignments(VariableBean var) |
String |
getApplicationName()
Gets the "application-name" element
|
String |
getConfigRoot()
Gets the "install-root" element
|
String |
getDescription()
Gets the "description" element
|
ModuleOverrideBean[] |
getModuleOverrides()
Gets array of all "module-override" elements
|
VariableDefinitionBean |
getVariableDefinition()
Gets the "variable-definition" element
|
String |
getVersion()
Gets the "version" element
|
boolean |
hasVariable(ModuleDescriptorBean desc,
DescriptorBean bean,
String prop) |
boolean |
isGlobalVariables()
Global variable names are of the form BeanName_[KeyValue_]PropertyName.
|
boolean |
isRemovable(DescriptorBean bean) |
boolean |
rootModule(String moduleName) |
void |
setApplicationName(String applicationName)
Sets the "application-name" element
|
void |
setConfigRoot(String configRoot)
Sets the "config-root" element
|
void |
setDescription(String description)
Sets the "description" element
|
void |
setGlobalVariables(boolean global) |
void |
setVersion(String version)
Sets the "version" element
|
Object |
valueOf(VariableBean var) |
String getDescription()
void setDescription(String description)
description
- String getApplicationName()
void setApplicationName(String applicationName)
applicationName
- String getVersion()
void setVersion(String version)
version
- VariableDefinitionBean getVariableDefinition()
ModuleOverrideBean[] getModuleOverrides()
ModuleOverrideBean createModuleOverride()
void destroyModuleOverride(ModuleOverrideBean moduleOverride)
ModuleOverrideBean findModuleOverride(String name)
ModuleDescriptorBean findModuleDescriptor(String name, String uri)
String getConfigRoot()
void setConfigRoot(String configRoot)
configRoot
- boolean rootModule(String moduleName)
moduleName
- boolean hasVariable(ModuleDescriptorBean desc, DescriptorBean bean, String prop) throws IllegalArgumentException
desc
- bean
- prop
- IllegalArgumentException
VariableBean findVariable(ModuleDescriptorBean desc, DescriptorBean bean, String prop) throws IllegalArgumentException
desc
- bean
- prop
- IllegalArgumentException
VariableBean findOrCreateVariable(ModuleDescriptorBean desc, DescriptorBean bean, String prop, boolean planBased) throws IllegalArgumentException
desc
- bean
- prop
- planBased
- IllegalArgumentException
- if the property is transientVariableBean findOrCreateVariable(ModuleDescriptorBean desc, DescriptorBean bean, String prop) throws IllegalArgumentException
desc
- bean
- prop
- IllegalArgumentException
- if the property is transientVariableBean findOrCreateVariable(ModuleDescriptorBean desc, DescriptorBean bean, String prop, boolean planBased, Object oldKeyValue) throws IllegalArgumentException
desc
- bean
- prop
- planBased
- oldKeyValue
- IllegalArgumentException
- if the property is transientVariableAssignmentBean[] findVariableAssignments(VariableBean var)
var
- VariableAssignmentBean findVariableAssignment(ModuleDescriptorBean desc, DescriptorBean bean, String prop) throws IllegalArgumentException
desc
- bean
- prop
- IllegalArgumentException
- if the desc is nullObject valueOf(VariableBean var)
var
- VariableAssignmentBean assignVariable(VariableBean var, ModuleDescriptorBean desc, DescriptorBean bean, String prop)
var
- desc
- bean
- prop
- boolean isGlobalVariables()
void setGlobalVariables(boolean global)
ModuleOverrideBean findRootModule()
boolean isRemovable(DescriptorBean bean) throws IllegalArgumentException
bean
- IllegalArgumentException