fix comments from Krystof

Author: Vladimir Kotal

src/org/opensolaris/opengrok/configuration/messages/ConfigMessage.java

@@ -18,20 +18,20 @@
  */
 
 /*
- * Copyright (c) 2017, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.configuration.messages;
 
-import java.beans.IntrospectionException;
-import java.beans.PropertyDescriptor;
 import java.io.IOException;
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
+import java.util.Arrays;
+import java.util.Set;
+import java.util.TreeSet;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
-import org.opensolaris.opengrok.authorization.AuthorizationFramework;
-import org.opensolaris.opengrok.configuration.Configuration;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
+import org.opensolaris.opengrok.util.BooleanUtil;
+import org.opensolaris.opengrok.util.ClassUtil;
+
 
 /**
  * A message to retrieve/change the configuration.
@@ -61,7 +61,7 @@ protected byte[] applyMessage(RuntimeEnvironment env) throws IOException {
             Matcher matcher = VARIABLE_PATTERN.matcher(getText());
             if (matcher.find()) {
                 // set the property
-                invokeSetter(
+                ClassUtil.invokeSetter(
                         env.getConfiguration(),
                         matcher.group(1), // field
                         matcher.group(2) // value
@@ -77,233 +77,23 @@ protected byte[] applyMessage(RuntimeEnvironment env) throws IOException {
                                 getText()));
             }
         } else if (hasTag("get")) {
-            return invokeGetter(env.getConfiguration(), getText()).getBytes();
+            return ClassUtil.invokeGetter(env.getConfiguration(), getText()).getBytes();
         } else if (hasTag("setconf")) {
             env.applyConfig(this, hasTag("reindex"));
         }
 
         return null;
     }
 
-    /**
-     * Invokes a setter on the configuration object and passes a value to that
-     * setter.
-     *
-     * The value is passed as string and the function will automatically try to
-     * convert it to the parameter type in the setter. These conversion are
-     * available only for
-     * <a href="https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html">java
-     * primitive datatypes</a>:
-     * <ul>
-     * <li>Boolean or boolean</li>
-     * <li>Short or short</li>
-     * <li>Integer or integer</li>
-     * <li>Long or long</li>
-     * <li>Float or float</li>
-     * <li>Double or double</li>
-     * <li>Byte or byte</li>
-     * <li>Character or char</li>
-     * <li>String</li>
-     * </ul>
-     * Any other parameter type will cause an exception.
-     *
-     * @param config the configuration object
-     * @param field name of the field which will be changed
-     * @param value desired value
-     *
-     * @throws IOException if any error occurs (no suitable method, bad
-     * conversion, ...)
-     */
-    protected void invokeSetter(Configuration config, String field, String value) throws IOException {
-        try {
-            PropertyDescriptor desc = new PropertyDescriptor(field, Configuration.class);
-            Method setter = desc.getWriteMethod();
-
-            if (setter == null) {
-                throw new IOException(
-                        String.format("No setter for the name \"%s\".",
-                                field));
-            }
-
-            if (setter.getParameterCount() != 1) {
-                // not a setter
-                /**
-                 * Actually should not happen as it is not considered as a
-                 * writer method so an exception would be thrown earlier.
-                 */
-                throw new IOException(
-                        String.format("The setter \"%s\" for the name \"%s\" does not take exactly 1 parameter.",
-                                setter.getName(), field));
-            }
-
-            Class c = setter.getParameterTypes()[0];
-            String paramClass = c.getName();
-
-            /**
-             * Java primitive types as per
-             * <a href="https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html">java
-             * datatypes</a>.
-             */
-            if (paramClass.equals("boolean") || paramClass.equals(Boolean.class.getName())) {
-                if (!isBoolean(value)) {
-                    throw new IOException(String.format("Unsupported type conversion from String to a boolean for name \"%s\" -"
-                            + " got \"%s\" - allowed values are [false, off, 0, true, on, 1].",
-                            field, value));
-                }
-                Boolean v = Boolean.valueOf(value);
-                if (!v) {
-                    /**
-                     * The Boolean.valueOf() returns true only for "true" case
-                     * insensitive so now we have either the false values or
-                     * "on" or "1". These are convenient shortcuts for "on", "1"
-                     * to be interpreted as booleans.
-                     */
-                    v = v || value.equalsIgnoreCase("on");
-                    v = v || value.equals("1");
-                }
-                setter.invoke(config, v);
-            } else if (paramClass.equals("short") || paramClass.equals(Short.class.getName())) {
-                setter.invoke(config, Short.valueOf(value));
-            } else if (paramClass.equals("int") || paramClass.equals(Integer.class.getName())) {
-                setter.invoke(config, Integer.valueOf(value));
-            } else if (paramClass.equals("long") || paramClass.equals(Long.class.getName())) {
-                setter.invoke(config, Long.valueOf(value));
-            } else if (paramClass.equals("float") || paramClass.equals(Float.class.getName())) {
-                setter.invoke(config, Float.valueOf(value));
-            } else if (paramClass.equals("double") || paramClass.equals(Double.class.getName())) {
-                setter.invoke(config, Double.valueOf(value));
-            } else if (paramClass.equals("byte") || paramClass.equals(Byte.class.getName())) {
-                setter.invoke(config, Byte.valueOf(value));
-            } else if (paramClass.equals("char") || paramClass.equals(Character.class.getName())) {
-                setter.invoke(config, value.charAt(0));
-            } else if (paramClass.equals(String.class.getName())) {
-                setter.invoke(config, value);
-            } else {
-                // error unknown type
-                throw new IOException(
-                        String.format("Unsupported type conversion for the name \"%s\". Expecting \"%s\".",
-                                field, paramClass));
-            }
-        } catch (NumberFormatException ex) {
-            throw new IOException(
-                    String.format("Unsupported type conversion from String to a number for name \"%s\" - %s.",
-                            field, ex.getLocalizedMessage()), ex);
-        } catch (IndexOutOfBoundsException ex) {
-            throw new IOException(
-                    String.format("The string is not long enough to extract 1 character for name \"%s\" - %s.",
-                            field, ex.getLocalizedMessage()), ex);
-        } catch (IntrospectionException
-                | IllegalAccessException
-                | IllegalArgumentException
-                /**
-                 * This the case when the invocation failed because the invoked
-                 * method failed with an exception. All exceptions are
-                 * propagated through this exception.
-                 */
-                | InvocationTargetException ex) {
-            throw new IOException(
-                    String.format("Unsupported operation with the configuration for name \"%s\" - %s.",
-                            field,
-                            ex.getCause() == null
-                            ? ex.getLocalizedMessage()
-                            : ex.getCause().getLocalizedMessage()),
-                    ex);
-        }
-    }
-
-    /**
-     * Invokes a getter of a property on the configuration object.
-     * 
-     * @param config configuration object
-     * @param field string with field name
-     * @return string representation of the field value
-     * @throws java.io.IOException 
-     */
-    protected String invokeGetter(Configuration config, String field) throws IOException {
-        String val = null;
-
-        try {
-            PropertyDescriptor desc = new PropertyDescriptor(field, Configuration.class);
-            Method getter = desc.getReadMethod();
-
-            if (getter == null) {
-                throw new IOException(
-                        String.format("No getter for the name \"%s\".", field));
-            }
-
-            if (getter.getParameterCount() != 0) {
-                /**
-                 * Actually should not happen as it is not considered as a
-                 * read method so an exception would be thrown earlier.
-                 */
-                throw new IOException(
-                        String.format("The getter \"%s\" for the name \"%s\" takes a parameter.",
-                                getter.getName(), field));
-            }
-            
-            val = getter.invoke(config).toString();
-        } catch (IntrospectionException
-                | IllegalAccessException
-                | InvocationTargetException
-                | IllegalArgumentException ex) {
-            throw new IOException(
-                    String.format("Unsupported operation with the configuration for name \"%s\" - %s.",
-                            field,
-                            ex.getCause() == null
-                            ? ex.getLocalizedMessage()
-                            : ex.getCause().getLocalizedMessage()),
-                    ex);
-        }
-
-        return val;
-    }
-    
-    /**
-     * Validate the string if it contains a boolean value.
-     *
-     * <p>
-     * Boolean values are (case insensitive):
-     * <ul>
-     * <li>false</li>
-     * <li>off</li>
-     * <li>0</li>
-     * <li>true</li>
-     * <li>on</li>
-     * <li>1</li>
-     * </ul>
-     * </p>
-     *
-     * @param value the string value
-     * @return if the value is boolean or not
-     */
-    private boolean isBoolean(String value) {
-        return "false".equalsIgnoreCase(value)
-                || "off".equalsIgnoreCase(value)
-                || "0".equalsIgnoreCase(value)
-                || "true".equalsIgnoreCase(value)
-                || "on".equalsIgnoreCase(value)
-                || "1".equalsIgnoreCase(value);
-
-    }
-
-    /**
-     * Cast a boolean value to integer.
-     *
-     * @param b boolean value
-     * @return 0 for false and 1 for true
-     */
-    protected int toInteger(boolean b) {
-        return b ? 1 : 0;
-    }
-
     @Override
     public void validate() throws Exception {
-        if (toInteger(hasTag("setconf"))
-                + toInteger(hasTag("getconf"))
-                + toInteger(hasTag("auth"))
-                + toInteger(hasTag("get"))
-                + toInteger(hasTag("set")) > 1) {
-            throw new Exception("The message tag must be either setconf, getconf, auth or set");
+        Set<String> allowedTags = new TreeSet<>(Arrays.asList("setconf",
+                "getconf", "auth", "get", "set"));
+
+        Set<String> tagCopy = new TreeSet<>(allowedTags);
+        tagCopy.retainAll(getTags());
+        if (tagCopy.size() > 1) {
+            throw new Exception("The message tag must be one of '" + allowedTags.toString() + "'");
         }
 
         if (hasTag("setconf")) {

src/org/opensolaris/opengrok/configuration/messages/ProjectMessage.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.configuration.messages;
 

src/org/opensolaris/opengrok/configuration/messages/RepositoryMessage.java

@@ -45,22 +45,22 @@ protected byte[] applyMessage(RuntimeEnvironment env) throws Exception {
 
         switch (msgtext) {
             case "get-repo-type":
-                List<String> types = new ArrayList<>();
+                List<String> types = new ArrayList<>(16);
 
                 for (String tag: getTags()) {
                     boolean found = false;
                     for (RepositoryInfo ri : env.getRepositories()) {
                         if (ri.getDirectoryNameRelative().equals(tag)) {
-                            types.add(ri.getType());
+                            types.add(tag + ":" + ri.getType());
                             found = true;
                             break;
                         }
                     }
                     if (!found) {
-                        types.add("N/A");
+                        types.add(tag + ":N/A");
                     }
                 }
-                ret = types.stream().collect(Collectors.joining("\n")).toString();
+                ret = types.stream().collect(Collectors.joining("\n"));
                 break;
         }
 
@@ -75,14 +75,14 @@ protected byte[] applyMessage(RuntimeEnvironment env) throws Exception {
     @Override
     public void validate() throws Exception {
         String command = getText();
-        Set<String> allowedText = new TreeSet<>(Arrays.asList("get-repo-type"));
+        Set<String> allowedTexts = new TreeSet<>(Arrays.asList("get-repo-type"));
 
         // The text field carries the command.
         if (command == null) {
-            throw new Exception("The message text must contain one of '" + allowedText.toString() + "'");
+            throw new Exception("The message text must contain one of '" + allowedTexts.toString() + "'");
         }
-        if (!allowedText.contains(command)) {
-            throw new Exception("The message text must contain one of '" + allowedText.toString() + "'");
+        if (!allowedTexts.contains(command)) {
+            throw new Exception("The message text must contain one of '" + allowedTexts.toString() + "'");
         }
 
         if (getTags().size() == 0) {