svn commit: r603582 - /lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java

Author: andreas
Date: Wed Dec 12 04:06:31 2007
New Revision: 603582

URL: http://svn.apache.org/viewvc?rev=603582&view=rev
Log:
Added some javadoc comments

Modified:
    lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java

Modified: lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java
URL: http://svn.apache.org/viewvc/lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java?rev=603582&r1=603581&r2=603582&view=diff
==============================================================================
--- lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java (original)
+++ lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java Wed Dec 12 04:06:31 2007
@@ -157,7 +157,7 @@
 
     protected void logAttributesMap(Map attributesMap) {
         if (getLogger().isDebugEnabled()) {
-            getLogger().debug("Shib attribute Map: \n\n" + attributesMap.toString() + "\n\n");
+            getLogger().debug("Shibboleth attribute map: \n\n" + attributesMap.toString() + "\n\n");
         }
     }
 
@@ -166,6 +166,11 @@
         handler.error(message);
     }
 
+    /**
+     * Replaces the identity's user with a new user.
+     * @param identity The identity.
+     * @param user The new user.
+     */
     protected void updateIdentity(Identity identity, User user) {
         if (!identity.contains(user)) {
             User oldUser = identity.getUser();
@@ -182,6 +187,14 @@
         }
     }
 
+    /**
+     * Passes the attributes from the <em>samlAttributes</em> parameter to the <em>user</em>
+     * object. The {@link AttributeTranslator}Êservice is used to translate the attributes. The
+     * name and e-mail attributes are extracted using the {@link UserFieldsMapper}.
+     * @param user
+     * @param samlAttributes
+     * @throws AccessControlException
+     */
     protected void passAttributes(TransientUser user, Map samlAttributes)
             throws AccessControlException {