Package weblogic.management.configuration

Interface AppDeploymentMBean

All Superinterfaces:

BasicDeploymentMBean, ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, TargetInfoMBean, WebLogicMBean

All Known Subinterfaces:

DBClientDataDirectoryMBean, LibraryMBean

public interface AppDeploymentMBean
extends BasicDeploymentMBean

This MBean is used to configure all physical package types which can be deployed on a WebLogic domain, for instance, EAR files and standalone Java EE and non-Java EE modules.

Access limited to the following security roles:

Deployer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_STAGE
static java.lang.String	EXTERNAL_STAGE	Indicates that the files will be expected in the target server's staging directory, but the server will not copy them there.
static java.lang.String	NO_STAGE	Specifies that the deployment will not be copied to target servers.
static java.lang.String	STAGE	Specifies that WebLogic Server will copy the application to the target server's staging directory.

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method	Description
java.lang.String	createPlan()	Create a deployment plan in a default directory
java.lang.String	createPlan(java.lang.String planPath)	Create a deployment plan in the specified directory.
java.lang.String	getAbsoluteAltDescriptorDir()	The fully resolved location of this application's alternate descriptor directory on the Administration Server.
java.lang.String	getAbsoluteAltDescriptorPath()	The fully resolved location of this application's alternate descriptor on the Administration Server.
java.lang.String	getAbsoluteInstallDir()	The fully resolved location of this application's installation root directory on the Administration Server.
java.lang.String	getAbsolutePlanDir()	The fully resolved location of this application's deployment plan directory on the Administration Server.
java.lang.String	getAbsolutePlanPath()	The fully resolved location of this application's deployment plan on the Administration Server.
java.lang.String	getAbsoluteSourcePath()	The fully resolved location of this application's source files on the Administration Server.
java.lang.String	getAltDescriptorDir()	The location of this application's configuration area.
java.lang.String	getApplicationIdentifier()	The Application Identifier of the application version uniquely identifies the application version across all versions of all applications.
java.lang.String	getApplicationName()	The name of the application.
byte[]	getDeploymentPlan()	The contents of this application's deployment plan, returned as a byte[] containing the XML.
byte[]	getDeploymentPlanExternalDescriptors()	A zip file containing the external descriptors referenced in the deployment plan.
java.lang.String	getInstallDir()	The path to the application's install-root directory, relative to the domain/config/deployments directory.
java.lang.String	getName()	The user-specified name of this MBean instance.
java.lang.String	getPlanDir()	The location of this application's configuration area.
java.lang.String	getPlanPath()	The path to the deployment plan document on the Administration Server.
java.lang.String	getPlanStagingMode()	Specifies whether an application's deployment plan is copied from a source on the Administration Server to the Managed Server's staging area during application preparation.
java.lang.String	getSecurityDDModel()	The security model that is used to secure a deployed module.
java.lang.String	getSourcePath()	The path to the source of the deployable unit on the Administration Server.
java.lang.String	getStagingMode()	Specifies whether a deployment's files are copied from a source on the Administration Server to the Managed Server's staging area during application preparation.
java.lang.String	getVersionIdentifier()	Uniquely identifies the application version across all versions of the same application.
boolean	isCacheInAppDirectory()
boolean	isValidateDDSecurityData()	This attribute is not used in the current release.
void	setValidateDDSecurityData(boolean validate)	Sets the value of the ValidateDDSecurityData attribute.

Methods inherited from interface weblogic.management.configuration.BasicDeploymentMBean

createSubDeployment, destroySubDeployment, getDeploymentOrder, getDeploymentPrincipalName, getSubDeployments, lookupSubDeployment, setDeploymentOrder, setDeploymentPrincipalName

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.configuration.TargetInfoMBean

addTarget, getCompatibilityName, getTargets, removeTarget, setCompatibilityName, setModuleType, setName, setTargets

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

Field Detail

DEFAULT_STAGE

static final java.lang.String DEFAULT_STAGE

NO_STAGE

static final java.lang.String NO_STAGE

Specifies that the deployment will not be copied to target servers.

See Also:

Constant Field Values

STAGE

static final java.lang.String STAGE

Specifies that WebLogic Server will copy the application to the target server's staging directory.

See Also:

Constant Field Values

EXTERNAL_STAGE

static final java.lang.String EXTERNAL_STAGE

Indicates that the files will be expected in the target server's staging directory, but the server will not copy them there. The user is responsible for distributing files.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

Specified by:

getName in interface ConfigurationMBean

Specified by:

getName in interface TargetInfoMBean

Specified by:

getName in interface WebLogicMBean

getInstallDir

java.lang.String getInstallDir()

The path to the application's install-root directory, relative to the domain/config/deployments directory.

When the installation directory is specified, SourcePath, PlanDir, and PlanPath are derived from this path and need not be specified.

The default value for this is the name of the deployment.

See Also:

getSourcePath(), getPlanDir(), getPlanPath()

getSourcePath

java.lang.String getSourcePath()

The path to the source of the deployable unit on the Administration Server.

Rules:

If the source path is relative, it is resolved relative to InstallDir/app if InstallDir is not null; otherwise, it is resolved relative to the domain root.

Use AbsoluteSourcePath to get a fully resolved value.

Specified by:

getSourcePath in interface BasicDeploymentMBean

Returns:

path

See Also:

getInstallDir(), getAbsoluteSourcePath()

getPlanDir

java.lang.String getPlanDir()

The location of this application's configuration area. This directory can contain external descriptor files as specified within the deployment plan document.

Rules:

If the plan directory is a relative path, it is resolved relative to InstallDir if InstallDir is not null; otherwise, it is resolved relative to the domain root.

Use AbsolutePlanDir to get a fully resolved value.

See Also:

getInstallDir(), getAbsolutePlanDir()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getPlanPath

java.lang.String getPlanPath()

The path to the deployment plan document on the Administration Server.

Rules:

If the plan path is a relative path, it is resolved relative to PlanDir if PlanDir is not null; otherwise, it is resolved relative to the domain root.

Use AbsolutePlanPath to get a fully resolved value.

If there is no plan, this returns no plan specified.

See Also:

getPlanDir(), getAbsolutePlanPath()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getVersionIdentifier

java.lang.String getVersionIdentifier()

Uniquely identifies the application version across all versions of the same application.

If the application is not versioned, this returns null.

Returns:

The Version Identifier of the application

isValidateDDSecurityData

boolean isValidateDDSecurityData()

This attribute is not used in the current release.

Returns:

a boolean indicating the validation setting

Default Value:

false

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setValidateDDSecurityData

void setValidateDDSecurityData(boolean validate)

Sets the value of the ValidateDDSecurityData attribute.

Parameters:

validate - a boolean indicating the validation setting.

See Also:

isValidateDDSecurityData()

getSecurityDDModel

java.lang.String getSecurityDDModel()

The security model that is used to secure a deployed module.

To set this value, you can use the weblogic.Deployer command-line tool, the Deployment Assistant in the Administration Console, the WebLogic Scripting Tool (WLST), or another JMX client.

If you deploy a module using one of the previously mentioned tools and you do not specify a security model value, the module is secured with the security realm's default model (see RealmMBean SecurityDDModel).

If you deploy a module by modifying the domain's config.xml file and restarting the server, and if you do not specify a security model value for the module in config.xml, the module is secured with the DDOnly model, which is the default value of this AppDeploymentMBean attribute.

In summary, the order of precedence for the value of this attribute is as follows:

• If you deploy a module using a runtime deployment utility, the order of precedence is:
  1. The value set by the deployment utility.
  2. The value set as the security realm's default security model.
• If you deploy a module by modifying config.xml and restarting the server, the order of precedence is:
  1. The value that you specify for the module in config.xml.
  2. The default value of this AppDeploymentMBean SecurityDDModel attribute.

Returns:

the name of the deployment model

See Also:

RealmMBean.getSecurityDDModel()

Default Value:

weblogic.management.security.DeploymentModel.DD_ONLY

Initial Value:

weblogic.management.mbeans.custom.AppDeployment.getInitialSecurityDDModel(this)

Valid Values:

weblogic.management.security.DeploymentModel.DD_ONLY, weblogic.management.security.DeploymentModel.CUSTOM_ROLES, weblogic.management.security.DeploymentModel.CUSTOM_ROLES_POLICIES, weblogic.management.security.DeploymentModel.ADVANCED

getStagingMode

java.lang.String getStagingMode()

Specifies whether a deployment's files are copied from a source on the Administration Server to the Managed Server's staging area during application preparation.

Staging mode for an application can only be set the first time the application is deployed. Once the staging mode for an application is set, it cannot be changed while the application is configured in the domain. The only way to change the staging mode is to undeploy and then redeploy the application.

This attribute overrides the server's staging mode.

See Also:

ServerTemplateMBean.getStagingMode()

Default Value:

AppDeploymentMBean.DEFAULT_STAGE

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

AppDeploymentMBean.DEFAULT_STAGE, AppDeploymentMBean.NO_STAGE, AppDeploymentMBean.STAGE, AppDeploymentMBean.EXTERNAL_STAGE

getPlanStagingMode

java.lang.String getPlanStagingMode()

Specifies whether an application's deployment plan is copied from a source on the Administration Server to the Managed Server's staging area during application preparation.

Plan staging mode for an application can only be set the first time the application is deployed. Once the plan staging mode for an application is set, it cannot be changed while the application is configured in the domain. The only way to change the plan staging mode is to undeploy and then redeploy the application.

This attribute overrides the server's plan staging mode.

See Also:

ServerTemplateMBean.getStagingMode()

Default Value:

AppDeploymentMBean.DEFAULT_STAGE

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

AppDeploymentMBean.DEFAULT_STAGE, AppDeploymentMBean.NO_STAGE, AppDeploymentMBean.STAGE, AppDeploymentMBean.EXTERNAL_STAGE

createPlan

java.lang.String createPlan(java.lang.String planPath)

Create a deployment plan in the specified directory.

Parameters:

planPath -

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

createPlan

java.lang.String createPlan()

Create a deployment plan in a default directory

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getAltDescriptorDir

java.lang.String getAltDescriptorDir()

The location of this application's configuration area. This directory can contain alternate descriptor files.

Rules:

If the alternate descriptor directory is a relative path, it is resolved relative to InstallDir if InstallDir is not null; otherwise, it is resolved relative to the domain root.

Use AbsoluteAltDescriptorDir to get a fully resolved value.

See Also:

getInstallDir(), getAbsoluteAltDescriptorDir()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getApplicationIdentifier

java.lang.String getApplicationIdentifier()

The Application Identifier of the application version uniquely identifies the application version across all versions of all applications. If the application is not versioned, the Application Identifier is the same as the application name.

Returns:

The Application Identifier of the application

getApplicationName

java.lang.String getApplicationName()

The name of the application.

Note that the name of the current MBean is not the name of the application.

Returns:

The name of the application

getAbsoluteInstallDir

java.lang.String getAbsoluteInstallDir()

The fully resolved location of this application's installation root directory on the Administration Server.

getAbsolutePlanPath

java.lang.String getAbsolutePlanPath()

The fully resolved location of this application's deployment plan on the Administration Server.

getAbsolutePlanDir

java.lang.String getAbsolutePlanDir()

The fully resolved location of this application's deployment plan directory on the Administration Server.

getAbsoluteAltDescriptorPath

java.lang.String getAbsoluteAltDescriptorPath()

The fully resolved location of this application's alternate descriptor on the Administration Server.

getAbsoluteAltDescriptorDir

java.lang.String getAbsoluteAltDescriptorDir()

The fully resolved location of this application's alternate descriptor directory on the Administration Server.

getAbsoluteSourcePath

java.lang.String getAbsoluteSourcePath()

The fully resolved location of this application's source files on the Administration Server.

getDeploymentPlan

byte[] getDeploymentPlan()

The contents of this application's deployment plan, returned as a byte[] containing the XML.

Access limited to the following security roles:

Deployer

getDeploymentPlanExternalDescriptors

byte[] getDeploymentPlanExternalDescriptors()

A zip file containing the external descriptors referenced in the deployment plan.

Returns:

A byte array containing a zip file of the external descriptors from the config root directory

Access limited to the following security roles:

Deployer

isCacheInAppDirectory

boolean isCacheInAppDirectory()