MBeanService


1   /**
2    * Copyright 2004-2005 jManage.org
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.jmanage.core.services;
17  
18  import org.jmanage.core.management.*;
19  import org.jmanage.core.data.OperationResultData;
20  import org.jmanage.core.data.AttributeListData;
21  
22  import java.util.List  ;
23  import java.util.Map  ;
24  
25  /**
26   *
27   * date:  Feb 21, 2005
28   * @author  Rakesh Kalra
29   * @author  Shashank Bellary
30   */
31  public interface MBeanService {
32  
33      public List   queryMBeans(ServiceContext context,
34                            String   filter)
35              throws ServiceException;
36  
37      /**
38       * if datatypes is null then Map will contain all the MBeans
39       * if datatype is not null then only Mbeans thats have attributes of matching
40       * data types will be returned
41       * @param context
42       * @param filter
43       * @param dataTypes
44       * @return
45       */
46      public Map   queryMBeansOutputMap(ServiceContext context, String   filter,
47                                      String  [] dataTypes, String   applyAttribFilter);
48  
49      /**
50       * Gets the MBean information.
51       *
52       * @param context   instance of ServiceContext
53       * @return  instance of ObjectInfo
54       * @throws ServiceException
55       */
56      public ObjectInfo getMBeanInfo(ServiceContext context)
57              throws ServiceException;
58  
59      /**
60       * @return list of all attribute values
61       */
62      public AttributeListData[] getAttributes(ServiceContext context)
63              throws ServiceException;
64  
65      public AttributeListData[] getAttributes(ServiceContext context,
66                                               String  [] attributes,
67                                               boolean handleCluster)
68              throws ServiceException;
69  
70      public List   filterAttributes(ServiceContext context,
71                                   ObjectName objectName,
72                                   ObjectAttributeInfo[] objAttrInfo,
73                                   String  [] dataTypes)
74              throws ServiceException;
75  
76      public ObjectAttribute getObjectAttribute(ServiceContext context,
77                                                String   attribute)
78              throws ServiceException;
79  
80      /**
81       * Invokes MBean operation
82       * @return
83       * @throws ServiceException
84       */
85      public OperationResultData[] invoke(ServiceContext context,
86                                          String   operationName,
87                                          String  [] params)
88              throws ServiceException;
89  
90      /**
91       * Invokes MBean operation
92       * @return
93       * @throws ServiceException
94       */
95      public OperationResultData[] invoke(ServiceContext context,
96                                          String   operationName,
97                                          String  [] params,
98                                          String  [] signature)
99          throws ServiceException;
100 
101 
102     public AttributeListData[] setAttributes(ServiceContext context,
103                                              String  [][] attributes)
104             throws ServiceException;
105 
106     /**
107      * Updates MBean attributes at a stand alone application level or at a
108      * cluster level.
109      *
110      * @param context
111      * @param attributes
112      * @throws ServiceException
113      */
114     public AttributeListData[] setAttributes(ServiceContext context,
115                                              Map   attributes)
116             throws ServiceException;
117 
118     public Map   queryMBeansWithNotifications(ServiceContext context)
119             throws ServiceException;
120     /**
121      * returns data type of an attribute
122      * @param context
123      * @param attributeName
124      * @param objectName
125      * @return
126      * @throws ServiceException
127      */
128     public String   getAttributeDataType(ServiceContext context,
129                                        String   attributeName,
130                                        String   objectName)
131             throws ServiceException;
132 
133     public ObjectOperationInfo getOperationInfo(ServiceContext context,
134                                        String   operationName,
135                                        String  [] signature)
136             throws ServiceException;
137 }
138
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags