svn commit: r828687 - /jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Impersonation.java

[an...@apache.org]

Author: angela
Date: Thu Oct 22 13:43:44 2009
New Revision: 828687

URL: http://svn.apache.org/viewvc?rev=828687&view=rev
Log:
javadoc

Modified:
    jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Impersonation.java

Modified: jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Impersonation.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Impersonation.java?rev=828687&r1=828686&r2=828687&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Impersonation.java (original)
+++ jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Impersonation.java Thu Oct 22 13:43:44 2009
@@ -36,7 +36,7 @@
      * @return An iterator over the <code>Principal</code>s that are allowed
      * to impersonate the <code>User</code> this <code>Impersonation</code>
      * object has been created for.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     PrincipalIterator getImpersonators() throws RepositoryException;
 
@@ -46,15 +46,16 @@
      * @return true if the specified <code>Principal</code> has not been allowed
      * to impersonate before and if impersonation has been successfully
      * granted to it, false otherwise.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     boolean grantImpersonation(Principal principal) throws RepositoryException;
 
     /**
-     * @param principal
+     * @param principal The principal that should no longer be allowed to
+     * impersonate.
      * @return If the granted impersonation has been successfully revoked for
      * the given principal; false otherwise.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     boolean revokeImpersonation(Principal principal) throws RepositoryException;
 
@@ -65,7 +66,7 @@
      * @param subject to impersonate.
      * @return true if this <code>Impersonation</code> allows the specified
      * Subject to impersonate.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     boolean allows(Subject subject) throws RepositoryException;
 }