MBeanInfoConfiguration


1   /*
2    * The contents of this file are subject to the Sapient Public License
3    * Version 1.0 (the "License"); you may not use this file except in compliance
4    * with the License. You may obtain a copy of the License at
5    * http://carbon.sf.net/License.html.
6    *
7    * Software distributed under the License is distributed on an "AS IS" basis,
8    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9    * the specific language governing rights and limitations under the License.
10   *
11   * The Original Code is The Carbon Component Framework.
12   *
13   * The Initial Developer of the Original Code is Sapient Corporation
14   *
15   * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16   */
17  
18  package org.sape.carbon.services.management.interceptor;
19  
20  import org.sape.carbon.core.config.Configuration;
21  
22  /**
23   * <P>Represents an MBean Configuration.</P>
24   *
25   * Copyright 2002 Sapient
26   * @since carbon 1.0
27   * @author Greg Hinkle, January 2002
28   * @version $Revision: 1.4 $($Author: dvoet $ / $Date: 2003/05/05 21:21:33 $)
29   * <br>Copyright 2002 Sapient
30   */
31  public interface MBeanInfoConfiguration extends Configuration {
32      /**
33       * Gets the class type this configuration describes.
34       *
35       * @return class type described by this configuration.
36       */
37      Class   getType();
38  
39      /**
40       * Describes the usage of the component.
41       *
42       * @return description of the component
43       */
44      String   getDescription();
45  
46      /**
47       * Sets the description of the usage of the component.
48       *
49       * @param value the description of the usage of the component.
50       */
51      void setDescription(String   value);
52  
53      /**
54       * Gets an array of all described attributes for the component.
55       *
56       * @return array of all described attributes for the component
57       */
58      MBeanAttributeInfoConfiguration[] getAttributes();
59  
60      /**
61       * Gets an array of all described constructors for the component.
62       *
63       * @return array of all described constructors for the component
64       */
65      MBeanConstructorInfoConfiguration[] getConstructors();
66  
67      /**
68       * Gets an array of all described operations for the component.
69       *
70       * @return array of all described operations for the component
71       */
72      MBeanOperationInfoConfiguration[] getOperations();
73  
74      /**
75       * Gets an array of all described notifications for the component.
76       *
77       * @return array of all described notifications for the component
78       */
79      MBeanNotificationInfoConfiguration[] getNotifications();
80  
81  
82      /**
83       * Basic interface describing an MBean Feature.
84       */
85      static interface MBeanFeatureInfoConfiguration extends Configuration {
86          /**
87           * Returns the name of the feature.
88           *
89           * @return the name of the feature
90           */
91          String   getName();
92  
93          /**
94           * Sets the name of the feature.
95           *
96           * @param value the name of the feature
97           */
98          void setName(String   value);
99  
100         /**
101          * Gets the description of the feature.
102          *
103          * @return the description of the feature
104          */
105         String   getDescription();
106 
107         /**
108          * Sets the description of the feature.
109          *
110          * @param value the description of the feature
111          */
112         void setDescription(String   value);
113     }
114 
115     /**
116      * Describes an MBean attribute.
117      */
118     static interface MBeanAttributeInfoConfiguration
119         extends MBeanFeatureInfoConfiguration {
120 
121         /**
122          * Gets the attribute type.
123          *
124          * @return the attribute type
125          */
126         String   getType();
127 
128         /**
129          * Sets the attribute type.
130          *
131          * @param value the attribute type
132          */
133         void setType(String   value);
134 
135         /**
136          * Indicates if the attribute getter uses the Is prefix
137          *
138          * @return if the attribute getter uses the Is prefix
139          */
140         boolean isIs();
141 
142         /**
143          * Sets if the attribute getter uses the Is prefix
144          *
145          * @param value if the attribute getter uses the Is prefix
146          */
147         void setIs(boolean value);
148 
149 
150         /**
151          * Indicates if the attribute is writable
152          *
153          * @return if the attribute is writable
154          */
155         boolean isWritable();
156 
157         /**
158          * Sets if the attribute is writable
159          *
160          * @param value if the attribute is writable
161          */
162         void setWritable(boolean value);
163 
164         /**
165          * Indicates if the attribute is readable
166          *
167          * @return if the attribute is readable
168          */
169         boolean isReadable();
170 
171         /**
172          * Sets if the attribute is readable
173          *
174          * @param value if the attribute is readable
175          */
176         void setReadable(boolean value);
177 
178     }
179 
180     /**
181      * Describes an MBean constructor method.
182      */
183     static interface MBeanConstructorInfoConfiguration
184         extends MBeanFeatureInfoConfiguration {
185 
186         /**
187          * Gets the array of parameters the constructor takes.
188          *
189          * @return the array of parameters the constructor takes.
190          */
191         MBeanParameterInfoConfiguration[] getSignature();
192 
193         /**
194          * Sets the array of parameters the constructor takes.
195          *
196          * @param value the array of parameters the constructor takes.
197          */
198         void setSignature(MBeanParameterInfoConfiguration[] value);
199 
200     }
201 
202     /**
203      * Describes an MBean operation.
204      */
205     static interface MBeanOperationInfoConfiguration
206         extends MBeanFeatureInfoConfiguration {
207 
208         /** MBeanOperationImpactEnum.UKNOWN */
209         MBeanOperationImpactEnum Impact = MBeanOperationImpactEnum.UKNOWN;
210 
211         /**
212          * Gets the impact of the operation.
213          *
214          * @return impact of the operation
215          * @since carbon 1.1
216          */
217         MBeanOperationImpactEnum getImpact();
218 
219         /**
220          * Sets the impact of the operation.
221          *
222          * @param impact impact of the operation
223          * @since carbon 1.1
224          */
225         void setImpact(MBeanOperationImpactEnum impact);
226 
227         /**
228          * Gets the return type of the operation.
229          *
230          * @return return type of the operation
231          */
232         String   getReturnType();
233 
234         /**
235          * Sets the return type of the operation.
236          *
237          * @param value return type of the operation
238          */
239         void setReturnType(String   value);
240 
241         /**
242          * Gets the array of parameters for the operation.
243          *
244          * @return the array of parameters for the operation.
245          */
246         MBeanParameterInfoConfiguration[] getSignature();
247 
248         /**
249          * Sets the array of parameters for the operation.
250          *
251          * @param value the array of parameters for the operation.
252          */
253         void setSignature(MBeanParameterInfoConfiguration[] value);
254 
255     }
256 
257     /**
258      * Describes an MBean notification settings.
259      */
260     static interface MBeanNotificationInfoConfiguration
261         extends MBeanFeatureInfoConfiguration {
262 
263         /**
264          * Gets the array of notification types supported by the MBean.
265          *
266          * @return array of notification types supported by the MBean
267          */
268         String  [] getNotifTypes();
269 
270         /**
271          * Sets the array of notification types supported by the MBean.
272          *
273          * @param value array of notification types supported by the MBean
274          */
275         void setNotifTypes(String  [] value);
276 
277     }
278 
279     /**
280      * Describes an parameter for an MBean operation.
281      */
282     static interface MBeanParameterInfoConfiguration
283         extends MBeanFeatureInfoConfiguration {
284 
285         /**
286          * Gets the type of class for the parameter.
287          *
288          * @return the type of class for the parameter.
289          */
290         String   getType();
291 
292         /**
293          * Sets the type of class for the parameter.
294          *
295          * @param value the type of class for the parameter.
296          */
297         void setType(String   value);
298 
299     }
300 
301 
302 }
303
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags