Package weblogic.management.runtime

Interface PartitionLifeCycleRuntimeMBean

All Superinterfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface PartitionLifeCycleRuntimeMBean
extends RuntimeMBean

Provides methods that transition partitions from one state to another. This class is instantiated once for each partition but only on the Administration Server. Even so, you can use a partition's instance to change the state of the partition on Managed Servers as well as on the Administration Server.

Detecting when Operations Complete

Methods representing operations on partitions return a PartitionLifeCycleTaskRuntimeMBean object. The caller should monitor the returned instance, invoking its TaskRuntimeMBean.isRunning() method to detect when the operation has completed. In particular, the caller should not rely on the value returned from getState() to indicate when an operation on a partition that is targeted to multiple servers has finished. That value will be accurate as described in detail on getState() but can change before the operation has finished.

Desired States

The system tracks the desired state for each partition, which defaults to the state SHUTDOWN and substate HALTED. Whenever a lifecycle operation method is called the system not only performs the requested action on the partition but also records the resulting state as the new desired state for the partition.

The system uses the desired state for a partition to bring the partition to the correct state during server restart. It can also be used when the getState() method computes the overall state for the partition.

Access limited to the following security roles:

Operator

Method Summary

Modifier and Type	Method	Description
PartitionLifeCycleTaskRuntimeMBean	boot()	Begins the transition of the partition from the SHUTDOWN state and HALTED substate to the SHUTDOWN state and BOOTED substate on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	boot(java.lang.String[] targetNames)	Begins the transition of the partition from the SHUTDOWN state and HALTED substate to the SHUTDOWN state and BOOTED substate on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	boot(TargetMBean[] targets)	Deprecated. 12.2.1.3.0
PartitionLifeCycleTaskRuntimeMBean	forceShutdown()	Begins to force the shutdown of this partition on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	forceShutdown(java.lang.String[] targetNames)	Begins to force the shut down of this partition on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	forceShutdown(TargetMBean[] targets)	Deprecated. 12.2.1.3.0
PartitionLifeCycleTaskRuntimeMBean	forceSuspend()	Begins the forceful transition of the partition from the RUNNING state to the ADMIN state on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	forceSuspend(java.lang.String[] targetNames)	Begins the forceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	forceSuspend(TargetMBean[] targets)	Deprecated. 12.2.1.3.0
ResourceGroupLifeCycleRuntimeMBean[]	getResourceGroupLifeCycleRuntimes()	The resource group lifecycle tasks for this partition.
java.lang.String	getState()	The current overall state of the partition.
java.lang.String	getState(java.lang.String serverName)	The current state of the partition on a specific server.
java.lang.String	getState(ServerMBean serverMBean)	Deprecated. 12.2.1.2.0
java.lang.String	getSubState()	The current substate of the partition.
java.lang.String	getSubState(java.lang.String serverName)	The current substate of the partition on a specific server.
java.lang.String	getSubState(ServerMBean serverMBean)	Deprecated. 12.2.1.2.0
PartitionLifeCycleTaskRuntimeMBean[]	getTasks()	The preexisting partition lifecycle tasks.
PartitionLifeCycleTaskRuntimeMBean	halt()	Begins the forceful transition of the partition from the RUNNING state or the ADMIN state to the SHUTDOWN state and HALTED substate on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	halt(java.lang.String[] targetNames)	Begins the forceful transition of the partition from the RUNNING state or the ADMIN state to the SHUTDOWN state and HALTED substate on a specific set of targets.
PartitionLifeCycleTaskRuntimeMBean	halt(TargetMBean[] targets)	Deprecated. 12.2.1.3.0
ResourceGroupLifeCycleRuntimeMBean	lookupResourceGroupLifeCycleRuntime(java.lang.String name)	Look up the named resource group lifecycle task for this partition.
PartitionLifeCycleTaskRuntimeMBean	lookupTask(java.lang.String taskName)	The preexisting partition lifecycle task.
void	purgeTasks()	Clears the retained task collection.
PartitionLifeCycleTaskRuntimeMBean	resume()	Begins the transition of the partition from the ADMIN state to the RUNNING state on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	resume(java.lang.String[] targetNames)	Begins the transition of the partition from the ADMIN state to the RUNNING state on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	resume(TargetMBean[] targets)	Deprecated. 12.2.1.3.0
PartitionLifeCycleTaskRuntimeMBean	shutdown()	Begins to shut down this partition gracefully on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	shutdown(int timeout, boolean ignoreSessions)	Begins to shut down this partition gracefully on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions)	Begins to shut down this partition gracefully on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions, java.lang.String[] targetNames)	Begins to shut down this partition gracefully on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions, TargetMBean[] targets)	Deprecated. 12.2.1.3.0
PartitionLifeCycleTaskRuntimeMBean	shutdown(int timeout, boolean ignoreSessions, java.lang.String[] targetNames)	Begins to shut down this partition gracefully on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	shutdown(int timeout, boolean ignoreSessions, TargetMBean[] targets)	Deprecated. 12.2.1.3.0
PartitionLifeCycleTaskRuntimeMBean	shutdown(java.lang.String[] targetNames)	Begins to shut down this partition gracefully on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	shutdown(TargetMBean[] targets)	Deprecated. 12.2.1.3.0
PartitionLifeCycleTaskRuntimeMBean	start()	Begins to start this partition on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	start(java.lang.String[] targetNames)	Begins to start this partition on the specified servers.
PartitionLifeCycleTaskRuntimeMBean	start(java.lang.String initialState, int timeOut)	Begins to start this partition in the specified initialState within the specified timeOut on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	start(TargetMBean[] targets)	Deprecated. 12.2.1.3.0
PartitionLifeCycleTaskRuntimeMBean	startInAdmin()	Begins to start this partition in the ADMIN state on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	startInAdmin(java.lang.String[] targetNames)	Begins to start this partition in the ADMIN state on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	startInAdmin(TargetMBean[] targets)	Deprecated. 12.2.1.3.0
PartitionLifeCycleTaskRuntimeMBean	suspend()	Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	suspend(int timeout, boolean ignoreSessions)	Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on all targeted servers.
PartitionLifeCycleTaskRuntimeMBean	suspend(int timeout, boolean ignoreSessions, java.lang.String[] targetNames)	Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	suspend(int timeout, boolean ignoreSessions, TargetMBean[] targets)	Deprecated. 12.2.1.3.0
PartitionLifeCycleTaskRuntimeMBean	suspend(java.lang.String[] targetNames)	Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.
PartitionLifeCycleTaskRuntimeMBean	suspend(TargetMBean[] targets)	Deprecated. 12.2.1.3.0

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

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

Method Detail

start

PartitionLifeCycleTaskRuntimeMBean start()
                                  throws PartitionLifeCycleException

Begins to start this partition on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Throws:

PartitionLifeCycleException - If start operation fails

getState

java.lang.String getState()

The current overall state of the partition.

The value returned is the highest state for the partition on all servers where it is targeted. As a result, the overall partition state can change (for example, to RUNNING) as soon as the operation (such as start) has finished on one server, even while the operation is still in progress elsewhere.

If the partition is not currently targeted to any running server then its reported state is the desired state indicated by the most recent partition life cycle operation on the partition.

Returns:

The state value

getSubState

java.lang.String getSubState()

The current substate of the partition. It is mostly useful for knowing whether the partition is completely shutdown and the administrative resource groups are not running, in which case this method returns HALTED, or if the partition is in the SHUTDOWN.BOOTED state and the administrative resource groups are running, in which case this method returns BOOTED.

Returns:

The substate value

getTasks

PartitionLifeCycleTaskRuntimeMBean[] getTasks()

The preexisting partition lifecycle tasks.

Returns:

an array of all completed or pending partition lifecycle tasks.

lookupTask

PartitionLifeCycleTaskRuntimeMBean lookupTask(java.lang.String taskName)

The preexisting partition lifecycle task.

Parameters:

taskName -

Returns:

PartitionLifeCycleTaskRuntimeMBean based on the name passed by the user

getResourceGroupLifeCycleRuntimes

ResourceGroupLifeCycleRuntimeMBean[] getResourceGroupLifeCycleRuntimes()

The resource group lifecycle tasks for this partition.

Returns:

an array of all resource group lifecycle runtimes in this partition

lookupResourceGroupLifeCycleRuntime

ResourceGroupLifeCycleRuntimeMBean lookupResourceGroupLifeCycleRuntime(java.lang.String name)

Look up the named resource group lifecycle task for this partition.

Parameters:

name - resource lifecycle name

Returns:

named resource group lifecycle runtime

start

@Deprecated
PartitionLifeCycleTaskRuntimeMBean start(TargetMBean[] targets)
                                  throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins to start this partition on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.start(String[] targetNames)

Parameters:

targets - the specific targets on which to start this partition

Returns:

task usable by caller to monitor progress

Throws:

PartitionLifeCycleException - if the start fails

start

PartitionLifeCycleTaskRuntimeMBean start(java.lang.String[] targetNames)
                                  throws PartitionLifeCycleException

Begins to start this partition on the specified servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Parameters:

targetNames - the specific servers on which to start this partition

Returns:

task usable by caller to monitor progress

Throws:

PartitionLifeCycleException - if the start fails

startInAdmin

@Deprecated
PartitionLifeCycleTaskRuntimeMBean startInAdmin(TargetMBean[] targets)
                                         throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins to start this partition in the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.startInAdmin(String[] targetNames)

Parameters:

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

Returns:

task usable by caller to monitor progress

Throws:

PartitionLifeCycleException - if the start fails

startInAdmin

PartitionLifeCycleTaskRuntimeMBean startInAdmin(java.lang.String[] targetNames)
                                         throws PartitionLifeCycleException

Begins to start this partition in the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Parameters:

targetNames - the specific servers on which to start this partition in "admin" state

Returns:

task usable by caller to monitor progress

Throws:

PartitionLifeCycleException - if the start fails

startInAdmin

PartitionLifeCycleTaskRuntimeMBean startInAdmin()
                                         throws PartitionLifeCycleException

Begins to start this partition in the ADMIN state on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Returns:

task usable by caller to monitor progress

Throws:

PartitionLifeCycleException - if the start fails

start

PartitionLifeCycleTaskRuntimeMBean start(java.lang.String initialState,
                                         int timeOut)
                                  throws PartitionLifeCycleException,
                                         java.lang.InterruptedException

Begins to start this partition in the specified initialState within the specified timeOut on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Parameters:

initialState - can be can be ADMIN or RUNNING, default is RUNNING.

timeOut - Specifies the number of milliseconds to start a Partition. Throws InterruptedException if Partition is unable to start during that duration and leaves the Partition in UNKNOWN state. Default is 60000ms

Returns:

Task usable by caller to monitor progress

Throws:

java.lang.InterruptedException

PartitionLifeCycleException

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                            boolean ignoreSessions,
                                            boolean waitForAllSessions)
                                     throws PartitionLifeCycleException

Begins to shut down this partition gracefully on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

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:

PartitionLifeCycleException - If the partition fails to gracefully shutdown. A forceShutdown() operation can be invoked.

shutdown

@Deprecated
PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                            boolean ignoreSessions,
                                            boolean waitForAllSessions,
                                            TargetMBean[] targets)
                                     throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins to shut down this partition gracefully on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions, String[] targetNames)

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 partition

Returns:

task object for monitoring the operation's progress

Throws:

PartitionLifeCycleException - If the partition fails to gracefully shutdown. A forceShutdown() operation can be invoked.

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                            boolean ignoreSessions,
                                            boolean waitForAllSessions,
                                            java.lang.String[] targetNames)
                                     throws PartitionLifeCycleException

Begins to shut down this partition gracefully on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

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.

targetNames - the specific servers on which to shut down this partition

Returns:

task object for monitoring the operation's progress

Throws:

PartitionLifeCycleException - If the partition fails to gracefully shutdown. A forceShutdown() operation can be invoked.

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                            boolean ignoreSessions)
                                     throws PartitionLifeCycleException

Begins to shut down this partition gracefully on all targeted servers.

(Equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

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:

PartitionLifeCycleException - Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the partition.

shutdown

@Deprecated
PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                            boolean ignoreSessions,
                                            TargetMBean[] targets)
                                     throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins to shut down this partition gracefully on the specified targets.

(Equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.shutdown(int timeout, boolean ignoreSessions, String[] targetNames)

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 partition

Throws:

PartitionLifeCycleException - Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the partition.

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                            boolean ignoreSessions,
                                            java.lang.String[] targetNames)
                                     throws PartitionLifeCycleException

Begins to shut down this partition gracefully on the specified targets.

(Equivalent to shutdown(timeout, ignoreSessions, false, targets)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

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.

targetNames - the specific servers on which to shut down this partition

Throws:

PartitionLifeCycleException - Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the partition.

shutdown

@Deprecated
PartitionLifeCycleTaskRuntimeMBean shutdown(TargetMBean[] targets)
                                     throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins to shut down this partition gracefully on the specified targets.

(Equivalent to shutdown(targets, 0, false)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.shutdown(String[] targetNames)

Parameters:

targets - the specific targets on which to shut down this partition

Returns:

task usable by caller to monitor progress

Throws:

PartitionLifeCycleException - if the shutdown fails

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown(java.lang.String[] targetNames)
                                     throws PartitionLifeCycleException

Begins to shut down this partition gracefully on the specified targets.

(Equivalent to shutdown(targets, 0, false)).

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Parameters:

targetNames - the specific servers on which to shut down this partition

Returns:

task usable by caller to monitor progress

Throws:

PartitionLifeCycleException - if the shutdown fails

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown()
                                     throws PartitionLifeCycleException

Begins to shut down this partition gracefully on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Returns:

task usable by caller to monitor progress

Throws:

PartitionLifeCycleException - if the shutdown fails

forceShutdown

@Deprecated
PartitionLifeCycleTaskRuntimeMBean forceShutdown(TargetMBean[] targets)
                                          throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins to force the shut down of this partition on the specified targets.

On each target the partition is shut down and then restored to its current state on that server.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.forceShutdown(String[] targetNames)

Parameters:

targets - the specific targets on which to shut down this partition

Returns:

task object for monitoring the shutdown

Throws:

PartitionLifeCycleException - if the partition fails to shut down

forceShutdown

PartitionLifeCycleTaskRuntimeMBean forceShutdown(java.lang.String[] targetNames)
                                          throws PartitionLifeCycleException

Begins to force the shut down of this partition on the specified targets.

On each target the partition is shut down and then restored to its current state on that server.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Parameters:

targetNames - the specific servers on which to shut down this partition

Returns:

task object for monitoring the shutdown

Throws:

PartitionLifeCycleException - if the partition fails to shut down

forceShutdown

PartitionLifeCycleTaskRuntimeMBean forceShutdown()
                                          throws PartitionLifeCycleException

Begins to force the shutdown of this partition on all targeted servers.

On each targeted server the partition is shut down and thenrestored to its current state on that server.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Returns:

task object for monitoring the shutdown

Throws:

PartitionLifeCycleException - if the partition fails to shut down

suspend

@Deprecated
PartitionLifeCycleTaskRuntimeMBean suspend(int timeout,
                                           boolean ignoreSessions,
                                           TargetMBean[] targets)
                                    throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Applications are in admin mode. Inflight work is completed.

Please use PartitionLifeCycleRuntimeMBean.suspend(int timeout, boolean ignoreSessions, String[] targetNames)

Parameters:

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

ignoreSessions - drop inflight HTTP sessions during graceful suspend

targets - the specific targets on which to suspend this partition

Throws:

PartitionLifeCycleException - partition failed to suspend gracefully. A forceSuspend() or a forceShutdown() operation can be invoked.

suspend

PartitionLifeCycleTaskRuntimeMBean suspend(int timeout,
                                           boolean ignoreSessions,
                                           java.lang.String[] targetNames)
                                    throws PartitionLifeCycleException

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Applications are in admin mode. Inflight work is completed.

Parameters:

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

ignoreSessions - drop inflight HTTP sessions during graceful suspend

targetNames - the specific servers on which to suspend this partition

Throws:

PartitionLifeCycleException - partition failed to suspend gracefully. A forceSuspend() or a forceShutdown() operation can be invoked.

suspend

PartitionLifeCycleTaskRuntimeMBean suspend(int timeout,
                                           boolean ignoreSessions)
                                    throws PartitionLifeCycleException

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Applications are in admin mode. Inflight work is completed.

Parameters:

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

ignoreSessions - drop inflight HTTP sessions during graceful suspend

Throws:

PartitionLifeCycleException - partition failed to suspend gracefully. A forceSuspend() or a forceShutdown() operation can be invoked.

suspend

@Deprecated
PartitionLifeCycleTaskRuntimeMBean suspend(TargetMBean[] targets)
                                    throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets. (Equivalent to suspend(0, false, targets))

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

New requests are rejected and inflight work is allowed to complete.

Please use PartitionLifeCycleRuntimeMBean.suspend(String[] targetNames)

Parameters:

targets - the specific targets on which to suspend this partition

Throws:

PartitionLifeCycleException - If the operation fails

See Also:

suspend(int, boolean)

suspend

PartitionLifeCycleTaskRuntimeMBean suspend(java.lang.String[] targetNames)
                                    throws PartitionLifeCycleException

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets. (Equivalent to suspend(0, false, targets))

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

New requests are rejected and inflight work is allowed to complete.

Parameters:

targetNames - the specific servers on which to suspend this partition

Throws:

PartitionLifeCycleException - If the operation fails

See Also:

suspend(int, boolean)

suspend

PartitionLifeCycleTaskRuntimeMBean suspend()
                                    throws PartitionLifeCycleException

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on all targeted servers.

(Equivalent to suspend(0, false))

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

New requests are rejected and inflight work is allowed to complete.

Throws:

PartitionLifeCycleException - If the operation fails

See Also:

suspend(int, boolean)

forceSuspend

@Deprecated
PartitionLifeCycleTaskRuntimeMBean forceSuspend(TargetMBean[] targets)
                                         throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins the forceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.forceSuspend(String[] targetNames)

Parameters:

targets - the specific targets on which to suspend this partition

Returns:

PartitionLifeCycleTaskRuntimeMBean task object for monitoring the operation

Throws:

PartitionLifeCycleException - the partition could not suspend.

forceSuspend

PartitionLifeCycleTaskRuntimeMBean forceSuspend(java.lang.String[] targetNames)
                                         throws PartitionLifeCycleException

Begins the forceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Parameters:

targetNames - the specific servers on which to suspend this partition

Returns:

PartitionLifeCycleTaskRuntimeMBean task object for monitoring the operation

Throws:

PartitionLifeCycleException - the partition could not suspend.

forceSuspend

PartitionLifeCycleTaskRuntimeMBean forceSuspend()
                                         throws PartitionLifeCycleException

Begins the forceful transition of the partition from the RUNNING state to the ADMIN state on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Returns:

PartitionLifeCycleTaskRuntimeMBean task object for monitoring the operation

Throws:

PartitionLifeCycleException - the partition could not suspend.

resume

@Deprecated
PartitionLifeCycleTaskRuntimeMBean resume(TargetMBean[] targets)
                                   throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins the transition of the partition from the ADMIN state to the RUNNING state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.resume(String[] targetNames)

Parameters:

targets - the specific targets on which to resume this partition

Throws:

PartitionLifeCycleException - If the resume operation fails

resume

PartitionLifeCycleTaskRuntimeMBean resume(java.lang.String[] targetNames)
                                   throws PartitionLifeCycleException

Begins the transition of the partition from the ADMIN state to the RUNNING state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Parameters:

targetNames - the specific servers on which to resume this partition

Throws:

PartitionLifeCycleException - If the resume operation fails

resume

PartitionLifeCycleTaskRuntimeMBean resume()
                                   throws PartitionLifeCycleException

Begins the transition of the partition from the ADMIN state to the RUNNING state on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Throws:

PartitionLifeCycleException - If the resume operation fails

boot

@Deprecated
PartitionLifeCycleTaskRuntimeMBean boot(TargetMBean[] targets)
                                 throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins the transition of the partition from the SHUTDOWN state and HALTED substate to the SHUTDOWN state and BOOTED substate on the specified targets.

This operation has the effect of starting the partition's administrative resource groups on those targets, changing their states on those targets from SHUTDOWN to RUNNING.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.boot(String[] targetNames)

Parameters:

targets - the specific targets on which to boot this partition

Throws:

PartitionLifeCycleException - If the boot operation fails

boot

PartitionLifeCycleTaskRuntimeMBean boot(java.lang.String[] targetNames)
                                 throws PartitionLifeCycleException

Begins the transition of the partition from the SHUTDOWN state and HALTED substate to the SHUTDOWN state and BOOTED substate on the specified targets.

This operation has the effect of starting the partition's administrative resource groups on those targets, changing their states on those targets from SHUTDOWN to RUNNING.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Parameters:

targetNames - the specific servers on which to boot this partition

Throws:

PartitionLifeCycleException - If the boot operation fails

boot

PartitionLifeCycleTaskRuntimeMBean boot()
                                 throws PartitionLifeCycleException

Begins the transition of the partition from the SHUTDOWN state and HALTED substate to the SHUTDOWN state and BOOTED substate on all targeted servers.

This operation has the effect of starting the partition's administrative resource groups, changing their states from SHUTDOWN to RUNNING.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Throws:

PartitionLifeCycleException - If the halt operation fails

halt

@Deprecated
PartitionLifeCycleTaskRuntimeMBean halt(TargetMBean[] targets)
                                 throws PartitionLifeCycleException

Deprecated.

12.2.1.3.0

Begins the forceful transition of the partition from the RUNNING state or the ADMIN state to the SHUTDOWN state and HALTED substate on a specific set of targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Please use PartitionLifeCycleRuntimeMBean.halt(String[] targetNames)

Parameters:

targets - the specific targets on which to halt this partition

Throws:

PartitionLifeCycleException - If the halt operation fails

halt

PartitionLifeCycleTaskRuntimeMBean halt(java.lang.String[] targetNames)
                                 throws PartitionLifeCycleException

Begins the forceful transition of the partition from the RUNNING state or the ADMIN state to the SHUTDOWN state and HALTED substate on a specific set of targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Parameters:

targetNames - the specific servers on which to halt this partition

Throws:

PartitionLifeCycleException - If the halt operation fails

halt

PartitionLifeCycleTaskRuntimeMBean halt()
                                 throws PartitionLifeCycleException

Begins the forceful transition of the partition from the RUNNING state or the ADMIN state to the SHUTDOWN state and HALTED substate on all targeted servers.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion.

Throws:

PartitionLifeCycleException - If the halt operation fails

purgeTasks

void purgeTasks()

Clears the retained task collection.

getState

@Deprecated
java.lang.String getState(ServerMBean serverMBean)
                   throws PartitionLifeCycleException

Deprecated.

12.2.1.2.0

The state of the partition on a specific server.

This method has been deprecated in favor of retrieving partition state correctly on dynamic servers. ServerMBean does not exist for dynamic servers in the domain runtime tree. So, although invoking this method from domain runtime tree works for static servers, does not work for dynamic servers.

Please use PartitionLifeCycleRuntimeMBean.getState(String serverName)

Parameters:

serverMBean -

Returns:

Throws:

PartitionLifeCycleException

getSubState

@Deprecated
java.lang.String getSubState(ServerMBean serverMBean)
                      throws PartitionLifeCycleException

Deprecated.

12.2.1.2.0

The current substate of the partition on a specific server.

This method has been deprecated in favor of retrieving partition substate correctly on dynamic servers. ServerMBean does not exist for dynamic servers in the domain runtime tree. So, although invoking this method from domain runtime tree works for static servers, does not work for dynamic servers.

Please use PartitionLifeCycleRuntimeMBean.getSubState(ServerLifeCycleRuntimeMBean serverLifeCycleRuntimeMBean)

Parameters:

serverMBean - the server on which the substate to check

Returns:

the substate of this partition

Throws:

PartitionLifeCycleException

getState

java.lang.String getState(java.lang.String serverName)
                   throws PartitionLifeCycleException

The current state of the partition on a specific server.

Parameters:

serverName - name of the server on which the substate to check

Returns:

the state of this partition

Throws:

PartitionLifeCycleException

getSubState

java.lang.String getSubState(java.lang.String serverName)
                      throws PartitionLifeCycleException

The current substate of the partition on a specific server.

Parameters:

serverName - name of the server on which the substate to check

Returns:

the substate of this partition

Throws:

PartitionLifeCycleException