weblogic.management.mbeanservers.runtime

Interface RuntimeServiceMBean

All Superinterfaces:

Service

public interface RuntimeServiceMBean
extends Service

Provides an entry point for navigating the hierarchy of WebLogic Server runtime MBeans and active configuration MBeans for the current server.

Each server instance in a domain provides its own instance of this MBean.

The javax.management.ObjectName of this MBean is "com.bea:Name=RuntimeService,Type=weblogic.management.mbeanservers.runtime.RuntimeServiceMBean".

This is the only object name that a JMX client needs to navigate the hierarchy available from this MBean. To start navigating, a JMX client invokes the javax.management.MBeanServerConnection.getAttribute() method and passes the following as parameters:

• The ObjectName of this service MBean
• A String representation for the name of an attribute in this MBean that contains the root of an MBean hierarchy

This 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 rs = new ObjectName("com.bea:Name=RuntimeService,Type=weblogic.management.mbeanservers.runtime.RuntimeServiceMBean");

// Get the ObjectName of the server's ServerRuntimeMBean by getting the value
// of the RuntimeServiceMBean ServerRuntime attribute

ObjectName serverrt = (ObjectName) MBeanServerConnection.getAttribute(rs,"ServerRuntime");

// Get the ObjectNames for all ApplicationRuntimeMBeans on the server by getting
// the value of the ServerRuntimeMBean ApplicationRuntimes attribute

ObjectName[] apprt = (ObjectName[]) MBeanServerConnection.getAttribute(serverrt,"ApplicationRuntimes");


All security roles can access this item.

Field Summary

Fields

Modifier and Type	Field and Description
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	MBEANSERVER_RUNTIME_CONTEXT Local MBean Servers regsitration in JNDI.
static String	OBJECT_NAME This is the ObjectName under which this service is registered in the MBeanServer

Method Summary

Modifier and Type	Method and Description
DescriptorBean	findConfiguration(RuntimeMBean runtimeMBean) Enables a JMX client to retrieve configuration data for a specific instance of a resource.
RuntimeMBean	findRuntime(DescriptorBean configurationMBean) Enables a JMX client to retrieve monitoring statistics for a specified resource on the current server.
Service	findService(String serviceName, String type) Enables client to retrieve a specific named service
DomainMBean	getDomainConfiguration() Contains the active DomainMBean for the current WebLogic Server domain.
ServerMBean	getServerConfiguration() Contains the active ServerMBean for the current server instance.
String	getServerName() The name of the current WebLogic Server instance as defined in the domain configuration.
ServerRuntimeMBean	getServerRuntime() Contains ServerRuntimeMBean for the current server.
Service[]	getServices() Returns all the services that do not have a parent (i.e., all the root services)

Methods inherited from interface weblogic.management.mbeanservers.Service

getName, getParentAttribute, getParentService, getPath, getType

Field Detail

MBEANSERVER_JNDI_NAME

static final String MBEANSERVER_JNDI_NAME

This is the JNDI Context that contains a reference to the MBeanServer in which this interfaces is registered.

See Also:

Constant Field Values

MBEANSERVER_RUNTIME_CONTEXT

static final String MBEANSERVER_RUNTIME_CONTEXT

Local MBean Servers regsitration in JNDI.

See Also:

Constant Field Values

OBJECT_NAME

static final String OBJECT_NAME

This is the ObjectName under which this service is registered in the MBeanServer

Method Detail

getDomainConfiguration

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.

Note: The DomainMBean that can be accessed from this (RuntimeServiceMBean) MBean attribute represents the active configuration of the domain and cannot be edited. The pending DomainMBean, which can be edited, is available only from the Edit MBean Server and its EditServiceMBean.

Returns:

a DomainMBean

getServerConfiguration

ServerMBean getServerConfiguration()

Contains the active ServerMBean for the current server instance.

Get this MBean to learn about the configuration of the current server, including any values that were overridden by the server's startup command.

Note: The ServerMBean that can be accessed from this (RuntimeServiceMBean) MBean attribute represents the active configuration of the server and cannot be edited.

Returns:

a ServerMBean

getServerName

String getServerName()

The name of the current WebLogic Server instance as defined in the domain configuration.

Returns:

the name of the server.

getServerRuntime

ServerRuntimeMBean getServerRuntime()

Contains ServerRuntimeMBean for the current server.

The ServerRuntimeMBean is the root of runtime MBean hierarchy for this 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.

Returns:

the root of the runtime MBean hierarchy for this server.

findRuntime

RuntimeMBean findRuntime(DescriptorBean configurationMBean)

Enables a JMX client to retrieve monitoring statistics for a specified resource on the current server. To use this operation, a JMX client passes a single configuration MBean. The operation returns the corresponding runtime MBean for the resource on the current server.

For example, given the JMSServerMBean for a JMS server named "JS1" on a the current server, this operation returns the JMSServerRuntimeMBean for "JS1."

Parameters:

configurationMBean -

Returns:

The corresponding RuntineMBean

findConfiguration

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

Parameters:

runtimeMBean -

Returns:

the corresponding configuraion MBean.

findService

Service findService(String serviceName,
                    String type)

Enables client to retrieve a specific named service

Parameters:

serviceName -

type -

getServices

Service[] getServices()

Returns all the services that do not have a parent (i.e., all the root services)

Returns:

Service[]