directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r995000 - in /directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor: BaseInterceptor.java Interceptor.java
Date Wed, 08 Sep 2010 12:03:40 GMT
Author: elecharny
Date: Wed Sep  8 12:03:40 2010
New Revision: 995000

URL: http://svn.apache.org/viewvc?rev=995000&view=rev
Log:
Added some missing Javadoc

Modified:
    directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/BaseInterceptor.java
    directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/Interceptor.java

Modified: directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/BaseInterceptor.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/BaseInterceptor.java?rev=995000&r1=994999&r2=995000&view=diff
==============================================================================
--- directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/BaseInterceptor.java
(original)
+++ directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/BaseInterceptor.java
Wed Sep  8 12:03:40 2010
@@ -58,10 +58,11 @@ import org.apache.directory.shared.ldap.
  */
 public abstract class BaseInterceptor implements Interceptor
 {
-    
+
     /** set of operational attribute types used for representing the password policy state
of a user entry */
     protected static final Set<AttributeType> PWD_POLICY_STATE_ATTRIBUTE_TYPES = new
HashSet<AttributeType>();
-    
+
+
     /**
      * default interceptor name is its class, preventing accidental duplication of interceptors
by naming
      * instances differently
@@ -71,7 +72,8 @@ public abstract class BaseInterceptor im
     {
         return getClass().getName();
     }
-    
+
+
     /**
      * TODO delete this since it uses static access
      * Returns {@link LdapPrincipal} of current context.
@@ -122,7 +124,9 @@ public abstract class BaseInterceptor im
     // ------------------------------------------------------------------------
     // Interceptor's Invoke Method
     // ------------------------------------------------------------------------
-
+    /**
+     * {@inheritDoc}
+     */
     public void add( NextInterceptor next, AddOperationContext addContext ) throws LdapException
     {
         next.add( addContext );
@@ -158,7 +162,7 @@ public abstract class BaseInterceptor im
         return next.lookup( lookupContext );
     }
 
-    
+
     public void modify( NextInterceptor next, ModifyOperationContext modifyContext ) throws
LdapException
     {
         next.modify( modifyContext );
@@ -172,8 +176,7 @@ public abstract class BaseInterceptor im
     }
 
 
-    public void rename( NextInterceptor next, RenameOperationContext renameContext )
-        throws LdapException
+    public void rename( NextInterceptor next, RenameOperationContext renameContext ) throws
LdapException
     {
         next.rename( renameContext );
     }
@@ -188,7 +191,8 @@ public abstract class BaseInterceptor im
     }
 
 
-    public EntryFilteringCursor search( NextInterceptor next, SearchOperationContext searchContext
) throws LdapException
+    public EntryFilteringCursor search( NextInterceptor next, SearchOperationContext searchContext
)
+        throws LdapException
     {
         return next.search( searchContext );
     }

Modified: directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/Interceptor.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/Interceptor.java?rev=995000&r1=994999&r2=995000&view=diff
==============================================================================
--- directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/Interceptor.java
(original)
+++ directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/interceptor/Interceptor.java
Wed Sep  8 12:03:40 2010
@@ -110,6 +110,7 @@ public interface Interceptor
      */
     String getName();
 
+
     /**
      * Intializes this interceptor.  This is invoked by {@link InterceptorChain}
      * when this intercepter is loaded into interceptor chain.
@@ -128,13 +129,13 @@ public interface Interceptor
     /**
      * Filters {@link DefaultPartitionNexus#getRootDSE( GetRootDSEOperationContext )} call.
      */
-    Entry getRootDSE( NextInterceptor next, GetRootDSEOperationContext  getRootDseContext
) throws LdapException;
+    Entry getRootDSE( NextInterceptor next, GetRootDSEOperationContext getRootDseContext
) throws LdapException;
 
 
     /**
      * Filters {@link DefaultPartitionNexus#compare( CompareOperationContext )} call.
      */
-    boolean compare( NextInterceptor next, CompareOperationContext compareContext) throws
LdapException;
+    boolean compare( NextInterceptor next, CompareOperationContext compareContext ) throws
LdapException;
 
 
     /**
@@ -145,6 +146,10 @@ public interface Interceptor
 
     /**
      * Filters {@link Partition#add( AddOperationContext )} call.
+     * 
+     * @param next The next {@link Interceptor} in the chain
+     * @param addContext The {@link AddOperationContext} instance
+     * @throws LdapException If we had some error while processing the Add operation
      */
     void add( NextInterceptor next, AddOperationContext addContext ) throws LdapException;
 
@@ -194,14 +199,14 @@ public interface Interceptor
     /**
      * Filters {@link Partition#moveAndRename( MoveAndRenameOperationContext) } call.
      */
-    void moveAndRename( NextInterceptor next, MoveAndRenameOperationContext moveAndRenameContext
)
-        throws LdapException;
+    void moveAndRename( NextInterceptor next, MoveAndRenameOperationContext moveAndRenameContext
) throws LdapException;
+
 
     /**
      * Filters {@link Partition#bind( BindOperationContext )} call.
      */
-    void bind( NextInterceptor next, BindOperationContext bindContext )
-        throws LdapException;
+    void bind( NextInterceptor next, BindOperationContext bindContext ) throws LdapException;
+
 
     /**
      * Filters {@link Partition#unbind( UnbindOperationContext )} call.



Mime
View raw message