DeploymentManagerMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean provides deployment operations. A DeploymentManager object is a stateless interface into the Weblogic Server deployment framework. It currently provides access to the App Deployment Runtime MBeans 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 WLS 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, and appdeployment.state.unknown. The userdata is the object name of the application.

           
Since10.3.6.0
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf 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:


    Related MBeans

    This section describes attributes that provide access to other MBeans.


    AppDeploymentRuntimes

    Provides access to the applications that are deployed in the domain.

               
    Lookup OperationlookupAppDeploymentRuntime(String name)

    Returns a javax.management.ObjectName for the instance of AppDeploymentRuntimeMBean named name.

    Privileges Read only
    TypeAppDeploymentRuntimeMBean[]
    Relationship type: Reference.

    DeploymentProgressObjects

    Provides access to the deployment operations that have been performed on this domain.

           
    Privileges Read only
    TypeDeploymentProgressObjectMBean[]
    Relationship type: Reference.

    LibDeploymentRuntimes

    Provides access to the libraries that are deployed to the domain.

               
    Lookup OperationlookupLibDeploymentRuntime(String name)

    Returns a javax.management.ObjectName for the instance of LibDeploymentRuntimeMBean named name.

    Privileges Read only
    TypeLibDeploymentRuntimeMBean[]
    Relationship type: Reference.


    Attributes

    This section describes the following attributes:


    CachingDisabled

    Private property that disables caching in proxies.

           
    Privileges Read only
    Typeboolean
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    MaximumDeploymentProgressObjectsCount

    The maximum number of progress objects allowed.

           
    Privileges Read/Write
    Typeint

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Name

    The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

           
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    ObjectName

    Returns the ObjectName under which this MBean is registered in the MBean server.

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    Registered

    Returns false if the MBean represented by this object has been unregistered.

    Deprecated.

           
    Privileges Read only
    Typeboolean
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


    Operations

    This section describes the following operations:


    confirmApplicationName

    Used by the deployment subsystem to confirm an application name. .

       
    Operation Name"confirmApplicationName"
    ParametersObject [] {  isRedeploymentappSourcetentativeNametentativeApplicationId }

    where:

    • isRedeployment is an object of type java.lang.Boolean that specifies:

      should be true in the case where this function is called for a redeployment.

    • appSource is an object of type java.lang.String that specifies:

      is a the path to the application.

    • tentativeName is an object of type java.lang.String that specifies:

      The name proposed for the application (provided by the user, or through the manifest). Null if no name was specified by the user or through the manifest.

    • tentativeApplicationId is an object of type java.lang.String that specifies:

      The tentative application id. May only be null if the application is not versioned. If tentativeName is null and the application is versioned, this should be just the version string (which includes both the implementation and specification versions).

    SignatureString [] { "java.lang.Boolean", "java.lang.String", "java.lang.String", "java.lang.String" }
    ReturnsString
    Exceptions
    • java.lang.RuntimeException
      RuntimeException

    deploy

    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"
    ParametersObject [] {  nameapplicationPathplan }

    where:

    • name is an object of type java.lang.String that specifies:

      The name of the application

    • applicationPath is an object of type java.lang.String that specifies:

      A supported Java EE application or module archive, or a root diectory for the application or module.

    • plan is an object of type java.lang.String that specifies:

      The deployment plan for this application. May be null.

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String" }
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException
      RuntimeException. All other errors are reported via the returned DeploymentProgressObjectMBean.

    deploy

    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"
    ParametersObject [] {  nameapplicationPathtargetsplandeploymentOptions }

    where:

    • name is an object of type java.lang.String that specifies:

      The name of the application

    • applicationPath is an object of type java.lang.String that specifies:

      A supported Java EE application or module archive, or a root diectory for the application or module.

    • targets is an object of type [Ljava.lang.String; that specifies:

      The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be redeployed on all configured targets.

    • plan is an object of type java.lang.String that specifies:

      The deployment plan for this application. May be null.

    • deploymentOptions is an object of type java.util.Properties that specifies:

      Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

    SignatureString [] { "java.lang.String", "java.lang.String", "[Ljava.lang.String;", "java.lang.String", "java.util.Properties" }
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException
      RuntimeException. All other errors are reported via the returned DeploymentProgressObjectMBean.

    distribute

    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"
    ParametersObject [] {  nameapplicationPathtargetsplandeploymentOptions }

    where:

    • name is an object of type java.lang.String that specifies:

      The name of the application

    • applicationPath is an object of type java.lang.String that specifies:

      A supported Java EE application or module archive, or a root diectory for the application or module.

    • targets is an object of type [Ljava.lang.String; that specifies:

      The targets on which to deploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be distributed on all configured targets.

    • plan is an object of type java.lang.String that specifies:

      The deployment plan for this application. May be null.

    • deploymentOptions is an object of type java.util.Properties that specifies:

      Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

    SignatureString [] { "java.lang.String", "java.lang.String", "[Ljava.lang.String;", "java.lang.String", "java.util.Properties" }
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException
      RuntimeException. All other errors are reported via the returned DeploymentProgressObjectMBean.

    distribute

    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"
    ParametersObject [] {  nameapplicationPathplan }

    where:

    • name is an object of type java.lang.String that specifies:

      The name of the application

    • applicationPath is an object of type java.lang.String that specifies:

      A supported Java EE application or module archive, or a root diectory for the application or module.

    • plan is an object of type java.lang.String that specifies:

      The deployment plan for this application. May be null.

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String" }
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException
      RuntimeException. All other errors are reported via the returned DeploymentProgressObjectMBean.

    preDeregister

       
    Operation Name"preDeregister"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • java.lang.Exception

    purgeCompletedDeploymentProgressObjects

    Removes progress objects for completed operations.

       
    Operation Name"purgeCompletedDeploymentProgressObjects"
    Parametersnull
    Signaturenull
    Returns void

    removeDeploymentProgressObject

    Remove a progress object.

       
    Operation Name"removeDeploymentProgressObject"
    ParametersObject [] {  appName }

    where:

    • appName is an object of type java.lang.String that specifies:

      The name of the application that the progress object is for

    SignatureString [] { "java.lang.String" }
    Returns void