cleanup Sonar issues in authnz plugins (#3791)

* cleanup Sonar issues

* fix javadoc

* fix test

* fix replace

Author: Vladimir Kotal

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin;
 
@@ -30,17 +30,21 @@
 import org.opengrok.indexer.configuration.Project;
 
 /**
+ * Authorization plugin that returns false (not allowed) for all decisions.
+ * This is mostly handy for testing or special cases when one needs to quickly disallow access.
  *
  * @author Krystof Tulinger
  */
 public class FalsePlugin implements IAuthorizationPlugin {
 
     @Override
     public void load(Map<String, Object> parameters) {
+        // trivial plugin
     }
 
     @Override
     public void unload() {
+        // trivial plugin
     }
 
     @Override

plugins/src/main/java/opengrok/auth/plugin/LdapFilterPlugin.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;
 
@@ -144,7 +144,7 @@ public void fillSession(HttpServletRequest req, User user) {
             throw new AuthorizationException(ex);
         }
 
-        LOGGER.log(Level.FINER, "LDAP user {0} allowed on {2}",
+        LOGGER.log(Level.FINER, "LDAP user {0} allowed on {1}",
                 new Object[]{ldapUser, ldapProvider});
         updateSession(req, true);
     }
@@ -179,7 +179,7 @@ String expandFilter(String filter, LdapUser ldapUser, User user) {
             }
         }
 
-        filter = filter.replaceAll("\\\\%", "%");
+        filter = filter.replace("\\%", "%");
 
         return filter;
     }

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

@@ -138,7 +138,7 @@ String expandFilter(User user) {
 
         filter = expandUserFilter(user, filter);
 
-        filter = filter.replaceAll("\\\\%", "%");
+        filter = filter.replace("\\%", "%");
 
         return filter;
     }

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin;
 
@@ -30,17 +30,21 @@
 import org.opengrok.indexer.configuration.Project;
 
 /**
+ * Authorization plugin that returns true (allowed) for all decisions.
+ * This is mostly handy for testing or cases when one needs to explicitly allow a project/group.
  *
  * @author Krystof Tulinger
  */
 public class TruePlugin implements IAuthorizationPlugin {
 
     @Override
     public void load(Map<String, Object> parameters) {
+        // trivial plugin
     }
 
     @Override
     public void unload() {
+        // trivial plugin
     }
 
     @Override

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin;
 
@@ -68,24 +68,25 @@ private IUserDecoder getDecoder(String name) throws ClassNotFoundException, NoSu
 
     @Override
     public void load(Map<String, Object> parameters) {
-        String decoder_name;
-        if ((decoder_name = (String) parameters.get(DECODER_CLASS_PARAM)) == null) {
+        String decoderName;
+        if ((decoderName = (String) parameters.get(DECODER_CLASS_PARAM)) == null) {
             throw new NullPointerException(String.format("missing " +
                     "parameter '%s' in %s configuration",
                     DECODER_CLASS_PARAM, UserPlugin.class.getName()));
         }
 
-        LOGGER.log(Level.INFO, "loading decoder: {0}", decoder_name);
+        LOGGER.log(Level.INFO, "loading decoder: {0}", decoderName);
         try {
-            decoder = getDecoder(decoder_name);
+            decoder = getDecoder(decoderName);
         } catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException |
                 InvocationTargetException | InstantiationException e) {
-            throw new RuntimeException("cannot load decoder " + decoder_name, e);
+            throw new RuntimeException("cannot load decoder " + decoderName, e);
         }
     }
 
     @Override
     public void unload() {
+        // no state to free
     }
 
     private User getUser(HttpServletRequest request) {

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

@@ -41,8 +41,8 @@
 import java.util.stream.Stream;
 
 public class UserWhiteListPlugin implements IAuthorizationPlugin {
-    private static final String className = UserWhiteListPlugin.class.getName();
-    private static final Logger LOGGER = Logger.getLogger(className);
+    private static final String CLASS_NAME = UserWhiteListPlugin.class.getName();
+    private static final Logger LOGGER = Logger.getLogger(CLASS_NAME);
 
     // configuration parameters
     static final String FILE_PARAM = "file";

plugins/src/main/java/opengrok/auth/plugin/ldap/FakeLdapFacade.java

@@ -30,7 +30,7 @@
 import java.util.TreeSet;
 
 /**
- *
+ * LDAP facade for testing.
  * @author Krystof Tulinger
  */
 public class FakeLdapFacade extends AbstractLdapProvider {
@@ -45,12 +45,12 @@ public LdapSearchResult<Map<String, Set<String>>> lookupLdapContent(String dn, S
         if ("objectclass=*".equals(filter)) {
             List<String> v = Arrays.asList(values);
             if (v.isEmpty()) {
-                map.put("mail", new TreeSet<>(Arrays.asList("[email protected]")));
-                map.put("ou", new TreeSet<>(Arrays.asList("MI6")));
+                map.put("mail", new TreeSet<>(List.of("[email protected]")));
+                map.put("ou", new TreeSet<>(List.of("MI6")));
             } else {
                 for (String x : v) {
                     if (x.equals("uid")) {
-                        map.put("uid", new TreeSet<>(Arrays.asList("bondjame")));
+                        map.put("uid", new TreeSet<>(List.of("bondjame")));
                     }
                 }
             }
@@ -72,6 +72,6 @@ public boolean isConfigured() {
 
     @Override
     public void close() {
+        // No need to close anything as this is fake plugin.
     }
-
 }