svn commit: r289678 - /directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/acl/ACDFEngine.java

[tr...@apache.org]

Author: trustin
Date: Fri Sep 16 17:03:27 2005
New Revision: 289678

URL: http://svn.apache.org/viewcvs?rev=289678&view=rev
Log:
Added JavaDoc for ACDFEngine

Modified:
    directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/acl/ACDFEngine.java

Modified: directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/acl/ACDFEngine.java
URL: http://svn.apache.org/viewcvs/directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/acl/ACDFEngine.java?rev=289678&r1=289677&r2=289678&view=diff
==============================================================================
--- directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/acl/ACDFEngine.java (original)
+++ directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/acl/ACDFEngine.java Fri Sep 16 17:03:27 2005
@@ -31,6 +31,22 @@
     {
     }
     
+    /**
+     * Checks the user with the specified name can access the specified resource
+     * (entry, attribute type, or attribute value) and throws {@link LdapNoPermissionException}
+     * if the user doesn't have any permission to perform the specified grants.
+     *  
+     * @param username the DN of the user who is trying to access the resource
+     * @param entryName the DN of the entry the user is trying to access 
+     * @param attrId the attribute type of the attribute the user is trying to access.
+     *               <tt>null</tt> if the user is not accessing a specific attribute type.
+     * @param attrValue the attribute value of the attribute the user is trying to access.
+     *                  <tt>null</tt> if the user is not accessing a specific attribute value.
+     * @param entry the attributes of the entry
+     * @param requiredGrants the required grants to perform the operation
+     * @param aciTuples {@link ACITuple}s translated from {@link ACIItem}s in the subtree entries
+     * @throws LdapNoPermissionException if user don't have enough permission to perform the operation
+     */
     public void checkPermission(
             Name username,
             Name entryName, String attrId, Object attrValue, Attributes entry,
@@ -43,6 +59,21 @@
         }
     }
     
+    /**
+     * Returns <tt>true</tt> if the user with the specified name can access the specified resource
+     * (entry, attribute type, or attribute value) and throws {@link LdapNoPermissionException}
+     * if the user doesn't have any permission to perform the specified grants.
+     *  
+     * @param username the DN of the user who is trying to access the resource
+     * @param entryName the DN of the entry the user is trying to access 
+     * @param attrId the attribute type of the attribute the user is trying to access.
+     *               <tt>null</tt> if the user is not accessing a specific attribute type.
+     * @param attrValue the attribute value of the attribute the user is trying to access.
+     *                  <tt>null</tt> if the user is not accessing a specific attribute value.
+     * @param entry the attributes of the entry
+     * @param requiredGrants the required grants to perform the operation
+     * @param aciTuples {@link ACITuple}s translated from {@link ACIItem}s in the subtree entries
+     */
     public boolean hasPermission(
             Name username,
             Name entryName, String attrId, Object attrValue, Attributes entry,