This MBean provides deployment operations for an application. Currently only start and stop are supported. In the future, this MBean may be enhanced with operations to support deployment applications to the domain as well as extended WLS deployment features such as production redeployment and partial deployment of modules in an enterprise application.
Since | 10.3.6.0 | ||
Security roles | The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
|
||
Fully Qualified Interface Name | If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:weblogic.management.runtime.AppDeploymentRuntimeMBean
|
||
Factory Methods | No factory methods. Instances of this MBean are created automatically. | ||
Access Points |
You can access this MBean from the following MBean attributes:
|
||
Access Points Inherited from RuntimeMBean |
Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:
|
This section describes the following attributes:
The application's name.
Privileges | Read only |
Type | java.lang.String |
The application's version identifier.
Privileges | Read only |
Type | java.lang.String |
Private property that disables caching in proxies.
Privileges | Read only |
Type | boolean |
Returns the MBean info for this MBean.
Deprecated.
Privileges | Read only |
Type | javax.management.MBeanInfo |
The list of modules for the application. These modules can be used in module level targeting.
Privileges | Read only |
Type | class java.lang.String[] |
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Privileges | Read only |
Type | java.lang.String |
Returns the ObjectName under which this MBean is registered in the MBean server.
Deprecated.
Privileges | Read only |
Type | weblogic.management.WebLogicObjectName |
Return the immediate parent for this MBean
Privileges | Read/Write |
Type |
Returns false if the MBean represented by this object has been unregistered.
Deprecated.
Privileges | Read only |
Type | boolean |
Returns the type of the MBean.
Privileges | Read only |
Type | java.lang.String |
This section describes the following operations:
The state of the application for a target. Notifications will be generated for this attribute on state changes. Valid states are those supported by the AppRuntimeStateRuntimeMBean The notification types are appdeployment.created, appdeployment.deleted, appdeployment.state.new, appdeployment.state.prepared, appdeployment.state.admin, appdeployment.state.active, appdeployment.state.retired, appdeployment.state.failed, appdeployment.state.update.pending, and appdeployment.state.unknown. The userdata is a Map where the keys are target names and the values are the application state for that target.
Operation Name | "getState" |
Parameters | Object [] { target }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns | String
|
Operation Name | "preDeregister" |
Parameters | null |
Signature | null |
Returns |
void
|
Exceptions |
|
Redeploy the application using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout
Operation Name | "redeploy" |
Parameters | null |
Signature | null |
Returns | DeploymentProgressObjectMBean |
Exceptions |
|
Redeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.
Operation Name | "redeploy" |
Parameters | Object [] { targets, plan, deploymentOptions }
where:
|
Signature | String [] {
"[Ljava.lang.String;",
"java.lang.String",
"java.util.Properties" } |
Returns | DeploymentProgressObjectMBean |
Exceptions |
|
Start the application using the default options and configured targets. This is a synchronous operation that returns when the start operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout
Operation Name | "start" |
Parameters | null |
Signature | null |
Returns | DeploymentProgressObjectMBean |
Exceptions |
|
Start the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.
Operation Name | "start" |
Parameters | Object [] { targets, deploymentOptions }
where:
|
Signature | String [] {
"[Ljava.lang.String;",
"java.util.Properties" } |
Returns | DeploymentProgressObjectMBean |
Exceptions |
|
Stop the application using the default options and configured targets. This is a synchronous operation that returns when the stop operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout
Operation Name | "stop" |
Parameters | null |
Signature | null |
Returns | DeploymentProgressObjectMBean |
Exceptions |
|
Stop the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.
Operation Name | "stop" |
Parameters | Object [] { targets, deploymentOptions }
where:
|
Signature | String [] {
"[Ljava.lang.String;",
"java.util.Properties" } |
Returns | DeploymentProgressObjectMBean |
Exceptions |
|
Undeploy the application in the background for the targets specified with the options specified. This is an asynchronous operation that returns immediately. The returned DeploymentProgressObjectMBean can be used to determine when the operation is completed.
Operation Name | "undeploy" |
Parameters | Object [] { targets, deploymentOptions }
where:
|
Signature | String [] {
"[Ljava.lang.String;",
"java.util.Properties" } |
Returns | DeploymentProgressObjectMBean |
Exceptions |
|
Undeploy the application using the default options and configured targets. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout
Operation Name | "undeploy" |
Parameters | null |
Signature | null |
Returns | DeploymentProgressObjectMBean |
Exceptions |
|
Allows for updating an application configuration using an changed deployment plan.
A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.
The update succeeds only if changes to the deployment plan do not require the application to be restarted. Configuration changes in the new deployment plan must be limited to tuning the application. Changes to resource bindings causes the update to fail. Use redeploy() to apply resource binding changes to a production application.
This method targets only root modules. Module level targeting is not supported.
For more information, see:
Operation Name | "update" |
Parameters | Object [] { targets, plan, deploymentOptions }
where:
|
Signature | String [] {
"[Ljava.lang.String;",
"java.lang.String",
"java.util.Properties" } |
Returns | DeploymentProgressObjectMBean |
Exceptions |
|