Package weblogic.management.runtime

Interface PartitionRuntimeMBean

All Superinterfaces:

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

public interface PartitionRuntimeMBean
extends RuntimeMBean

Partition Runtime information.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PartitionRuntimeMBean.Operation
static class	PartitionRuntimeMBean.State

Method Summary

Modifier and Type	Method	Description
void	forceShutdown()	Force shutdown the partition.
void	forceShutdownResourceGroup(java.lang.String resourceGroupName)	Force shutdown the resource group.
void	forceSuspend()	Transitions the partition from RUNNING to ADMIN state forcefully cancelling inflight work.
void	forceSuspendResourceGroup(java.lang.String resourceGroupName)	Transitions the resource group from RUNNING to ADMIN state forcefully cancelling inflight work.
ApplicationRuntimeMBean[]	getApplicationRuntimes()	Currently running Applications of this partition.
BatchJobRepositoryRuntimeMBean	getBatchJobRepositoryRuntime()	The partition BatchJobRepositoryPartitionRuntimeMBean
ConcurrentManagedObjectsRuntimeMBean	getConcurrentManagedObjectsRuntime()	The ConcurrentManagedObjectsRuntimeMBean for this partition.
ConnectorServiceRuntimeMBean	getConnectorServiceRuntime()	The access point for partition specific control and monitoring of the Connector Container.
JMSRuntimeMBean	getJMSRuntime()	The JMSRuntimeMBean for this partition.
LibraryRuntimeMBean[]	getLibraryRuntimes()	Deployed Libraries of this partition.
MailSessionRuntimeMBean[]	getMailSessionRuntimes()	The JavaMail Mail RuntimeMBeans for this partition.
MaxThreadsConstraintRuntimeMBean[]	getMaxThreadsConstraintRuntimes()	RuntimeMBeans which expose this partition's globally defined MaxThreadsConstraints.
MessagingBridgeRuntimeMBean[]	getMessagingBridgeRuntimes()	The MessagingBridgeRuntimeMBeans for this partition.
MinThreadsConstraintRuntimeMBean[]	getMinThreadsConstraintRuntimes()	RuntimeMBeans which exposes this partition's globally defined MinThreadsConstraints.
java.lang.String	getName()	The name of this configuration.
HealthState	getOverallHealthState()	The aggregate health state of the partition as reported by components within the partition
javax.management.openmbean.CompositeData	getOverallHealthStateJMX()	The overall health state of this partition returned as a CompositeData type.
java.lang.String	getPartitionID()	Partition ID for this partition.
PartitionResourceMetricsRuntimeMBean	getPartitionResourceMetricsRuntime()	The partition resource consumption metrics for this partition.
PartitionWorkManagerRuntimeMBean	getPartitionWorkManagerRuntime()	The PartitionWorkManagerRuntimeMBean for this partition.
PathServiceRuntimeMBean[]	getPathServiceRuntimes()	Array of all PathServiceRuntimeMBean instances for this partition.
PersistentStoreRuntimeMBean[]	getPersistentStoreRuntimes()	The mbeans that provide runtime information for each PersistentStore.
RequestClassRuntimeMBean[]	getRequestClassRuntimes()	RuntimeMBeans which exposes this partition's globally defined Request Classes.
java.lang.String	getRgState(java.lang.String resourceGroupName)	The current state of the named resource group MBean
SAFRuntimeMBean	getSAFRuntime()	The SAFRuntimeMBean for this partition.
java.lang.String	getServerName()	The server associated with this configuration.
java.lang.String	getState()	The current state of the partition runtime MBean
java.lang.String	getSubState()	The current substate of the partition runtime MBean
HealthState[]	getSubsystemHealthStates()	An array of health states for major subsystems in the partition.
javax.management.openmbean.CompositeData[]	getSubsystemHealthStatesJMX()	The health states for major subsystems in the partition as an array of CompositeData type.
java.lang.String	getSystemFileSystemRoot()	System file system root directory for this partition.
java.lang.String	getUserFileSystemRoot()	User file system root directory for this partition.
WLDFPartitionRuntimeMBean	getWLDFPartitionRuntime()	The MBean which provides access to all Diagnostic runtime MBeans for this partition.
WorkManagerRuntimeMBean[]	getWorkManagerRuntimes()	An array of MBeans which expose this partition's active internal WorkManagers.
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.
void	halt()	Halts the partition.
boolean	isRestartRequired()	Indicates whether the partition must be restarted in order to activate configuration changes.
ApplicationRuntimeMBean	lookupApplicationRuntime(java.lang.String name)	The name of the ApplicationRuntimeMBean requested.
LibraryRuntimeMBean	lookupLibraryRuntime(java.lang.String name)	The name of the LibraryRuntimeMBean requested.
MessagingBridgeRuntimeMBean	lookupMessagingBridgeRuntime(java.lang.String name)
PersistentStoreRuntimeMBean	lookupPersistentStoreRuntime(java.lang.String name)	The Runtime mbean for the persistent store with the specified short name.
void	resume()	Resume a suspended partition.
void	resumeResourceGroup(java.lang.String resourceGroupName)	Resume suspended resource group.
void	shutdown()	Gracefully shuts down the partition after handling inflight work.
void	shutdown(int timeout, boolean ignoreSessions)	Gracefully shuts down the partition after handling inflight work.
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.
void	shutdownResourceGroup(java.lang.String resourceGroupName)	Gracefully shuts down the resource group after handling inflight work.
void	shutdownResourceGroup(java.lang.String resourceGroupName, int timeout, boolean ignoreSessions)	Gracefully shuts down the partition after handling inflight work.
void	shutdownResourceGroup(java.lang.String resourceGroupName, int timeout, boolean ignoreSessions, boolean waitForAllSessions)	Gracefully shuts down the partition after handling inflight work.
void	startResourceGroup(java.lang.String resourceGroupName)	starts the resource group.
void	startResourceGroupInAdmin(java.lang.String resourceGroupName)	Starts the resource group in ADMIN state.
void	suspend()	Suspends the partition.
void	suspend(int timeout, boolean ignoreSessions)	Transitions the partition from RUNNING to ADMIN state gracefully.
void	suspendResourceGroup(java.lang.String resourceGroupName)	Suspends resource group.
void	suspendResourceGroup(java.lang.String resourceGroupName, int timeout, boolean ignoreSessions)	Suspends resource group.

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, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Method Detail

getName

java.lang.String getName()

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:

getName in interface WebLogicMBean

getServerName

java.lang.String getServerName()

The server associated with this configuration.

getState

java.lang.String getState()

The current state of the partition runtime MBean

Returns:

state

getSubState

java.lang.String getSubState()

The current substate of the partition runtime MBean

Returns:

substate

getPartitionID

java.lang.String getPartitionID()

Partition ID for this partition.

Returns:

Partition ID value

getSystemFileSystemRoot

java.lang.String getSystemFileSystemRoot()

System file system root directory for this partition.

Returns:

System file system root directory as canonical path

getUserFileSystemRoot

java.lang.String getUserFileSystemRoot()

User file system root directory for this partition.

Returns:

User file system root directory as canonical path

getJMSRuntime

JMSRuntimeMBean getJMSRuntime()

The JMSRuntimeMBean for this partition.

Returns:

The jMSRuntime value

getApplicationRuntimes

ApplicationRuntimeMBean[] getApplicationRuntimes()

Currently running Applications of this partition.

Returns:

the currently running applications

lookupApplicationRuntime

ApplicationRuntimeMBean lookupApplicationRuntime(java.lang.String name)

The name of the ApplicationRuntimeMBean requested.

Parameters:

name - the name of the ApplicationRuntime MBean to find

Returns:

The requested ApplicationRuntimeMBean, null if it does not exist

Access limited to the following security roles:

Deployer

getLibraryRuntimes

LibraryRuntimeMBean[] getLibraryRuntimes()

Deployed Libraries of this partition.

Returns:

Array of LibraryRuntimeMBeans

lookupLibraryRuntime

LibraryRuntimeMBean lookupLibraryRuntime(java.lang.String name)

The name of the LibraryRuntimeMBean requested.

Parameters:

name - the name of the LibraryRuntimeMBean to find

Returns:

The requested LibraryRuntimeMBean, null if it does not exist

getWorkManagerRuntimes

WorkManagerRuntimeMBean[] getWorkManagerRuntimes()

An array of MBeans which expose this partition's active internal WorkManagers.

Returns:

The workManagerRuntimes value

getPartitionWorkManagerRuntime

PartitionWorkManagerRuntimeMBean getPartitionWorkManagerRuntime()

The PartitionWorkManagerRuntimeMBean for this partition.

Returns:

the PartitionWorkManagerRuntimeMBean object

getMaxThreadsConstraintRuntimes

MaxThreadsConstraintRuntimeMBean[] getMaxThreadsConstraintRuntimes()

RuntimeMBeans which expose this partition's globally defined MaxThreadsConstraints.

Returns:

an array of Runtime MBeans

getMinThreadsConstraintRuntimes

MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()

RuntimeMBeans which exposes this partition's globally defined MinThreadsConstraints.

Returns:

an array of Runtime MBeans

getRequestClassRuntimes

RequestClassRuntimeMBean[] getRequestClassRuntimes()

RuntimeMBeans which exposes this partition's globally defined Request Classes.

Returns:

an array of Runtime MBeans

getMailSessionRuntimes

MailSessionRuntimeMBean[] getMailSessionRuntimes()

The JavaMail Mail RuntimeMBeans for this partition.

Returns:

an array of MailSessionRuntimes

getMessagingBridgeRuntimes

MessagingBridgeRuntimeMBean[] getMessagingBridgeRuntimes()

The MessagingBridgeRuntimeMBeans for this partition.

Returns:

an array of messagingBridgeRuntimes

lookupMessagingBridgeRuntime

MessagingBridgeRuntimeMBean lookupMessagingBridgeRuntime(java.lang.String name)

Parameters:

name - the name of the messagingBridgeRuntime to find

getPersistentStoreRuntimes

PersistentStoreRuntimeMBean[] getPersistentStoreRuntimes()

The mbeans that provide runtime information for each PersistentStore.

Returns:

an array of PersistentStoreRuntimes

lookupPersistentStoreRuntime

PersistentStoreRuntimeMBean lookupPersistentStoreRuntime(java.lang.String name)

The Runtime mbean for the persistent store with the specified short name.

Parameters:

name - the name of the persistent store Runtime mbean to find

getConnectorServiceRuntime

ConnectorServiceRuntimeMBean getConnectorServiceRuntime()

The access point for partition specific control and monitoring of the Connector Container.

Returns:

the Connector Service MBean for this partition

getPathServiceRuntimes

PathServiceRuntimeMBean[] getPathServiceRuntimes()

Array of all PathServiceRuntimeMBean instances for this partition.

Returns:

Array of PathServiceRuntimes

getSAFRuntime

SAFRuntimeMBean getSAFRuntime()

The SAFRuntimeMBean for this partition.

Returns:

The sAFRuntime value

getWLDFPartitionRuntime

WLDFPartitionRuntimeMBean getWLDFPartitionRuntime()

The MBean which provides access to all Diagnostic runtime MBeans for this partition.

Returns:

WLDF partition runtime

getConcurrentManagedObjectsRuntime

ConcurrentManagedObjectsRuntimeMBean getConcurrentManagedObjectsRuntime()

The ConcurrentManagedObjectsRuntimeMBean for this partition.

Returns:

The concurrentManagedObjectsRuntime value

getPartitionResourceMetricsRuntime

PartitionResourceMetricsRuntimeMBean getPartitionResourceMetricsRuntime()

The partition resource consumption metrics for this partition.

Returns:

the PartitionResourceMetricsRuntimeMBean

getBatchJobRepositoryRuntime

BatchJobRepositoryRuntimeMBean getBatchJobRepositoryRuntime()

The partition BatchJobRepositoryPartitionRuntimeMBean

Returns:

the BatchJobRepositoryRuntimeMBean

suspend

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

Parameters:

timeout - Seconds to wait for partition to transition gracefully. The forceSuspend() is called after timeout.

ignoreSessions - drop inflight HTTP sessions during graceful suspend

Throws:

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

Access limited to the following security roles:

Operator

suspend

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

Throws:

PartitionLifeCycleException

See Also:

suspend(int, boolean)

Access limited to the following security roles:

Operator

forceSuspend

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.

Throws:

PartitionLifeCycleException - partition failed to force suspend. A forceShutdown() operation can be invoked.

Access limited to the following security roles:

Operator

resume

void resume()
     throws PartitionLifeCycleException

Resume a suspended partition. Allow new requests. This operation transitions the partition into RUNNING state.

Throws:

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.

Access limited to the following security roles:

Operator

shutdown

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.

Parameters:

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.

Throws:

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

Access limited to the following security roles:

Operator

shutdown

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);

Parameters:

timeout -

ignoreSessions -

Throws:

PartitionLifeCycleException

See Also:

shutdown(int, boolean, boolean)

Access limited to the following security roles:

Operator

shutdown

void shutdown()
       throws PartitionLifeCycleException

Gracefully shuts down the partition after handling inflight work.

Throws:

PartitionLifeCycleException

See Also:

shutdown(int, boolean, boolean)

Access limited to the following security roles:

Operator

halt

void halt()
   throws PartitionLifeCycleException

Halts the partition.

Throws:

PartitionLifeCycleException

Access limited to the following security roles:

Operator

forceShutdown

void forceShutdown()
            throws PartitionLifeCycleException

Force shutdown the partition. Causes the partition to reject new requests and fail pending requests.

Throws:

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.

Access limited to the following security roles:

Operator

startResourceGroup

void startResourceGroup(java.lang.String resourceGroupName)
                 throws ResourceGroupLifecycleException

starts the resource group.

Parameters:

resourceGroupName - The resource group name

Throws:

ResourceGroupLifecycleException - resource group failed to start.

Access limited to the following security roles:

Operator

startResourceGroupInAdmin

void startResourceGroupInAdmin(java.lang.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

Parameters:

resourceGroupName -

Throws:

ResourceGroupLifecycleException - resource group failed to start in admin mode.

Access limited to the following security roles:

Operator

suspendResourceGroup

void suspendResourceGroup(java.lang.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

Parameters:

resourceGroupName -

timeout -

ignoreSessions -

Throws:

ResourceGroupLifecycleException

Access limited to the following security roles:

Operator

suspendResourceGroup

void suspendResourceGroup(java.lang.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

Parameters:

resourceGroupName -

Throws:

ResourceGroupLifecycleException

See Also:

suspendResourceGroup(String, int, boolean)

Access limited to the following security roles:

Operator

forceSuspendResourceGroup

void forceSuspendResourceGroup(java.lang.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.

Parameters:

resourceGroupName -

Throws:

ResourceGroupLifecycleException - partition failed to force suspend. A forceShutdown() operation can be invoked.

Access limited to the following security roles:

Operator

resumeResourceGroup

void resumeResourceGroup(java.lang.String resourceGroupName)
                  throws ResourceGroupLifecycleException

Resume suspended resource group. Allow new requests. This operation transitions the resource group into RUNNING state.

Parameters:

resourceGroupName -

Throws:

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.

Access limited to the following security roles:

Operator

forceShutdownResourceGroup

void forceShutdownResourceGroup(java.lang.String resourceGroupName)
                         throws ResourceGroupLifecycleException

Force shutdown the resource group. Causes the resource group to reject new requests and fail pending requests.

Parameters:

resourceGroupName -

Throws:

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.

Access limited to the following security roles:

Operator

shutdownResourceGroup

void shutdownResourceGroup(java.lang.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:

• 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 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.

Parameters:

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.

Throws:

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

ResourceGroupLifecycleException

Access limited to the following security roles:

Operator

shutdownResourceGroup

void shutdownResourceGroup(java.lang.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);

Parameters:

resourceGroupName -

timeout -

ignoreSessions -

Throws:

ResourceGroupLifecycleException

See Also:

shutdownResourceGroup(String, int, boolean, boolean)

Access limited to the following security roles:

Operator

shutdownResourceGroup

void shutdownResourceGroup(java.lang.String resourceGroupName)
                    throws ResourceGroupLifecycleException

Gracefully shuts down the resource group after handling inflight work.

Parameters:

resourceGroupName -

Throws:

ResourceGroupLifecycleException

See Also:

shutdownResourceGroup(String, int, boolean, boolean)

Access limited to the following security roles:

Operator

getRgState

java.lang.String getRgState(java.lang.String resourceGroupName)
                     throws ResourceGroupLifecycleException

The current state of the named resource group MBean

Parameters:

resourceGroupName - the resource group name

Throws:

ResourceGroupLifecycleException

Access limited to the following security roles:

Deployer, Operator, Monitor

getWseeClusterFrontEndRuntime

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.

getOverallHealthState

HealthState getOverallHealthState()

The aggregate health state of the partition as reported by components within the partition

Returns:

The healthState of the partition

See Also:

HealthState

getOverallHealthStateJMX

javax.management.openmbean.CompositeData getOverallHealthStateJMX()
                                                           throws javax.management.openmbean.OpenDataException

The overall health state of this partition returned as a CompositeData type.

Returns:

The HealthState represented as a CompositeData

Throws:

javax.management.openmbean.OpenDataException

See Also:

getOverallHealthState(), HealthState

isRestartRequired

boolean isRestartRequired()

Indicates whether the partition must be restarted in order to activate configuration changes.

Returns:

true if the partition needs to be restarted, false otherwise.

getSubsystemHealthStates

HealthState[] getSubsystemHealthStates()

An array of health states for major subsystems in the partition.

Returns:

Array of subsystem HealthStates

getSubsystemHealthStatesJMX

javax.management.openmbean.CompositeData[] getSubsystemHealthStatesJMX()
                                                                throws javax.management.openmbean.OpenDataException

The health states for major subsystems in the partition as an array of CompositeData type.

Returns:

Array of subsystem health state as CompositeData objects

Throws:

javax.management.openmbean.OpenDataException