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 DomainRuntimeMBean

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

 

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

getName

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

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
Since:
9.0.0.0

lookupServerLifeCycleRuntime

ServerLifeCycleRuntimeMBean lookupServerLifeCycleRuntime(String name)

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

Parameters:
name -
Since:
9.0.0.0

getCoherenceServerLifeCycleRuntimes

CoherenceServerLifeCycleRuntimeMBean[] getCoherenceServerLifeCycleRuntimes()
Deprecated. 12.2.1.0 CoherenceServerLifeCycleRuntimeMBean has been deprecated

The CoherenceServerLifecycleRuntimeMBean for all configured Coherence servers in the domain.

Returns:
an array of CoherenceServerLifecycleRuntimeMBean value
Since:
10.3.4.0

lookupCoherenceServerLifeCycleRuntime

CoherenceServerLifeCycleRuntimeMBean lookupCoherenceServerLifeCycleRuntime(String name)
Deprecated. 12.2.1.0 CoherenceServerLifeCycleRuntimeMBean has been deprecated

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

Parameters:
name -
Since:
10.3.4.0

getSystemComponentLifeCycleRuntimes

SystemComponentLifeCycleRuntimeMBean[] getSystemComponentLifeCycleRuntimes()

The SystemComponentLifecycleRuntimeMBean for all configured System Components in the domain.

Returns:
an array of SystemComponentLifecycleRuntimeMBean value
Since:
12.1.2.0

lookupSystemComponentLifeCycleRuntime

SystemComponentLifeCycleRuntimeMBean lookupSystemComponentLifeCycleRuntime(String name)

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

Parameters:
name -
Since:
12.1.2.0

getDeployerRuntime

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.
Since:
9.0.0.0

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.

Since:
9.0

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.

Since:
9.0

getConsoleRuntime

ConsoleRuntimeMBean getConsoleRuntime()

Return the MBean which provides access to console runtime services.

Since:
10.3.1.0

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
Since:
9.0.0.0

getServiceMigrationDataRuntimes

ServiceMigrationDataRuntimeMBean[] getServiceMigrationDataRuntimes()

Returns all the service migrations done in the domain


startPartitionWait

PartitionLifeCycleTaskRuntimeMBean startPartitionWait(PartitionMBean partitionMBean,
                                                      String initialState,
                                                      int timeOut)
                                                      throws ManagementException,
                                                             PartitionLifeCycleException,
                                                             InterruptedException,
                                                             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
InterruptedException
PartitionLifeCycleException
IllegalArgumentException

forceShutdownPartitionWait

PartitionLifeCycleTaskRuntimeMBean forceShutdownPartitionWait(PartitionMBean partitionMBean,
                                                              int timeout)
                                                              throws ManagementException,
                                                                     PartitionLifeCycleException,
                                                                     InterruptedException,
                                                                     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
InterruptedException
IllegalArgumentException

getResourceGroupLifeCycleRuntimes

ResourceGroupLifeCycleRuntimeMBean[] getResourceGroupLifeCycleRuntimes()

Returns life cycle runtimes for domain-level resource groups.

Returns:
array of ResourceGroupLifeCycleRuntimeMBeans
Since:
12.2.1.0

lookupResourceGroupLifeCycleRuntime

ResourceGroupLifeCycleRuntimeMBean lookupResourceGroupLifeCycleRuntime(String name)

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

Parameters:
name -
Returns:
matching ResourceGroupLifeCycleRuntimeMBean
Since:
12.2.1.0

getDomainPartitionRuntimes

DomainPartitionRuntimeMBean[] getDomainPartitionRuntimes()

Returns domain partition runtimes.

Returns:
array of DomainPartitionRuntimeMBeans
Since:
12.2.1.0

lookupDomainPartitionRuntime

DomainPartitionRuntimeMBean lookupDomainPartitionRuntime(String name)

Returns the domain partition runtime MBean for the specified partition

Parameters:
name -
Returns:
matching DomainPartitionRuntimeMBean
Since:
12.2.1.0

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
Since:
12.2.1.0

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