Package weblogic.management.runtime

Interface DomainRuntimeMBean

All Superinterfaces:

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

public interface DomainRuntimeMBean
extends RuntimeMBean

This class is used for monitoring a WebLogic domain. A domain may contain zero or more clusters. A cluster may be looked up by a logical name.

Method Summary

Modifier and Type	Method	Description
PartitionLifeCycleTaskRuntimeMBean	forceShutdownPartitionWait(PartitionMBean partitionMBean, int timeout)
java.util.Date	getActivationTime()	The time when the domain became active.
AppRuntimeStateRuntimeMBean	getAppRuntimeStateRuntime()	Returns a service from which it is possible to determine the state applications throughout the domain.
BatchJobRepositoryRuntimeMBean	getBatchJobRepositoryRuntime()
CoherenceServerLifeCycleRuntimeMBean[]	getCoherenceServerLifeCycleRuntimes()	Deprecated. 12.2.1.0.0 CoherenceServerLifeCycleRuntimeMBean has been deprecated
ConsoleRuntimeMBean	getConsoleRuntime()	Deprecated. 14.1.2.0.0
DomainPartitionRuntimeMBean	getCurrentDomainPartitionRuntime()	Returns the domain partition runtime MBean for the "current" partition
DeployerRuntimeMBean	getDeployerRuntime()	Deprecated. 9.0.0.0
DeploymentManagerMBean	getDeploymentManager()	Provides access to the service interface to the interface that is used to deploy new customer applications or modules into this domain.
DomainPartitionRuntimeMBean[]	getDomainPartitionRuntimes()	Returns domain partition runtimes.
DomainSecurityRuntimeMBean	getDomainSecurityRuntime()	Returns the Domain Security runtime MBean.
EditSessionConfigurationManagerMBean	getEditSessionConfigurationManager()	Provides access to the service interface used to manage named edit sessions in this domain.
ElasticServiceManagerRuntimeMBean	getElasticServiceManagerRuntime()
LogRuntimeMBean	getLogRuntime()	Return the MBean which provides access to the control interface for WLS server logging.
MessageDrivenControlEJBRuntimeMBean	getMessageDrivenControlEJBRuntime()	The MessageDrivenControlEJBRuntimeMBean for this server.
MigratableServiceCoordinatorRuntimeMBean	getMigratableServiceCoordinatorRuntime()	Returns the service used for coordinating the migraiton of migratable services.
MigrationDataRuntimeMBean[]	getMigrationDataRuntimes()	Returns a history of server migrations.
java.lang.String	getName()	The user-specified name of this MBean instance.
WseePolicySubjectManagerRuntimeMBean	getPolicySubjectManagerRuntime()
ResourceGroupLifeCycleRuntimeMBean[]	getResourceGroupLifeCycleRuntimes()	Returns life cycle runtimes for domain-level resource groups.
RolloutServiceRuntimeMBean	getRolloutService()
ServerLifeCycleRuntimeMBean[]	getServerLifeCycleRuntimes()	The ServerLifecycleRuntimeMBean for all configured servers in the domain.
ServiceMigrationDataRuntimeMBean[]	getServiceMigrationDataRuntimes()	Returns all the service migrations done in the domain
SNMPAgentRuntimeMBean	getSNMPAgentRuntime()	Return the MBean which provides access to the monitoring statistics for WLS SNMP Agent.
SystemComponentLifeCycleRuntimeMBean[]	getSystemComponentLifeCycleRuntimes()	The SystemComponentLifecycleRuntimeMBean for all configured System Components in the domain.
CoherenceServerLifeCycleRuntimeMBean	lookupCoherenceServerLifeCycleRuntime(java.lang.String name)	Deprecated. 12.2.1.0.0 CoherenceServerLifeCycleRuntimeMBean has been deprecated
DomainPartitionRuntimeMBean	lookupDomainPartitionRuntime(java.lang.String name)	Returns the domain partition runtime MBean for the specified partition
ResourceGroupLifeCycleRuntimeMBean	lookupResourceGroupLifeCycleRuntime(java.lang.String name)	Returns the resource group life cycle run-time MBean for the specified domain-level resource group.
ServerLifeCycleRuntimeMBean	lookupServerLifeCycleRuntime(java.lang.String name)	Returns the server life cycle run-time MBean for the specified server.
SystemComponentLifeCycleRuntimeMBean	lookupSystemComponentLifeCycleRuntime(java.lang.String name)	Returns the SystemComponent life cycle run-time MBean for the specified server.
void	restartSystemResource(SystemResourceMBean resource)	Restarts a system resource on all nodes to which it is deployed.
PartitionLifeCycleTaskRuntimeMBean	startPartitionWait(PartitionMBean partitionMBean, java.lang.String initialState, int timeOut)	Starts the Partition with initialState and within timeOut msec.

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 user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

Specified by:

getName in interface WebLogicMBean

getActivationTime

java.util.Date getActivationTime()

The time when the domain became active.

Returns:

The activationTime value

getServerLifeCycleRuntimes

ServerLifeCycleRuntimeMBean[] getServerLifeCycleRuntimes()

The ServerLifecycleRuntimeMBean for all configured servers in the domain.

Returns:

an array of ServerLifecycleRuntimeMBean value

lookupServerLifeCycleRuntime

ServerLifeCycleRuntimeMBean lookupServerLifeCycleRuntime(java.lang.String name)

Returns the server life cycle run-time MBean for the specified server.

Parameters:

name -

getCoherenceServerLifeCycleRuntimes

@Deprecated
CoherenceServerLifeCycleRuntimeMBean[] getCoherenceServerLifeCycleRuntimes()

Deprecated.

12.2.1.0.0 CoherenceServerLifeCycleRuntimeMBean has been deprecated

The CoherenceServerLifecycleRuntimeMBean for all configured Coherence servers in the domain.

Returns:

an array of CoherenceServerLifecycleRuntimeMBean value

lookupCoherenceServerLifeCycleRuntime

@Deprecated
CoherenceServerLifeCycleRuntimeMBean lookupCoherenceServerLifeCycleRuntime(java.lang.String name)

Deprecated.

12.2.1.0.0 CoherenceServerLifeCycleRuntimeMBean has been deprecated

Returns the Coherence server life cycle run-time MBean for the specified server.

Parameters:

name -

getSystemComponentLifeCycleRuntimes

SystemComponentLifeCycleRuntimeMBean[] getSystemComponentLifeCycleRuntimes()

The SystemComponentLifecycleRuntimeMBean for all configured System Components in the domain.

Returns:

an array of SystemComponentLifecycleRuntimeMBean value

lookupSystemComponentLifeCycleRuntime

SystemComponentLifeCycleRuntimeMBean lookupSystemComponentLifeCycleRuntime(java.lang.String name)

Returns the SystemComponent life cycle run-time MBean for the specified server.

Parameters:

name -

getDeployerRuntime

@Deprecated
DeployerRuntimeMBean getDeployerRuntime()

Deprecated.

9.0.0.0

Provides access to the service interface to the interface that is used to deploy new customer applications or modules into this domain.

Returns:

The DeployerRuntime for this domain.

getDeploymentManager

DeploymentManagerMBean getDeploymentManager()

Provides access to the service interface to the interface that is used to deploy new customer applications or modules into this domain.

Returns:

The DeploymentManager for this domain.

getAppRuntimeStateRuntime

AppRuntimeStateRuntimeMBean getAppRuntimeStateRuntime()

Returns a service from which it is possible to determine the state applications throughout the domain.

Returns:

the domain wide AppRuntimeState runtime mbean.

getMigratableServiceCoordinatorRuntime

MigratableServiceCoordinatorRuntimeMBean getMigratableServiceCoordinatorRuntime()

Returns the service used for coordinating the migraiton of migratable services.

Returns:

the Domain Wide mbean for control service migration.

getMigrationDataRuntimes

MigrationDataRuntimeMBean[] getMigrationDataRuntimes()

Returns a history of server migrations. Each array element represents a past or an ongoing migration.

getLogRuntime

LogRuntimeMBean getLogRuntime()

Return the MBean which provides access to the control interface for WLS server logging.

getMessageDrivenControlEJBRuntime

MessageDrivenControlEJBRuntimeMBean getMessageDrivenControlEJBRuntime()

The MessageDrivenControlEJBRuntimeMBean for this server.

Returns:

The MessageDrivenControlEJBRuntime value

getSNMPAgentRuntime

SNMPAgentRuntimeMBean getSNMPAgentRuntime()

Return the MBean which provides access to the monitoring statistics for WLS SNMP Agent.

getConsoleRuntime

@Deprecated
ConsoleRuntimeMBean getConsoleRuntime()

Deprecated.

14.1.2.0.0

Return the MBean which provides access to console runtime services.

getPolicySubjectManagerRuntime

WseePolicySubjectManagerRuntimeMBean getPolicySubjectManagerRuntime()

restartSystemResource

void restartSystemResource(SystemResourceMBean resource)
                    throws ManagementException

Restarts a system resource on all nodes to which it is deployed.

Parameters:

resource -

Throws:

ManagementException

Access limited to the following security roles:

Operator

getServiceMigrationDataRuntimes

ServiceMigrationDataRuntimeMBean[] getServiceMigrationDataRuntimes()

Returns all the service migrations done in the domain

startPartitionWait

PartitionLifeCycleTaskRuntimeMBean startPartitionWait(PartitionMBean partitionMBean,
                                                      java.lang.String initialState,
                                                      int timeOut)
                                               throws ManagementException,
                                                      PartitionLifeCycleException,
                                                      java.lang.InterruptedException,
                                                      java.lang.IllegalArgumentException

Starts the Partition with initialState and within timeOut msec. This is synchronous operation, where the function will not return untill the partition is started or an exception is thrown

Parameters:

partitionMBean -

initialState - 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:

PartitionLifeCycleTaskRuntimeMBean to get the status of start operation

Throws:

ManagementException

java.lang.InterruptedException

PartitionLifeCycleException

java.lang.IllegalArgumentException

forceShutdownPartitionWait

PartitionLifeCycleTaskRuntimeMBean forceShutdownPartitionWait(PartitionMBean partitionMBean,
                                                              int timeout)
                                                       throws ManagementException,
                                                              PartitionLifeCycleException,
                                                              java.lang.InterruptedException,
                                                              java.lang.IllegalArgumentException

Parameters:

partitionMBean -

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

Returns:

PartitionLifeCycleTaskRuntimeMBean to get the status of shutdown operation

Throws:

ManagementException

PartitionLifeCycleException

java.lang.InterruptedException

java.lang.IllegalArgumentException

getResourceGroupLifeCycleRuntimes

ResourceGroupLifeCycleRuntimeMBean[] getResourceGroupLifeCycleRuntimes()

Returns life cycle runtimes for domain-level resource groups.

Returns:

array of ResourceGroupLifeCycleRuntimeMBeans

lookupResourceGroupLifeCycleRuntime

ResourceGroupLifeCycleRuntimeMBean lookupResourceGroupLifeCycleRuntime(java.lang.String name)

Returns the resource group life cycle run-time MBean for the specified domain-level resource group.

Parameters:

name -

Returns:

matching ResourceGroupLifeCycleRuntimeMBean

getDomainPartitionRuntimes

DomainPartitionRuntimeMBean[] getDomainPartitionRuntimes()

Returns domain partition runtimes.

Returns:

array of DomainPartitionRuntimeMBeans

lookupDomainPartitionRuntime

DomainPartitionRuntimeMBean lookupDomainPartitionRuntime(java.lang.String name)

Returns the domain partition runtime MBean for the specified partition

Parameters:

name -

Returns:

matching DomainPartitionRuntimeMBean

getElasticServiceManagerRuntime

ElasticServiceManagerRuntimeMBean getElasticServiceManagerRuntime()

Returns:

the ElasticServiceManagerRuntimeMBean

getRolloutService

RolloutServiceRuntimeMBean getRolloutService()

getBatchJobRepositoryRuntime

BatchJobRepositoryRuntimeMBean getBatchJobRepositoryRuntime()

Returns:

the BatchJobRepositoryRuntimeMBean

getEditSessionConfigurationManager

EditSessionConfigurationManagerMBean getEditSessionConfigurationManager()

Provides access to the service interface used to manage named edit sessions in this domain.

Returns:

The EditSessionConfigurationManager for this domain.

getCurrentDomainPartitionRuntime

DomainPartitionRuntimeMBean getCurrentDomainPartitionRuntime()

Returns the domain partition runtime MBean for the "current" partition

Returns:

matching DomainPartitionRuntimeMBean

getDomainSecurityRuntime

DomainSecurityRuntimeMBean getDomainSecurityRuntime()

Returns the Domain Security runtime MBean.

Returns:

matching DomainSecurityRuntimeMBean