org.objectweb.jonas.mejb
Interface ManagementEndpoint

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

ManagementBean

public interface ManagementEndpoint
extends java.rmi.Remote

This is the interface for a monitoring webservice used to remotely monitor mbeans in the domain.

Author:

Matt Wringe, Vivek Lakshmanan

Method Summary

java.lang.String[]	getAttribute(java.lang.String domainServerName, java.lang.String objectName, java.lang.String attribute) Returns the attribute value for an mbean on a server in the domain.
java.lang.String[]	getAttributesList(java.lang.String domainServerName, java.lang.String objectName) Returns a list of attributes for a specified mbean on a server in the domain.
java.lang.String	getDefaultDomain() Returns the name of the current domain.
java.lang.String	getDescription(java.lang.String domainServerName, java.lang.String objectName) Returns the description for an mbean on a server in the domain.
java.lang.Integer	getMBeanCount(java.lang.String domainServerName) Returns the number of mbeans for a server in the domain.
java.lang.String[]	getOperations(java.lang.String domainServerName, java.lang.String objectName) Returns the list of operations for an mbean on a server in the domain.
java.lang.String[]	getServers() Returns the server names in the domain.
java.lang.String[]	invoke(java.lang.String domainServerName, java.lang.String objectName, java.lang.String operationName, java.lang.String[] params) Invokes an mbean operation having String params on a server in the domain.
boolean	isRegistered(java.lang.String domainServerName, java.lang.String objectName) Returns True if the mbean is registered with the server in the domain, false otherwise.
java.lang.String[]	queryNames(java.lang.String domainServerName, java.lang.String objectName, java.lang.String query) Returns the search results for mbeans on a server in the domain.

Method Detail

getDefaultDomain

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

Returns the name of the current domain.

Returns:

The name of the domain.

Throws:

java.rmi.RemoteException - If an error occurs communicating with the server.

getServers

java.lang.String[] getServers()
                              throws ManagementEndpointException,
                                     java.rmi.RemoteException

Returns the server names in the domain.

Returns:

The servers in the domain.

Throws:

java.rmi.RemoteException - If an error occurs with the web service.

ManagementEndpointException - If any error occurs with getServers.

getAttribute

java.lang.String[] getAttribute(java.lang.String domainServerName,
                                java.lang.String objectName,
                                java.lang.String attribute)
                                throws ManagementEndpointException,
                                       java.rmi.RemoteException

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

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.

java.rmi.RemoteException - If an error occurs with the web service.

getMBeanCount

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

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

Parameters:

domainServerName - The name of the server in the domain.

Returns:

The number of mbeans for the specified server.

Throws:

java.rmi.RemoteException - If an error occurs communicating with the server.

isRegistered

boolean isRegistered(java.lang.String domainServerName,
                     java.lang.String objectName)
                     throws ManagementEndpointException,
                            java.rmi.RemoteException

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

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.

java.rmi.RemoteException - If an error occurs with the web service.

queryNames

java.lang.String[] queryNames(java.lang.String domainServerName,
                              java.lang.String objectName,
                              java.lang.String query)
                              throws ManagementEndpointException,
                                     java.rmi.RemoteException

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

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.

java.rmi.RemoteException - If an error occurs with the web service.

getAttributesList

java.lang.String[] getAttributesList(java.lang.String domainServerName,
                                     java.lang.String objectName)
                                     throws ManagementEndpointException,
                                            java.rmi.RemoteException

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

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.

java.rmi.RemoteException - If an error occurs with the web service.

getDescription

java.lang.String getDescription(java.lang.String domainServerName,
                                java.lang.String objectName)
                                throws ManagementEndpointException,
                                       java.rmi.RemoteException

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

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.

java.rmi.RemoteException - If an error occurs with the web service.

getOperations

java.lang.String[] getOperations(java.lang.String domainServerName,
                                 java.lang.String objectName)
                                 throws ManagementEndpointException,
                                        java.rmi.RemoteException

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

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.

java.rmi.RemoteException - If an error occurs with the web service.

invoke

java.lang.String[] invoke(java.lang.String domainServerName,
                          java.lang.String objectName,
                          java.lang.String operationName,
                          java.lang.String[] params)
                          throws ManagementEndpointException,
                                 java.rmi.RemoteException

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

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.

java.rmi.RemoteException - If an error occurs with the web service.