ServerLifeCycleRuntimeMBean


Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

Provides methods that transition servers from one state to another. This class is instantiated only on the Administration Server, but you can use it to transition the states of Managed Servers as well as Administration Servers.

You cannot use it to start an Administration Server, and if you want to use it to start Managed Servers, you must first set up a Node Manager on each Managed Server's host machine.

If you want to use the methods that transition a server into the ADMIN state, you must first set up an administration channel for that server.

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.ServerLifeCycleRuntimeMBean

Factory Methods

No factory methods. Instances of this MBean are created automatically.

Access Points

You can access this MBean from the following MBean attributes:


    Child MBeans

    This section describes attributes that contain child MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.


      Tasks

      Get preexisting Server Lifecycle Tasks

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeServerLifeCycleTaskRuntimeMBean[]


      Attributes

      This section describes the following attributes:


      Name

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

             
      Privileges Read only
      Typejava.lang.String

      NodeManagerRestartCount

      Number of times the server has been restarted using the NodeManager since creation. The first start does not count. The count is valid only if the NodeManager is used to start and restart the server everytime.

             
      Privileges Read only
      Typeint

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      State

      The current state of the server.

      Server states are described in weblogic.management.runtime.ServerStates.

             
      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

      Immediately transitions a server to the SHUTDOWN state. The server immediately terminates all current work, moves through the SHUTTING_DOWN state, and ends in the SHUTDOWN state.

      You can forcefully shut down a server from any state except UNKNOWN.

         
      Operation Name"forceShutdown"
      Parametersnull
      Signaturenull
      ReturnsServerLifeCycleTaskRuntimeMBean

      Exceptions

      forceSuspend

      Transitions the server from RUNNING to ADMIN state forcefully cancelling inflight work.

      Work that cannot be cancelled is dropped. Applications are brought into the admin mode forcefully.

         
      Operation Name"forceSuspend"
      Parametersnull
      Signaturenull
      ReturnsServerLifeCycleTaskRuntimeMBean

      Exceptions

      resume

      Transitions the server from ADMIN to RUNNING state.

         
      Operation Name"resume"
      Parametersnull
      Signaturenull
      ReturnsServerLifeCycleTaskRuntimeMBean

      Exceptions

      shutdown

      Gracefully transitions a server to the SHUTDOWN state. The server completes all current work before it shuts down.

         
      Operation Name"shutdown"
      Parametersnull
      Signaturenull
      ReturnsServerLifeCycleTaskRuntimeMBean

      Exceptions

      shutdown

      Gracefully shutdown the server after handling inflight work. The following inflight work is handled :

         
      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 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.

      SignatureString [] { "java.lang.Integer", "java.lang.Boolean" }
      ReturnsServerLifeCycleTaskRuntimeMBean

      Exceptions

      start

      Uses the Node Manager to start a Managed Server.

         
      Operation Name"start"
      Parametersnull
      Signaturenull
      ReturnsServerLifeCycleTaskRuntimeMBean

      Exceptions

      suspend

      Transitions the server 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 server to transition gracefully. The server 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" }
      ReturnsServerLifeCycleTaskRuntimeMBean

      Exceptions

      suspend

      Gracefully suspends server to ADMIN state. New requests are rejected and inflight work is allowed to complete.

      For more information, see:

         
      Operation Name"suspend"
      Parametersnull
      Signaturenull
      ReturnsServerLifeCycleTaskRuntimeMBean

      Exceptions