|
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 DomainRuntimeServiceMBean
Provides a common access point for navigating to all runtime and configuration MBeans in the domain as well as to MBeans that provide domain-wide services (such as controlling and monitoring the life cycles of servers and message-driven EJBs and coordinating the migration of migratable services).
This MBean is available only on the Administration Server.
The javax.management.ObjectName
of this MBean is "com.bea:Name=DomainRuntimeService,Type=weblogic.management.mbeanservers.domainruntime.DomainRuntimeServiceMBean
".
This is the only object name that a JMX client needs to navigate the hierarchy available from this MBean.
Note: If your JMX client uses the Domain Runtime MBean Server to access runtime or configuration MBeans by constructing object names (instead of by using this DomainRuntimeServiceMBean
to navigate the MBean hierarchy), the client must add a Location=servername
key property to the MBean object name. The MBean server uses this key property to route the JMX request to the appropriate WebLogic Server instance. If your client uses the DomainRuntimeServiceMBean
to navigate the MBean hierarchy, the object names that it obtains automatically contain the location key property.
To start navigating, a JMX client invokes the javax.management.MBeanServerConnection.getAttribute()
method and passes the following as parameters:
ObjectName
of this service MBeanString
representation for the name of an attribute in this MBean that contains the root of an MBean hierarchyThis method call returns the ObjectName
for the root MBean. To access MBeans below the root, the JMX client passes the root MBean's ObjectName
and the name of a root MBean attribute that contains a child MBean to the MBeanServerConnection.getAttribute()
method. This method call returns the ObjectName
of the child MBean.
For example:
ObjectName drs =
new ObjectName("com.bea:Name=DomainRuntimeService,Type=weblogic.management.mbeanservers.domainruntime.DomainRuntimeServiceMBean");
// Get the ObjectName of the domain's DomainMBean by gettingthe
// of the DomainRuntimeServiceMBean DomainConfiguration
ObjectName domainconfig = (ObjectName) MBeanServerConnection.getAttribute(drs,"DomainConfiguration");
// Get the ObjectNames for all ServerMBeans in the domain by getting
// the value of the DomainMBean Servers attribute
ObjectName[] servers = (ObjectName[]) MBeanServerConnection.getAttribute(domainconfig,"Servers");
Field Summary | |
---|---|
static String |
MBEANSERVER_JNDI_NAME This is the JNDI Context that contains a reference to the MBeanServer in which this interfaces is registered. |
static String |
OBJECT_NAME This is the ObjectName under which this service is registered in the MBeanServer |
Method Summary | |
---|---|
abstract DescriptorBean |
findConfiguration(RuntimeMBean runtimeMBean) Enables a JMX client to retrieve configuration data for a specific instance of a resource. |
abstract DomainMBean |
findDomainConfiguration(String serverName) Returns the active DomainMBean for the specified server. |
abstract PartitionRuntimeMBean |
findPartitionRuntime(String partitionName, String serverName) Returns the PartitionRuntimeMBean for the specified partition and server instance. |
abstract PartitionRuntimeMBean[] |
findPartitionRuntimes(String partitionName) Returns all current PartitionRuntimeMBean instances for given partition on all targeted servers in the domain. |
abstract RuntimeMBean |
findRuntime(DescriptorBean configurationMBean, String serverName) Enables a JMX client to retrieve monitoring statistics for a specific resource on a specific server. |
abstract RuntimeMBean[] |
findRuntimes(DescriptorBean configurationMBean) Enables a JMX client to retrieve monitoring statistics for all instances of a specific resource on all servers in a domain. |
abstract ServerMBean |
findServerConfiguration(String serverName) Returns the active ServerMBean for the specified server. |
abstract Service |
findService(String name, String type, String location) Returns the Service on the specified Server or in the primary MBeanServer if the location is not specified. |
abstract DomainMBean |
getDomainConfiguration() Contains the active DomainMBean for the current WebLogic Server domain. |
abstract DomainMBean |
getDomainPending() Contains a read-only version of the pending DomainMBean for the current WebLogic Server domain. |
abstract DomainRuntimeMBean |
getDomainRuntime() Contains the DomainRuntimeMBean for the current WebLogic Server domain. |
abstract String |
getServerName() The name of this WebLogic Server instance as defined in the domain configuration. |
abstract ServerRuntimeMBean[] |
getServerRuntimes() Contains all ServerRuntimeMBean instances on all servers in the domain. |
abstract Service[] |
getServices(String serverName) Returns all the services that do not have a parent (i.e, all the root services) |
abstract ServerRuntimeMBean |
lookupServerRuntime(String name) Returns the ServerRuntimeMBean for the specified server instance. |
Methods inherited from interface weblogic.management.mbeanservers.Service |
---|
getName, getParentAttribute, getParentService, getPath, getType |
Field Detail |
---|
static final String MBEANSERVER_JNDI_NAME
static final String OBJECT_NAME
Method Detail |
---|
DomainMBean getDomainPending()
Contains a read-only version of the pending DomainMBean
for the current WebLogic Server domain. You cannot use this MBean to modify a domain's configuration.
If you want to modify a domain's configuration, use the startEdit
operation in the ConfigurationManagerMBean
to start an edit session. The startEdit
operation returns an editable DomainMBean
.
Get this read-only version of the MBean to learn about the pending configuration of all servers and resources in the domain.
DomainMBean getDomainConfiguration()
Contains the active DomainMBean
for the current WebLogic Server domain.
Get this MBean to learn about the active configuration of all servers and resources in the domain. Any command line options that were used to start servers in this domain override the values in this DomainMBean
. For example, if you used a command line option to override a server's listen port, the ServerMBean
that you navigate to from this DomainMBean
will show the value persisted in the config.xml
file; it will not show the value that was passed in the command line option.
Note: The DomainMBean
that can be accessed from this (DomainRuntimeServiceMBean
) MBean attribute represents the active configuration of the domain and cannot be edited. The pending DomainMBean
, which can be edited, is returned by the startEdit
operation in the ConfigurationManagerMBean
.
DomainRuntimeServiceMBean.findDomainConfiguration(java.lang.String)
, DomainRuntimeServiceMBean.findServerConfiguration(java.lang.String)
DomainMBean findDomainConfiguration(String serverName)
Returns the active DomainMBean
for the specified server.
Get this MBean to learn about the current configuration of the server, including any values that were overridden by the server's startup command. For example, if you used a command line option to override a server's listen port, the ServerMBean
that you navigate to from this DomainMBean
will show the value that was passed in the command line option.
Note: The pending DomainMBean
, which can be edited, is available only from the Edit MBean Server and its EditServiceMBean
. The DomainMBean
that can be accessed from this (DomainRuntimeServiceMBean
) MBean attribute represents the active configuration of the specified server and cannot be edited.
serverName
-ServerMBean findServerConfiguration(String serverName)
Returns the active ServerMBean
for the specified server.
Get this MBean to learn about the current configuration of the server, including any values that were overridden by the server's startup command. For example, if you used a command line option to override a server's listen port, this ServerMBean
will show the value that was passed in the command line option.
Note: The pending ServerMBean
, which can be edited, is available only from the Edit MBean Server and its EditServiceMBean
. The ServerMBean
that can be accessed from this (DomainRuntimeServiceMBean
) MBean attribute represents the active configuration of the specified server and cannot be edited.
serverName
-String getServerName()
The name of this WebLogic Server instance as defined in the domain configuration.
DomainRuntimeMBean getDomainRuntime()
Contains the DomainRuntimeMBean
for the current WebLogic Server domain.
This MBean provides access to the special service interfaces that exist only on the Administration Server and provide life cycle control over the domain.
RuntimeMBean[] findRuntimes(DescriptorBean configurationMBean)
Enables a JMX client to retrieve monitoring statistics for all instances of a specific resource on all servers in a domain. To use this operation, a JMX client passes a single configuration MBean and the operation returns runtime MBeans for this resource from all servers in the domain.
For example, a JMX client connects to the Domain Runtime MBean server and gets the JMSServerMBean
for a JMS server named "JS1." The JMX client then invokes this operation and the operation determines the active server instances on which the "JS1" JMS server has been targeted. It then returns all of the JMSServerRuntimeMBean
s for "JS1" from all servers in the domain.
configurationMBean
-RuntimeMBean findRuntime(DescriptorBean configurationMBean, String serverName)
Enables a JMX client to retrieve monitoring statistics for a specific resource on a specific server. To use this operation, a JMX client passes a single configuration MBean and the name of a server instance. The operation returns the corresponding runtime MBean for the resource on the named server, assuming that the resource has been targeted or deployed to the server.
For example, given the JMSServerMBean
for a JMS server named "JS1" on a server instance named "ManagedServer1," this operation returns the JMSServerRuntimeMBean
for "JS1" on "ManagedServer1."
configurationMBean
-serverName
- that owns that runtime mbean.DescriptorBean findConfiguration(RuntimeMBean runtimeMBean)
Enables a JMX client to retrieve configuration data for a specific instance of a resource. To use this operation, a JMX client passes a single runtime MBean and the operation returns the active configuration MBean for the resource.
For example, given the JMSServerRuntimeMBean
for a JMS server named "JS1" on the current server instance, this operation returns the active JMSServerMBean
for "JS1."
runtimeMBean
-ServerRuntimeMBean[] getServerRuntimes()
Contains all ServerRuntimeMBean
instances on all servers in the domain.
Get these MBeans to learn about the current runtime statistics for all server instances in the domain.
ServerRuntimeMBean lookupServerRuntime(String name)
Returns the ServerRuntimeMBean
for the specified server instance. The operation will return a null value if the named server is not currently running.
The ServerRuntimeMBean
is the root of runtime MBean hierarchy for a server instance. Each runtime MBean in the hierarchy provides access to the server's status and control as well as statistical information about any deployed or configured service on the server.
name
-PartitionRuntimeMBean[] findPartitionRuntimes(String partitionName)
Returns all current PartitionRuntimeMBean
instances for given partition on all targeted servers in the domain.
Get these MBeans to learn about the current runtime statistics for all partition runtime instances in the domain.
partitionName
-PartitionRuntimeMBean findPartitionRuntime(String partitionName, String serverName)
Returns the PartitionRuntimeMBean
for the specified partition and server instance. The operation will return a null value if partition is not currently running on the named server.
partitionName
-serverName
-Service findService(String name, String type, String location)
Returns the Service on the specified Server or in the primary MBeanServer if the location is not specified.
name
-type
-location
-Service[] getServices(String serverName)
Returns all the services that do not have a parent (i.e, all the root services)
serverName
- String
|
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 |