View Javadoc

    1   /*
    2    $Id: GroovyMBean.java,v 1.3 2004/07/31 03:39:28 jstrachan 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.MBeanServer;
    62  import javax.management.ObjectName;
    63  import javax.management.MBeanServerConnection;
    64
    65
    66  /***
    67   * A GroovyObject facade for an underlying MBean which acts like a normal
    68   * groovy object but which is actually implemented via
    69   * an underlying JMX MBean.
    70   * Properties and normal method invocations
    71   * delegate to the MBeanServer to the actual MBean.
    72   *
    73   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
    74   * @version $Revision: 1.3 $
    75   */
    76  public class GroovyMBean extends GroovyObjectSupport {
    77
    78      private MBeanServerConnection server;
    79      private ObjectName name;
    80      private MBeanInfo beanInfo;
    81      private Map operations = new HashMap();
    82
    83      public GroovyMBean(MBeanServerConnection server, ObjectName name) throws JMException, IOException {
    84          this.server = server;
    85          this.name = name;
    86          this.beanInfo = server.getMBeanInfo(name);
    87
    88          MBeanOperationInfo[] operationInfos = beanInfo.getOperations();
    89          for (int i = 0; i < operationInfos.length; i++ ) {
    90              MBeanOperationInfo info = operationInfos[i];
    91              operations.put(info.getName(), createSignature(info));
    92          }
    93      }
    94
    95      public MBeanServerConnection server() {
    96          return server;
    97      }
    98
    99      public ObjectName name() {
    100         return name;
    101     }
    102
    103     public MBeanInfo info() {
    104         return beanInfo;
    105     }
    106
    107     public Object getProperty(String property) {
    108         try {
    109             return server.getAttribute(name, property);
    110         }
    111         catch (MBeanException e) {
    112             throw new GroovyRuntimeException("Could not access property: " + property + ". Reason: " + e, e.getTargetException());
    113         }
    114         catch (Exception e) {
    115             throw new GroovyRuntimeException("Could not access property: " + property + ". Reason: " + e, e);
    116         }
    117     }
    118
    119     public void setProperty(String property, Object value) {
    120         try {
    121             server.setAttribute(name, new Attribute(property, value));
    122         }
    123         catch (MBeanException e) {
    124             throw new GroovyRuntimeException("Could not set property: " + property + ". Reason: " + e, e.getTargetException());
    125         }
    126         catch (Exception e) {
    127             throw new GroovyRuntimeException("Could not set property: " + property + ". Reason: " + e, e);
    128         }
    129     }
    130
    131     public Object invokeMethod(String method, Object arguments) {
    132         String[] signature = (String[]) operations.get(method);
    133         if (signature != null) {
    134             Object[] argArray = null;
    135             if (arguments instanceof Object[]) {
    136                 argArray = (Object[]) arguments;
    137             }
    138             else {
    139                 argArray = new Object[] { arguments };
    140             }
    141             try {
    142                 return server.invoke(name, method, argArray, signature);
    143             }
    144             catch (MBeanException e) {
    145                 throw new GroovyRuntimeException("Could not invoke method: " + method + ". Reason: " + e, e.getTargetException());
    146             }
    147             catch (Exception e) {
    148                 throw new GroovyRuntimeException("Could not invoke method: " + method + ". Reason: " + e, e);
    149             }
    150         }
    151         else {
    152             return super.invokeMethod(method, arguments);
    153         }
    154     }
    155
    156     protected String[] createSignature(MBeanOperationInfo info) {
    157         MBeanParameterInfo[] params = info.getSignature();
    158         String[] answer = new String[params.length];
    159         for (int i = 0; i < params.length; i++) {
    160             answer[i] = params[i].getType();
    161         }
    162         return answer;
    163     }
    164 }