|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AppDeploymentMBean
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.
Field Summary | |
---|---|
static String |
DEFAULT_STAGE |
static 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 String |
NO_STAGE Specifies that the deployment will not be copied to target servers. |
static 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 | |
---|---|
abstract String |
createPlan() Create a deployment plan in a default directory |
abstract String |
createPlan(String planPath) Create a deployment plan in the specified directory. |
abstract String |
getAbsoluteAltDescriptorDir() The fully resolved location of this application's alternate descriptor directory on the Administration Server. |
abstract String |
getAbsoluteAltDescriptorPath() The fully resolved location of this application's alternate descriptor on the Administration Server. |
abstract String |
getAbsoluteInstallDir() The fully resolved location of this application's installation root directory on the Administration Server. |
abstract String |
getAbsolutePlanDir() The fully resolved location of this application's deployment plan directory on the Administration Server. |
abstract String |
getAbsolutePlanPath() The fully resolved location of this application's deployment plan on the Administration Server. |
abstract String |
getAbsoluteSourcePath() The fully resolved location of this application's source files on the Administration Server. |
abstract String |
getAltDescriptorDir() The location of this application's configuration area. |
abstract String |
getApplicationIdentifier() The Application Identifier of the application version uniquely identifies the application version across all versions of all applications. |
abstract String |
getApplicationName() The name of the application. |
abstract byte[] |
getDeploymentPlan() The contents of this application's deployment plan, returned as a byte[] containing the XML. |
abstract byte[] |
getDeploymentPlanExternalDescriptors() A zip file containing the external descriptors referenced in the deployment plan. |
abstract String |
getInstallDir() The path to the application's install-root directory, relative to the domain/config/deployments directory. |
abstract String |
getName() The user-specified name of this MBean instance. |
abstract String |
getPlanDir() The location of this application's configuration area. |
abstract String |
getPlanPath() The path to the deployment plan document on the Administration Server. |
abstract 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. |
abstract String |
getSecurityDDModel() The security model that is used to secure a deployed module. |
abstract String |
getSourcePath() The path to the source of the deployable unit on the Administration Server. |
abstract 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. |
abstract String |
getVersionIdentifier() Uniquely identifies the application version across all versions of the same application. |
abstract boolean |
isCacheInAppDirectory() |
abstract boolean |
isValidateDDSecurityData() This attribute is not used in the current release. |
abstract 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, setSourcePath |
Methods inherited from interface weblogic.management.configuration.TargetInfoMBean |
---|
addTarget, getCompatibilityName, getTargets, removeTarget, setCompatibilityName, setModuleType, setName, setTargets |
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.management.WebLogicMBean |
---|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
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.descriptor.DescriptorBean |
---|
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener |
Field Detail |
---|
static final String DEFAULT_STAGE
static final String NO_STAGE
Specifies that the deployment will not be copied to target servers.
static final String STAGE
Specifies that WebLogic Server will copy the application to the target server's staging directory.
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.
Method Detail |
---|
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
getName
in interface ConfigurationMBean
getName
in interface TargetInfoMBean
getName
in interface WebLogicMBean
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.
AppDeploymentMBean.getSourcePath()
, AppDeploymentMBean.getPlanDir()
, AppDeploymentMBean.getPlanPath()
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.
getSourcePath
in interface BasicDeploymentMBean
AppDeploymentMBean.getInstallDir()
, AppDeploymentMBean.getAbsoluteSourcePath()
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.
AppDeploymentMBean.getInstallDir()
, AppDeploymentMBean.getAbsolutePlanDir()
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.
AppDeploymentMBean.getPlanDir()
, AppDeploymentMBean.getAbsolutePlanPath()
String getVersionIdentifier()
Uniquely identifies the application version across all versions of the same application.
If the application is not versioned, this returns null.
boolean isValidateDDSecurityData()
This attribute is not used in the current release.
void setValidateDDSecurityData(boolean validate)
Sets the value of the ValidateDDSecurityData attribute.
validate
- a boolean indicating the validation setting.AppDeploymentMBean.isValidateDDSecurityData()
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:
config.xml
and restarting the server, the order of precedence is:
config.xml
.AppDeploymentMBean SecurityDDModel
attribute.RealmMBean.getSecurityDDModel()
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.
ServerTemplateMBean.getStagingMode()
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.
ServerTemplateMBean.getStagingMode()
String createPlan(String planPath)
planPath
-String createPlan()
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.
AppDeploymentMBean.getInstallDir()
, AppDeploymentMBean.getAbsoluteAltDescriptorDir()
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.
String getApplicationName()
The name of the application.
Note that the name of the current MBean is not the name of the application.
String getAbsoluteInstallDir()
String getAbsolutePlanPath()
String getAbsolutePlanDir()
String getAbsoluteAltDescriptorPath()
String getAbsoluteAltDescriptorDir()
String getAbsoluteSourcePath()
byte[] getDeploymentPlan()
byte[] getDeploymentPlanExternalDescriptors()
boolean isCacheInAppDirectory()
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |