AppDeploymentRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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.

           
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
  • Operator
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.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:


    Attributes

    This section describes the following attributes:


    ApplicationName

    The application's name.

           
    Privileges Read only
    Typejava.lang.String

    ApplicationVersion

    The application's version identifier.

           
    Privileges Read only
    Typejava.lang.String

    CachingDisabled

    Private property that disables caching in proxies.

           
    Privileges Read only
    Typeboolean

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo

    Modules

    The list of modules for the application. These modules can be used in module level targeting.

           
    Privileges Read only
    Typeclass java.lang.String[]

    Name

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

           
    Privileges Read only
    Typejava.lang.String

    ObjectName

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

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    PartitionName

    The name of the partition the application is in.

           
    Available Since Release 12.2.1.0.0
    Privileges Read only
    Typejava.lang.String

    Registered

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

    Deprecated.

           
    Privileges Read only
    Typeboolean

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String


    Operations

    This section describes the following operations:


    getState

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

    where:

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

      the target for the application state

    SignatureString [] { "java.lang.String" }
    ReturnsString

    redeploy

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

    where:

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

      The targets on which to redeploy 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.

    • 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. May be null.

    • 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 [] { "[Ljava.lang.String;", "java.lang.String", "java.lang.String", "java.util.Properties" }
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException

    redeploy

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

    where:

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

      The targets on which to redeploy 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 [] { "[Ljava.lang.String;", "java.lang.String", "java.util.Properties" }
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException

    redeploy

    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"
    Parametersnull
    Signaturenull
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException

    start

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

    where:

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

      The targets on which to start 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 started on all configured targets.

    • 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 [] { "[Ljava.lang.String;", "java.util.Properties" }
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException

    start

    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"
    Parametersnull
    Signaturenull
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException

    stop

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

    where:

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

      The targets on which to stop 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 stoped on all configured targets.

    • 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 [] { "[Ljava.lang.String;", "java.util.Properties" }
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException

    stop

    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"
    Parametersnull
    Signaturenull
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException

    undeploy

    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"
    Parametersnull
    Signaturenull
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException

    undeploy

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

    where:

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

      The targets on which to undeploy 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 undeployed on all configured targets.

    • 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 [] { "[Ljava.lang.String;", "java.util.Properties" }
    ReturnsDeploymentProgressObjectMBean
    Exceptions
    • java.lang.RuntimeException

    update

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

    where:

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

      represent the targets on which to update the application.

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

      The deployment plan containing the new deployment configuration information.

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

      Allows for overriding the deployment options. May be null.

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