Extend the JMXQuery library to let the user invoke JMX methods.

This would be very useful to create custom reports, where we can trigger
actions as well.

Author: E506806

java/README.md

@@ -10,7 +10,7 @@ Usage
 ------
 
 ```
-jmxquery [-url] [-username,u] [-password,p] [-query,q] [-incjvm] [-json] [-help]
+jmxquery [-url] [-username,u] [-password,p] [-query,q] [-call,c] [-incjvm] [-json] [-help]
 ```
 
 options are:
@@ -33,6 +33,12 @@ options are:
         {attributeKey} is optional and only used for Composite metric types. 
         Use semi-colon to separate metrics.
 
+-call, c
+		Call a method using a base64 encoded JSON as parameter
+		JSON format: 
+		{"objectName":"{mBeanName}","name":"{methodName}","params":[{"value":"{value}","type":"{type}"},...]}
+		Supported types: char, short, int, long, boolean, double, float, String, Float, Double, Short, Int, Long
+		
 -incjvm
         Will add all standard JVM metrics to the -metrics query if used under java.lang domain
         Useful utility function to add JVM metrics quickly and also for testing connections if
@@ -79,6 +85,12 @@ You can get multiple values by joining the mbeans together with semi colons.
 java -jar JMXQuery.jar -url service:jmx:rmi:///jndi/rmi://localhost:1616/jmxrmi -q "java.lang:type=ClassLoading/LoadedClassCount;java.lang:type=ClassLoading/UnloadedClassCount"
 ```
 
+```
+Invoke the add method: {"objectName":"com.outlyer.jmx.jmxquery.app.tests:type=Test","name":"add","params":[{"value":"Test ","type":"String"},{"value":"test","type":"String"}]}
+
+java -jar JMXQuery.jar -url service:jmx:rmi:///jndi/rmi://localhost:1616/jmxrmi -c eyJvYmplY3ROYW1lIjoiY29tLm91dGx5ZXIuam14LmpteHF1ZXJ5LmFwcC50ZXN0czp0eXBlPVRlc3QiLCJuYW1lIjoiYWRkIiwicGFyYW1zIjpbeyJ2YWx1ZSI6IlRlc3QgIiwidHlwZSI6IlN0cmluZyJ9LHsidmFsdWUiOiJ0ZXN0IiwidHlwZSI6IlN0cmluZyJ9XX0=
+
+```
 Building the Jar
 ----------------
 

java/pom.xml

@@ -31,6 +31,11 @@
             <scope>system</scope>
             <systemPath>${toolsjar}</systemPath>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.9.8</version>
+        </dependency>       
     </dependencies>
 
     <build>

java/src/main/java/com/outlyer/jmx/jmxquery/JMXConnector.java

@@ -3,14 +3,14 @@
 import com.outlyer.jmx.jmxquery.tools.JMXTools;
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.Map;
 import java.util.Set;
 import javax.management.InstanceNotFoundException;
 import javax.management.IntrospectionException;
 import javax.management.MBeanAttributeInfo;
+import javax.management.MBeanException;
 import javax.management.MBeanInfo;
 import javax.management.MBeanServerConnection;
 import javax.management.MalformedObjectNameException;
@@ -108,6 +108,48 @@ public void disconnect() throws IOException {
         }
     }
 
+    /**
+     * invokes a method on the server using JMX
+     * 
+     * @param name
+     *            - The object name of the MBean on which the method is to be
+     *            invoked.
+     * @param method
+     *            - The name of the method to be invoked.
+     * @param args
+     *            - An array containing the arguments of the method to be set
+     *            when the operation is invoked
+     * @param signatures
+     *            - An array containing the signatures of the arguments, an
+     *            array of class names in the format returned by
+     *            Class.getName().
+     * @return result of invoking the operation on the MBean specified
+     * @throws java.io.IOException
+     * @throws javax.management.MalformedObjectNameException
+     * @throws javax.management.InstanceNotFoundException
+     * @throws javax.management.IntrospectionException
+     * @throws javax.management.ReflectionException
+     * @throws MBeanException
+     */
+    public Object invoke(String objectName, String method, Object[] args, String[] signatures)
+            throws IOException, MalformedObjectNameException, InstanceNotFoundException, IntrospectionException,
+            ReflectionException, MBeanException {
+        return connection.invoke(new ObjectName(objectName), method, args, signatures);
+    }
+
+    /**
+     * query the actual name of the MBean
+     * 
+     * @param name
+     *            - The object search string.
+     * @return actual name of the MBean
+     * @throws java.io.IOException
+     * @throws javax.management.MalformedObjectNameException
+     */
+    public ObjectName queryName(String name) throws MalformedObjectNameException, IOException {
+        return connection.queryNames(new ObjectName(name), null).iterator().next();
+    }
+
     /**
      * Fetches a list of metrics and their values in one go
      * 

java/src/main/java/com/outlyer/jmx/jmxquery/JMXMethod.java

@@ -0,0 +1,210 @@
+package com.outlyer.jmx.jmxquery;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
+/**
+ *
+ * JMXMethod is used for local or remote invoke of JMX methods
+ *
+ * @author Tibor Kiss
+ *
+ */
+public class JMXMethod {
+
+    /**
+     *
+     * MethodParam is used for pass parameters to a JMXMethod
+     *
+     * @author Tibor Kiss
+     *
+     */
+    public static class MethodParam {
+        private Object value;
+        private String type;
+
+        /**
+         * Default constructor
+         */
+        public MethodParam() {
+            this(null, null);
+        }
+
+        /**
+         * This constructor is used to create a parameter
+         * 
+         * @param value
+         *            is the actual value
+         * @param type
+         *            is a basic type from:
+         *            (String,Double,Float,Short,Integer,Long,Boolean,char,double,float,short,integer,long,
+         *            boolean)
+         */
+        public MethodParam(Object value, String type) {
+            setValue(value);
+            setType(type);
+        }
+
+        /**
+         * returns the parameter value
+         * 
+         * @return parameter value
+         */
+        public Object getValue() {
+            return value;
+        }
+
+        /**
+         * set the parameters value
+         * 
+         * @param value
+         *            parameters value
+         */
+        public void setValue(Object value) {
+            this.value = value;
+        }
+
+        public String getType() {
+            return type;
+        }
+
+        public void setType(String type) {
+            this.type = type;
+        }
+    }
+
+    private static final Map<String, String> typeMap = new HashMap<String, String>();
+    static {
+        typeMap.put("String", String.class.getName());
+        typeMap.put("Double", Double.class.getName());
+        typeMap.put("Float", Float.class.getName());
+        typeMap.put("Short", Short.class.getName());
+        typeMap.put("Integer", Integer.class.getName());
+        typeMap.put("Long", Long.class.getName());
+        typeMap.put("Boolean", Boolean.class.getName());
+
+        typeMap.put("char", char.class.getName());
+        typeMap.put("short", short.class.getName());
+        typeMap.put("int", int.class.getName());
+        typeMap.put("long", long.class.getName());
+        typeMap.put("double", double.class.getName());
+        typeMap.put("float", float.class.getName());
+        typeMap.put("boolean", boolean.class.getName());
+        typeMap.put("double", double.class.getName());
+
+    }
+
+    private final static Object toObject(final String typeName, final String value) {
+        if (Boolean.class.getName().endsWith(typeName))
+            return Boolean.parseBoolean(value);
+        if (Byte.class.getName().endsWith(typeName))
+            return Byte.parseByte(value);
+        if (Short.class.getName().endsWith(typeName))
+            return Short.parseShort(value);
+        if (Integer.class.getName().endsWith(typeName))
+            return Integer.parseInt(value);
+        if (Long.class.getName().endsWith(typeName))
+            return Long.parseLong(value);
+        if (Float.class.getName().endsWith(typeName))
+            return Float.parseFloat(value);
+        if (Double.class.getName().endsWith(typeName))
+            return Double.parseDouble(value);
+
+        return value;
+    }
+
+    private String objectName;
+    private String name;
+
+    private final List<MethodParam> params = new ArrayList<MethodParam>();
+
+    /**
+     * return the JMX MBean name
+     * 
+     * @return JMX MBean name
+     */
+    public String getObjectName() {
+        return objectName;
+    }
+
+    /**
+     * Set the JMX MBean name
+     * 
+     * @param objectName
+     *            JMX MBean name
+     */
+    public void setObjectName(String objectName) {
+        this.objectName = objectName;
+    }
+
+    /**
+     * return the name of the JMX method
+     * 
+     * @return name of the JMX method
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * set the name of the JMX method
+     * 
+     * @param name
+     *            name of the JMX method
+     */
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    /**
+     * return the list of parameters
+     * 
+     * @return list of parameters
+     */
+    public List<MethodParam> getParams() {
+        return params;
+    }
+
+    /**
+     * This method can be used to add a parameter to a method
+     * 
+     * @param value
+     * @param type
+     */
+    public void addParam(Object value, String type) {
+        params.add(new MethodParam(value, type));
+    }
+
+    /**
+     * This method returns the values as an array
+     * 
+     * @return array of value
+     */
+    @JsonIgnore
+    public Object[] getValues() {
+        List<Object> result = new ArrayList<Object>();
+        for (MethodParam par : params) {
+            result.add(toObject(typeMap.get(par.getType()), par.getValue().toString()));
+        }
+        return result.toArray(new Object[result.size()]);
+    }
+
+    /**
+     * This method returns the values types as an array
+     * 
+     * @return array of the type of values
+     */
+    @JsonIgnore
+    public String[] getTypes() {
+        List<String> result = new ArrayList<String>();
+        for (MethodParam par : params) {
+            result.add(typeMap.get(par.getType()));
+        }
+        return result.toArray(new String[result.size()]);
+    }
+
+}

java/src/main/java/com/outlyer/jmx/jmxquery/JMXMetric.java

@@ -289,11 +289,42 @@ public String toString() {
             s += " (" + attributeType + ")";
         }
         if (value != null) {
-            s += " = " + value.toString();
+            if (value instanceof String) {
+                s += " = " + value.toString();
+            } else {
+                s += " = " + valueToString(value);
+            }
         }
 
         return s;
     }
+
+    private static String valueToString(Object value) {
+        if (value == null) {
+            return "null";
+        }
+        if (value.getClass().isArray()) {
+            return arrayToString((Object[]) value);
+        }
+        if ((value instanceof Integer) || (value instanceof Long) || (value instanceof Double)
+                || (value instanceof Boolean)) {
+            return value.toString();
+        }
+        return new StringBuilder().append("\"").append(value).append("\"").toString();
+    }
+
+    private static String arrayToString(Object[] array) {
+        String s = "[";
+        boolean separatorRequired = false;
+        for (Object v : array) {
+            if (separatorRequired)
+                s += ",";
+            separatorRequired = true;
+            s += valueToString(v);
+        }
+        s += "]";
+        return s;
+    }
 
     /**
      * Returns JSON representation of metric
@@ -326,14 +357,7 @@ public String toJSON() {
             json += ", \"attributeType\" : \"" + this.attributeType + "\"";
         }
         if (this.value != null) {
-            if ((this.value instanceof Integer) || 
-                    (this.value instanceof Long) || 
-                    (this.value instanceof Double) || 
-                    (this.value instanceof Boolean)) {
-                json += ", \"value\" : " + this.value.toString();
-            } else {
-                json += ", \"value\" : \"" + this.value.toString() + "\"";
-            }
+            json += ", \"value\" : " + valueToString(value);
         }
         json += "}";