Removed DOCUMENT ME comments that were generated and applied source code

[utils] / security / src / main / java / org / wamblee / usermgt / JaasUserAccessor.java

diff --git a/security/src/main/java/org/wamblee/usermgt/JaasUserAccessor.java b/security/src/main/java/org/wamblee/usermgt/JaasUserAccessor.java
index 56ae836e5feb02686bbca3b09e47e5b82eb27685..5050a75ec5d8e6b76fda9faf22c8147f5e18d341 100644 (file)
--- a/security/src/main/java/org/wamblee/usermgt/JaasUserAccessor.java
+++ b/security/src/main/java/org/wamblee/usermgt/JaasUserAccessor.java
@@ -1,55 +1,62 @@
 /*
  * Copyright 2005 the original author or authors.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.wamblee.usermgt;
 
 import java.security.AccessController;
 import java.security.Principal;
+
 import java.util.Set;
 
 import javax.security.auth.Subject;
 
 /**
- * Implementation of the user accessor that retrieves user information
- * from JAAS. 
+ * Implementation of the user accessor that retrieves user information from
+ * JAAS.
+ * 
+ * @author Erik Brakkee
  */
 public class JaasUserAccessor implements UserAccessor {
-
     /**
-     * User administration to use. 
+     * User administration to use.
      */
-    private UserAdministration _admin;
+    private UserAdministration admin;
 
     /**
-     * Class of the JAAS user principal. 
+     * Class of the JAAS user principal.
      */
-    private Class _userPrincipalClass;
+    private Class userPrincipalClass;
 
     /**
-     * Constructs user accessor. 
-     * @param aAdmin User administration. 
-     * @param aUserClassName Class name of the user principal. 
+     * Constructs user accessor.
+     * 
+     * @param aAdmin
+     *            User administration.
+     * @param aUserClassName
+     *            Class name of the user principal.
      */
     public JaasUserAccessor(UserAdministration aAdmin, String aUserClassName) {
-        _admin = aAdmin;
+        admin = aAdmin;
+
         try {
-            _userPrincipalClass = Class.forName(aUserClassName);
-            if ( !Principal.class.isAssignableFrom(_userPrincipalClass)) {
-                throw new IllegalArgumentException("Specified class '" + aUserClassName + "' is not a subclass of '" +
-                        Principal.class.getName());
+            userPrincipalClass = Class.forName(aUserClassName);
+
+            if (!Principal.class.isAssignableFrom(userPrincipalClass)) {
+                throw new IllegalArgumentException("Specified class '" +
+                    aUserClassName + "' is not a subclass of '" +
+                    Principal.class.getName());
             }
         } catch (ClassNotFoundException e) {
             throw new RuntimeException(e);
@@ -63,37 +70,50 @@ public class JaasUserAccessor implements UserAccessor {
      */
     public User getCurrentUser() {
         Subject subject = Subject.getSubject(AccessController.getContext());
+
         if (subject == null) {
             return null;
         }
+
         Principal userPrincipal = getUserPrincipal(subject);
-      
-        return _admin.getUser(userPrincipal.getName());
+
+        return admin.getUser(userPrincipal.getName());
     }
 
     /**
-     * Gets the user principal from the subject. 
-     * @param subject Subject. 
-     * @return User principal. 
-     * @throws IllegalArgumentException In case there is a duplicate principal or the principal was not found. 
+     * Gets the user principal from the subject.
+     * 
+     * @param subject
+     *            Subject.
+     * 
+     * @return User principal.
+     * 
+     * @throws IllegalArgumentException
+     *             In case there is a duplicate principal or the principal was
+     *             not found.
      */
     private Principal getUserPrincipal(Subject subject) {
         Set<Principal> principals = subject.getPrincipals();
-        Principal userPrincipal = null;  
-        for ( Principal principal: principals) { 
-            if ( principal.getClass().equals(_userPrincipalClass)) { 
-                if ( userPrincipal != null ) { 
+        Principal userPrincipal = null;
+
+        for (Principal principal : principals) {
+            if (principal.getClass().equals(userPrincipalClass)) {
+                if (userPrincipal != null) {
                     throw new IllegalArgumentException(
-                            "Multiple principals for class '" + _userPrincipalClass + "', subject: " + subject);                   
+                        "Multiple principals for class '" + userPrincipalClass +
+                            "', subject: " + subject);
                 }
-                userPrincipal = principal; 
+
+                userPrincipal = principal;
             }
         }
-        if ( userPrincipal == null ) { 
+
+        if (userPrincipal == null) {
             throw new IllegalArgumentException(
-                    "No user principal found for class '" + _userPrincipalClass + "', subject: " + subject);
+                "No user principal found for class '" + userPrincipalClass +
+                    "', subject: " + subject);
         }
+
         return userPrincipal;
     }
-
 }