Skip navigation links

weblogic.management.runtime
Interface ResourceGroupLifeCycleRuntimeMBean

All Superinterfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface ResourceGroupLifeCycleRuntimeMBean

extends RuntimeMBean

start

ResourceGroupLifeCycleTaskRuntimeMBean start()
                                             throws ResourceGroupLifecycleException

Starts resource group.

Throws:

ResourceGroupLifecycleException - if start operation fails

getState

String getState()

Current resource group state.

Returns:

The state value

getTasks

ResourceGroupLifeCycleTaskRuntimeMBean[] getTasks()

Get preexisting Resource Group Lifecycle Tasks

Returns:

an array of all completed or pending resource group lifecycle tasks.

lookupTask

ResourceGroupLifeCycleTaskRuntimeMBean lookupTask(String taskName)

Get preexisting Partition Lifecycle Task.

Parameters:

taskName -

Returns:

ResourceGroupLifeCycleTaskRuntimeMBean based on the name passed by the user

start

ResourceGroupLifeCycleTaskRuntimeMBean start(TargetMBean[] targets)
                                             throws ResourceGroupLifecycleException

Starts the resource group on specified targets.

Parameters:

targets - the specific targets on which to start this resource group

Returns:

task usable by caller to monitor progress

Throws:

ResourceGroupLifecycleException - if the start fails

startInAdmin

ResourceGroupLifeCycleTaskRuntimeMBean startInAdmin(TargetMBean[] targets)
                                                    throws ResourceGroupLifecycleException

Starts the resource group in the admin state in specified targets

Parameters:

targets - the specific targets on which to start this resource group in "admin" state

Returns:

task usable by caller to monitor progress

Throws:

ResourceGroupLifecycleException - if the start fails

startInAdmin

ResourceGroupLifeCycleTaskRuntimeMBean startInAdmin()
                                                    throws ResourceGroupLifecycleException

Starts the resource group in the admin state in all the targets

Returns:

task usable by caller to monitor progress

Throws:

ResourceGroupLifecycleException - if the start fails

shutdown

ResourceGroupLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                                boolean ignoreSessions,
                                                boolean waitForAllSessions)
                                                throws ResourceGroupLifecycleException

Gracefully shuts down a resource group.

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.

waitForAllSessions - Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

Returns:

task object for monitoring the operation's progress

Throws:

ResourceGroupLifecycleException - If the resource group fails to gracefully shutdown. A ResourceGroupLifeCycleRuntimeMBean.forceShutdown() operation can be invoked.

shutdown

ResourceGroupLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                                boolean ignoreSessions,
                                                boolean waitForAllSessions,
                                                TargetMBean[] targets)
                                                throws ResourceGroupLifecycleException

Gracefully shuts down a resource group.

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.

waitForAllSessions - Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

targets - the specific targets on which to shut down this resource group

Returns:

task object for monitoring the operation's progress

Throws:

ResourceGroupLifecycleException - If the resource group fails to gracefully shutdown. A ResourceGroupLifeCycleRuntimeMBean.forceShutdown() operation can be invoked.

shutdown

ResourceGroupLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                                boolean ignoreSessions,
                                                TargetMBean[] targets)
                                                throws ResourceGroupLifecycleException

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Parameters:

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

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

targets - the specific targets on which to shut down this resource group

Throws:

ResourceGroupLifecycleException - Thrown if the resource group cannot gracefully shutdown. Use the forceShutdown command to shutdown the resource group.

shutdown

ResourceGroupLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                                boolean ignoreSessions)
                                                throws ResourceGroupLifecycleException

Shuts down a resource group gracefully. (equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Parameters:

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

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

Throws:

ResourceGroupLifecycleException - Thrown if the resource group cannot gracefully shutdown. Use the forceShutdown command to shutdown the resource group.

shutdown

ResourceGroupLifeCycleTaskRuntimeMBean shutdown(TargetMBean[] targets)
                                                throws ResourceGroupLifecycleException

Shuts down the resource group gracefully. (equivalent to shutdown(targets, 0, false)).

Parameters:

targets - the specific targets on which to start this resource group

Returns:

task usable by caller to monitor progress

Throws:

ResourceGroupLifecycleException - if the shutdown fails

shutdown

ResourceGroupLifeCycleTaskRuntimeMBean shutdown()
                                                throws ResourceGroupLifecycleException

Shuts down the resource group gracefully on all targets.

Returns:

task usable by caller to monitor progress

Throws:

ResourceGroupLifecycleException - if the shutdown fails

forceShutdown

ResourceGroupLifeCycleTaskRuntimeMBean forceShutdown(TargetMBean[] targets)
                                                     throws ResourceGroupLifecycleException

Forces the shutdown of the resource group on specified targets.

Parameters:

targets - the specific targets on which to start this resource group

Returns:

task object for monitoring the shutdown

Throws:

ResourceGroupLifecycleException - if the resource group fails to shut down

forceShutdown

ResourceGroupLifeCycleTaskRuntimeMBean forceShutdown()
                                                     throws ResourceGroupLifecycleException

Forces the shutdown of the resource group.

Returns:

task object for monitoring the shutdown

Throws:

ResourceGroupLifecycleException - if the resource group fails to shut down

suspend

ResourceGroupLifeCycleTaskRuntimeMBean suspend(int timeout,
                                               boolean ignoreSessions,
                                               TargetMBean[] targets)
                                               throws ResourceGroupLifecycleException

Transitions the resource group from RUNNING to ADMIN state gracefully on specified targets.

Applications are in admin mode. Inflight work is completed.

Parameters:

timeout - Seconds to wait for the resource group to transition gracefully. The resource group automatically calls ResourceGroupLifeCycleRuntimeMBean.forceSuspend() after timeout.

ignoreSessions - drop inflight HTTP sessions during graceful suspend

targets - the specific targets on which to start this resource group

Throws:

ResourceGroupLifecycleException - resource group failed to suspend gracefully. A ResourceGroupLifeCycleRuntimeMBean.forceSuspend() or a ResourceGroupLifeCycleRuntimeMBean.forceShutdown() operation can be invoked.

suspend

ResourceGroupLifeCycleTaskRuntimeMBean suspend(int timeout,
                                               boolean ignoreSessions)
                                               throws ResourceGroupLifecycleException

Transitions the resource group from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

Parameters:

timeout - Seconds to wait for the resource group to transition gracefully. The resource group automatically calls ResourceGroupLifeCycleRuntimeMBean.forceSuspend() after timeout.

ignoreSessions - drop inflight HTTP sessions during graceful suspend

Throws:

ResourceGroupLifecycleException - resource group failed to suspend gracefully. A ResourceGroupLifeCycleRuntimeMBean.forceSuspend() or a ResourceGroupLifeCycleRuntimeMBean.forceShutdown() operation can be invoked.

suspend

ResourceGroupLifeCycleTaskRuntimeMBean suspend(TargetMBean[] targets)
                                               throws ResourceGroupLifecycleException

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

Parameters:

targets - the specific targets on which to start this resource group

Throws:

ResourceGroupLifecycleException - If the operation fails

See Also:

ResourceGroupLifeCycleRuntimeMBean.suspend(int, boolean)

suspend

ResourceGroupLifeCycleTaskRuntimeMBean suspend()
                                               throws ResourceGroupLifecycleException

Gracefully suspends the resource group to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.

Throws:

ResourceGroupLifecycleException - If the operation fails

See Also:

ResourceGroupLifeCycleRuntimeMBean.suspend(int, boolean)

forceSuspend

ResourceGroupLifeCycleTaskRuntimeMBean forceSuspend(TargetMBean[] targets)
                                                    throws ResourceGroupLifecycleException

Forcefully suspends the resource group on specified targets.

Parameters:

targets - the specific targets on which to start this resource group

Returns:

ResourceGroupLifeCycleTaskRuntimeMBean task object for monitoring the operation

Throws:

ResourceGroupLifecycleException - the resource group could not suspend.

forceSuspend

ResourceGroupLifeCycleTaskRuntimeMBean forceSuspend()
                                                    throws ResourceGroupLifecycleException

Forcefully suspends the resource group.

Returns:

ResourceGroupLifeCycleTaskRuntimeMBean task object for monitoring the operation

Throws:

ResourceGroupLifecycleException - the resource group could not suspend.

resume

ResourceGroupLifeCycleTaskRuntimeMBean resume(TargetMBean[] targets)
                                              throws ResourceGroupLifecycleException

Transitions the resource group from ADMIN to RUNNING state on specified targets.

Parameters:

targets - the specific targets on which to start this resource group

Throws:

ResourceGroupLifecycleException - If the resume operation fails

resume

ResourceGroupLifeCycleTaskRuntimeMBean resume()
                                              throws ResourceGroupLifecycleException

Transitions the resource group from ADMIN to RUNNING state.

Throws:

ResourceGroupLifecycleException - If the resume operation fails

purgeTasks

void purgeTasks()

Clears the retained task collection.

Skip navigation links