svn commit: r1398687 - /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/UserAuthentication.java

[an...@apache.org]

Author: angela
Date: Tue Oct 16 07:48:52 2012
New Revision: 1398687

URL: http://svn.apache.org/viewvc?rev=1398687&view=rev
Log:
 OAK-91 - Implement Authentication Support (WIP)

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/UserAuthentication.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/UserAuthentication.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/UserAuthentication.java?rev=1398687&r1=1398686&r2=1398687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/UserAuthentication.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/UserAuthentication.java Tue Oct 16 07:48:52 2012
@@ -36,7 +36,25 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * AuthenticationImpl...
+ * Implementation of the Authentication interface that validates credentials
+ * against user information stored in the repository. If no user exists with
+ * the specified userID or if the user has been disabled authentication will
+ * will fail irrespective of the specified credentials. Otherwise the following
+ * validation is performed:
+ *
+ * <ul>
+ *     <li>{@link SimpleCredentials}: Authentication succeeds if userID and
+ *     password match the information exposed by the {@link UserProvider}.</li>
+ *     <li>{@link ImpersonationCredentials}: Authentication succeeds if the
+ *     subject to be authenticated is allowed to impersonate the user identified
+ *     by the userID.</li>
+ *     <li>{@link GuestCredentials}: The authentication succeeds if an 'anonymous'
+ *     user exists in the repository.</li>
+ * </ul>
+ *
+ * For any other credentials {@link #authenticate(javax.jcr.Credentials)}
+ * will return {@code false} indicating that this implementation is not able
+ * to verify their validity.
  */
 public class UserAuthentication implements Authentication {