SystemComponentLifeCycleRuntimeMBean (Java API Reference for Oracle WebLogic Server)

Class

Use

Tree

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.runtime
Interface SystemComponentLifeCycleRuntimeMBean

All Superinterfaces:: DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, ServerStates, WebLogicMBean

public interface SystemComponentLifeCycleRuntimeMBean

extends RuntimeMBean, ServerStates

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.

Since:: 12.1.2.0

Field Summary

Fields inherited from interface weblogic.server.ServerStates
`ACTIVATE_LATER, ADMIN, FAILED, FAILED_NOT_RESTARTABLE, FAILED_RESTARTING, FORCE_SHUTTING_DOWN, FORCE_SUSPENDING, RESUMING, RUNNING, SHUTDOWN, SHUTDOWN_IN_PROCESS, SHUTDOWN_PENDING, SHUTTING_DOWN, STANDBY, STARTING, SUSPENDING, UNKNOWN`

Method Summary
`abstract int`	`getNodeManagerRestartCount()` The number of times the server has been restarted using the Node Manager since its creation.
`abstract String`	`getState()` The current state of the server.
`abstract SystemComponentLifeCycleTaskRuntimeMBean[]`	`getTasks()` Gets pre-existing server life cycle tasks.
`abstract SystemComponentLifeCycleTaskRuntimeMBean`	`lookupTask(String taskName)` Gets a pre-existing server life cycle task by name.
`abstract SystemComponentLifeCycleTaskRuntimeMBean`	`shutdown(Properties props)` Uses Node Manager to shut down a system component.
`abstract SystemComponentLifeCycleTaskRuntimeMBean`	`softRestart(Properties props)` Uses Node Manager to signal a system component for softRestart.
`abstract SystemComponentLifeCycleTaskRuntimeMBean`	`start(Properties props)` Uses Node Manager to start a system component.

Methods inherited from interface weblogic.management.runtime.RuntimeMBean
`addPropertyChangeListener, removePropertyChangeListener`

Methods inherited from interface weblogic.management.WebLogicMBean
`getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent`

Methods inherited from interface javax.management.DynamicMBean
`getAttribute, getAttributes, invoke, setAttribute, setAttributes`

Methods inherited from interface javax.management.MBeanRegistration
`postDeregister, postRegister, preDeregister, preRegister`

Methods inherited from interface javax.management.NotificationBroadcaster
`addNotificationListener, getNotificationInfo, removeNotificationListener`

Method Detail

start

SystemComponentLifeCycleTaskRuntimeMBean start(Properties props)
                                               throws ServerLifecycleException

Uses Node Manager to start a system component.

Parameters:: props - properties to use when starting this system component. These properties are used by the nodemanager plugin.
Returns:: a bean that can be used to track the state of thecommand.
Throws:: ServerLifecycleException - If start operation fails

shutdown

SystemComponentLifeCycleTaskRuntimeMBean shutdown(Properties props)
                                                  throws ServerLifecycleException

Uses Node Manager to shut down a system component.

Parameters:: props - properties to use when shutting down this system component. These properties are used by the nodemanager plugin.
Returns:: a bean that can be used to track the state of thecommand.
Throws:: ServerLifecycleException - If shutdown fails. The server process will exit after ServerMBean.ServerLifeCycleTimeoutVal() seconds.

getTasks

SystemComponentLifeCycleTaskRuntimeMBean[] getTasks()

Gets pre-existing server life cycle tasks.

Returns:: a list of all completed or pending server life cycle tasks.

lookupTask

SystemComponentLifeCycleTaskRuntimeMBean lookupTask(String taskName)

Gets a pre-existing server life cycle task by name.

Parameters:: taskName - a string used to find a task of the same name
Returns:: a server life cycle task that matches taskName or null if no task name matches taskName

getState

String getState()

The current state of the server.

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

Returns:: The state value

getNodeManagerRestartCount

int getNodeManagerRestartCount()

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.

Returns:: Number of server restarts using the Node Manager

softRestart

SystemComponentLifeCycleTaskRuntimeMBean softRestart(Properties props)
                                                     throws ServerLifecycleException

Uses Node Manager to signal a system component for softRestart.

Parameters:: props - properties to use when soft-restarting this system component. These properties are used by the nodemanager plugin.
Returns:: a bean that can be used to track the state of thecommand.
Throws:: ServerLifecycleException - If softRestart operation fails

Overview

Package