Package weblogic.j2ee.descriptor.wl

Interface DeploymentPlanBean

public interface DeploymentPlanBean

An XML deployment-planType(@http://xmlns.oracle.com/weblogic/deployment-plan). This is a complex type.

Access limited to the following security roles:

Deployer

Method Summary

Modifier and Type	Method	Description
VariableAssignmentBean	assignVariable(VariableBean var, ModuleDescriptorBean desc, DescriptorBean bean, java.lang.String prop)	Create new variable assignment from existing variable.
ModuleOverrideBean	createModuleOverride()
void	destroyModuleOverride(ModuleOverrideBean moduleOverride)
ModuleDescriptorBean	findModuleDescriptor(java.lang.String name, java.lang.String uri)	Get descriptor for module in plan.
ModuleOverrideBean	findModuleOverride(java.lang.String name)	Get descriptor overrides for any module in plan.
VariableBean	findOrCreateVariable(ModuleDescriptorBean desc, DescriptorBean bean, java.lang.String prop)
VariableBean	findOrCreateVariable(ModuleDescriptorBean desc, DescriptorBean bean, java.lang.String prop, boolean planBased)
VariableBean	findOrCreateVariable(ModuleDescriptorBean desc, DescriptorBean bean, java.lang.String prop, boolean planBased, java.lang.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, java.lang.String prop)
VariableAssignmentBean	findVariableAssignment(ModuleDescriptorBean desc, DescriptorBean bean, java.lang.String prop)
VariableAssignmentBean[]	findVariableAssignments(VariableBean var)
java.lang.String	getApplicationName()	Gets the "application-name" element
java.lang.String	getConfigRoot()	Gets the "install-root" element
java.lang.String	getDescription()	Gets the "description" element
ModuleOverrideBean[]	getModuleOverrides()	Gets array of all "module-override" elements
VariableDefinitionBean	getVariableDefinition()	Gets the "variable-definition" element
java.lang.String	getVersion()	Gets the "version" element
boolean	hasVariable(ModuleDescriptorBean desc, DescriptorBean bean, java.lang.String prop)
boolean	isGlobalVariables()	Global variable names are of the form BeanName_[KeyValue_]PropertyName.
boolean	isRemovable(DescriptorBean bean)
boolean	rootModule(java.lang.String moduleName)
void	setApplicationName(java.lang.String applicationName)	Sets the "application-name" element
void	setConfigRoot(java.lang.String configRoot)	Sets the "config-root" element
void	setDescription(java.lang.String description)	Sets the "description" element
void	setGlobalVariables(boolean global)
void	setVersion(java.lang.String version)	Sets the "version" element
java.lang.Object	valueOf(VariableBean var)

Method Detail

getDescription

java.lang.String getDescription()

Gets the "description" element

setDescription

void setDescription(java.lang.String description)

Sets the "description" element

Parameters:

description -

getApplicationName

java.lang.String getApplicationName()

Gets the "application-name" element

setApplicationName

void setApplicationName(java.lang.String applicationName)

Sets the "application-name" element

Parameters:

applicationName -

getVersion

java.lang.String getVersion()

Gets the "version" element

setVersion

void setVersion(java.lang.String version)

Sets the "version" element

Parameters:

version -

getVariableDefinition

VariableDefinitionBean getVariableDefinition()

Gets the "variable-definition" element

getModuleOverrides

ModuleOverrideBean[] getModuleOverrides()

Gets array of all "module-override" elements

createModuleOverride

ModuleOverrideBean createModuleOverride()

destroyModuleOverride

void destroyModuleOverride(ModuleOverrideBean moduleOverride)

findModuleOverride

ModuleOverrideBean findModuleOverride(java.lang.String name)

Get descriptor overrides for any module in plan.

findModuleDescriptor

ModuleDescriptorBean findModuleDescriptor(java.lang.String name,
                                          java.lang.String uri)

Get descriptor for module in plan.

getConfigRoot

java.lang.String getConfigRoot()

Gets the "install-root" element

setConfigRoot

void setConfigRoot(java.lang.String configRoot)

Sets the "config-root" element

Parameters:

configRoot -

rootModule

boolean rootModule(java.lang.String moduleName)

Parameters:

moduleName -

Returns:

whether a module is the root module of the application.

hasVariable

boolean hasVariable(ModuleDescriptorBean desc,
                    DescriptorBean bean,
                    java.lang.String prop)
             throws java.lang.IllegalArgumentException

Parameters:

desc -

bean -

prop -

Returns:

indicates if a variable assignment exists for the property

Throws:

java.lang.IllegalArgumentException

findVariable

VariableBean findVariable(ModuleDescriptorBean desc,
                          DescriptorBean bean,
                          java.lang.String prop)
                   throws java.lang.IllegalArgumentException

Parameters:

desc -

bean -

prop -

Returns:

VariableBean associated with a descriptor property or null if none.

Throws:

java.lang.IllegalArgumentException

findOrCreateVariable

VariableBean findOrCreateVariable(ModuleDescriptorBean desc,
                                  DescriptorBean bean,
                                  java.lang.String prop,
                                  boolean planBased)
                           throws java.lang.IllegalArgumentException

Parameters:

desc -

bean -

prop -

planBased -

Returns:

VariableBean associated with a descriptor property. Creates a variable assignment if necessary

Throws:

java.lang.IllegalArgumentException - if the property is transient

findOrCreateVariable

VariableBean findOrCreateVariable(ModuleDescriptorBean desc,
                                  DescriptorBean bean,
                                  java.lang.String prop)
                           throws java.lang.IllegalArgumentException

Parameters:

desc -

bean -

prop -

Returns:

VariableBean associated with a descriptor property. Creates a variable assignment if necessary

Throws:

java.lang.IllegalArgumentException - if the property is transient

findOrCreateVariable

VariableBean findOrCreateVariable(ModuleDescriptorBean desc,
                                  DescriptorBean bean,
                                  java.lang.String prop,
                                  boolean planBased,
                                  java.lang.Object oldKeyValue)
                           throws java.lang.IllegalArgumentException

Parameters:

desc -

bean -

prop -

planBased -

oldKeyValue -

Returns:

VariableBean associated with a descriptor property. Creates a variable assignment if necessary

Throws:

java.lang.IllegalArgumentException - if the property is transient

findVariableAssignments

VariableAssignmentBean[] findVariableAssignments(VariableBean var)

Parameters:

var -

Returns:

VariableAssignmentBean object using this variable

findVariableAssignment

VariableAssignmentBean findVariableAssignment(ModuleDescriptorBean desc,
                                              DescriptorBean bean,
                                              java.lang.String prop)
                                       throws java.lang.IllegalArgumentException

Parameters:

desc -

bean -

prop -

Returns:

VariableAssignmentBean associated with a descriptor property or null if none.

Throws:

java.lang.IllegalArgumentException - if the desc is null

valueOf

java.lang.Object valueOf(VariableBean var)

Parameters:

var -

Returns:

typed object representing variable's value.

assignVariable

VariableAssignmentBean assignVariable(VariableBean var,
                                      ModuleDescriptorBean desc,
                                      DescriptorBean bean,
                                      java.lang.String prop)

Create new variable assignment from existing variable.

Parameters:

var -

desc -

bean -

prop -

isGlobalVariables

boolean isGlobalVariables()

Global variable names are of the form BeanName_[KeyValue_]PropertyName. If false then the name is appended with a unique number. Global variables are useful for most descriptors since this allows a single variable value to affect all like references to it.

Returns:

whether to use global variable naming.

Default Value:

false

setGlobalVariables

void setGlobalVariables(boolean global)

findRootModule

ModuleOverrideBean findRootModule()

A plan can have at most one ModuleOverride that represents the root module of the application.

Returns:

root ModuleOverrideBean or null if none found

isRemovable

boolean isRemovable(DescriptorBean bean)
             throws java.lang.IllegalArgumentException

Parameters:

bean -

Returns:

indicates if a descriptor bean can be removed from the plan

Throws:

java.lang.IllegalArgumentException