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 PartitionLifeCycleTaskRuntimeMBean#isRunning() method to detect when the operation has completed. In particular, the caller shouldnotrely on the value returned from State() 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 State() 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 State() method computes the overall state for the partition.
| Since | 12.2.1.0.0 | ||
| Security roles | The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
|
||
| Fully Qualified Interface Name | If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:weblogic.management.runtime.PartitionLifeCycleRuntimeMBean
|
||
| Factory Methods | No factory methods. Instances of this MBean are created automatically. | ||
| Access Points |
You can access this MBean from the following MBean attributes:
|
||
| Access Points Inherited from RuntimeMBean |
Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:
|
This section describes attributes that provide access to other MBeans.
|
|
The resource group lifecycle tasks for this partition.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Lookup Operation | lookupResourceGroupLifeCycleRuntime(String name)
Returns a |
| Privileges | Read only |
| Type | ResourceGroupLifeCycleRuntimeMBean[] |
| Relationship type: | Containment. |
The preexisting partition lifecycle tasks.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Lookup Operation | lookupTask(String name)
Returns a |
| Privileges | Read only |
| Type | PartitionLifeCycleTaskRuntimeMBean[] |
| Relationship type: | Containment. |
This section describes the following attributes:
Private property that disables caching in proxies.
| Privileges | Read only |
| Type | boolean |
Returns the MBean info for this MBean.
Deprecated.
| Privileges | Read only |
| Type | javax.management.MBeanInfo |
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
| Privileges | Read only |
| Type | java.lang.String |
Returns the ObjectName under which this MBean is registered in the MBean server.
Deprecated.
| Privileges | Read only |
| Type | weblogic.management.WebLogicObjectName |
Return the immediate parent for this MBean
| Privileges | Read/Write |
| Type |
Returns false if the MBean represented by this object has been unregistered.
Deprecated.
| Privileges | Read only |
| Type | boolean |
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.
| Privileges | Read only |
| Type | java.lang.String |
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.
| Available Since | Release 12.2.1.1.0 |
| Privileges | Read only |
| Type | java.lang.String |
Returns the type of the MBean.
| Privileges | Read only |
| Type | java.lang.String |
This section describes the following operations:
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 tocheck for completion.
| Operation Name | "boot" |
| Parameters | Object [] { targets }
where:
|
| Signature | String [] {
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
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 tocheck for completion.
| Operation Name | "boot" |
| Parameters | null |
| Signature | null |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to force the shutdown of this partition with the specified timeout on all targeted servers.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "forceShutdown" |
| Parameters | Object [] { timeout }
where:
|
| Signature | String [] {
"java.lang.Integer" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
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 tocheck for completion.
| Operation Name | "forceShutdown" |
| Parameters | null |
| Signature | null |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
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 tocheck for completion.
| Operation Name | "forceShutdown" |
| Parameters | Object [] { targets }
where:
|
| Signature | String [] {
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins the forceful transition of the partition from the
RUNNING state to the ADMIN state on all
targeted servers.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "forceSuspend" |
| Parameters | null |
| Signature | null |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins the forceful transition of the partition from the
RUNNING state to the ADMIN state on the
specified targets.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "forceSuspend" |
| Parameters | Object [] { targets }
where:
|
| Signature | String [] {
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
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(ServerLifeCycleRuntimeMBean
serverLifeCycleRuntimeMBean)
Deprecated.
| Operation Name | "getState" |
| Parameters | Object [] { serverMBean }
where:
|
| Signature | String [] {
"weblogic.management.configuration.ServerMBean" } |
| Returns | String
|
| Exceptions |
|
The current state of the partition on a specific server.
| Operation Name | "getState" |
| Parameters | Object [] { serverName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
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)
Deprecated.
| Operation Name | "getSubState" |
| Parameters | Object [] { serverMBean }
where:
|
| Signature | String [] {
"weblogic.management.configuration.ServerMBean" } |
| Returns | String
|
| Exceptions |
|
The current substate of the partition on a specific server.
| Operation Name | "getSubState" |
| Parameters | Object [] { serverName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
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 tocheck for completion.
| Operation Name | "halt" |
| Parameters | null |
| Signature | null |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
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 tocheck for completion.
| Operation Name | "halt" |
| Parameters | Object [] { targets }
where:
|
| Signature | String [] {
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Clears the retained task collection.
| Operation Name | "purgeTasks" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
Begins the transition of the partition from the
ADMIN state to the RUNNING state on all
targeted servers.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "resume" |
| Parameters | null |
| Signature | null |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins the transition of the partition from the
ADMIN state to the RUNNING state on the
specified targets.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "resume" |
| Parameters | Object [] { targets }
where:
|
| Signature | String [] {
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to shut down this partition gracefully on the specified targets.
(Equivalent to shutdown(targets, 0, false)).
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "shutdown" |
| Parameters | Object [] { targets }
where:
|
| Signature | String [] {
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to shut down this partition gracefully on the specified targets.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "shutdown" |
| Parameters | Object [] { timeout, ignoreSessions, waitForAllSessions, targets }
where:
|
| Signature | String [] {
"java.lang.Integer",
"java.lang.Boolean",
"java.lang.Boolean",
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to shut down this partition gracefully on all targeted servers.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "shutdown" |
| Parameters | Object [] { timeout, ignoreSessions, waitForAllSessions }
where:
|
| Signature | String [] {
"java.lang.Integer",
"java.lang.Boolean",
"java.lang.Boolean" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to shut down this partition gracefully on the specified targets.
(Equivalent to shutdown(timeout, ignoreSessions, false, targets)).
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "shutdown" |
| Parameters | Object [] { timeout, ignoreSessions, targets }
where:
|
| Signature | String [] {
"java.lang.Integer",
"java.lang.Boolean",
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to shut down this partition gracefully on all targeted servers.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "shutdown" |
| Parameters | null |
| Signature | null |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to shut down this partition gracefully on all targeted servers.
(Equivalent to shutdown(timeout, ignoreSessions, false, targets)).
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "shutdown" |
| Parameters | Object [] { timeout, ignoreSessions }
where:
|
| Signature | String [] {
"java.lang.Integer",
"java.lang.Boolean" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to start this partition on all targeted servers.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "start" |
| Parameters | null |
| Signature | null |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to start this partition in the specified
initialState within the specified timeOut
on all targeted servers.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "start" |
| Parameters | Object [] { initialState, timeOut }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to start this partition on the specified targets.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "start" |
| Parameters | Object [] { targets }
where:
|
| Signature | String [] {
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to start this partition in the ADMIN state
on all targeted servers.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "startInAdmin" |
| Parameters | null |
| Signature | null |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins to start this partition in the ADMIN state
on the specified targets.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
| Operation Name | "startInAdmin" |
| Parameters | Object [] { targets }
where:
|
| Signature | String [] {
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins the graceful transition of the partition from the
RUNNING state to the ADMIN state on the
specified targets.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
Applications are in admin mode. Inflight work is completed.
| Operation Name | "suspend" |
| Parameters | Object [] { timeout, ignoreSessions, targets }
where:
|
| Signature | String [] {
"java.lang.Integer",
"java.lang.Boolean",
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
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 tocheck for completion.
New requests are rejected and inflight work is allowed to complete.
For more information, see:
| Operation Name | "suspend" |
| Parameters | null |
| Signature | null |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
Begins the graceful transition of the partition from the
RUNNING state to the ADMIN state on all
targeted servers.
Use the returned PartitionLifeCycleTaskRuntimeMBean value tocheck for completion.
Applications are in admin mode. Inflight work is completed.
| Operation Name | "suspend" |
| Parameters | Object [] { timeout, ignoreSessions }
where:
|
| Signature | String [] {
"java.lang.Integer",
"java.lang.Boolean" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|
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 tocheck for completion.
New requests are rejected and inflight work is allowed to complete.
For more information, see:
| Operation Name | "suspend" |
| Parameters | Object [] { targets }
where:
|
| Signature | String [] {
"[Lweblogic.management.configuration.TargetMBean;" } |
| Returns | PartitionLifeCycleTaskRuntimeMBean |
| Exceptions |
|