PartitionLifeCycleRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Information for this MBean is available only at runtime.

To view information about this MBean, start the host WebLogic Server instance, then use WebLogic Scripting Tool in interactive mode. Or use some other MBean browser.

       
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • 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.PartitionLifeCycleRuntimeMBean
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.


      ResourceGroupLifeCycleRuntimes

      Get resource group lifecycle tasks for this partition.

                 
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Lookup OperationlookupResourceGroupLifeCycleRuntime(String name)

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

      Privileges Read only
      TypeResourceGroupLifeCycleRuntimeMBean[]
      Relationship type: Containment.

      Tasks

      Get preexisting Partition Lifecycle Tasks.

                 
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Lookup OperationlookupTask(String name)

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

      Privileges Read only
      TypePartitionLifeCycleTaskRuntimeMBean[]
      Relationship type: Containment.


      Attributes

      This section describes the following attributes:


      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

      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

      Registered

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

      Deprecated.

             
      Privileges Read only
      Typeboolean

      State

      The current state of the partition.

             
      Privileges Read only
      Typejava.lang.String

      Type

      Returns the type of the MBean.

             
      Privileges Read only
      Typejava.lang.String


      Operations

      This section describes the following operations:


      forceShutdown

         
      Operation Name"forceShutdown"
      ParametersObject [] {  timeout }

      where:

      • timeout is an object of type java.lang.Integer that specifies:

        timeout

      SignatureString [] { "java.lang.Integer" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException
      • java.lang.InterruptedException
        InterruptedException

      forceShutdown

      Forces the shutdown of the partition.

         
      Operation Name"forceShutdown"
      Parametersnull
      Signaturenull
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException if the partition fails to shut down

      forceShutdown

      Forces the shutdown of the partition on specified targets.

         
      Operation Name"forceShutdown"
      ParametersObject [] {  targets }

      where:

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to start this partition

      SignatureString [] { "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException if the partition fails to shut down

      forceSuspend

      Forcefully suspends the partition.

         
      Operation Name"forceSuspend"
      Parametersnull
      Signaturenull
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException the partition could not suspend.

      forceSuspend

      Forcefully suspends the partition on specified targets.

         
      Operation Name"forceSuspend"
      ParametersObject [] {  targets }

      where:

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to start this partition

      SignatureString [] { "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException the partition could not suspend.

      getState

      Get the state of partition on a specific server.

         
      Operation Name"getState"
      ParametersObject [] {  serverMBean }

      where:

      • serverMBean is an object of type weblogic.management.configuration.ServerMBean that specifies:

        serverMBean

      SignatureString [] { "weblogic.management.configuration.ServerMBean" }
      ReturnsString
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException

      purgeTasks

      Clears the retained task collection.

         
      Operation Name"purgeTasks"
      Parametersnull
      Signaturenull
      Returns void

      resume

      Transitions the partition from ADMIN to RUNNING state.

         
      Operation Name"resume"
      Parametersnull
      Signaturenull
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException If the resume operation fails

      resume

      Transitions the partition from ADMIN to RUNNING state on specified targets..

         
      Operation Name"resume"
      ParametersObject [] {  targets }

      where:

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to start this partition

      SignatureString [] { "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException If the resume operation fails

      shutdown

      Shuts down the partition gracefully. (equivalent to shutdown(targets, 0, false)).

         
      Operation Name"shutdown"
      ParametersObject [] {  targets }

      where:

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to start this partition

      SignatureString [] { "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException if the shutdown fails

      shutdown

      Gracefully shuts down a partition.

         
      Operation Name"shutdown"
      ParametersObject [] {  timeoutignoreSessionswaitForAllSessionstargets }

      where:

      • timeout is an object of type java.lang.Integer that specifies:

        Number of seconds to wait before aborting inflight work and force shutting down the server.

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

        Set to true to ignore pending HTTP sessions during inflight work handling.

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

        Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to shut down this partition

      SignatureString [] { "java.lang.Integer", "java.lang.Boolean", "java.lang.Boolean", "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException If the partition fails to gracefully shutdown. A {@link #forceShutdown()} operation can be invoked.

      shutdown

      Gracefully shuts down a partition.

         
      Operation Name"shutdown"
      ParametersObject [] {  timeoutignoreSessionswaitForAllSessions }

      where:

      • timeout is an object of type java.lang.Integer that specifies:

        Number of seconds to wait before aborting inflight work and force shutting down the server.

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

        Set to true to ignore pending HTTP sessions during inflight work handling.

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

        Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

      SignatureString [] { "java.lang.Integer", "java.lang.Boolean", "java.lang.Boolean" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException If the partition fails to gracefully shutdown. A {@link #forceShutdown()} operation can be invoked.

      shutdown

      Shuts down a partition gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

         
      Operation Name"shutdown"
      ParametersObject [] {  timeoutignoreSessionstargets }

      where:

      • timeout is an object of type java.lang.Integer that specifies:

        Number of seconds to wait before aborting inflight work and shutting down the server.

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

        true

        indicates ignore pending HTTP sessions during inflight work handling.

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to shut down this partition

      SignatureString [] { "java.lang.Integer", "java.lang.Boolean", "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the partition.

      shutdown

      Shuts down the partition gracefully on all targets.

         
      Operation Name"shutdown"
      Parametersnull
      Signaturenull
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException if the shutdown fails

      shutdown

      Shuts down a partition gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

         
      Operation Name"shutdown"
      ParametersObject [] {  timeoutignoreSessions }

      where:

      • timeout is an object of type java.lang.Integer that specifies:

        Number of seconds to wait before aborting inflight work and shutting down the server.

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

        true

        indicates ignore pending HTTP sessions during inflight work handling.

      SignatureString [] { "java.lang.Integer", "java.lang.Boolean" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the partition.

      start

      Starts partition.

         
      Operation Name"start"
      Parametersnull
      Signaturenull
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException If start operation fails

      start

      Starts the partition in initalState within the specified timeOut

         
      Operation Name"start"
      ParametersObject [] {  initialStatetimeOut }

      where:

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

        can be can be ADMIN or RUNNING, Default is RUNNING

      • timeOut is an object of type java.lang.Integer that specifies:

        Specifies the number of milliseconds to start a Partition. Throws InterruptedException if Partition is unable to start during that duration and leaves the Partition in UNKNOWN state. Default is 60000ms

      SignatureString [] { "java.lang.String", "java.lang.Integer" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        InterruptedException
      • java.lang.InterruptedException
        PartitionLifeCycleException

      start

      Starts the partition on specified targets.

         
      Operation Name"start"
      ParametersObject [] {  targets }

      where:

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to start this partition

      SignatureString [] { "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException if the start fails

      startInAdmin

      Starts the partition in the admin state.

         
      Operation Name"startInAdmin"
      Parametersnull
      Signaturenull
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException if the start fails

      startInAdmin

      Starts the partition in the admin state.

         
      Operation Name"startInAdmin"
      ParametersObject [] {  targets }

      where:

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to start this partition in "admin" state

      SignatureString [] { "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException if the start fails

      suspend

      Transitions the partition from RUNNING to ADMIN state gracefully on specified targets.

      Applications are in admin mode. Inflight work is completed.

         
      Operation Name"suspend"
      ParametersObject [] {  timeoutignoreSessionstargets }

      where:

      • timeout is an object of type java.lang.Integer that specifies:

        Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.

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

        drop inflight HTTP sessions during graceful suspend

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to start this partition

      SignatureString [] { "java.lang.Integer", "java.lang.Boolean", "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException partition failed to suspend gracefully. A {@link #forceSuspend()} or a {@link #forceShutdown()} operation can be invoked.

      suspend

      Gracefully suspends the partition to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

      For more information, see:

         
      Operation Name"suspend"
      Parametersnull
      Signaturenull
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException If the operation fails

      suspend

      Transitions the partition from RUNNING to ADMIN state gracefully.

      Applications are in admin mode. Inflight work is completed.

         
      Operation Name"suspend"
      ParametersObject [] {  timeoutignoreSessions }

      where:

      • timeout is an object of type java.lang.Integer that specifies:

        Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.

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

        drop inflight HTTP sessions during graceful suspend

      SignatureString [] { "java.lang.Integer", "java.lang.Boolean" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException partition failed to suspend gracefully. A {@link #forceSuspend()} or a {@link #forceShutdown()} operation can be invoked.

      suspend

      Gracefully suspends the partition to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

      For more information, see:

         
      Operation Name"suspend"
      ParametersObject [] {  targets }

      where:

      • targets is an object of type [Lweblogic.management.configuration.TargetMBean; that specifies:

        the specific targets on which to start this partition

      SignatureString [] { "[Lweblogic.management.configuration.TargetMBean;" }
      ReturnsPartitionLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.management.PartitionLifeCycleException
        PartitionLifeCycleException If the operation fails