fix comments

Author: Vladimir Kotal

plugins/LdapPlugin/src/opengrok/auth/plugin/AbstractLdapPlugin.java

@@ -17,7 +17,7 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin;
@@ -38,11 +38,11 @@
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 
 /**
- * Abstract class for all plugins working with LDAP. Takes care of
+ * Abstract class for all plug-ins working with LDAP. Takes care of
  * <ul>
  * <li>controlling the established session</li>
  * <li>controlling if the session belongs to the user</li>
- * <li>controlling plugin version</li>
+ * <li>controlling plug-in version</li>
  * </ul>
  *
  * <p>
@@ -55,7 +55,7 @@
 abstract public class AbstractLdapPlugin implements IAuthorizationPlugin {
 
     /**
-     * This is used to ensure that every instance of this plugin has its own
+     * This is used to ensure that every instance of this plug-in has its own
      * unique name for its session parameters.
      */
     public static long nextId = 1;
@@ -153,7 +153,8 @@ public void load(Map<String, Object> parameters) {
      */
     protected Configuration getConfiguration(String configurationPath) throws IOException {
         if ((cfg = LOADED_CONFIGURATIONS.get(configurationPath)) == null) {
-            LOADED_CONFIGURATIONS.put(configurationPath, cfg = Configuration.read(new File(configurationPath)));
+            LOADED_CONFIGURATIONS.put(configurationPath, cfg =
+                    Configuration.read(new File(configurationPath)));
         }
         return cfg;
     }
@@ -205,7 +206,7 @@ protected boolean isSameUser(String sessionUsername, String authUser) {
 
     /**
      * Check if the session exists and contains all necessary fields required by
-     * this plugin.
+     * this plug-in.
      *
      * @param req the HTTP request
      * @return true if it does; false otherwise
@@ -228,7 +229,7 @@ protected boolean sessionExists(HttpServletRequest req) {
      * the session is established as an empty session to avoid any exception in
      * the caller.
      *
-     * @param req the http request
+     * @param req the HTTP request
      */
     @SuppressWarnings("unchecked")
     private void ensureSessionExists(HttpServletRequest req) {
@@ -335,7 +336,7 @@ protected void setSessionUsername(HttpServletRequest req, String value) {
     }
 
     /**
-     * Return the current plugin version tracked by the authorization framework.
+     * Return the current plug-in version tracked by the authorization framework.
      *
      * @return the version
      */

plugins/LdapPlugin/src/opengrok/auth/plugin/LdapAttr.java

@@ -35,6 +35,11 @@
 import org.opensolaris.opengrok.configuration.Group;
 import org.opensolaris.opengrok.configuration.Project;
 
+/**
+ * Authorization plug-in to check user's LDAP attribute against whitelist.
+ *
+ * @author Krystof Tulinger
+ */
 public class LdapAttr extends AbstractLdapPlugin {
 
     protected static final String ATTR_PARAM = "attribute";

plugins/LdapPlugin/src/opengrok/auth/plugin/LdapFilter.java

@@ -17,7 +17,7 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2016, 2017 Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin;
@@ -34,6 +34,11 @@
 import org.opensolaris.opengrok.configuration.Group;
 import org.opensolaris.opengrok.configuration.Project;
 
+/**
+ * Authorization plug-in to check if given user matches configured LDAP filter.
+ *
+ * @author Krystof Tulinger
+ */
 public class LdapFilter extends AbstractLdapPlugin {
 
     private static final Logger LOGGER = Logger.getLogger(LdapFilter.class.getName());

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

@@ -17,7 +17,7 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2016, 2017 Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin;
@@ -30,13 +30,18 @@
 import org.opensolaris.opengrok.configuration.Group;
 import org.opensolaris.opengrok.configuration.Project;
 
+/**
+ * Authorization plug-in to extract user's LDAP attributes.
+ *
+ * @author Krystof Tulinger
+ */
 public class LdapUserPlugin extends AbstractLdapPlugin {
 
     public static final String SESSION_ATTR = "opengrok-ldap-plugin-user";
 
     /**
      * Check if the session exists and contains all necessary fields required by
-     * this plugin.
+     * this plug-in.
      *
      * @param req the HTTP request
      * @return true if it does; false otherwise

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

@@ -17,7 +17,7 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin.ldap;

plugins/LdapPlugin/test/opengrok/auth/plugin/configuration/ConfigurationTest.java

@@ -17,7 +17,7 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin.configuration;

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

@@ -17,7 +17,7 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin;
@@ -33,8 +33,9 @@
 import org.opensolaris.opengrok.configuration.Project;
 
 /**
+ * Authorization plug-in to extract user info from HTTP headers.
  *
- * @author ktulinge
+ * @author Krystof Tulinger
  */
 public class UserPlugin implements IAuthorizationPlugin {
 

plugins/UserPlugin/src/opengrok/auth/plugin/decoders/HeaderDecoder.java

@@ -31,6 +31,7 @@
 
 /**
  * Decode Oracle SSO specific headers.
+ *
  * @author Krystof Tulinger
  */
 public class HeaderDecoder implements IUserDecoder {
@@ -79,7 +80,7 @@ public User fromRequest(HttpServletRequest request) {
 
         /**
          * Creating new user entity with provided information. The entity can be
-         * checked if it is timeouted via {@link User#isTimeouted()}.
+         * checked if the timeout expired via {@link User#isTimeouted()}.
          */
         User user = new User(username, userguid, cookieTimestamp,
                 "true".equalsIgnoreCase(timeouted));

src/org/opensolaris/opengrok/authorization/IAuthorizationPlugin.java

@@ -17,7 +17,7 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.authorization;
@@ -28,26 +28,27 @@
 import org.opensolaris.opengrok.configuration.Project;
 
 /**
- * Interface for authorization plugins.
+ * Interface for authorization plug-ins.
  *
- * All plugins considered for authorization must implement this interface
+ * All plug-ins considered for authorization must implement this interface
  *
  * @author Krystof Tulinger
  */
 public interface IAuthorizationPlugin {
 
     /**
-     * Called when the plugin is loaded into memory. With the parameters from
+     * Called when the plug-in is loaded into memory. With the parameters from
      * the configuration.
      *
-     * This can be used for establishing db/ldap connection or other init stuff.
+     * This can be used for establishing database/LDAP connection or perform
+     * initialization.
      *
      * @param parameters parameters specified in the configuration
      */
     void load(Map<String, Object> parameters);
 
     /**
-     * Called when the plugin is about to be deleted from the memory.
+     * Called when the plug-in is about to be deleted from the memory.
      *
      * This can be used for releasing connections and/or other release stuff.
      */