This MBean provides deployment operations.
A DeploymentManager object is a stateless interface into the WebLogic Server deployment framework. It currently provides access to the AppDeploymentRuntimeMBeans that allow the user to start and stop deployments. In the future, this MBean may be enhanced with operations to support deployment applications to the domain, as well as extended WebLogic Server deployment features, such as production redeployment and partial deployment of modules in an enterprise application.
This MBean emits notifications when an application is created or removed and when the application state changes. 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
appdeployment.state.unknown
The userdata is the object name of the 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.DeploymentManagerMBean
|
||
| 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 attributes that provide access to other MBeans.
Provides access to the applications that are deployed in the domain.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Lookup Operation | lookupAppDeploymentRuntime(String name)
Returns a |
| Lookup Operation | lookupAppDeploymentRuntime(String name)
Returns a |
| Privileges | Read only |
| Type | AppDeploymentRuntimeMBean[] |
| Relationship type: | Containment. |
Provides access to the deployment operations that have been performed on this domain.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Privileges | Read only |
| Type | DeploymentProgressObjectMBean[] |
| Relationship type: | Containment. |
Provides access to the libraries that are deployed to the domain.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Lookup Operation | lookupLibDeploymentRuntime(String name)
Returns a |
| Privileges | Read only |
| Type | LibDeploymentRuntimeMBean[] |
| Relationship type: | Containment. |
This section describes the following attributes:
Private property that disables caching in proxies.
| Privileges | Read only |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The maximum number of progress objects allowed.
| Privileges | Read/Write |
| Type | int |
Returns the MBean info for this MBean.
Deprecated.
| Privileges | Read only |
| Type | javax.management.MBeanInfo |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
| Privileges | Read only |
| Type | java.lang.String |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns the ObjectName under which this MBean is registered in the MBean server.
Deprecated.
| Privileges | Read only |
| Type | weblogic.management.WebLogicObjectName |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns the type of the MBean.
| Privileges | Read only |
| Type | java.lang.String |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
Appends a code source to the search path of the WebLogic Extension Loader, which is also referred to as the WebLogic Domain Loader. The code source file is distributed to the targets using the options specified. When the operation is complete, classes and resources in the jar file will be visible for class loading at the extension loader. Since the jar is now in place on targeted servers, the classes and resources will continue to be available even after a targeted server restarts. This is an asynchronous operation that returns immediately.
| Operation Name | "appendToExtensionLoader" |
| Parameters | Object [] { codeSourcePath, targets, deploymentOptions }
where:
|
| Signature | String [] {
"java.lang.String",
"[Ljava.lang.String;",
"java.util.Properties" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
Appends a code source to the search path of the WebLogic Extension Loader, which is also referred to as the WebLogic Domain Loader. The code source file is distributed to all targets using default options. When the operation is complete, classes and resources in the jar file will be visible for class loading at the extension loader. Since the jar is now in place on targeted servers, the classes and resources will continue to be available even after a targeted server restarts. This is an asynchronous operation that returns immediately.
| Operation Name | "appendToExtensionLoader" |
| Parameters | Object [] { codeSourcePath }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
Used by the deployment subsystem to confirm an application name.
| Operation Name | "confirmApplicationName" |
| Parameters | Object [] { isRedeployment, appSource, optional, tentativeName, tentativeApplicationId, deploymentOptions }
where:
|
| Signature | String [] {
"java.lang.Boolean",
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns | String
|
| Exceptions |
|
Used by the deployment subsystem to confirm an application name.
| Operation Name | "confirmApplicationName" |
| Parameters | Object [] { isRedeployment, appSource, optional, tentativeName, tentativeApplicationId }
where:
|
| Signature | String [] {
"java.lang.Boolean",
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
A convenience method for distributing and starting an application.
The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the deploy operation has completed. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.
The default options are
clusterDeploymentTimeout: 3600000 milliseconds
gracefulIgnoreSessions: false
gracefulProductionToAdmin: false
retireGracefully: true
retireTimeout: no timeout
adminMode: false
timeout: no timeout
If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.
| Operation Name | "deploy" |
| Parameters | Object [] { name, applicationPath, plan }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
A convenience method for distributing and starting an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.
If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.
| Operation Name | "deploy" |
| Parameters | Object [] { name, applicationPath, targets, plan, deploymentOptions }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"[Ljava.lang.String;",
"java.lang.String",
"java.util.Properties" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
Distribute an application.
The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the distribute 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 | "distribute" |
| Parameters | Object [] { name, applicationPath, plan }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
Distribute an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately.
| Operation Name | "distribute" |
| Parameters | Object [] { name, applicationPath, targets, plan, deploymentOptions }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"[Ljava.lang.String;",
"java.lang.String",
"java.util.Properties" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
Removes progress objects for completed operations.
| Operation Name | "purgeCompletedDeploymentProgressObjects" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
Redeploy the application that is deployed to a resource group template 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.
Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.
| Operation Name | "redeploy" |
| Parameters | Object [] { name, applicationPath, plan, deploymentOptions }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
Redeploy the application that is deployed to a resource group template 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.
Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.
| Operation Name | "redeploy" |
| Parameters | Object [] { name, plan, deploymentOptions }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
Removes a progress object.
| Operation Name | "removeDeploymentProgressObject" |
| Parameters | Object [] { appName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
Undeploy the application that is deployed to a resource group template using the default options. 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 | Object [] { name, template }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
Undeploy the application that is deployed to a resource group template in the background 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.
Note that this API is only for undeploying applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for undeploying applications that are not deployed to a resource group template.
| Operation Name | "undeploy" |
| Parameters | Object [] { name, deploymentOptions }
where:
|
| Signature | String [] {
"java.lang.String",
"java.util.Properties" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|
Allows for updating an application configuration using an changed deployment plan for applications deployed to a resource group template.
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(String, String, Properties) to apply resource binding changes to a production application.
This method targets only root modules. Module level targeting is not supported.
Note that this API is only for updating applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for updating applications that are not deployed to a resource group template.
| Operation Name | "update" |
| Parameters | Object [] { name, plan, deploymentOptions }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns | DeploymentProgressObjectMBean |
| Exceptions |
|