weblogic.management.configuration
Interface AppDeploymentMBean

All Known Subinterfaces:

LibraryMBean

public interface AppDeploymentMBean

This MBean is used to configure all physical package types which can be deployed on a weblogic domain. For instance, EARs, standalone J2EE and non-J2EE modules.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. .

Since:

9.0.0.0

Access limited to the following security roles:

Deployer

DEFAULT_STAGE

static final String DEFAULT_STAGE

NO_STAGE

static final String NO_STAGE

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

See Also:

Constant Field Values

STAGE

static final 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 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

getInstallDir

String getInstallDir()

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

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

Default value for this is the name of the deployment.

See Also:

AppDeploymentMBean.getSourcePath(), AppDeploymentMBean.getPlanDir(), AppDeploymentMBean.getPlanPath()

getSourcePath

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 domain root.

Use AbsoluteSourcePath to get a fully resolved value.

See Also:

AppDeploymentMBean.getInstallDir(), AppDeploymentMBean.getAbsoluteSourcePath()

getPlanDir

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 domain root.

Use AbsolutePlanDir to get a fully resolved value.

See Also:

AppDeploymentMBean.getInstallDir(), AppDeploymentMBean.getAbsolutePlanDir()

getPlanPath

String getPlanPath()

The path to the deployment plan document on 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 domain root.

Use AbsolutePlanPath to get a fully resolved value.

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

See Also:

AppDeploymentMBean.getPlanDir(), AppDeploymentMBean.getAbsolutePlanPath()

Changes take effect after you redeploy the module or restart the server.

getVersionIdentifier

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

setValidateDDSecurityData

void setValidateDDSecurityData(boolean validate)

Sets the value of the ValidateDDSecurityData attribute.

Parameters:

validate - a boolean indicating the validation setting.

See Also:

AppDeploymentMBean.isValidateDDSecurityData()

getSecurityDDModel

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 some other 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

String getStagingMode()

The mode that 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 staging mode for an application is set, it cannot be changed while the application is configured in the domain. The only way to change staging mode is to undeploy then redeploy the application.

This attribute overrides the server's staging mode.

See Also:

ServerMBean.getStagingMode()

Default Value:

AppDeploymentMBean.DEFAULT_STAGE

Valid Values:

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

getApplicationIdentifier

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

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

String getAbsoluteInstallDir()

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

getAbsolutePlanPath

String getAbsolutePlanPath()

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

getAbsolutePlanDir

String getAbsolutePlanDir()

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

getAbsoluteSourcePath

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