|
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 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PartitionRuntimeMBean
Partition Runtime information.
Method Summary | |
---|---|
abstract void |
forceShutdown() Force shutdown the partition. |
abstract void |
forceShutdownResourceGroup(String resourceGroupName) Force shutdown the resource group. |
abstract void |
forceSuspend() Transitions the partition from RUNNING to ADMIN state forcefully cancelling inflight work. |
abstract void |
forceSuspendResourceGroup(String resourceGroupName) Transitions the resource group from RUNNING to ADMIN state forcefully cancelling inflight work. |
abstract ApplicationRuntimeMBean[] |
getApplicationRuntimes() Currently running Applications of this partition. |
abstract BatchJobRepositoryRuntimeMBean |
getBatchJobRepositoryRuntime() The partition BatchJobRepositoryPartitionRuntimeMBean |
abstract ConcurrentManagedObjectsRuntimeMBean |
getConcurrentManagedObjectsRuntime() The ConcurrentManagedObjectsRuntimeMBean for this partition. |
abstract ConnectorServiceRuntimeMBean |
getConnectorServiceRuntime() The access point for partition specific control and monitoring of the Connector Container. |
abstract JDBCPartitionRuntimeMBean |
getJDBCPartitionRuntime() The JDBCPartitionRuntimeMBean for this partition. |
abstract JMSRuntimeMBean |
getJMSRuntime() The JMSRuntimeMBean for this partition. |
abstract JTAPartitionRuntimeMBean |
getJTAPartitionRuntime() The MBean which provides access to all JTA runtime MBeans for this partition. |
abstract LibraryRuntimeMBean[] |
getLibraryRuntimes() Deployed Libraries of this partition. |
abstract MailSessionRuntimeMBean[] |
getMailSessionRuntimes() The JavaMail Mail RuntimeMBeans for this partition. |
abstract MaxThreadsConstraintRuntimeMBean[] |
getMaxThreadsConstraintRuntimes() RuntimeMBeans which expose this partition's globally defined MaxThreadsConstraints. |
abstract MessagingBridgeRuntimeMBean[] |
getMessagingBridgeRuntimes() The MessagingBridgeRuntimeMBeans for this partition. |
abstract MinThreadsConstraintRuntimeMBean[] |
getMinThreadsConstraintRuntimes() RuntimeMBeans which exposes this partition's globally defined MinThreadsConstraints. |
abstract String |
getName() The name of this configuration. |
abstract HealthState |
getOverallHealthState() The aggregate health state of the partition as reported by components within the partition |
abstract CompositeData |
getOverallHealthStateJMX() The overall health state of this partition returned as a CompositeData type. |
abstract String |
getPartitionID() Partition ID for this partition. |
abstract PartitionResourceMetricsRuntimeMBean |
getPartitionResourceMetricsRuntime() The partition resource consumption metrics for this partition. |
abstract PartitionWorkManagerRuntimeMBean |
getPartitionWorkManagerRuntime() The PartitionWorkManagerRuntimeMBean for this partition. |
abstract PathServiceRuntimeMBean[] |
getPathServiceRuntimes() Array of all PathServiceRuntimeMBean instances for this partition. |
abstract PersistentStoreRuntimeMBean[] |
getPersistentStoreRuntimes() The mbeans that provide runtime information for each PersistentStore. |
abstract RequestClassRuntimeMBean[] |
getRequestClassRuntimes() RuntimeMBeans which exposes this partition's globally defined Request Classes. |
abstract ResourceManagerRuntimeMBean |
getResourceManagerRuntime() The ResourceManagerRuntimeMBean for this Partition in this server instance. |
abstract String |
getRgState(String resourceGroupName) The current state of the named resource group MBean |
abstract SAFRuntimeMBean |
getSAFRuntime() The SAFRuntimeMBean for this partition. |
abstract String |
getServerName() The server associated with this configuration. |
abstract String |
getState() The current state of the partition runtime MBean |
abstract HealthState[] |
getSubsystemHealthStates() An array of health states for major subsystems in the partition. |
abstract CompositeData[] |
getSubsystemHealthStatesJMX() The health states for major subsystems in the partition as an array of CompositeData type. |
abstract WLDFPartitionRuntimeMBean |
getWLDFPartitionRuntime() The MBean which provides access to all Diagnostic runtime MBeans for this partition. |
abstract WorkManagerRuntimeMBean[] |
getWorkManagerRuntimes() An array of MBeans which expose this partition's active internal WorkManagers. |
abstract WseeClusterFrontEndRuntimeMBean |
getWseeClusterFrontEndRuntime() A non-null value only when this partition of the server is running as a host to a front-end proxy (HttpClusterServlet) instance. |
abstract boolean |
isRestartRequired() Indicates whether the partition must be restarted in order to activate configuration changes. |
abstract ApplicationRuntimeMBean |
lookupApplicationRuntime(String name) The name of the ApplicationRuntimeMBean requested. |
abstract LibraryRuntimeMBean |
lookupLibraryRuntime(String name) The name of the LibraryRuntimeMBean requested. |
abstract MessagingBridgeRuntimeMBean |
lookupMessagingBridgeRuntime(String name) |
abstract PersistentStoreRuntimeMBean |
lookupPersistentStoreRuntime(String name) The Runtime mbean for the persistent store with the specified short name. |
abstract void |
resume() Resume a suspended partition. |
abstract void |
resumeResourceGroup(String resourceGroupName) Resume suspended resource group. |
abstract void |
shutdown() Gracefully shuts down the partition after handling inflight work. |
abstract void |
shutdown(int timeout, boolean ignoreSessions) Gracefully shuts down the partition after handling inflight work. |
abstract void |
shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions) Gracefully shuts down the partition after handling inflight work; optionally ignores pending HTTP sessions while handling inflight work. |
abstract void |
shutdownResourceGroup(String resourceGroupName) Gracefully shuts down the resource group after handling inflight work. |
abstract void |
shutdownResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions) Gracefully shuts down the partition after handling inflight work. |
abstract void |
shutdownResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions, boolean waitForAllSessions) Gracefully shuts down the partition after handling inflight work. |
abstract void |
startResourceGroup(String resourceGroupName) starts the resource group. |
abstract void |
startResourceGroupInAdmin(String resourceGroupName) Starts the resource group in ADMIN state. |
abstract void |
suspend() Suspends the partition. |
abstract void |
suspend(int timeout, boolean ignoreSessions) Transitions the partition from RUNNING to ADMIN state gracefully. |
abstract void |
suspendResourceGroup(String resourceGroupName) Suspends resource group. |
abstract void |
suspendResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions) Suspends resource group. |
Methods inherited from interface weblogic.management.runtime.RuntimeMBean |
---|
addPropertyChangeListener, removePropertyChangeListener |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, 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 |
---|
String getName()
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
getName
in interface WebLogicMBean
String getServerName()
The server associated with this configuration.
String getState()
The current state of the partition runtime MBean
String getPartitionID()
Partition ID for this partition.
JMSRuntimeMBean getJMSRuntime()
The JMSRuntimeMBean for this partition.
JDBCPartitionRuntimeMBean getJDBCPartitionRuntime()
The JDBCPartitionRuntimeMBean for this partition.
ApplicationRuntimeMBean[] getApplicationRuntimes()
Currently running Applications of this partition.
ApplicationRuntimeMBean lookupApplicationRuntime(String name)
The name of the ApplicationRuntimeMBean requested.
name
- the name of the ApplicationRuntime MBean to findLibraryRuntimeMBean[] getLibraryRuntimes()
Deployed Libraries of this partition.
LibraryRuntimeMBean lookupLibraryRuntime(String name)
The name of the LibraryRuntimeMBean requested.
name
- the name of the LibraryRuntimeMBean to findWorkManagerRuntimeMBean[] getWorkManagerRuntimes()
An array of MBeans which expose this partition's active internal WorkManagers.
PartitionWorkManagerRuntimeMBean getPartitionWorkManagerRuntime()
The PartitionWorkManagerRuntimeMBean for this partition.
MaxThreadsConstraintRuntimeMBean[] getMaxThreadsConstraintRuntimes()
RuntimeMBeans which expose this partition's globally defined MaxThreadsConstraints.
MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()
RuntimeMBeans which exposes this partition's globally defined MinThreadsConstraints.
RequestClassRuntimeMBean[] getRequestClassRuntimes()
RuntimeMBeans which exposes this partition's globally defined Request Classes.
MailSessionRuntimeMBean[] getMailSessionRuntimes()
The JavaMail Mail RuntimeMBeans for this partition.
MessagingBridgeRuntimeMBean[] getMessagingBridgeRuntimes()
The MessagingBridgeRuntimeMBeans for this partition.
MessagingBridgeRuntimeMBean lookupMessagingBridgeRuntime(String name)
name
- the name of the messagingBridgeRuntime to findPersistentStoreRuntimeMBean[] getPersistentStoreRuntimes()
The mbeans that provide runtime information for each PersistentStore.
PersistentStoreRuntimeMBean lookupPersistentStoreRuntime(String name)
The Runtime mbean for the persistent store with the specified short name.
name
- the name of the persistent store Runtime mbean to findConnectorServiceRuntimeMBean getConnectorServiceRuntime()
The access point for partition specific control and monitoring of the Connector Container.
PathServiceRuntimeMBean[] getPathServiceRuntimes()
Array of all PathServiceRuntimeMBean instances for this partition.
SAFRuntimeMBean getSAFRuntime()
The SAFRuntimeMBean for this partition.
WLDFPartitionRuntimeMBean getWLDFPartitionRuntime()
The MBean which provides access to all Diagnostic runtime MBeans for this partition.
ConcurrentManagedObjectsRuntimeMBean getConcurrentManagedObjectsRuntime()
The ConcurrentManagedObjectsRuntimeMBean for this partition.
JTAPartitionRuntimeMBean getJTAPartitionRuntime()
The MBean which provides access to all JTA runtime MBeans for this partition.
PartitionResourceMetricsRuntimeMBean getPartitionResourceMetricsRuntime()
The partition resource consumption metrics for this partition.
BatchJobRepositoryRuntimeMBean getBatchJobRepositoryRuntime()
The partition BatchJobRepositoryPartitionRuntimeMBean
void 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. Applications and resources are fully available to administrators in ADMIN
state. Non-admin users are denied access to applications and resources
timeout
- Seconds to wait for partition to transition gracefully. The PartitionRuntimeMBean.forceSuspend()
is called after timeout.ignoreSessions
- drop inflight HTTP sessions during graceful suspendPartitionLifeCycleException
- if partition failed to suspend gracefully. A PartitionRuntimeMBean.forceSuspend()
or a PartitionRuntimeMBean.forceShutdown()
operation can be invoked.void suspend() throws PartitionLifeCycleException
Suspends the partition. Denies new requests except by privileged users. Allows pending requests to complete. This operation transitions the partition into ADMIN
state. Applications and resources are fully available to administrators in ADMIN
state. Non-admin users are denied access to applications and resources
PartitionLifeCycleException
PartitionRuntimeMBean.suspend(int, boolean)
void forceSuspend() throws PartitionLifeCycleException
Transitions the partition from RUNNING
to ADMIN
state forcefully cancelling inflight work.
Work that cannot be cancelled is dropped. Applications are transitioned to admin mode. This forcefully suspends the partition and transitions it to ADMIN
state.
PartitionLifeCycleException
- partition failed to force suspend. A PartitionRuntimeMBean.forceShutdown()
operation can be invoked.void resume() throws PartitionLifeCycleException
Resume a suspended partition. Allow new requests. This operation transitions the partition into RUNNING
state.
PartitionLifeCycleException
- if this operation fails to complete. The partition transitions back to the previous state from which this operation was invoked. For example, if the partition was in the ADMIN
state before this operation, it returns to the ADMIN
state if a resume fails.void shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions) throws PartitionLifeCycleException
Gracefully shuts down the partition after handling inflight work; optionally ignores pending HTTP sessions while handling inflight work.
The following inflight work is allowed to complete before shutdown:
Pending transaction's and TLOG checkpoint
Pending HTTP sessions
Pending JMS work
Pending work in the execute queues
RMI requests with transaction context
Further administrative calls are accepted while the partition is completing inflight work. For example, a forceShutdown command can be issued to quickly shutdown the partition if graceful shutdown is taking too long to complete.
timeout
- Number of seconds to wait before aborting inflight work and shutting down the partition.ignoreSessions
- true
indicates ignore pending HTTP sessions during inflight work handling.waitForAllSessions
- true
indicates waiting for all HTTP sessions during inflight work handling; false
indicates waiting for non-persisted HTTP sessions only.PartitionLifeCycleException
- Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the partition.void shutdown(int timeout, boolean ignoreSessions) throws PartitionLifeCycleException
Gracefully shuts down the partition after handling inflight work.
This method is same to call: shutdown(timeout, ignoreSessions, false);
timeout
-ignoreSessions
-PartitionLifeCycleException
PartitionRuntimeMBean.shutdown(int, boolean, boolean)
void shutdown() throws PartitionLifeCycleException
Gracefully shuts down the partition after handling inflight work.
PartitionLifeCycleException
PartitionRuntimeMBean.shutdown(int, boolean, boolean)
void forceShutdown() throws PartitionLifeCycleException
Force shutdown the partition. Causes the partition to reject new requests and fail pending requests.
PartitionLifeCycleException
- Thrown when the partition cannot force shutdown due to a fatal exception. Even after this exception is thrown indicating failure the partition exits after PartitionLifeCycleTimeoutVal seconds defined in the PartitionMBean.void startResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
starts the resource group.
resourceGroupName
- The resource group nameResourceGroupLifecycleException
- resource group failed to start.void startResourceGroupInAdmin(String resourceGroupName) throws ResourceGroupLifecycleException
Starts the resource group in ADMIN state. Applications and resources are fully available to administrators in ADMIN
state. Non-admin users are denied access to applications and resources
resourceGroupName
-ResourceGroupLifecycleException
- resource group failed to start in admin mode.void suspendResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions) throws ResourceGroupLifecycleException
Suspends resource group. Denies new requests except by privileged users. Allows pending requests to complete. This operation transitions the partition into ADMIN
state. Applications and resources are fully available to administrators in ADMIN
state. Non-admin users are denied access to applications and resources
resourceGroupName
-timeout
-ignoreSessions
-ResourceGroupLifecycleException
void suspendResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Suspends resource group. Denies new requests except by privileged users. Allows pending requests to complete. This operation transitions the partition into ADMIN
state. Applications and resources are fully available to administrators in ADMIN
state. Non-admin users are denied access to applications and resources
resourceGroupName
-ResourceGroupLifecycleException
PartitionRuntimeMBean.suspendResourceGroup(String, int, boolean)
void forceSuspendResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Transitions the resource group from RUNNING
to ADMIN
state forcefully cancelling inflight work.
Work that cannot be cancelled is dropped. Applications are brought into the admin mode. This forcefully suspends the resource group and transitions it ADMIN
state.
resourceGroupName
-ResourceGroupLifecycleException
- partition failed to force suspend. A PartitionRuntimeMBean.forceShutdown()
operation can be invoked.void resumeResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Resume suspended resource group. Allow new requests. This operation transitions the resource group into RUNNING
state.
resourceGroupName
-ResourceGroupLifecycleException
- if this operation fails to complete. The resource group transitions back to the previous state from which this operation was invoked. For example, if the resource group was in the ADMIN
state before this operation, it returns to the ADMIN
state if resume fails.void forceShutdownResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Force shutdown the resource group. Causes the resource group to reject new requests and fail pending requests.
resourceGroupName
-ResourceGroupLifecycleException
- Thrown when the resource group cannot force shutdown due to a fatal exception. Even after this exception is thrown indicating failure the partition exits after PartitionLifeCycleTimeoutVal seconds defined in the PartitionMBean.void shutdownResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions, boolean waitForAllSessions) throws ResourceGroupLifecycleException
Gracefully shuts down the partition after handling inflight work. Optionally, ignores pending HTTP sessions while handling inflight work.
The following inflight work is allowed to complete before shutdown:
Further administrative calls are accepted while the server is completing inflight work. For example a forceShutdown command can be issued to quickly shutdown the partition if graceful shutdown takes a long time.
resourceGroupName
-timeout
- Number of seconds to wait before aborting inflight work and shutting down the partition.ignoreSessions
- true
indicates ignore pending HTTP sessions during inflight work handling.waitForAllSessions
- true
indicates waiting for all HTTP sessions during inflight work handling; false
indicates waiting for non-persisted HTTP sessions only.PartitionLifeCycleException
- Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the server.ResourceGroupLifecycleException
void shutdownResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions) throws ResourceGroupLifecycleException
Gracefully shuts down the partition after handling inflight work.
This method is same to call: shutdown(timeout, ignoreSessions, false);
resourceGroupName
-timeout
-ignoreSessions
-ResourceGroupLifecycleException
PartitionRuntimeMBean.shutdownResourceGroup(String, int, boolean, boolean)
void shutdownResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Gracefully shuts down the resource group after handling inflight work.
resourceGroupName
-ResourceGroupLifecycleException
PartitionRuntimeMBean.shutdownResourceGroup(String, int, boolean, boolean)
ResourceManagerRuntimeMBean getResourceManagerRuntime()
The ResourceManagerRuntimeMBean
for this Partition in this server instance. The ResourceManagerRuntimeMBean
is used for retrieving the runtime state (information about policy evaluation, current resource usage, recourse actions taken etc) of configured resource management policies established for this Partition by a system administrator.
String getRgState(String resourceGroupName) throws ResourceGroupLifecycleException
The current state of the named resource group MBean
resourceGroupName
- the resource group nameResourceGroupLifecycleException
WseeClusterFrontEndRuntimeMBean getWseeClusterFrontEndRuntime()
HealthState getOverallHealthState()
The aggregate health state of the partition as reported by components within the partition
HealthState
CompositeData getOverallHealthStateJMX() throws OpenDataException
OpenDataException
PartitionRuntimeMBean.getOverallHealthState()
, HealthState
boolean isRestartRequired()
Indicates whether the partition must be restarted in order to activate configuration changes.
HealthState[] getSubsystemHealthStates()
CompositeData[] getSubsystemHealthStatesJMX() throws OpenDataException
OpenDataException
|
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 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |