Skip navigation links

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


weblogic.management.runtime
Interface PartitionLifeCycleRuntimeMBean

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

public interface PartitionLifeCycleRuntimeMBean
extends RuntimeMBean

Method Summary
abstract  PartitionLifeCycleTaskRuntimeMBean forceShutdown()
          Forces the shutdown of the partition.
abstract  PartitionLifeCycleTaskRuntimeMBean forceShutdown(TargetMBean[] targets)
          Forces the shutdown of the partition on specified targets.
abstract  PartitionLifeCycleTaskRuntimeMBean forceSuspend()
          Forcefully suspends the partition.
abstract  PartitionLifeCycleTaskRuntimeMBean forceSuspend(TargetMBean[] targets)
          Forcefully suspends the partition on specified targets.
abstract  ResourceGroupLifeCycleRuntimeMBean[] getResourceGroupLifeCycleRuntimes()
          Get resource group lifecycle tasks for this partition.
abstract  String getState()
          The current state of the partition.
abstract  String getState(ServerMBean serverMBean)
          Get the state of partition on a specific server.
abstract  PartitionLifeCycleTaskRuntimeMBean[] getTasks()
          Get preexisting Partition Lifecycle Tasks.
abstract  ResourceGroupLifeCycleRuntimeMBean lookupResourceGroupLifeCycleRuntime(String name)
          Lookup named resource group lifecycle task for this partition.
abstract  PartitionLifeCycleTaskRuntimeMBean lookupTask(String taskName)
          Get preexisting Partition Lifecycle Task.
abstract  void purgeTasks()
          Clears the retained task collection.
abstract  PartitionLifeCycleTaskRuntimeMBean resume()
          Transitions the partition from ADMIN to RUNNING state.
abstract  PartitionLifeCycleTaskRuntimeMBean resume(TargetMBean[] targets)
          Transitions the partition from ADMIN to RUNNING state on specified targets..
abstract  PartitionLifeCycleTaskRuntimeMBean shutdown()
          Shuts down the partition gracefully on all targets.
abstract  PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout, boolean ignoreSessions)
          Shuts down a partition gracefully.
abstract  PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions)
          Gracefully shuts down a partition.
abstract  PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions, TargetMBean[] targets)
          Gracefully shuts down a partition.
abstract  PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout, boolean ignoreSessions, TargetMBean[] targets)
          Shuts down a partition gracefully.
abstract  PartitionLifeCycleTaskRuntimeMBean shutdown(TargetMBean[] targets)
          Shuts down the partition gracefully.
abstract  PartitionLifeCycleTaskRuntimeMBean start()
          Starts partition.
abstract  PartitionLifeCycleTaskRuntimeMBean start(String initialState, int timeOut)
           Starts the partition in initalState within the specified timeOut
abstract  PartitionLifeCycleTaskRuntimeMBean start(TargetMBean[] targets)
          Starts the partition on specified targets.
abstract  PartitionLifeCycleTaskRuntimeMBean startInAdmin()
          Starts the partition in the admin state.
abstract  PartitionLifeCycleTaskRuntimeMBean startInAdmin(TargetMBean[] targets)
          Starts the partition in the admin state.
abstract  PartitionLifeCycleTaskRuntimeMBean suspend()
          Gracefully suspends the partition to ADMIN state.
abstract  PartitionLifeCycleTaskRuntimeMBean suspend(int timeout, boolean ignoreSessions)
          Transitions the partition from RUNNING to ADMIN state gracefully.
abstract  PartitionLifeCycleTaskRuntimeMBean suspend(int timeout, boolean ignoreSessions, TargetMBean[] targets)
          Transitions the partition from RUNNING to ADMIN state gracefully on specified targets.
abstract  PartitionLifeCycleTaskRuntimeMBean suspend(TargetMBean[] targets)
          Gracefully suspends the partition to ADMIN state.

 

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

PartitionLifeCycleTaskRuntimeMBean start()
                                         throws PartitionLifeCycleException

Starts partition.

Throws:
PartitionLifeCycleException - If start operation fails

getState

String getState()

The current state of the partition.

Returns:
The state value

getTasks

PartitionLifeCycleTaskRuntimeMBean[] getTasks()

Get preexisting Partition Lifecycle Tasks.

Returns:
an array of all completed or pending partition lifecycle tasks.

lookupTask

PartitionLifeCycleTaskRuntimeMBean lookupTask(String taskName)

Get preexisting Partition Lifecycle Task.

Parameters:
taskName -
Returns:
PartitionLifeCycleTaskRuntimeMBean based on the name passed by the user

getResourceGroupLifeCycleRuntimes

ResourceGroupLifeCycleRuntimeMBean[] getResourceGroupLifeCycleRuntimes()

Get resource group lifecycle tasks for this partition.

Returns:
an array of all resource group lifecycle runtimes in this partition

lookupResourceGroupLifeCycleRuntime

ResourceGroupLifeCycleRuntimeMBean lookupResourceGroupLifeCycleRuntime(String name)

Lookup named resource group lifecycle task for this partition.

Parameters:
name - resource lifecycle name
Returns:
named resource group lifecycle runtime

start

PartitionLifeCycleTaskRuntimeMBean start(TargetMBean[] targets)
                                         throws PartitionLifeCycleException

Starts the partition on specified targets.

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

startInAdmin

PartitionLifeCycleTaskRuntimeMBean startInAdmin(TargetMBean[] targets)
                                                throws PartitionLifeCycleException

Starts the partition in the admin state.

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()
                                                throws PartitionLifeCycleException

Starts the partition in the admin state.

Returns:
task usable by caller to monitor progress
Throws:
PartitionLifeCycleException - if the start fails

start

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

Starts the partition in initalState within the specified timeOut

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:
InterruptedException
PartitionLifeCycleException

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                            boolean ignoreSessions,
                                            boolean waitForAllSessions)
                                            throws PartitionLifeCycleException
Gracefully shuts down a partition.
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 PartitionLifeCycleRuntimeMBean.forceShutdown() operation can be invoked.

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                            boolean ignoreSessions,
                                            boolean waitForAllSessions,
                                            TargetMBean[] targets)
                                            throws PartitionLifeCycleException
Gracefully shuts down a partition.
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 PartitionLifeCycleRuntimeMBean.forceShutdown() operation can be invoked.

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown(int timeout,
                                            boolean ignoreSessions)
                                            throws PartitionLifeCycleException

Shuts down a partition 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:
PartitionLifeCycleException - Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the partition.

shutdown

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

Shuts down a partition 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 partition
Throws:
PartitionLifeCycleException - Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the partition.

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown(TargetMBean[] targets)
                                            throws PartitionLifeCycleException

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

Parameters:
targets - the specific targets on which to start this partition
Returns:
task usable by caller to monitor progress
Throws:
PartitionLifeCycleException - if the shutdown fails

shutdown

PartitionLifeCycleTaskRuntimeMBean shutdown()
                                            throws PartitionLifeCycleException

Shuts down the partition gracefully on all targets.

Returns:
task usable by caller to monitor progress
Throws:
PartitionLifeCycleException - if the shutdown fails

forceShutdown

PartitionLifeCycleTaskRuntimeMBean forceShutdown(TargetMBean[] targets)
                                                 throws PartitionLifeCycleException

Forces the shutdown of the partition on specified targets.

Parameters:
targets - the specific targets on which to start this partition
Returns:
task object for monitoring the shutdown
Throws:
PartitionLifeCycleException - if the partition fails to shut down

forceShutdown

PartitionLifeCycleTaskRuntimeMBean forceShutdown()
                                                 throws PartitionLifeCycleException

Forces the shutdown of the partition.

Returns:
task object for monitoring the shutdown
Throws:
PartitionLifeCycleException - if the partition fails to shut down

suspend

PartitionLifeCycleTaskRuntimeMBean suspend(int timeout,
                                           boolean ignoreSessions,
                                           TargetMBean[] targets)
                                           throws PartitionLifeCycleException
Transitions the partition 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 partition to transition gracefully. The partition automatically calls PartitionLifeCycleRuntimeMBean.forceSuspend() after timeout.
ignoreSessions - drop inflight HTTP sessions during graceful suspend
targets - the specific targets on which to start this partition
Throws:
PartitionLifeCycleException - partition failed to suspend gracefully. A PartitionLifeCycleRuntimeMBean.forceSuspend() or a PartitionLifeCycleRuntimeMBean.forceShutdown() operation can be invoked.

suspend

PartitionLifeCycleTaskRuntimeMBean suspend(int timeout,
                                           boolean ignoreSessions)
                                           throws PartitionLifeCycleException
Transitions the partition from RUNNING to ADMIN state gracefully.

Applications are in admin mode. Inflight work is completed.

Parameters:
timeout - Seconds to wait for the partition to transition gracefully. The partition automatically calls PartitionLifeCycleRuntimeMBean.forceSuspend() after timeout.
ignoreSessions - drop inflight HTTP sessions during graceful suspend
Throws:
PartitionLifeCycleException - partition failed to suspend gracefully. A PartitionLifeCycleRuntimeMBean.forceSuspend() or a PartitionLifeCycleRuntimeMBean.forceShutdown() operation can be invoked.

suspend

PartitionLifeCycleTaskRuntimeMBean suspend(TargetMBean[] targets)
                                           throws PartitionLifeCycleException
Gracefully suspends the partition 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 partition
Throws:
PartitionLifeCycleException - If the operation fails
See Also:
PartitionLifeCycleRuntimeMBean.suspend(int, boolean)

suspend

PartitionLifeCycleTaskRuntimeMBean suspend()
                                           throws PartitionLifeCycleException
Gracefully suspends the partition to ADMIN state. (equivalent to suspend(0, false)) New requests are rejected and inflight work is allowed to complete.
Throws:
PartitionLifeCycleException - If the operation fails
See Also:
PartitionLifeCycleRuntimeMBean.suspend(int, boolean)

forceSuspend

PartitionLifeCycleTaskRuntimeMBean forceSuspend(TargetMBean[] targets)
                                                throws PartitionLifeCycleException
Forcefully suspends the partition on specified targets.
Parameters:
targets - the specific targets on which to start this partition
Returns:
PartitionLifeCycleTaskRuntimeMBean task object for monitoring the operation
Throws:
PartitionLifeCycleException - the partition could not suspend.

forceSuspend

PartitionLifeCycleTaskRuntimeMBean forceSuspend()
                                                throws PartitionLifeCycleException
Forcefully suspends the partition.
Returns:
PartitionLifeCycleTaskRuntimeMBean task object for monitoring the operation
Throws:
PartitionLifeCycleException - the partition could not suspend.

resume

PartitionLifeCycleTaskRuntimeMBean resume(TargetMBean[] targets)
                                          throws PartitionLifeCycleException
Transitions the partition from ADMIN to RUNNING state on specified targets..
Parameters:
targets - the specific targets on which to start this partition
Throws:
PartitionLifeCycleException - If the resume operation fails

resume

PartitionLifeCycleTaskRuntimeMBean resume()
                                          throws PartitionLifeCycleException
Transitions the partition from ADMIN to RUNNING state.
Throws:
PartitionLifeCycleException - If the resume operation fails

purgeTasks

void purgeTasks()
Clears the retained task collection.

getState

String getState(ServerMBean serverMBean)
                throws PartitionLifeCycleException
Get the state of partition on a specific server.
Parameters:
serverMBean -
Returns:
Throws:
PartitionLifeCycleException

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

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