directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject [directory-server] branch master updated: Core-Jndi and protocol-ldap javadoc fixes
Date Sun, 12 Aug 2018 13:32:18 GMT
This is an automated email from the ASF dual-hosted git repository.

elecharny pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-server.git


The following commit(s) were added to refs/heads/master by this push:
     new 37be382  Core-Jndi and protocol-ldap javadoc fixes
37be382 is described below

commit 37be38284a2632875b45bd31f85cd157afb54018
Author: Emmanuel L├ęcharny <elecharny@symas.com>
AuthorDate: Sun Aug 12 15:32:16 2018 +0200

    Core-Jndi and protocol-ldap javadoc fixes
---
 .../server/core/jndi/AbstractContextFactory.java   |  3 +
 .../directory/server/core/jndi/ServerContext.java  | 74 +++++++++++++++++++---
 .../server/core/jndi/ServerDirContext.java         |  6 ++
 .../server/core/jndi/ServerDirObjectFactory.java   |  2 +-
 .../server/ldap/ExtendedOperationHandler.java      |  2 +-
 .../server/ldap/LdapProtocolConstants.java         |  2 +-
 .../directory/server/ldap/LdapProtocolUtils.java   | 11 ++--
 .../apache/directory/server/ldap/LdapServer.java   | 16 +++--
 .../apache/directory/server/ldap/LdapSession.java  |  5 +-
 .../directory/server/ldap/LdapSessionManager.java  |  2 +
 .../server/ldap/handlers/LdapRequestHandler.java   |  4 ++
 .../ldap/handlers/controls/PagedSearchContext.java |  3 +
 .../handlers/extended/GracefulShutdownHandler.java |  3 +-
 .../StoredProcedureExtendedOperationHandler.java   |  3 +-
 .../ldap/handlers/request/BindRequestHandler.java  |  3 +-
 .../handlers/request/SearchRequestHandler.java     | 18 ++++--
 .../handlers/sasl/AbstractSaslCallbackHandler.java |  8 ++-
 .../ldap/handlers/sasl/MechanismHandler.java       |  6 +-
 .../ldap/handlers/sasl/ntlm/NtlmProvider.java      |  2 +
 .../ldap/handlers/sasl/plain/PlainSaslServer.java  |  3 +-
 .../ldap/replication/ReplicaEventMessage.java      |  2 +-
 .../ldap/replication/SyncReplConfiguration.java    |  8 +--
 .../replication/consumer/ReplicationConsumer.java  |  2 +
 .../replication/provider/ReplConsumerManager.java  |  2 +-
 .../ldap/replication/provider/ReplicaEventLog.java |  2 +
 .../replication/provider/ReplicaJournalCursor.java |  7 +-
 .../provider/ReplicationRequestHandler.java        |  2 +-
 27 files changed, 157 insertions(+), 44 deletions(-)

diff --git a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/AbstractContextFactory.java
b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/AbstractContextFactory.java
index 50b110c..7958bca 100644
--- a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/AbstractContextFactory.java
+++ b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/AbstractContextFactory.java
@@ -20,8 +20,11 @@
 package org.apache.directory.server.core.jndi;
 
 
+import javax.naming.InitialContext;
 import javax.naming.spi.InitialContextFactory;
 
+import org.apache.directory.server.core.api.DirectoryService;
+
 
 /**
  * A server-side JNDI provider implementation of {@link InitialContextFactory}.
diff --git a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerContext.java
b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerContext.java
index 76f6755..bba9003 100644
--- a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerContext.java
+++ b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerContext.java
@@ -296,6 +296,8 @@ public abstract class ServerContext implements EventContext
     /**
      * Set the referral handling flag into the operation context using
      * the JNDI value stored into the environment.
+     * 
+     * @param opCtx The operation context
      */
     protected void injectReferralControl( OperationContext opCtx )
     {
@@ -327,8 +329,10 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after add operations.
-     * @param entry
-     * @param target
+     * 
+     * @param target The entry's Dn to add
+     * @param entry The entry to add
+     * @throws Exception If the add failed
      */
     protected void doAddOperation( Dn target, Entry entry ) throws Exception
     {
@@ -353,7 +357,9 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after delete operations.
-     * @param target
+     * 
+     * @param target The entry's Dn we want to delete
+     * @throws Exception If we can't delete the entry
      */
     protected void doDeleteOperation( Dn target ) throws Exception
     {
@@ -493,11 +499,13 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after list operations.
-     * @param dn
-     * @param aliasDerefMode
-     * @param filter
-     * @param searchControls
-     * @return NamingEnumeration
+     * 
+     * @param dn The base search Dn
+     * @param aliasDerefMode The AliasDeref mode
+     * @param filter The search filter
+     * @param searchControls The controls
+     * @return A cursor on the found entries
+     * @throws Exception If the search failed 
      */
     protected EntryFilteringCursor doSearchOperation( Dn dn, AliasDerefMode aliasDerefMode,
         ExprNode filter, SearchControls searchControls ) throws Exception
@@ -579,6 +587,10 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after list operations.
+     * 
+     * @param target The search Dn
+     * @return A cursor on the found entries
+     * @throws Exception If we can't process the search
      */
     protected EntryFilteringCursor doListOperation( Dn target ) throws Exception
     {
@@ -600,6 +612,13 @@ public abstract class ServerContext implements EventContext
     }
 
 
+    /**
+     * Fetch the rootDSE entry
+     * 
+     * @param target Should be empty
+     * @return The RootDSE entry
+     * @throws Exception If we can't fetch the RootDSE entry
+     */
     protected Entry doGetRootDseOperation( Dn target ) throws Exception
     {
         GetRootDseOperationContext getRootDseContext = new GetRootDseOperationContext( session,
target );
@@ -615,6 +634,10 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after lookup operations.
+     * 
+     * @param target The Dn we are looking for
+     * @return The found entry
+     * @throws Exception If the lookup failed
      */
     protected Entry doLookupOperation( Dn target ) throws Exception
     {
@@ -637,6 +660,11 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after lookup operations.
+     * 
+     * @param target The Dn we are looking for
+     * @param attrIds The attributes to return
+     * @return The found entry
+     * @throws Exception If the lookup failed
      */
     protected Entry doLookupOperation( Dn target, String[] attrIds ) throws Exception
     {
@@ -668,6 +696,13 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after bind operations.
+     * 
+     * @param bindDn The user's Dn
+     * @param credentials The credentials
+     * @param saslMechanism The SASL mechanism to use
+     * @param saslAuthId The SASL authorization ID
+     * @return A BindOperationContext instance
+     * @throws Exception If the Bind failed
      */
     protected BindOperationContext doBindOperation( Dn bindDn, byte[] credentials, String
saslMechanism,
         String saslAuthId ) throws Exception
@@ -695,13 +730,19 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after moveAndRename operations.
+     * 
+     * @param oldDn The old Dn
+     * @param parent The new parent
+     * @param newRdn The new Rdn
+     * @param delOldRdn If we shoud delete the old Rdn
+     * @throws Exception If the move and rename failed
      */
-    protected void doMoveAndRenameOperation( Dn oldDn, Dn parent, Rdn newRdn, boolean delOldDn
)
+    protected void doMoveAndRenameOperation( Dn oldDn, Dn parent, Rdn newRdn, boolean delOldRdn
)
         throws Exception
     {
         // setup the op context and populate with request controls
         MoveAndRenameOperationContext moveAndRenameContext = new MoveAndRenameOperationContext(
session, oldDn, parent,
-            newRdn, delOldDn );
+            newRdn, delOldRdn );
         moveAndRenameContext.addRequestControls( convertControls( true, requestControls )
);
 
         // Inject the referral handling into the operation context
@@ -720,6 +761,10 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after modify operations.
+     * 
+     * @param dn The modified entry's dn
+     * @param modifications The list of modifications to apply
+     * @throws Exception If the modify failed
      */
     protected void doModifyOperation( Dn dn, List<Modification> modifications ) throws
Exception
     {
@@ -743,6 +788,10 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after moveAndRename operations.
+     * 
+     * @param oldDn The old Dn
+     * @param target The target
+     * @throws Exception If the move failed
      */
     protected void doMove( Dn oldDn, Dn target ) throws Exception
     {
@@ -766,6 +815,11 @@ public abstract class ServerContext implements EventContext
 
     /**
      * Used to encapsulate [de]marshalling of controls before and after rename operations.
+     * 
+     * @param oldDn The old Dn
+     * @param newRdn The new Rdn
+     * @param delOldRdn If we should delete the old Rdn
+     * @throws Exception If the rename failed
      */
     protected void doRename( Dn oldDn, Rdn newRdn, boolean delOldRdn ) throws Exception
     {
diff --git a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirContext.java
b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirContext.java
index 0040497..4f426ed 100644
--- a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirContext.java
+++ b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirContext.java
@@ -105,8 +105,10 @@ public abstract class ServerDirContext extends ServerContext implements
EventDir
      * Creates a new ServerDirContext with a distinguished name which is used to
      * set the PROVIDER_URL to the distinguished name for this context.
      *
+     * @param service The DirectoryService instance
      * @param principal the principal which is propagated
      * @param dn the distinguished name of this context
+     * @throws Exception If we weren't able to create the ServerDirContext instance
      */
     public ServerDirContext( DirectoryService service, LdapPrincipal principal, Name dn )
throws Exception
     {
@@ -283,6 +285,10 @@ public abstract class ServerDirContext extends ServerContext implements
EventDir
     /**
      * @see javax.naming.directory.DirContext#modifyAttributes(
      * javax.naming.Name, javax.naming.directory.ModificationItem[])
+     * 
+     * @param name The entry to modify
+     * @param mods The modifications to apply
+     * @throws NamingException If the modify operation failed
      */
     public void modifyAttributes( Name name, List<ModificationItem> mods ) throws NamingException
     {
diff --git a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirObjectFactory.java
b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirObjectFactory.java
index 12d9ff1..71eaf88 100644
--- a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirObjectFactory.java
+++ b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirObjectFactory.java
@@ -34,7 +34,7 @@ import javax.naming.spi.DirObjectFactory;
  * looks up the most specific object factory based on this additional
  * information.  This makes a huge difference when the number of ObjectFactory
  * instances is large.
- * <p/>
+ * <p>
  * Eventually, it is highly feasible for generated schemas, to also include
  * state and object factories for various objectClasses, or domain objects.
  * This means the number of factories will increase.  By associating object and
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/ExtendedOperationHandler.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/ExtendedOperationHandler.java
index cdaa909..07cd342 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/ExtendedOperationHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/ExtendedOperationHandler.java
@@ -36,7 +36,7 @@ import org.apache.directory.api.ldap.model.message.ExtendedResponse;
 public interface ExtendedOperationHandler<R extends ExtendedRequest, P extends ExtendedResponse>
 {
     /**
-     * Returns the EXTENSION_OID of the extended request this handler can handle.
+     * @return the EXTENSION_OID of the extended request this handler can handle.
      */
     String getOid();
 
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapProtocolConstants.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapProtocolConstants.java
index 46273f8..3ab3498 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapProtocolConstants.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapProtocolConstants.java
@@ -25,7 +25,7 @@ import org.apache.directory.api.ldap.model.message.Control;
 
 /**
  * Constants for LDAP protocol service.
- * Final reference -> class shouldn't be extended
+ * Final reference -&gt; class shouldn't be extended
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapProtocolUtils.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapProtocolUtils.java
index 6a89ccf..0d596f2 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapProtocolUtils.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapProtocolUtils.java
@@ -65,7 +65,7 @@ public final class LdapProtocolUtils
      * @param opContext the context to populate with request controls
      * @param request the request to extract controls from
      */
-    public static void setRequestControls( OperationContext opContext, Request request )
throws Exception
+    public static void setRequestControls( OperationContext opContext, Request request )
     {
         if ( request.getControls() != null )
         {
@@ -82,7 +82,7 @@ public final class LdapProtocolUtils
      * @param opContext the context to extract controls from
      * @param response the response to populate with response controls
      */
-    public static void setResponseControls( OperationContext opContext, Response response
) throws Exception
+    public static void setResponseControls( OperationContext opContext, Response response
)
     {
         response.addAllControls( opContext.getResponseControls() );
     }
@@ -100,6 +100,9 @@ public final class LdapProtocolUtils
     /**
      * Check the cookie syntax. A cookie must have the following syntax :
      * { rid={replicaId},csn={CSN} }
+     * 
+     * @param cookieString The cookie
+     * @return <tt>true</tt> if the cookie is valid
      */
     public static boolean isValidCookie( String cookieString )
     {
@@ -144,7 +147,7 @@ public final class LdapProtocolUtils
      * returns the CSN present in cookie
      * 
      * @param cookieString the cookie
-     * @return
+     * @return The CSN
      */
     public static String getCsn( String cookieString )
     {
@@ -157,7 +160,7 @@ public final class LdapProtocolUtils
      * returns the replica id present in cookie
      * 
      * @param cookieString  the cookie
-     * @return
+     * @return The replica Id
      */
     public static int getReplicaId( String cookieString )
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapServer.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapServer.java
index 54c8620..19af647 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapServer.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapServer.java
@@ -44,6 +44,7 @@ import org.apache.directory.api.ldap.codec.api.LdapApiServiceFactory;
 import org.apache.directory.api.ldap.model.constants.Loggers;
 import org.apache.directory.api.ldap.model.constants.SaslQoP;
 import org.apache.directory.api.ldap.model.exception.LdapConfigurationException;
+import org.apache.directory.api.ldap.model.exception.LdapException;
 import org.apache.directory.api.ldap.model.message.AbandonRequest;
 import org.apache.directory.api.ldap.model.message.AddRequest;
 import org.apache.directory.api.ldap.model.message.AddResponse;
@@ -359,7 +360,9 @@ public class LdapServer extends DirectoryBackedService
 
 
     /**
-     * loads the digital certificate either from a keystore file or from the admin entry
in DIT
+     * Loads the digital certificate either from a keystore file or from the admin entry
in DIT
+     * 
+     * @throws Exception If the KeyStore can't be loaded
      */
     public void loadKeyStore() throws Exception
     {
@@ -441,6 +444,7 @@ public class LdapServer extends DirectoryBackedService
      * with a new SslFilter after reloading the keystore.
      * 
      * Note: should be called to reload the keystore after changing the digital certificate.
+     * @throws Exception If teh SSLContext can't be reloaded
      */
     public void reloadSslContext() throws Exception
     {
@@ -730,7 +734,9 @@ public class LdapServer extends DirectoryBackedService
 
 
     /**
-     * starts the replication consumers
+     * Starts the replication consumers
+     * 
+     * @throws LdapException If the consumer can't be started
      */
     public void startReplicationConsumers() throws Exception
     {
@@ -945,7 +951,8 @@ public class LdapServer extends DirectoryBackedService
     /**
      * Returns <tt>true</tt> if LDAPS is enabled.
      *
-     * @return True if LDAPS is enabled.
+     * @param transport The LDAP transport
+     * @return <tt>true</tt> if LDAPS is enabled.
      */
     public boolean isEnableLdaps( Transport transport )
     {
@@ -1111,6 +1118,7 @@ public class LdapServer extends DirectoryBackedService
 
 
     /**
+     * @return the supported SASL mechanisms
      */
     public Map<String, MechanismHandler> getSaslMechanismHandlers()
     {
@@ -1754,7 +1762,7 @@ public class LdapServer extends DirectoryBackedService
     /**
      * The number of seconds pinger thread should sleep before pinging the providers
      *  
-     * @param pingerSleepTime
+     * @param pingerSleepTime The delay between 2 pings
      */
     public void setReplPingerSleepTime( int pingerSleepTime )
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapSession.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapSession.java
index b37dcd0..e736236 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapSession.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapSession.java
@@ -237,6 +237,7 @@ public class LdapSession
      * Abandons a specific request by messageId.
      *
      * @param messageId The request ID to abandon
+     * @return The found request
      */
     public AbandonableRequest abandonOutstandingRequest( int messageId )
     {
@@ -348,6 +349,7 @@ public class LdapSession
      * Registers a new searchRequest
      *
      * @param searchRequest a new searchRequest
+     * @param cursor The cursor to register
      */
     public void registerSearchRequest( SearchRequest searchRequest, Cursor<Entry> cursor
)
     {
@@ -379,6 +381,7 @@ public class LdapSession
      * Find the searchRequestContainer associated with a MessageID
      *
      * @param messageId the SearchRequestContainer MessageID we are looking for
+     * @return The found SearchRequestContainer 
      */
     public SearchRequestContainer getSearchRequest( int messageId )
     {
@@ -552,7 +555,7 @@ public class LdapSession
     /**
      * Close all the pending cursors for all the pending PagedSearches
      *
-     * @throws Exception If we've got an exception.
+     * @throws IOException If we've got an exception.
      */
     public void closeAllPagedSearches() throws IOException
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapSessionManager.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapSessionManager.java
index e7e1538..c0ab8ac 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapSessionManager.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapSessionManager.java
@@ -47,6 +47,8 @@ public class LdapSessionManager
 
     /**
      * Gets the active sessions managed by the LdapServer.
+     * 
+     * @return The active sessions
      */
     public LdapSession[] getSessions()
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/LdapRequestHandler.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/LdapRequestHandler.java
index 44cca27..537468f 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/LdapRequestHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/LdapRequestHandler.java
@@ -237,6 +237,10 @@ public abstract class LdapRequestHandler<T extends Request> implements
MessageHa
 
     /**
      * Handles processing with referrals without ManageDsaIT decorator.
+     * 
+     * @param session The associated session
+     * @param req The response
+     * @param e The associated exception 
      */
     public void handleException( LdapSession session, ResultResponseRequest req, Exception
e )
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/controls/PagedSearchContext.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/controls/PagedSearchContext.java
index e0eedc4..6957dfa 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/controls/PagedSearchContext.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/controls/PagedSearchContext.java
@@ -64,6 +64,8 @@ public class PagedSearchContext
 
     /**
      * Creates a new instance of this class, storing the SearchRequest into it.
+     * 
+     * @param searchRequest The SearchRequest
      */
     public PagedSearchContext( SearchRequest searchRequest )
     {
@@ -151,6 +153,7 @@ public class PagedSearchContext
      * true if they are equal. We compare every field but the MessageID.
      *
      * @param request The new SearchRequest
+     * @param session The LdapSession in use
      * @return true if both request are equal.
      */
     public boolean hasSameRequest( SearchRequest request, LdapSession session )
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/extended/GracefulShutdownHandler.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/extended/GracefulShutdownHandler.java
index 40ad009..58d5cfb 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/extended/GracefulShutdownHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/extended/GracefulShutdownHandler.java
@@ -46,7 +46,8 @@ import org.slf4j.LoggerFactory;
 
 
 /**
- * @todo : missing Javadoc
+ * A Handler for the GracefulShutdown extended operation
+ * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public class GracefulShutdownHandler implements
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/extended/StoredProcedureExtendedOperationHandler.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/extended/StoredProcedureExtendedOperationHandler.java
index 02db414..e16bb8d 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/extended/StoredProcedureExtendedOperationHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/extended/StoredProcedureExtendedOperationHandler.java
@@ -44,7 +44,8 @@ import org.apache.directory.server.ldap.LdapSession;
 
 
 /**
- * @todo : Missing Javadoc
+ * A Handler for the StoredProcedure extended operation
+ * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public class StoredProcedureExtendedOperationHandler implements
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/BindRequestHandler.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/BindRequestHandler.java
index 5cb9aa5..6cf7265 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/BindRequestHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/BindRequestHandler.java
@@ -536,7 +536,7 @@ public class BindRequestHandler extends LdapRequestHandler<BindRequest>
      * <li>The user does not has a session yet</li>
      * <li>The user already has a session</li>
      * <li>The user has started a SASL negotiation</li>
-     * </lu><br>
+     * </ul>
      * 
      * In the first case, we initiate a SaslBind session, which will be used all
      * along the negotiation.<br>
@@ -548,7 +548,6 @@ public class BindRequestHandler extends LdapRequestHandler<BindRequest>
      * current negotiation. We move back to an Anonymous state</li>
      * <li>The mechanism is provided : the user is initializing a new negotiation
      * with another mechanism. The current SaslBind session is reinitialized</li>
-     * <li></li>
      * </ul><br>
      *
      * @param ldapSession The associated Session
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/SearchRequestHandler.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/SearchRequestHandler.java
index 804b370..00a8761 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/SearchRequestHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/SearchRequestHandler.java
@@ -1466,11 +1466,15 @@ public class SearchRequestHandler extends LdapRequestHandler<SearchRequest>
      * an ancestor that is a referral.  The original entry was not found and
      * the walk of the ancestry returned a referral.
      *
+     * @param session The LdapSession in use
+     * @param req The SearchRequest
      * @param referralAncestor the farthest referral ancestor of the missing
      * entry
+     * @return The found referral
+     * @throws LdapException If we weren't able to retrieve the referral
      */
     public Referral getReferralOnAncestorForSearch( LdapSession session, SearchRequest req,
-        Entry referralAncestor ) throws Exception
+        Entry referralAncestor ) throws LdapException
     {
         if ( IS_DEBUG )
         {
@@ -1546,11 +1550,16 @@ public class SearchRequestHandler extends LdapRequestHandler<SearchRequest>
      * an ancestor that is a referral.  The original entry was not found and
      * the walk of the ancestry returned a referral.
      *
+     * @param session The LdapSession in use
+     * @param reqTargetDn the request target Dn
+     * @param req The SearchRequest
      * @param referralAncestor the farthest referral ancestor of the missing
      * entry
+     * @return The found referral
+     * @throws LdapException If we weren't able to retrieve the ancestor
      */
     public Referral getReferralOnAncestor( LdapSession session, Dn reqTargetDn, SearchRequest
req,
-        Entry referralAncestor ) throws Exception
+        Entry referralAncestor ) throws LdapException
     {
         if ( IS_DEBUG )
         {
@@ -1715,12 +1724,13 @@ public class SearchRequestHandler extends LdapRequestHandler<SearchRequest>
      * Techniques can be employed later to improve this performance hit by
      * having an intelligent referral cache.
      *
+     * @param session The LdapSession in use
+     * @param target the base Dn
      * @return the farthest referral ancestor or null
-     * @throws Exception if there are problems during this search
      */
     // This will suppress PMD.EmptyCatchBlock warnings in this method
     @SuppressWarnings("PMD.EmptyCatchBlock")
-    public static final Entry getFarthestReferralAncestor( LdapSession session, Dn target
) throws Exception
+    public static final Entry getFarthestReferralAncestor( LdapSession session, Dn target
)
     {
         Entry entry;
         Entry farthestReferralAncestor = null;
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/AbstractSaslCallbackHandler.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/AbstractSaslCallbackHandler.java
index 1bb8bf1..a166f40 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/AbstractSaslCallbackHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/AbstractSaslCallbackHandler.java
@@ -87,7 +87,8 @@ public abstract class AbstractSaslCallbackHandler implements CallbackHandler
     /**
      * Creates a new instance of AbstractSaslCallbackHandler.
      *
-     * @param directoryService
+     * @param directoryService The DirectoryService instance
+     * @param bindRequest The Bind request
      */
     protected AbstractSaslCallbackHandler( DirectoryService directoryService, BindRequest
bindRequest )
     {
@@ -100,6 +101,8 @@ public abstract class AbstractSaslCallbackHandler implements CallbackHandler
      * Implementors use this method to access the username resulting from a callback.
      * Callback default name will be username, eg 'hnelson', for CRAM-MD5 and DIGEST-MD5.
      * The {@link NameCallback} is not used by GSSAPI.
+     * 
+     * @return The user name
      */
     protected String getUsername()
     {
@@ -111,6 +114,8 @@ public abstract class AbstractSaslCallbackHandler implements CallbackHandler
      * Implementors use this method to access the realm resulting from a callback.
      * Callback default text will be realm name, eg 'example.com', for DIGEST-MD5.
      * The {@link RealmCallback} is not used by GSSAPI nor by CRAM-MD5.
+     * 
+     * @return The realm
      */
     protected String getRealm()
     {
@@ -141,6 +146,7 @@ public abstract class AbstractSaslCallbackHandler implements CallbackHandler
      * Implementors must setAuthorized() to <code>true</code> if authentication
was successful.
      * 
      * @param callback An {@link AuthorizeCallback}.
+     * @throws Exception If the authorization failed
      */
     protected abstract void authorize( AuthorizeCallback callback ) throws Exception;
 
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/MechanismHandler.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/MechanismHandler.java
index 2c38e15..4bb1ebf 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/MechanismHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/MechanismHandler.java
@@ -38,10 +38,10 @@ public interface MechanismHandler
      * Implementors will use the session and message to determine what kind of
      * {@link SaslServer} to create and what initialization parameters it will require.
      *
-     * @param session
-     * @param bindRequest
+     * @param session The LdapSession in use
+     * @param bindRequest The BindRequest
      * @return The {@link SaslServer} to use for the duration of the bound session.
-     * @throws Exception
+     * @throws Exception If we can't find the SASL Mechanism
      */
     SaslServer handleMechanism( LdapSession session, BindRequest bindRequest ) throws Exception;
 
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/ntlm/NtlmProvider.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/ntlm/NtlmProvider.java
index bbe7762..1f272fe 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/ntlm/NtlmProvider.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/ntlm/NtlmProvider.java
@@ -39,6 +39,7 @@ public interface NtlmProvider
      * @param session the MINA IoSession to store any state to be thread safe
      * @param type1reponse the Type 1 NTLM response from client
      * @return the NTLM Type 2 message with the challenge
+     * @throws Exception If the challenge cannot be generated
      */
     byte[] generateChallenge( IoSession session, byte[] type1reponse ) throws Exception;
 
@@ -49,6 +50,7 @@ public interface NtlmProvider
      * @param session the MINA IoSession to store any state to be thread safe
      * @param type3response the Type 3 NTLM response from the client
      * @return the result of the authentication from the server
+     * @throws Exception If the authentication failed
      */
     boolean authenticate( IoSession session, byte[] type3response ) throws Exception;
 }
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/plain/PlainSaslServer.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/plain/PlainSaslServer.java
index fc356dd..7119646 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/plain/PlainSaslServer.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/sasl/plain/PlainSaslServer.java
@@ -93,8 +93,9 @@ public final class PlainSaslServer extends AbstractSaslServer
      * 
      * Creates a new instance of PlainSaslServer.
      *
+     * @param ldapSession The associated LdapSession instance
+     * @param adminSession The Administrator session 
      * @param bindRequest The associated BindRequest object
-     * @param ldapSession The associated LdapSession instance 
      */
     public PlainSaslServer( LdapSession ldapSession, CoreSession adminSession, BindRequest
bindRequest )
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/ReplicaEventMessage.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/ReplicaEventMessage.java
index 8d3b1b0..d7ef374 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/ReplicaEventMessage.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/ReplicaEventMessage.java
@@ -84,7 +84,7 @@ public class ReplicaEventMessage
      *
      * @param csn the CSN
      * @return true if the event's CSN is older than the given CSN
-     * @throws Exception if there are any extreme conditions like a null entry or missing
entryCSN attribute.
+     * @throws LdapException if there are any extreme conditions like a null entry or missing
entryCSN attribute.
      */
     public boolean isEventOlderThan( String csn ) throws LdapException
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/SyncReplConfiguration.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/SyncReplConfiguration.java
index e2aa086..0c4d188 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/SyncReplConfiguration.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/SyncReplConfiguration.java
@@ -172,7 +172,7 @@ public class SyncReplConfiguration implements ReplicationConsumerConfig
 
     /**
      * A convenient method that concatenates the host and port of the producer
-     * @return The <host>:<port> the consumer is connected to
+     * @return The &lt;host&gt;:&lt;port&gt; the consumer is connected to
      */
     public String getProducer()
     {
@@ -505,7 +505,7 @@ public class SyncReplConfiguration implements ReplicationConsumerConfig
     /**
      * set the option to turn on/off use of TLS
      * 
-     * @param useTls
+     * @param useTls If we have to use TLS
      */
     public void setUseTls( boolean useTls )
     {
@@ -525,7 +525,7 @@ public class SyncReplConfiguration implements ReplicationConsumerConfig
     /**
      * set the strict certificate verification
      * 
-     * @param strictCertVerification
+     * @param strictCertVerification If we require a certificate validation
      */
     public void setStrictCertVerification( boolean strictCertVerification )
     {
@@ -572,7 +572,7 @@ public class SyncReplConfiguration implements ReplicationConsumerConfig
     /**
      * enable/disable MMR option
      *
-     * @param mmrMode
+     * @param mmrMode The type of replication
      */
     public void setMmrMode( boolean mmrMode )
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java
index e0c58f2..339673e 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java
@@ -93,6 +93,8 @@ public interface ReplicationConsumer
     
     /**
      * Starts the synchronization operation
+     * 
+     * @return The replication status
      */
     ReplicationStatusEnum startSync();
 }
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplConsumerManager.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplConsumerManager.java
index b66a6c5..a591262 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplConsumerManager.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplConsumerManager.java
@@ -188,7 +188,7 @@ public class ReplConsumerManager
      * Delete an existing consumer entry from ou=consumers,ou=system
      * 
      * @param replica The added consumer replica
-     * @throws Exception If the addition failed
+     * @throws LdapException If the addition failed
      */
     public void deleteConsumerEntry( ReplicaEventLog replica ) throws LdapException
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaEventLog.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaEventLog.java
index 4310011..614f1fb 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaEventLog.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaEventLog.java
@@ -127,8 +127,10 @@ public class ReplicaEventLog implements Comparable<ReplicaEventLog>
     /**
      * Creates a new instance of EventLog for a replica
      * 
+     * @param partitionTxn The Transaction to use
      * @param directoryService The DirectoryService instance
      * @param replicaId The replica ID
+     * @throws IOException if we weren't able to log the event
      */
     public ReplicaEventLog( PartitionTxn partitionTxn, DirectoryService directoryService,
int replicaId ) throws IOException
     {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaJournalCursor.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaJournalCursor.java
index 02fc923..f4d68b8 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaJournalCursor.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaJournalCursor.java
@@ -76,11 +76,14 @@ public class ReplicaJournalCursor extends AbstractCursor<ReplicaEventMessage>
 
     /**
      * Creates a cursor on top of the given journal
+     * 
+     * @param partitionTxn The Transaction to use
      * @param journal the log journal
      * @param consumerCsn the consumer's CSN taken from cookie
-     * @throws Exception 
+     * @throws Exception If the cursor creation failed
      */
-    public ReplicaJournalCursor( PartitionTxn partitionTxn, JdbmTable<String, ReplicaEventMessage>
journal, String consumerCsn ) throws Exception
+    public ReplicaJournalCursor( PartitionTxn partitionTxn, JdbmTable<String, ReplicaEventMessage>
journal, 
+            String consumerCsn ) throws Exception
     {
         if ( IS_DEBUG )
         {
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicationRequestHandler.java
b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicationRequestHandler.java
index 81fa3ab..a2389f1 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicationRequestHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicationRequestHandler.java
@@ -53,7 +53,7 @@ public interface ReplicationRequestHandler
      *
      * @param session the LdapSession instance
      * @param req the SearchRequest with the SyncRequest control
-     * @throws LdapException
+     * @throws LdapException If the syncrepl request wasn't handled properly
      */
     void handleSyncRequest( LdapSession session, SearchRequest req ) throws LdapException;
 }


Mime
View raw message