another round of fixes for Sonar warnings (#3787)

* another round of fixes for Sonar warnings

* fix Sonar warnings

* deduplicate

Author: Vladimir Kotal

opengrok-indexer/src/main/java/org/opengrok/indexer/Info.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2021, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.indexer;
 
@@ -39,14 +39,16 @@ public final class Info {
     private static final String REVISION;
     private static final String REVISION_SHORT;
 
+    private static final String UNKNOWN = "unknown";
+
     static {
         try (InputStream in = Info.class.getResourceAsStream("info.properties")) {
             if (in != null) {
                 properties.load(in);
             }
-            VERSION = properties.getProperty("version", "unknown");
-            REVISION = properties.getProperty("changeset", "unknown");
-            REVISION_SHORT = properties.getProperty("changeset_short", "unknown");
+            VERSION = properties.getProperty("version", UNKNOWN);
+            REVISION = properties.getProperty("changeset", UNKNOWN);
+            REVISION_SHORT = properties.getProperty("changeset_short", UNKNOWN);
         } catch (IOException ioe) {
             throw new RuntimeException(ioe);
         }

opengrok-indexer/src/main/java/org/opengrok/indexer/history/SSCMRepository.java

@@ -113,7 +113,7 @@ private Properties getProperties(File file) {
                 LOGGER.log(Level.WARNING,
                         "Failed to work with {0} file of {1}: {2}", new Object[]{
                             MYSCMSERVERINFO_FILE,
-                            getDirectoryName(), ex.getClass().toString()});
+                            getDirectoryName(), ex.getClass()});
             }
         }
 
@@ -140,8 +140,12 @@ Executor getHistoryLogExecutor(final File file, String sinceRevision) throws IOE
         } else {
             argv.add(file.getName());
         }
-        if (sinceRevision != null && new Scanner(sinceRevision).hasNextInt()) {
-            argv.add("-v" + (Integer.parseInt(sinceRevision) + 1) + ":" + Integer.MAX_VALUE);
+        if (sinceRevision != null) {
+            try (Scanner scanner = new Scanner(sinceRevision)) {
+                if (scanner.hasNextInt()) {
+                    argv.add("-v" + (Integer.parseInt(sinceRevision) + 1) + ":" + Integer.MAX_VALUE);
+                }
+            }
         }
         argv.add("-w-");
 
@@ -227,9 +231,8 @@ boolean getHistoryGet(OutputStream out, String parent, String basename, String r
                 }
             }
             return true;
-        } catch (IOException exp) {
-            LOGGER.log(Level.SEVERE,
-                    "Failed to get file: " + exp.getClass().toString(), exp);
+        } catch (IOException exception) {
+            LOGGER.log(Level.SEVERE, "Failed to get file", exception);
         }
 
         return false;
@@ -249,8 +252,12 @@ boolean fileHasAnnotation(File file) {
                     if (parts[0].equals(file.getName())) {
                         // Check if the version field is greater than 1
                         //  which indicates that annotate will work
-                        if (parts.length > 2 && new Scanner(parts[2]).hasNextInt()) {
-                            return Integer.parseInt(parts[2]) > 1;
+                        if (parts.length > 2) {
+                            try (Scanner scanner = new Scanner(parts[2])) {
+                                if (scanner.hasNextInt()) {
+                                    return Integer.parseInt(parts[2]) > 1;
+                                }
+                            }
                         }
                         break;
                     }
@@ -259,7 +266,7 @@ boolean fileHasAnnotation(File file) {
                 LOGGER.log(Level.WARNING,
                         "Failed to work with {0} file of {1}: {2}", new Object[]{
                             MYSCMSERVERINFO_FILE,
-                            getDirectoryName(), ex.getClass().toString()});
+                            getDirectoryName(), ex.getClass()});
             }
         }
         return false;

opengrok-indexer/src/main/java/org/opengrok/indexer/search/context/LineMatcher.java

@@ -28,13 +28,16 @@
 /**
  * Base class for matching a line against terms.
  */
+// Avoid the warning about 'WAIT' being confusing w.r.t. Object.wait().
+@SuppressWarnings("java:S1845")
 public abstract class LineMatcher {
+    // Line Matcher States
     public static final int NOT_MATCHED = 0;
     public static final int MATCHED = 1;
     public static final int WAIT = 2;
 
     /**
-     * Tells whether the matching should be done in a case insensitive manner.
+     * Tells whether the matching should be done in a case-insensitive manner.
      */
     private final boolean caseInsensitive;
 
@@ -49,7 +52,7 @@ public abstract class LineMatcher {
     }
 
     /**
-     * Check if two strings are equal. If this is a case insensitive matcher,
+     * Check if two strings are equal. If this is a case-insensitive matcher,
      * the check will return true if the only difference between the strings
      * is difference in case.
      */
@@ -60,7 +63,7 @@ boolean equal(String s1, String s2) {
     /**
      * Compare two strings and return -1, 0 or 1 if the first string is
      * lexicographically smaller than, equal to or greater than the second
-     * string. If this is a case insensitive matcher, case differences will
+     * string. If this is a case-insensitive matcher, case differences will
      * be ignored.
      */
     int compareStrings(String s1, String s2) {
@@ -75,7 +78,7 @@ int compareStrings(String s1, String s2) {
 
     /**
      * Normalize a string token for comparison with other string tokens. That
-     * is, convert to lower case if this is a case insensitive matcher.
+     * is, convert to lower case if this is a case-insensitive matcher.
      * Otherwise, return the string itself.
      */
     String normalizeString(String s) {

plugins/src/main/java/opengrok/auth/plugin/LdapUserPlugin.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin;
 
@@ -69,8 +69,8 @@ public class LdapUserPlugin extends AbstractLdapPlugin {
 
     private String ldapFilter;
     private Boolean useDN;
-    private Set<String> attributes;
-    private Integer instance;
+    private Set<String> attrSet;
+    private Integer instanceNum;
 
     // for testing
     void load(Map<String, Object> parameters, AbstractLdapProvider provider) {
@@ -92,22 +92,22 @@ private void init(Map<String, Object> parameters) {
             throw new NullPointerException("Missing configuration parameter [" + ATTRIBUTES +
                     "] in the setup");
         }
-        attributes = new HashSet<>(Arrays.asList(attributesVal.split(",")));
+        attrSet = new HashSet<>(Arrays.asList(attributesVal.split(",")));
 
         ldapFilter = (String) parameters.get(LDAP_FILTER);
 
         if ((useDN = (Boolean) parameters.get(USE_DN)) == null) {
             useDN = false;
         }
 
-        String instance_param = (String) parameters.get(INSTANCE);
-        if (instance_param != null) {
-            instance = Integer.parseInt(instance_param);
+        String instanceParam = (String) parameters.get(INSTANCE);
+        if (instanceParam != null) {
+            instanceNum = Integer.parseInt(instanceParam);
         }
 
         LOGGER.log(Level.FINE, "LdapUser plugin loaded with filter={0}, " +
                         "attributes={1}, useDN={2}, instance={3}",
-                new Object[]{ldapFilter, attributes, useDN, instance});
+                new Object[]{ldapFilter, attrSet, useDN, instanceNum});
     }
 
     /**
@@ -155,7 +155,7 @@ public void fillSession(HttpServletRequest req, User user) {
         }
 
         String dn = null;
-        if (useDN) {
+        if (Boolean.TRUE.equals(useDN)) {
             dn = user.getUsername();
             LOGGER.log(Level.FINEST, "using DN ''{0}'' for user {1}",
                     new Object[]{dn, user});
@@ -172,17 +172,17 @@ public void fillSession(HttpServletRequest req, User user) {
         try {
             AbstractLdapProvider.LdapSearchResult<Map<String, Set<String>>> res;
             if ((res = ldapProvider.lookupLdapContent(dn, expandedFilter,
-                    attributes.toArray(new String[0]))) == null) {
+                    attrSet.toArray(new String[0]))) == null) {
                 LOGGER.log(Level.WARNING, "failed to get LDAP attributes ''{2}'' for user {0} " +
                                 "with filter ''{1}'' from LDAP provider {3}",
-                        new Object[]{user, expandedFilter, attributes, getLdapProvider()});
+                        new Object[]{user, expandedFilter, attrSet, getLdapProvider()});
                 return;
             }
 
             records = res.getAttrs();
-            if (!useDN) {
+            if (Boolean.FALSE.equals(useDN)) {
                 dn = res.getDN();
-                LOGGER.log(Level.FINEST, "got DN ''{0}'' for user {1} on {2}",
+                LOGGER.log(Level.FINEST, "got DN ''{0}'' for user {1}",
                         new Object[]{dn, user});
             }
         } catch (LdapException ex) {
@@ -195,21 +195,21 @@ public void fillSession(HttpServletRequest req, User user) {
             return;
         }
 
-        for (String attrName : attributes) {
+        for (String attrName : attrSet) {
             if (!records.containsKey(attrName) || records.get(attrName) == null || records.get(attrName).isEmpty()) {
                 LOGGER.log(Level.WARNING, "''{0}'' record for user {1} is not present or empty on {2}",
                         new Object[]{attrName, user, ldapProvider});
             }
         }
 
-        Map<String, Set<String>> attrSet = new HashMap<>();
-        for (String attrName : attributes) {
-            attrSet.put(attrName, records.get(attrName));
+        Map<String, Set<String>> userAttrSet = new HashMap<>();
+        for (String attrName : this.attrSet) {
+            userAttrSet.put(attrName, records.get(attrName));
         }
 
         LOGGER.log(Level.FINEST, "DN for user {0} is ''{1}'' on {2}",
                 new Object[]{user, dn, ldapProvider});
-        updateSession(req, new LdapUser(dn, attrSet));
+        updateSession(req, new LdapUser(dn, userAttrSet));
     }
 
     /**
@@ -227,7 +227,7 @@ static String getSessionAttrName(Integer instance) {
     }
 
     private String getSessionAttrName() {
-        return getSessionAttrName(instance);
+        return getSessionAttrName(instanceNum);
     }
 
     @Override