Author: trustin
Date: Mon Mar 21 03:24:30 2005
New Revision: 158450

URL: http://svn.apache.org/viewcvs?view=rev&rev=158450
Log:
* Added Interceptor naming convention rules section in JavaDoc
* Updated Authorizer JavaDocs



Modified:
    
directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Authorizer.java
    
directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Interceptor.java

Modified: 
directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Authorizer.java
URL: 
http://svn.apache.org/viewcvs/directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Authorizer.java?view=diff&r1=158449&r2=158450
==============================================================================
--- 
directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Authorizer.java
 (original)
+++ 
directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Authorizer.java
 Mon Mar 21 03:24:30 2005
@@ -51,7 +51,9 @@
 
 /**
  * An [EMAIL PROTECTED] Interceptor} that controls access to [EMAIL PROTECTED] 
BackingStore}
- * operations.
+ * operations.  If a user tries to perform any operations that requires
+ * permission he or she doesn't have, [EMAIL PROTECTED] NamingException} will 
be thrown
+ * and therefore the current invocation chain will terminate.
  *
  * @author The Apache Directory Project ([email protected])
  * @author Alex Karasulu ([EMAIL PROTECTED])

Modified: 
directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Interceptor.java
URL: 
http://svn.apache.org/viewcvs/directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Interceptor.java?view=diff&r1=158449&r2=158450
==============================================================================
--- 
directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Interceptor.java
 (original)
+++ 
directory/apacheds/branches/interceptor_revamp/core/src/main/java/org/apache/ldap/server/jndi/invocation/interceptor/Interceptor.java
 Mon Mar 21 03:24:30 2005
@@ -27,6 +27,18 @@
  * [EMAIL PROTECTED] Invocation}s performed on [EMAIL PROTECTED] 
BackingStore}s just like Servlet
  * filters do.
  * 
+ * <h2>Interceptor Naming Convention</h2>
+ * <p>
+ * When you create an implementation of Interceptor, you have to follow
+ * the basic class naming convention to avoid others' confusion:
+ * <ul>
+ *   <li>Class name must be an agent noun or end with 
'<code>Interceptor</code>'.</li>
+ *   <li>If the role of the interceptor is to add or modify attributes of
+ *       entries, class name must end with '<code>Tagger</code>.' (e.g. 
EntryUUIDTagger)</li>
+ * </ul>
+ * Plus, placing your interceptor implementations to packages like
+ * '<code>interceptor</code>' would be the best practice.
+ * 
  * @author The Apache Directory Project ([email protected])
  * @author Trustin Lee ([EMAIL PROTECTED])
  * @version $Rev$, $Date$


Reply via email to