WebLogic Server 6.1 API Reference

weblogic.management
Interface MBeanHome

public interface MBeanHome

extends java.rmi.Remote

There are 2 interfaces to access MBeans:

MBeanServer - Each WebLogic Server contains an MBeanServer. The MBeanServer contains all MBeans for its host WebLogic Server. Using the JMX API, MBean attribute values can be retrieved and other JMX operations can be performed on MBeans in the MBeanServer.

MBeanHome - Each WebLogic Server publishes an MBeanHome, which is a wrapper on MBeanServer, exposing a strongly-typed interface. MBeanServer and MBeanHome provide access to the same set of MBeans in a given server. Each server in a domain contains an MBeanHome (and a corresponding MBeanServer), which hosts configuration and runtime MBeans on that server.

Administration(or Admin) MBeanHome

In addition to the regular MBeanHome, the Administration server has an administration MBeanHome that provides access to all MBeans in the entire domain. It also implements this interface. The only difference is in the set of mbeans it hosts.

The Administration MBeans reside only on the Administration Server, and are only available through the Administration MBeanHome. For the difference between Administration, Configuration and Runtime MBeans, please see weblogic.management.WebLogicMBean

For example, a query for server run-time MBeans on the Administration MBeanHome returns one server MBean for each running server in the domain. The same query on the MBeanHome of a managed server (or the regular MBeanHome of the Administration Server) returns only the server run-time MBean for that server. While MBeanHome is local (and serializable), the underlying MBeanServer is remote.

Author:

Copyright © 2001 BEA Systems, Inc. All Rights Reserved.

See Also:

WebLogicMBean, MBeanServer, Helper

Field Summary

static java.lang.String	ADMIN_JNDI_NAME The JNDI name used to access the admin server MBeanHome
static java.lang.String	JNDI_NAME The JNDI name used to access the local server MBeanHome

Method Summary

WebLogicMBean	createAdminMBean(java.lang.String name, java.lang.String type) Create an Admin MBean with the specified name and type in the current domain.
WebLogicMBean	createAdminMBean(java.lang.String name, java.lang.String type, java.lang.String domain) Create an Admin MBean with the specified name, type, and domain.
WebLogicMBean	createAdminMBean(java.lang.String name, java.lang.String type, java.lang.String domain, ConfigurationMBean parent) Create an Admin MBean with the specified name, type, domain and parent.
DomainMBean	getActiveDomain() Return the Active Domain
ConfigurationMBean	getAdminMBean(java.lang.String name, java.lang.String type) Return the Admin MBean matching a given name and type for the current domain.
ConfigurationMBean	getAdminMBean(java.lang.String name, java.lang.String type, java.lang.String domain) Return the Admin MBean matching a give name, type and domain.
java.util.Set	getAllMBeans() Return all the mbeans.
java.util.Set	getAllMBeans(java.lang.String domain) Return all the mbeans for the specified domain.
ConfigurationMBean	getConfigurationMBean(java.lang.String name, java.lang.String type) Return the Configuration MBean matching a given name and type in the current domain.
java.lang.String	getDomainName() Return the domain name of the server on which this home was originally instantiated.
WebLogicMBean	getMBean(javax.management.ObjectName objectName) Return the MBean with the specified objectName.
WebLogicMBean	getMBean(java.lang.String name, java.lang.Class cls) Return the MBean with the specified name that implements the specified class in the active domain.
WebLogicMBean	getMBean(java.lang.String name, java.lang.String type) Return the MBean with the specified name and type in the default domain.
WebLogicMBean	getMBean(java.lang.String name, java.lang.String type, java.lang.String domain) Return the MBean with the specified name and type in the specified domain.
java.util.Set	getMBeansByClass(java.lang.Class cls) Return all the MBeans that implement a particular class in the active domain.
java.util.Set	getMBeansByClass(java.lang.Class cls, java.lang.String domain) Return all the MBeans that implement a particular class in the specified domain.
java.util.Set	getMBeansByClass(java.lang.Class cls, WebLogicMBean parent) Return all the MBeans that implement a particular class and which have the given MBean as their parent.
java.util.Set	getMBeansByType(java.lang.String type) Return all mbeans of a particular type in all domains.
java.util.Set	getMBeansByType(java.lang.String type, java.lang.String domain) Return all mbeans of a particular type the in the specified domain.
RemoteMBeanServer	getMBeanServer() Return the default MBean Server that backs this home.
weblogic.management.runtime.RuntimeMBean	getRuntimeMBean(java.lang.String name, java.lang.String type) Return the runtime MBean matching a given name and type in the current domain.

Field Detail

JNDI_NAME

public static final java.lang.String JNDI_NAME

The JNDI name used to access the local server MBeanHome

ADMIN_JNDI_NAME

public static final java.lang.String ADMIN_JNDI_NAME

The JNDI name used to access the admin server MBeanHome

Method Detail

getMBeanServer

public RemoteMBeanServer getMBeanServer()

Return the default MBean Server that backs this home.

getMBean

public WebLogicMBean getMBean(javax.management.ObjectName objectName)
                       throws javax.management.InstanceNotFoundException

Return the MBean with the specified objectName. The object name may not contain any wildcard.

getMBean

public WebLogicMBean getMBean(java.lang.String name,
                              java.lang.String type,
                              java.lang.String domain)
                       throws javax.management.InstanceNotFoundException

Return the MBean with the specified name and type in the specified domain.

getMBean

public WebLogicMBean getMBean(java.lang.String name,
                              java.lang.String type)
                       throws javax.management.InstanceNotFoundException

Return the MBean with the specified name and type in the default domain.

getMBean

public WebLogicMBean getMBean(java.lang.String name,
                              java.lang.Class cls)
                       throws javax.management.InstanceNotFoundException

Return the MBean with the specified name that implements the specified class in the active domain.

getMBeansByType

public java.util.Set getMBeansByType(java.lang.String type,
                                     java.lang.String domain)

Return all mbeans of a particular type the in the specified domain.

getMBeansByType

public java.util.Set getMBeansByType(java.lang.String type)

Return all mbeans of a particular type in all domains.

getMBeansByClass

public java.util.Set getMBeansByClass(java.lang.Class cls)

Return all the MBeans that implement a particular class in the active domain.

getMBeansByClass

public java.util.Set getMBeansByClass(java.lang.Class cls,
                                      WebLogicMBean parent)

Return all the MBeans that implement a particular class and which have the given MBean as their parent.

getMBeansByClass

public java.util.Set getMBeansByClass(java.lang.Class cls,
                                      java.lang.String domain)

Return all the MBeans that implement a particular class in the specified domain.

getAllMBeans

public java.util.Set getAllMBeans(java.lang.String domain)

Return all the mbeans for the specified domain.

getAllMBeans

public java.util.Set getAllMBeans()

Return all the mbeans.

getActiveDomain

public DomainMBean getActiveDomain()

Return the Active Domain

getAdminMBean

public ConfigurationMBean getAdminMBean(java.lang.String name,
                                        java.lang.String type,
                                        java.lang.String domain)
                                 throws javax.management.InstanceNotFoundException

Return the Admin MBean matching a give name, type and domain. An Admin MBean is an MBean that is part of the the persistent configuration of the Domain. This call will only work if this MBean Home is the Admin Server's. The type of an Admin MBean is like the name of its MBean interface, without the package name or the MBean suffix. For example: Server, Cluster, Machine, etc.

getAdminMBean

public ConfigurationMBean getAdminMBean(java.lang.String name,
                                        java.lang.String type)
                                 throws javax.management.InstanceNotFoundException

Return the Admin MBean matching a given name and type for the current domain. An Admin MBean is an MBean that is part of the the persistent configuration of the Domain. This call will only work if this MBean Home is the Admin Server's. The type of an Admin MBean is like the name of its MBean interface, without the package name or the MBean suffix. For example: Server, Cluster, Machine, etc.

getConfigurationMBean

public ConfigurationMBean getConfigurationMBean(java.lang.String name,
                                                java.lang.String type)
                                         throws javax.management.InstanceNotFoundException

Return the Configuration MBean matching a given name and type in the current domain. A Configuration MBean is a local version of an Admin MBean. Configuration MBeans usually have an Admin equivalent, and if they do they are automatically updated everytime a dynamic change takes place on the Admin MBean. The type of a Configuration MBean is Config. For example: ServerConfig, WebAppComponentConfig, etc.

See Also:

getAdminMBean(java.lang.String, java.lang.String, java.lang.String)

getRuntimeMBean

public weblogic.management.runtime.RuntimeMBean getRuntimeMBean(java.lang.String name,
                                                                java.lang.String type)
                             throws javax.management.InstanceNotFoundException

Return the runtime MBean matching a given name and type in the current domain. A runtime MBean is a local MBean that gives runtime information about the various Server and Application components. The type of a Runtime MBean is Runtime. For example: ServerRuntime, ClusterRuntime, etc.

See Also:

getAdminMBean(java.lang.String, java.lang.String, java.lang.String)

createAdminMBean

public WebLogicMBean createAdminMBean(java.lang.String name,
                                      java.lang.String type,
                                      java.lang.String domain,
                                      ConfigurationMBean parent)
                               throws MBeanCreationException

Create an Admin MBean with the specified name, type, domain and parent. An Admin MBean is an MBean that is part of the persistent configuration of the Domain. This call will only work if this MBean Home is the Admin Server's. The type of an Admin MBean is like the name of its MBean interface, without the package name or the MBean suffix. For example: Server, Cluster, Machine, etc.

createAdminMBean

public WebLogicMBean createAdminMBean(java.lang.String name,
                                      java.lang.String type,
                                      java.lang.String domain)
                               throws MBeanCreationException

Create an Admin MBean with the specified name, type, and domain. An Admin MBean is an MBean that is part of the the persistent configuration of the Domain. This call will only work if this MBean Home is the Admin Server's. The type of an Admin MBean is like the name of its MBean interface, without the package name or the MBean suffix. For example: Server, Cluster, Machine, etc.

createAdminMBean

public WebLogicMBean createAdminMBean(java.lang.String name,
                                      java.lang.String type)
                               throws MBeanCreationException

Create an Admin MBean with the specified name and type in the current domain. An Admin MBean is an MBean that is part of the the persistent configuration of the Domain. This call will only work if this MBean Home is the Admin Server's. The type of an Admin MBean is like the name of its MBean interface, without the package name or the MBean suffix. For example: Server, Cluster, Machine, etc.

getDomainName

public java.lang.String getDomainName()

Return the domain name of the server on which this home was originally instantiated. It will be null if the home is instantiated on a client.