CoherenceServerLifeCycleRuntimeMBean (Java API Reference for Oracle WebLogic Server)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

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

Part Number E27170-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.runtime
Interface CoherenceServerLifeCycleRuntimeMBean

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

public interface CoherenceServerLifeCycleRuntimeMBean
extends RuntimeMBean, ServerStates
extends RuntimeMBean, ServerStates

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 all managed Coherence cache servers.

To start Coherence cache servers, you must first configure a Node Manager on each Coherence cache server's host machine.

Access limited to the following security roles:: Operator

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
`CoherenceServerLifeCycleTaskRuntimeMBean`	`forceShutdown()` Immediately transitions a server to the `SHUTDOWN` state.
`int`	`getNodeManagerRestartCount()` The number of times the server has been restarted using the Node Manager since its creation.
`String`	`getState()` The current state of the server.
`CoherenceServerLifeCycleTaskRuntimeMBean[]`	`getTasks()` Gets pre-existing server life cycle tasks.
`CoherenceServerLifeCycleTaskRuntimeMBean`	`start()` Uses Node Manager to start a Coherence cache server.

Methods inherited from interface weblogic.management.WebLogicMBean
`getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, 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

CoherenceServerLifeCycleTaskRuntimeMBean start()
                                               throws ServerLifecycleException

Uses Node Manager to start a Coherence cache server.

Throws:: ServerLifecycleException - If start operation fails

forceShutdown

CoherenceServerLifeCycleTaskRuntimeMBean forceShutdown()
                                                       throws ServerLifecycleException

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.

Throws:: ServerLifecycleException - If force shutdown fails. The server process will exit after ServerMBean.ServerLifeCycleTimeoutVal() seconds.

getTasks

CoherenceServerLifeCycleTaskRuntimeMBean[] getTasks()

Gets pre-existing server life cycle tasks.

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

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