ManagementEndpoint


1   /**
2    * JOnAS: Java(TM) Open Application Server
3    * Copyright (C) 2005 Bull S.A.
4    * Contact: jonas-team@objectweb.org
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public
8    * License as published by the Free Software Foundation; either
9    * version 2.1 of the License, or any later version.
10   *
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   *
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
19   * USA
20   *
21   * --------------------------------------------------------------------------
22   * $Id: ManagementEndpoint.java,v 1.2 2005/05/09 21:14:38 mwringe Exp $
23   * --------------------------------------------------------------------------
24   */
25  package org.objectweb.jonas.mejb;
26  
27  import java.rmi.Remote  ;
28  import java.rmi.RemoteException  ;
29  
30  /**
31   * This is the interface for a monitoring webservice used to remotely
32   * monitor mbeans in the domain.
33   * @author Matt Wringe
34   * @author Vivek Lakshmanan
35   */
36  public interface ManagementEndpoint extends Remote   {
37  
38      /**
39       * Returns the name of the current domain.
40       * @return The name of the domain.
41       * @throws RemoteException    If an error occurs communicating with the server.
42       */
43      String   getDefaultDomain() throws RemoteException  ;
44  
45      /**
46       * Returns the server names in the domain.
47       * @return The servers in the domain.
48       * @throws RemoteException                If an error occurs with the web service.
49       * @throws ManagementEndpointException    If any error occurs with getServers.
50       */
51      String  [] getServers() throws ManagementEndpointException, RemoteException  ;
52  
53      /**
54       * Returns the attribute value for an mbean on a server in the domain.
55       * @param domainServerName The name of the server in the domain.
56       * @param objectName The objectname of the mbean.
57       * @param attribute The attribute to be returned.
58       * @return The value of the attribute.
59       * @throws ManagementEndpointException    If any error occurs with getAttribute.
60       * @throws RemoteException                If an error occurs with the web service.
61       */
62      String  [] getAttribute(String   domainServerName, String   objectName, String   attribute)
63          throws ManagementEndpointException, RemoteException  ;
64  
65      /**
66       * Returns the number of mbeans for a server in the domain.
67       * @param domainServerName The name of the server in the domain.
68       * @return The number of mbeans for the specified server.
69       * @throws RemoteException    If an error occurs communicating with the server.
70       */
71      Integer   getMBeanCount(String   domainServerName) throws RemoteException  ;
72  
73      /**
74       * Returns True if the mbean is registered with the server in the domain,
75       * false otherwise.
76       * @param domainServerName The name of the server in the domain.
77       * @param objectName The objectname of the mbean.
78       * @return True if the mbean is registered, false if not.
79       * @throws ManagementEndpointException    If any error occurs with isRegistered.
80       * @throws RemoteException                If an error occurs with the web service.
81       */
82      boolean isRegistered(String   domainServerName, String   objectName)
83          throws ManagementEndpointException, RemoteException  ;
84  
85      /**
86       * Returns the search results for mbeans on a server in the domain. The query
87       * parameter currently does nothing.
88       * @param domainServerName The name of the server in the domain.
89       * @param objectName The objectname of the mbean.
90       * @param query Currently does nothing.
91       * @return The ObjectNames for the queried mbeans.
92       * @throws ManagementEndpointException    If any error occurs with queryNames.
93       * @throws RemoteException                If an error occurs with the web service.
94       */
95      String  [] queryNames(String   domainServerName, String   objectName, String   query)
96          throws ManagementEndpointException, RemoteException  ;
97  
98      /**
99       * Returns a list of attributes for a specified mbean on a server in the
100      * domain.
101      * @param domainServerName The name of the server in the domain.
102      * @param objectName The objectname of the mbean.
103      * @return The list of attributes for the mbean.
104      * @throws ManagementEndpointException    If any error occurs with getAttributesList.
105      * @throws RemoteException                If an error occurs with the web service.
106      */
107     String  [] getAttributesList(String   domainServerName, String   objectName)
108         throws ManagementEndpointException, RemoteException  ;
109 
110     /**
111      * Returns the description for an mbean on a server in the domain.
112      * @param domainServerName The name of the server in the domain.
113      * @param objectName The objectname of the mbean.
114      * @return The description for the mbean.
115      * @throws ManagementEndpointException    If any error occurs with getDescription.
116      * @throws RemoteException                If an error occurs with the web service.
117      */
118     String   getDescription(String   domainServerName, String   objectName)
119         throws ManagementEndpointException, RemoteException  ;
120 
121     /**
122      * Returns the list of operations for an mbean on a server in the domain.
123      * @param domainServerName The name of the server in the domain.
124      * @param objectName The objectname of the mbean.
125      * @return The operations for the mbean.
126      * @throws ManagementEndpointException    If any error occurs with getOperations.
127      * @throws RemoteException                If an error occurs with the web service.
128      */
129     String  [] getOperations(String   domainServerName, String   objectName)
130         throws ManagementEndpointException, RemoteException  ;
131 
132 }
133
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags