SystemComponentLifeCycleRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Provides methods that transition system component from one state to another. This class is instantiated only on the Administration Server, but you can use it to transition the states of all managed system component servers.

To start system components, you must first configure a Node Manager on each component's host machine.

           
Since12.1.2.0
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.SystemComponentLifeCycleRuntimeMBean
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.


      Tasks

      Gets pre-existing server life cycle 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 SystemComponentLifeCycleTaskRuntimeMBean named name.

      Privileges Read only
      TypeSystemComponentLifeCycleTaskRuntimeMBean[]
      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

      NodeManagerRestartCount

      The number of times the server has been restarted using the Node Manager since its creation. The first start does not count. The count is valid only if the Node Manager is used to start and restart the server every time.

             
      Privileges Read only
      Typeint

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

      Server states are described in "Managing Server Startup and Shutdown for Oracle WebLogic Server."

             
      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:


      shutdown

      Uses Node Manager to shut down a system component.

         
      Operation Name"shutdown"
      ParametersObject [] {  props }

      where:

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

        properties to use when shutting down this system component. These properties are used by the nodemanager plugin.

      SignatureString [] { "java.util.Properties" }
      ReturnsSystemComponentLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.server.ServerLifecycleException

      softRestart

      Uses Node Manager to signal a system component for softRestart.

         
      Operation Name"softRestart"
      ParametersObject [] {  props }

      where:

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

        properties to use when soft-restarting this system component. These properties are used by the nodemanager plugin.

      SignatureString [] { "java.util.Properties" }
      ReturnsSystemComponentLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.server.ServerLifecycleException

      start

      Uses Node Manager to start a system component.

         
      Operation Name"start"
      ParametersObject [] {  props }

      where:

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

        properties to use when starting this system component. These properties are used by the nodemanager plugin.

      SignatureString [] { "java.util.Properties" }
      ReturnsSystemComponentLifeCycleTaskRuntimeMBean
      Exceptions
      • weblogic.server.ServerLifecycleException