jackrabbit-oak-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r1407400 - /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/token/TokenInfo.java
Date Fri, 09 Nov 2012 09:44:06 GMT
Author: angela
Date: Fri Nov  9 09:44:06 2012
New Revision: 1407400

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

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

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/token/TokenInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/token/TokenInfo.java?rev=1407400&r1=1407399&r2=1407400&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/token/TokenInfo.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/token/TokenInfo.java
Fri Nov  9 09:44:06 2012
@@ -22,23 +22,60 @@ import javax.annotation.Nonnull;
 import org.apache.jackrabbit.api.security.authentication.token.TokenCredentials;
 
 /**
- * TokenInfo... TODO
+ * The {@code TokenInfo} provides data associated with a login token and
+ * basic methods to verify the validity of token credentials at given
+ * point in time.
  */
 public interface TokenInfo {
 
+    /**
+     * Returns the ID of the user associated with this token info object.
+     *
+     * @return the ID of the user.
+     */
     @Nonnull
     String getUserId();
 
+    /**
+     * Returns the login token.
+     *
+     * @return the login token.
+     */
     @Nonnull
     String getToken();
 
+    /**
+     * Returns {@code true} if the token has already expired; {@code false} otherwise.
+     *
+     * @param loginTime The login time used to calculate the expiration status.
+     * @return {@code true} if the token has already expired; {@code false} otherwise.
+     */
     boolean isExpired(long loginTime);
 
+    /**
+     * Returns {@code true} if the specified credentials can be successfully
+     * validated against the information stored in this instance.
+     *
+     * @param tokenCredentials The credentials to validate.
+     * @return {@code true} if the specified credentials can be successfully
+     * validated against the information stored in this instance; {@code false}
+     * otherwise.
+     */
     boolean matches(TokenCredentials tokenCredentials);
 
+    /**
+     * Returns the private attributes stored with this info object.
+     *
+     * @return the private attributes stored with this info object.
+     */
     @Nonnull
     Map<String, String> getPrivateAttributes();
 
+    /**
+     * Returns the public attributes stored with this info object.
+     *
+     * @return the public attributes stored with this info object.
+     */
     @Nonnull
     Map<String, String> getPublicAttributes();
 }



Mime
View raw message