Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.management.runtime
Interface ServerLifeCycleRuntimeMBean

All Superinterfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.management.runtime.RuntimeMBean, ServerStates, weblogic.management.WebLogicMBean

public interface ServerLifeCycleRuntimeMBean

extends weblogic.management.runtime.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 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.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Field Summary

Fields inherited from interface weblogic.management.runtime.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

ServerLifeCycleTaskRuntimeMBean	forceShutdown() Immediately transitions a server to the SHUTDOWN state.
ServerLifeCycleTaskRuntimeMBean	forceSuspend() Transitions the server from RUNNING to ADMIN state forcefully cancelling inflight work.
int	getNodeManagerRestartCount() Number of times the server has been restarted using the NodeManager since creation.
String	getState() The current state of the server.
ServerLifeCycleTaskRuntimeMBean[]	getTasks() Get preexisting Server Lifecycle Tasks
ServerLifeCycleTaskRuntimeMBean	resume() Transitions the server from ADMIN to RUNNING state.
ServerLifeCycleTaskRuntimeMBean	shutdown() Gracefully transitions a server to the SHUTDOWN state.
ServerLifeCycleTaskRuntimeMBean	shutdown(int timeout, boolean ignoreSessions) Gracefully shutdown the server after handling inflight work.
ServerLifeCycleTaskRuntimeMBean	start() Uses the Node Manager to start a Managed Server.
ServerLifeCycleTaskRuntimeMBean	suspend() Gracefully suspends server to ADMIN state.
ServerLifeCycleTaskRuntimeMBean	suspend(int timeout, boolean ignoreSessions) Transitions the server from RUNNING to ADMIN state gracefully.

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

forceShutdown

public ServerLifeCycleTaskRuntimeMBean forceShutdown()
                                              throws weblogic.server.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.

Returns:

Throws:

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

forceSuspend

public ServerLifeCycleTaskRuntimeMBean forceSuspend()
                                             throws weblogic.server.ServerLifecycleException

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.

Throws:

weblogic.server.ServerLifecycleException - server failed to force suspend. A forceShutdown() operation can be invoked.

getNodeManagerRestartCount

public int getNodeManagerRestartCount()

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.

Returns:

Number of server restarts using the NodeManager

getState

public String getState()

The current state of the server.

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

Returns:

The state value

getTasks

public ServerLifeCycleTaskRuntimeMBean[] getTasks()

Get preexisting Server Lifecycle Tasks

Returns:

a list of all completed or pending server lifecycle tasks.

resume

public ServerLifeCycleTaskRuntimeMBean resume()
                                       throws weblogic.server.ServerLifecycleException

Transitions the server from ADMIN to RUNNING state.

Throws:

weblogic.server.ServerLifecycleException - If the resume operation fails

shutdown

public ServerLifeCycleTaskRuntimeMBean shutdown()
                                         throws weblogic.server.ServerLifecycleException

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

Returns:

Throws:

weblogic.server.ServerLifecycleException - If the server fails to gracefully shutdown. A forceShutdown() operation can be invoked.

shutdown

public ServerLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                                boolean ignoreSessions)
                                         throws weblogic.server.ServerLifecycleException

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

• Pending transaction's and TLOG checkpoint

• Pending HTTP sessions

• Pending JMS work

• Pending work in the Work Managers

• RMI requests with tx context or administrator calls

Parameters:

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

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

Returns:

Throws:

weblogic.server.ServerLifecycleException - If the server fails to gracefully shutdown. A forceShutdown() operation can be invoked.

start

public ServerLifeCycleTaskRuntimeMBean start()
                                      throws weblogic.server.ServerLifecycleException

Uses the Node Manager to start a Managed Server.

Throws:

weblogic.server.ServerLifecycleException - If start operation fails

suspend

public ServerLifeCycleTaskRuntimeMBean suspend()
                                        throws weblogic.server.ServerLifecycleException

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

Returns:

Throws:

weblogic.server.ServerLifecycleException - If the operation fails

See Also:

suspend(int, boolean)

suspend

public ServerLifeCycleTaskRuntimeMBean suspend(int timeout,
                                               boolean ignoreSessions)
                                        throws weblogic.server.ServerLifecycleException

Transitions the server from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

Parameters:

timeout - Seconds to wait for server to transition gracefully. The server calls forceSuspend() after timeout.

ignoreSessions - drop inflight HTTP sessions during graceful suspend

Throws:

weblogic.server.ServerLifecycleException - server failed to suspend gracefully. A forceSuspend() or a forceShutdown() operation can be invoked.