View Javadoc

1   /*
2    $Id: GroovyMBean.java,v 1.4 2005/06/10 09:55:30 cstein Exp $
3   
4    Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5   
6    Redistribution and use of this software and associated documentation
7    ("Software"), with or without modification, are permitted provided
8    that the following conditions are met:
9   
10   1. Redistributions of source code must retain copyright
11      statements and notices.  Redistributions must also contain a
12      copy of this document.
13  
14   2. Redistributions in binary form must reproduce the
15      above copyright notice, this list of conditions and the
16      following disclaimer in the documentation and/or other
17      materials provided with the distribution.
18  
19   3. The name "groovy" must not be used to endorse or promote
20      products derived from this Software without prior written
21      permission of The Codehaus.  For written permission,
22      please contact info@codehaus.org.
23  
24   4. Products derived from this Software may not be called "groovy"
25      nor may "groovy" appear in their names without prior written
26      permission of The Codehaus. "groovy" is a registered
27      trademark of The Codehaus.
28  
29   5. Due credit should be given to The Codehaus -
30      http://groovy.codehaus.org/
31  
32   THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
33   ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
34   NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
35   FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
36   THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
43   OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45   */
46  package groovy.util;
47  
48  import groovy.lang.GroovyObjectSupport;
49  import groovy.lang.GroovyRuntimeException;
50  
51  import java.util.HashMap;
52  import java.util.Map;
53  import java.io.IOException;
54  
55  import javax.management.Attribute;
56  import javax.management.JMException;
57  import javax.management.MBeanException;
58  import javax.management.MBeanInfo;
59  import javax.management.MBeanOperationInfo;
60  import javax.management.MBeanParameterInfo;
61  import javax.management.ObjectName;
62  import javax.management.MBeanServerConnection;
63  
64  
65  /***
66   * A GroovyObject facade for an underlying MBean which acts like a normal 
67   * groovy object but which is actually implemented via 
68   * an underlying JMX MBean. 
69   * Properties and normal method invocations
70   * delegate to the MBeanServer to the actual MBean.
71   * 
72   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
73   * @version $Revision: 1.4 $
74   */
75  public class GroovyMBean extends GroovyObjectSupport {
76  
77      private MBeanServerConnection server;
78      private ObjectName name;
79      private MBeanInfo beanInfo;
80      private Map operations = new HashMap();
81  
82      public GroovyMBean(MBeanServerConnection server, ObjectName name) throws JMException, IOException {
83          this.server = server;
84          this.name = name;
85          this.beanInfo = server.getMBeanInfo(name);
86          
87          MBeanOperationInfo[] operationInfos = beanInfo.getOperations();
88          for (int i = 0; i < operationInfos.length; i++ ) {
89              MBeanOperationInfo info = operationInfos[i];
90              operations.put(info.getName(), createSignature(info));
91          }
92      }
93  
94      public MBeanServerConnection server() {
95          return server;
96      }
97      
98      public ObjectName name() {
99          return name;
100     }
101     
102     public MBeanInfo info() {
103         return beanInfo;
104     }
105     
106     public Object getProperty(String property) {
107         try {
108             return server.getAttribute(name, property);
109         }
110         catch (MBeanException e) {
111             throw new GroovyRuntimeException("Could not access property: " + property + ". Reason: " + e, e.getTargetException());
112         }
113         catch (Exception e) {
114             throw new GroovyRuntimeException("Could not access property: " + property + ". Reason: " + e, e);
115         }
116     }
117     
118     public void setProperty(String property, Object value) {
119         try {
120             server.setAttribute(name, new Attribute(property, value));
121         }
122         catch (MBeanException e) {
123             throw new GroovyRuntimeException("Could not set property: " + property + ". Reason: " + e, e.getTargetException());
124         }
125         catch (Exception e) {
126             throw new GroovyRuntimeException("Could not set property: " + property + ". Reason: " + e, e);
127         }
128     }
129     
130     public Object invokeMethod(String method, Object arguments) {
131         String[] signature = (String[]) operations.get(method);
132         if (signature != null) {
133             Object[] argArray = null;
134             if (arguments instanceof Object[]) {
135                 argArray = (Object[]) arguments;
136             }
137             else {
138                 argArray = new Object[] { arguments };
139             }
140             try {
141                 return server.invoke(name, method, argArray, signature);
142             }
143             catch (MBeanException e) {
144                 throw new GroovyRuntimeException("Could not invoke method: " + method + ". Reason: " + e, e.getTargetException());
145             }
146             catch (Exception e) {
147                 throw new GroovyRuntimeException("Could not invoke method: " + method + ". Reason: " + e, e);
148             }
149         }
150         else {
151             return super.invokeMethod(method, arguments);
152         }
153     }
154 
155     protected String[] createSignature(MBeanOperationInfo info) {
156         MBeanParameterInfo[] params = info.getSignature();
157         String[] answer = new String[params.length];
158         for (int i = 0; i < params.length; i++) {
159             answer[i] = params[i].getType();
160         }
161         return answer;
162     }
163 }