org.glassfish.admin.mejb
Interface IIOPMBeanServer

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

IIOPMBeanServerImpl

public interface IIOPMBeanServer
extends java.rmi.Remote

Method Summary

java.lang.Object	getAttribute(javax.management.ObjectName name, java.lang.String attribute) Gets the value of a specific attribute of a named managed object.
javax.management.AttributeList	getAttributes(javax.management.ObjectName name, java.lang.String[] attributes) Enables the values of several attributes of a named managed object.
java.lang.String	getDefaultDomain() Returns the domain name of this MEJB.
java.lang.Integer	getMBeanCount() Returns the number of managed objects registered in the MEJB.
javax.management.MBeanInfo	getMBeanInfo(javax.management.ObjectName name) This method discovers the attributes and operations that an managed object exposes for management.
java.lang.Object	invoke(javax.management.ObjectName name, java.lang.String operationName, java.lang.Object[] params, java.lang.String[] signature) Invokes an operation on an managed object.
boolean	isRegistered(javax.management.ObjectName name) Checks whether an managed object, identified by its object name, is already registered with the MEJB.
java.util.Set	queryNames(javax.management.ObjectName name, javax.management.QueryExp query)
void	setAttribute(javax.management.ObjectName name, javax.management.Attribute attribute) Sets the value of a specific attribute of a named managed object.
javax.management.AttributeList	setAttributes(javax.management.ObjectName name, javax.management.AttributeList attributes) Sets the values of several attributes of a named managed object.
void	unregisterMBean(javax.management.ObjectName name) De-registers an MBean from the MBean server.

Method Detail

queryNames

java.util.Set queryNames(javax.management.ObjectName name,
                         javax.management.QueryExp query)
                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

isRegistered

boolean isRegistered(javax.management.ObjectName name)
                     throws java.rmi.RemoteException

Checks whether an managed object, identified by its object name, is already registered with the MEJB.

Parameters:

name - The object name of the managed object to be checked.

Returns:

True if the managed object is already registered in the MEJB, false otherwise.

Throws:

javax.management.RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null.

java.rmi.RemoteException

getMBeanCount

java.lang.Integer getMBeanCount()
                                throws java.rmi.RemoteException

Returns the number of managed objects registered in the MEJB.

Throws:

java.rmi.RemoteException

getMBeanInfo

javax.management.MBeanInfo getMBeanInfo(javax.management.ObjectName name)
                                        throws javax.management.InstanceNotFoundException,
                                               javax.management.IntrospectionException,
                                               javax.management.ReflectionException,
                                               java.rmi.RemoteException

This method discovers the attributes and operations that an managed object exposes for management.

Parameters:

name - The name of the managed object to analyze

Returns:

An instance of MBeanInfo allowing the retrieval of all attributes and operations of this managed object.

Throws:

javax.management.IntrospectionException - An exception occurs during introspection.

javax.management.InstanceNotFoundException - The managed object specified is not found.

javax.management.ReflectionException

java.rmi.RemoteException

getAttribute

java.lang.Object getAttribute(javax.management.ObjectName name,
                              java.lang.String attribute)
                              throws javax.management.AttributeNotFoundException,
                                     javax.management.MBeanException,
                                     javax.management.InstanceNotFoundException,
                                     javax.management.ReflectionException,
                                     java.rmi.RemoteException

Gets the value of a specific attribute of a named managed object. The managed object is identified by its object name.

Parameters:

name - The object name of the managed object from which the attribute is to be retrieved.

attribute - A String specifying the name of the attribute to be retrieved.

Returns:

The value of the retrieved attribute.

Throws:

javax.management.AttributeNotFoundException - The attribute specified is not accessible in the managed object.

javax.management.MBeanException - Wraps an exception thrown by the managed object's getter.

javax.management.InstanceNotFoundException - The managed object specified is not registered in the MEJB.

javax.management.ReflectionException - Wraps a java.lang.Exception thrown when trying to invoke the setter.

javax.management.RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or the attribute in parameter is null.

java.rmi.RemoteException

getAttributes

javax.management.AttributeList getAttributes(javax.management.ObjectName name,
                                             java.lang.String[] attributes)
                                             throws javax.management.InstanceNotFoundException,
                                                    javax.management.ReflectionException,
                                                    java.rmi.RemoteException

Enables the values of several attributes of a named managed object. The managed object is identified by its object name.

Parameters:

name - The object name of the managed object from which the attributes are retrieved.

attributes - A list of the attributes to be retrieved.

Returns:

The list of the retrieved attributes.

Throws:

javax.management.InstanceNotFoundException - The managed object specified is not registered in the MEJB.

javax.management.ReflectionException - An exception occurred when trying to invoke the getAttributes method of a Dynamic managed object.

javax.management.RuntimeOperationsException - Wrap a java.lang.IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.

java.rmi.RemoteException

setAttribute

void setAttribute(javax.management.ObjectName name,
                  javax.management.Attribute attribute)
                  throws javax.management.InstanceNotFoundException,
                         javax.management.AttributeNotFoundException,
                         javax.management.InvalidAttributeValueException,
                         javax.management.MBeanException,
                         javax.management.ReflectionException,
                         java.rmi.RemoteException

Sets the value of a specific attribute of a named managed object. The managed object is identified by its object name.

Parameters:

name - The name of the managed object within which the attribute is to be set.

attribute - The identification of the attribute to be set and the value it is to be set to.

Throws:

javax.management.InstanceNotFoundException - The managed object specified is not registered in the MEJB.

javax.management.AttributeNotFoundException - The attribute specified is not accessible in the managed object.

javax.management.InvalidAttributeValueException - The value specified for the attribute is not valid.

javax.management.MBeanException - Wraps an exception thrown by the managed object's setter.

javax.management.ReflectionException - Wraps a java.lang.Exception thrown when trying to invoke the setter.

javax.management.RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or the attribute in parameter is null.

java.rmi.RemoteException

setAttributes

javax.management.AttributeList setAttributes(javax.management.ObjectName name,
                                             javax.management.AttributeList attributes)
                                             throws javax.management.InstanceNotFoundException,
                                                    javax.management.ReflectionException,
                                                    java.rmi.RemoteException

Sets the values of several attributes of a named managed object. The managed object is identified by its object name.

Parameters:

name - The object name of the managed object within which the attributes are to be set.

attributes - A list of attributes: The identification of the attributes to be set and the values they are to be set to.

Returns:

The list of attributes that were set, with their new values.

Throws:

javax.management.InstanceNotFoundException - The managed object specified is not registered in the MEJB.

javax.management.ReflectionException - An exception occurred when trying to invoke the getAttributes method of a Dynamic managed object.

javax.management.RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.

java.rmi.RemoteException

invoke

java.lang.Object invoke(javax.management.ObjectName name,
                        java.lang.String operationName,
                        java.lang.Object[] params,
                        java.lang.String[] signature)
                        throws javax.management.InstanceNotFoundException,
                               javax.management.MBeanException,
                               javax.management.ReflectionException,
                               java.rmi.RemoteException

Invokes an operation on an managed object.

Parameters:

name - The object name of the managed object on which the method is to be invoked.

operationName - The name of the operation to be invoked.

params - An array containing the parameters to be set when the operation is invoked

signature - An array containing the signature of the operation. The class objects will be loaded using the same class loader as the one used for loading the managed object on which the operation was invoked.

Returns:

The object returned by the operation, which represents the result ofinvoking the operation on the managed object specified.

Throws:

javax.management.InstanceNotFoundException - The managed object specified is not registered in the MEJB.

javax.management.MBeanException - Wraps an exception thrown by the managed object's invoked method.

javax.management.ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the method.

java.rmi.RemoteException

getDefaultDomain

java.lang.String getDefaultDomain()
                                  throws java.rmi.RemoteException

Returns the domain name of this MEJB.

Throws:

java.rmi.RemoteException

unregisterMBean

void unregisterMBean(javax.management.ObjectName name)
                     throws javax.management.InstanceNotFoundException,
                            javax.management.MBeanRegistrationException,
                            java.rmi.RemoteException

De-registers an MBean from the MBean server. The MBean is identified by its object name. Once the method has been invoked, the MBean may no longer be accessed by its object name.

Parameters:

name - The object name of the MBean to be de-registered.

Throws:

javax.management.InstanceNotFoundException - The MBean specified is not registered in the MBean server.

javax.management.MBeanRegistrationException - The preDeregister ((MBeanRegistration interface) method of the MBean has thrown an exception.

javax.management.RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or the MBean you are when trying to de-register is the MBeanServerDelegate MBean.

java.rmi.RemoteException