org.ow2.jonas.ee.mejb
Class ManagementBean

java.lang.Object
  org.ow2.jonas.ee.mejb.ManagementBean

All Implemented Interfaces:

Serializable, Remote, EnterpriseBean, SessionBean, ManagementEndpoint

public class ManagementBean
extends Object
implements SessionBean, ManagementEndpoint

This is the Management EJB implementation for JOnAS. A MEJB instance is created and deployed at JOnAS start time. It is registered in the ejb/mgmt naming subcontext. The current implementation allows access to managed resources registered in the current (local) MBean server via the standard management methods defined in the javax.management.j2ee.Management interface. It also allows access to managed resources registered in remote MBean servers which belong to the current management domain, via management methods exposed as a WebService endpoint (defined in the ManagementEndpoint interface).

Author:

Adriana Danes, Vivek Lakshmanan, Matt Wringe

See Also:

Serialized Form

Constructor Summary

ManagementBean()

Method Summary

void	ejbActivate()
void	ejbCreate() ejbCreate method Get the MBeanServer reference to allow local access
void	ejbPassivate()
void	ejbRemove()
Object	getAttribute(ObjectName name, String attribute)
Object	getAttribute(String domainServerName, ObjectName name, String attribute)
String[]	getAttribute(String domainServerName, String objectName, String attribute) Returns the attribute value for an mbean on a server in the domain.
AttributeList	getAttributes(ObjectName name, String[] attributes)
AttributeList	getAttributes(String domainServerName, ObjectName name, String[] attributes)
String[]	getAttributesList(String domainServerName, String objectName) Returns a list of attributes for a specified mbean on a server in the domain.
String	getDefaultDomain() Returns the name of the current domain.
String	getDescription(String domainServerName, String objectName) Returns the description for an mbean on a server in the domain.
ListenerRegistration	getListenerRegistry() Returns the ListenerRegistration implementation object which allows the client to register a event notification listener.
Integer	getMBeanCount()
Integer	getMBeanCount(String domainServerName) Returns the number of mbeans for a server in the domain.
MBeanInfo	getMBeanInfo(ObjectName name)
MBeanInfo	getMBeanInfo(String domainServerName, ObjectName name)
String[]	getOperations(String domainServerName, String objectName) Returns the list of operations for an mbean on a server in the domain.
String[]	getServers() Returns the names of the servers in the domain.
Object	invoke(ObjectName name, String operationName, Object[] params, String[] signature)
Object	invoke(String domainServerName, ObjectName name, String operationName, Object[] params, String[] signature)
String[]	invoke(String domainServerName, String objectName, String operationName, String[] params) Invokes an mbean operation having String params on a server in the domain.
boolean	isRegistered(ObjectName name)
boolean	isRegistered(String domainServerName, ObjectName name)
boolean	isRegistered(String domainServerName, String objectName) Returns True if the mbean is registered with the server in the domain, false otherwise.
Set	queryNames(ObjectName name, QueryExp query)
Set	queryNames(String domainServerName, ObjectName name, QueryExp query)
String[]	queryNames(String domainServerName, String objectName, String query) Returns the search results for mbeans on a server in the domain.
void	setAttribute(ObjectName name, Attribute attribute)
void	setAttribute(String domainServerName, ObjectName name, Attribute attribute)
AttributeList	setAttributes(ObjectName name, AttributeList attributes)
AttributeList	setAttributes(String domainServerName, ObjectName name, AttributeList attributes)
void	setSessionContext(SessionContext sessionContext) Sets the associated session context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManagementBean

public ManagementBean()

Method Detail

ejbCreate

public void ejbCreate()
               throws CreateException

ejbCreate method Get the MBeanServer reference to allow local access

Throws:

CreateException

ejbActivate

public void ejbActivate()

Specified by:

ejbActivate in interface SessionBean

ejbPassivate

public void ejbPassivate()

Specified by:

ejbPassivate in interface SessionBean

ejbRemove

public void ejbRemove()

Specified by:

ejbRemove in interface SessionBean

setSessionContext

public void setSessionContext(SessionContext sessionContext)

Sets the associated session context.

Specified by:

setSessionContext in interface SessionBean

Parameters:

sessionContext - - A SessionContext interface for the instance.

getAttribute

public Object getAttribute(ObjectName name,
                           String attribute)
                    throws MBeanException,
                           AttributeNotFoundException,
                           InstanceNotFoundException,
                           ReflectionException,
                           RemoteException

Throws:

MBeanException

AttributeNotFoundException

InstanceNotFoundException

ReflectionException

RemoteException

getAttributes

public AttributeList getAttributes(ObjectName name,
                                   String[] attributes)
                            throws InstanceNotFoundException,
                                   ReflectionException,
                                   RemoteException

Throws:

InstanceNotFoundException

ReflectionException

RemoteException

getDefaultDomain

public String getDefaultDomain()
                        throws RemoteException

Description copied from interface: ManagementEndpoint

Returns the name of the current domain.

Specified by:

getDefaultDomain in interface ManagementEndpoint

Returns:

The name of the domain.

Throws:

RemoteException - If an error occurs communicating with the server.

getMBeanCount

public Integer getMBeanCount()
                      throws RemoteException

Throws:

RemoteException

getMBeanInfo

public MBeanInfo getMBeanInfo(ObjectName name)
                       throws IntrospectionException,
                              InstanceNotFoundException,
                              ReflectionException,
                              RemoteException

Throws:

IntrospectionException

InstanceNotFoundException

ReflectionException

RemoteException

invoke

public Object invoke(ObjectName name,
                     String operationName,
                     Object[] params,
                     String[] signature)
              throws MBeanException,
                     InstanceNotFoundException,
                     ReflectionException,
                     RemoteException

Throws:

MBeanException

InstanceNotFoundException

ReflectionException

RemoteException

isRegistered

public boolean isRegistered(ObjectName name)
                     throws RemoteException

Throws:

RemoteException

queryNames

public Set queryNames(ObjectName name,
                      QueryExp query)
               throws RemoteException

Throws:

RemoteException

setAttribute

public void setAttribute(ObjectName name,
                         Attribute attribute)
                  throws MBeanException,
                         AttributeNotFoundException,
                         InstanceNotFoundException,
                         InvalidAttributeValueException,
                         ReflectionException,
                         RemoteException

Throws:

MBeanException

AttributeNotFoundException

InstanceNotFoundException

InvalidAttributeValueException

ReflectionException

RemoteException

setAttributes

public AttributeList setAttributes(ObjectName name,
                                   AttributeList attributes)
                            throws InstanceNotFoundException,
                                   ReflectionException,
                                   RemoteException

Throws:

InstanceNotFoundException

ReflectionException

RemoteException

getListenerRegistry

public ListenerRegistration getListenerRegistry()
                                         throws RemoteException

Returns the ListenerRegistration implementation object which allows the client to register a event notification listener. This method also creates a MBean

Returns:

An instance of the class implementing the ListenerRegistration interface. null is returned if

Throws:

RemoteException

getAttribute

public Object getAttribute(String domainServerName,
                           ObjectName name,
                           String attribute)
                    throws AttributeNotFoundException,
                           InstanceNotFoundException,
                           MBeanException,
                           ReflectionException,
                           RemoteException

Throws:

AttributeNotFoundException

InstanceNotFoundException

MBeanException

ReflectionException

RemoteException

getAttributes

public AttributeList getAttributes(String domainServerName,
                                   ObjectName name,
                                   String[] attributes)
                            throws InstanceNotFoundException,
                                   ReflectionException,
                                   RemoteException

Throws:

InstanceNotFoundException

ReflectionException

RemoteException

getMBeanCount

public Integer getMBeanCount(String domainServerName)
                      throws RemoteException

Description copied from interface: ManagementEndpoint

Returns the number of mbeans for a server in the domain.

Specified by:

getMBeanCount in interface ManagementEndpoint

Parameters:

domainServerName - The name of the server in the domain.

Returns:

The number of mbeans for the specified server.

Throws:

RemoteException - If an error occurs communicating with the server.

getMBeanInfo

public MBeanInfo getMBeanInfo(String domainServerName,
                              ObjectName name)
                       throws IntrospectionException,
                              InstanceNotFoundException,
                              ReflectionException,
                              RemoteException

Throws:

IntrospectionException

InstanceNotFoundException

ReflectionException

RemoteException

invoke

public Object invoke(String domainServerName,
                     ObjectName name,
                     String operationName,
                     Object[] params,
                     String[] signature)
              throws MBeanException,
                     InstanceNotFoundException,
                     ReflectionException,
                     RemoteException

Throws:

MBeanException

InstanceNotFoundException

ReflectionException

RemoteException

isRegistered

public boolean isRegistered(String domainServerName,
                            ObjectName name)
                     throws RemoteException

Throws:

RemoteException

queryNames

public Set queryNames(String domainServerName,
                      ObjectName name,
                      QueryExp query)
               throws RemoteException

Throws:

RemoteException

setAttribute

public void setAttribute(String domainServerName,
                         ObjectName name,
                         Attribute attribute)
                  throws MBeanException,
                         AttributeNotFoundException,
                         InstanceNotFoundException,
                         InvalidAttributeValueException,
                         ReflectionException,
                         RemoteException

Throws:

MBeanException

AttributeNotFoundException

InstanceNotFoundException

InvalidAttributeValueException

ReflectionException

RemoteException

setAttributes

public AttributeList setAttributes(String domainServerName,
                                   ObjectName name,
                                   AttributeList attributes)
                            throws InstanceNotFoundException,
                                   ReflectionException,
                                   RemoteException

Throws:

InstanceNotFoundException

ReflectionException

RemoteException

getServers

public String[] getServers()
                    throws ManagementEndpointException,
                           RemoteException

Returns the names of the servers in the domain.

Specified by:

getServers in interface ManagementEndpoint

Returns:

The names of the servers in the domain.

Throws:

ManagementEndpointException - If any errors occur.

RemoteException - If a connection error occurs.

getAttribute

public String[] getAttribute(String domainServerName,
                             String objectName,
                             String attribute)
                      throws ManagementEndpointException

Description copied from interface: ManagementEndpoint

Returns the attribute value for an mbean on a server in the domain.

Specified by:

getAttribute in interface ManagementEndpoint

Parameters:

domainServerName - The name of the server in the domain.

objectName - The objectname of the mbean.

attribute - The attribute to be returned.

Returns:

The value of the attribute.

Throws:

ManagementEndpointException - If any error occurs with getAttribute.

See Also:

ManagementEndpoint.getAttribute(String, String, String)

isRegistered

public boolean isRegistered(String domainServerName,
                            String objectName)
                     throws ManagementEndpointException

Description copied from interface: ManagementEndpoint

Returns True if the mbean is registered with the server in the domain, false otherwise.

Specified by:

isRegistered in interface ManagementEndpoint

Parameters:

domainServerName - The name of the server in the domain.

objectName - The objectname of the mbean.

Returns:

True if the mbean is registered, false if not.

Throws:

ManagementEndpointException - If any error occurs with isRegistered.

See Also:

ManagementEndpoint.isRegistered(String, String)

queryNames

public String[] queryNames(String domainServerName,
                           String objectName,
                           String query)
                    throws ManagementEndpointException

Description copied from interface: ManagementEndpoint

Returns the search results for mbeans on a server in the domain. The query parameter currently does nothing.

Specified by:

queryNames in interface ManagementEndpoint

Parameters:

domainServerName - The name of the server in the domain.

objectName - The objectname of the mbean.

query - Currently does nothing.

Returns:

The ObjectNames for the queried mbeans.

Throws:

ManagementEndpointException - If any error occurs with queryNames.

See Also:

ManagementEndpoint.queryNames(String, String, String)

getAttributesList

public String[] getAttributesList(String domainServerName,
                                  String objectName)
                           throws ManagementEndpointException

Description copied from interface: ManagementEndpoint

Returns a list of attributes for a specified mbean on a server in the domain.

Specified by:

getAttributesList in interface ManagementEndpoint

Parameters:

domainServerName - The name of the server in the domain.

objectName - The objectname of the mbean.

Returns:

The list of attributes for the mbean.

Throws:

ManagementEndpointException - If any error occurs with getAttributesList.

See Also:

ManagementEndpoint.getAttributesList(String, String)

getDescription

public String getDescription(String domainServerName,
                             String objectName)
                      throws ManagementEndpointException

Description copied from interface: ManagementEndpoint

Returns the description for an mbean on a server in the domain.

Specified by:

getDescription in interface ManagementEndpoint

Parameters:

domainServerName - The name of the server in the domain.

objectName - The objectname of the mbean.

Returns:

The description for the mbean.

Throws:

ManagementEndpointException - If any error occurs with getDescription.

See Also:

ManagementEndpoint.getDescription(String, String)

getOperations

public String[] getOperations(String domainServerName,
                              String objectName)
                       throws ManagementEndpointException

Description copied from interface: ManagementEndpoint

Returns the list of operations for an mbean on a server in the domain.

Specified by:

getOperations in interface ManagementEndpoint

Parameters:

domainServerName - The name of the server in the domain.

objectName - The objectname of the mbean.

Returns:

The operations for the mbean.

Throws:

ManagementEndpointException - If any error occurs with getOperations.

See Also:

ManagementEndpoint.getOperations(String, String)

invoke

public String[] invoke(String domainServerName,
                       String objectName,
                       String operationName,
                       String[] params)
                throws ManagementEndpointException,
                       RemoteException

Description copied from interface: ManagementEndpoint

Invokes an mbean operation having String params on a server in the domain.

Specified by:

invoke in interface ManagementEndpoint

Parameters:

domainServerName - The name of the server in the domain.

objectName - The objectname of the mbean.

operationName - operation name

params - String parameters

Returns:

The operation result

Throws:

ManagementEndpointException - If any error occurs with getOperations.

RemoteException - If an error occurs with the web service.

See Also:

ManagementEndpoint#invoke(String, String, String[])