directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1758963 - in /directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client: api/ api/search/ template/ template/exception/
Date Fri, 02 Sep 2016 14:23:39 GMT
Author: elecharny
Date: Fri Sep  2 14:23:38 2016
New Revision: 1758963

URL: http://svn.apache.org/viewvc?rev=1758963&view=rev
Log:
Updated Javadocs

Modified:
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractLdapConnection.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultPoolableLdapConnectionFactory.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultSchemaLoader.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionConfig.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionFactory.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdifAnonymizer.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/search/FilterBuilder.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/AbstractPasswordPolicyResponder.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/EntryMapper.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/LdapConnectionOperations.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/ModelFactory.java
    directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/PasswordException.java

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractLdapConnection.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractLdapConnection.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractLdapConnection.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractLdapConnection.java Fri Sep  2 14:23:38 2016
@@ -132,6 +132,13 @@ public abstract class AbstractLdapConnec
 
     /**
      * Create a complete BindRequest ready to be sent.
+     *
+     * @param name The DN to bind with
+     * @param credentials The user's password
+     * @param saslMechanism The SASL mechanism to use
+     * @param controls The controls to send
+     * @return The created BindRequest
+     * @throws LdapException If the creation failed
      */
     protected BindRequest createBindRequest( String name, byte[] credentials, String saslMechanism, Control... controls )
         throws LdapException

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultPoolableLdapConnectionFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultPoolableLdapConnectionFactory.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultPoolableLdapConnectionFactory.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultPoolableLdapConnectionFactory.java Fri Sep  2 14:23:38 2016
@@ -26,9 +26,9 @@ package org.apache.directory.ldap.client
 /**
  * A factory for creating LdapConnection objects managed by LdapConnectionPool. The connections are
  * not validated when they are pulled from the pool : we just check if they are still connected, using
- * their internal flag. We don't either re-bind when we push back teh connection into the pool.
- * <br/>
- * It's up to the users to be careful with the way they deal with connectiosn -especially when using
+ * their internal flag. We don't either re-bind when we push back the connection into the pool.
+ * <br>
+ * It's up to the users to be careful with the way they deal with connections -especially when using
  * the StartTLS extended operation -.
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultSchemaLoader.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultSchemaLoader.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultSchemaLoader.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultSchemaLoader.java Fri Sep  2 14:23:38 2016
@@ -121,7 +121,7 @@ public class DefaultSchemaLoader extends
      * Creates a new instance of DefaultSchemaLoader.
      *
      * @param connection the LDAP connection
-     * @param initial setting for the relaxed mode
+     * @param relaxed initial setting for the relaxed mode
      * @throws LdapException if the connection is not authenticated or if there are any problems
      *                   while loading the schema entries
      */
@@ -238,6 +238,7 @@ public class DefaultSchemaLoader extends
      * Creates a new instance of NetworkSchemaLoader.
      *
      * @param connection the LDAP connection
+     * @param subschemaSubentryDn The SubschemaSubentry
      * @throws Exception if the connection is not authenticated or if there are any problems
      *                   while loading the schema entries
      */

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java Fri Sep  2 14:23:38 2016
@@ -152,7 +152,6 @@ public interface LdapConnection extends
      * Bind on a server, using the {@link LdapConnectionConfig} information of this connection.
      *
      * @throws LdapException if some error occurred
-     * @throws IOException if an I/O exception occurred
      */
     void bind() throws LdapException;
 
@@ -325,7 +324,6 @@ public interface LdapConnection extends
      *
      * @param dn The entry's distinguished name, it must be a valid {@link Dn}
      * @param modifications The list of modifications to be applied
-     * @return the modify operation's response
      * @throws LdapException in case of modify operation failure or timeout happens
      */
     void modify( String dn, Modification... modifications ) throws LdapException;
@@ -336,7 +334,6 @@ public interface LdapConnection extends
      *
      * @param entry the entry with the attributes to be modified
      * @param modOp the operation to be applied on all the attributes of the above entry
-     * @return the modify operation's response
      * @throws LdapException in case of modify operation failure or timeout happens
      */
     void modify( Entry entry, ModificationOperation modOp ) throws LdapException;
@@ -395,7 +392,6 @@ public interface LdapConnection extends
      * @param entryDn the target Dn
      * @param newRdn new Rdn for the target Dn
      * @param deleteOldRdn flag to indicate whether to delete the old Rdn
-     * @return modifyDn operation's response
      * @throws LdapException if some error occurred
      */
     void rename( Dn entryDn, Rdn newRdn, boolean deleteOldRdn ) throws LdapException;
@@ -537,7 +533,7 @@ public interface LdapConnection extends
      *
      * @param dn the target entry's distinguished name, it must be a valid {@link Dn}
      * @param attributeName the attribute's name
-     * @param value a Value<?> value with which the target entry's attribute value to be compared with
+     * @param value a Value&lt;?&gt; value with which the target entry's attribute value to be compared with
      * @return <code>true</code> if the value matches, <code>false</code> otherwise
      * @throws LdapException if some error occurred
      */
@@ -576,7 +572,7 @@ public interface LdapConnection extends
      *
      * @param dn the target entry's distinguished name
      * @param attributeName the attribute's name
-     * @param value a Value<?> value with which the target entry's attribute value to be compared with
+     * @param value a Value&lt;?&gt; value with which the target entry's attribute value to be compared with
      * @return <code>true</code> if the value matches, <code>false</code> otherwise
      * @throws LdapException if some error occurred
      */
@@ -793,7 +789,7 @@ public interface LdapConnection extends
 
     /**
      * Loads all the default schemas that are bundled with the API, in a relaxed mode.<br><br>
-     * <b>Note:</b> This method enables <b>all</b> schemas prior to loading.<br/>
+     * <b>Note:</b> This method enables <b>all</b> schemas prior to loading.<br>
      * The relaxed mode will allow inconsistencies in the schema.
      * 
      * @throws LdapException in case of problems while loading the schema
@@ -833,12 +829,15 @@ public interface LdapConnection extends
 
     /**
      * Sets the object responsible for the detection of binary attributes.
+     * 
+     * @param binaryAttributeDetecter The Binary Attribute Detector to use
      */
     void setBinaryAttributeDetector( BinaryAttributeDetector binaryAttributeDetecter );
 
 
     /**
      * sets a SchemaManager to be used by this connection
+     * @param schemaManager The SchemaManager to set
      */
     void setSchemaManager( SchemaManager schemaManager );
 }
\ No newline at end of file

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionConfig.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionConfig.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionConfig.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionConfig.java Fri Sep  2 14:23:38 2016
@@ -326,7 +326,7 @@ public class LdapConnectionConfig
     /**
      * Sets the timeout.
      *
-     * @return the timeout
+     * @param timeout the timeout to set
      */
     public void setTimeout( long timeout )
     {

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionFactory.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionFactory.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionFactory.java Fri Sep  2 14:23:38 2016
@@ -80,7 +80,7 @@ public interface LdapConnectionFactory
      * instances.
      * 
      * @return A newly created, configured, and authenticated LdapConnection.
-     * @throws LdapException
+     * @throws LdapException If the new connection couldn't be established
      */
     LdapConnection newLdapConnection() throws LdapException;
 

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java Fri Sep  2 14:23:38 2016
@@ -112,7 +112,7 @@ public class LdapConnectionPool extends
      * Gives a LdapConnection fetched from the pool.
      *
      * @return an LdapConnection object from pool
-     * @throws Exception if an error occurs while obtaining a connection from the factory
+     * @throws LdapException if an error occurs while obtaining a connection from the factory
      */
     public LdapConnection getConnection() throws LdapException
     {
@@ -160,7 +160,7 @@ public class LdapConnectionPool extends
      * Places the given LdapConnection back in the pool.
      * 
      * @param connection the LdapConnection to be released
-     * @throws Exception if an error occurs while releasing the connection
+     * @throws LdapException if an error occurs while releasing the connection
      */
     public void releaseConnection( LdapConnection connection ) throws LdapException
     {

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java Fri Sep  2 14:23:38 2016
@@ -318,6 +318,10 @@ public class LdapNetworkConnection exten
     /**
      * Get the largest timeout from the search time limit and the connection
      * timeout.
+     * 
+     * @param connectionTimoutInMS Connection timeout
+     * @param searchTimeLimitInSeconds Search timeout
+     * @return The largest timeout
      */
     public long getTimeout( long connectionTimoutInMS, int searchTimeLimitInSeconds )
     {
@@ -1310,7 +1314,7 @@ public class LdapNetworkConnection exten
      * @param authcid The Authentication identity
      * @param credentials The password. It can't be null
      * @return The BindResponse LdapResponse
-     * @throws {@link LdapException} if some error occurred
+     * @throws LdapException if some error occurred
      */
     public BindResponse bindSaslPlain( String authcid, String credentials ) throws LdapException
     {
@@ -1325,7 +1329,7 @@ public class LdapNetworkConnection exten
      * @param authcid The Authentication identity
      * @param credentials The password. It can't be null
      * @return The BindResponse LdapResponse
-     * @throws {@link LdapException} if some error occurred
+     * @throws LdapException if some error occurred
      */
     public BindResponse bindSaslPlain( String authzid, String authcid, String credentials ) throws LdapException
     {
@@ -2805,7 +2809,6 @@ public class LdapNetworkConnection exten
      * deletes the entry with the given Dn, and all its children
      *
      * @param dn the target entry's Dn
-     * @return operation's response
      * @throws LdapException If the Dn is not valid or if the deletion failed
      */
     public void deleteTree( Dn dn ) throws LdapException
@@ -2835,7 +2838,6 @@ public class LdapNetworkConnection exten
      * deletes the entry with the given Dn, and all its children
      *
      * @param dn the target entry's Dn as a String
-     * @return operation's response
      * @throws LdapException If the Dn is not valid or if the deletion failed
      */
     public void deleteTree( String dn ) throws LdapException
@@ -3538,7 +3540,7 @@ public class LdapNetworkConnection exten
      * loads schema using the specified schema loader
      *
      * @param loader the {@link SchemaLoader} to be used to load schema
-     * @throws LdapException
+     * @throws LdapException If the schema loading failed
      */
     public void loadSchema( SchemaLoader loader ) throws LdapException
     {
@@ -3622,6 +3624,8 @@ public class LdapNetworkConnection exten
 
     /**
      * @see #addSchema(File)
+     * @param schemaFileName The schema file name to add
+     * @throws LdapException If the schema addition failed
      */
     public void addSchema( String schemaFileName ) throws LdapException
     {
@@ -3851,7 +3855,7 @@ public class LdapNetworkConnection exten
      * upon receiving a response with successful result. Note that we will use
      * the default LDAP connection.
      *
-     * @throws LdapException
+     * @throws LdapException If the StartTLS operation failed
      */
     public void startTls() throws LdapException
     {

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdifAnonymizer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdifAnonymizer.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdifAnonymizer.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdifAnonymizer.java Fri Sep  2 14:23:38 2016
@@ -517,8 +517,8 @@ public class LdifAnonymizer
     /**
      * Anonymize a LDIF 
      * 
-     * @param ldif The ldif content to anonymize
-     * @return an anonymized version of the given ldif
+     * @param ldifFile The ldif file to anonymize
+     * @param writer The Writer to use to write the result
      * @throws LdapException If we got some LDAP related exception
      * @throws IOException If we had some issue during some IO operations
      */
@@ -1111,6 +1111,8 @@ public class LdifAnonymizer
      *
      * @param args Contains the arguments : the file to convert. The anonymized 
      * LDIF will be printed on stdout
+     * @throws IOException If we had an issue opening the file to anonymise ot writing the result
+     * @throws LdapException If we had some issue while processing the LDAP data
      */
     public static void main( String[] args ) throws IOException, LdapException
     {

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/search/FilterBuilder.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/search/FilterBuilder.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/search/FilterBuilder.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/search/FilterBuilder.java Fri Sep  2 14:23:38 2016
@@ -61,7 +61,7 @@ public class FilterBuilder
 
 
     /**
-     * Returns a new FilterBuilder that will <code>&</code> together all of the 
+     * Returns a new FilterBuilder that will <code>&amp;</code> together all of the 
      * supplied filters.  For example:
      * 
      * <pre>
@@ -69,7 +69,7 @@ public class FilterBuilder
      * </pre>
      * would result in the string:
      * <pre>
-     * (&(givenName=kermit)(sn=the frog))
+     * (&amp;(givenName=kermit)(sn=the frog))
      * </pre>
      * 
      * Which would match all entries with a given name of <code>kermit</code>
@@ -126,7 +126,7 @@ public class FilterBuilder
      * </pre>
      * would result in the string:
      * <pre>
-     * (cn>=Kermit The Frog)
+     * (cn&gt;=Kermit The Frog)
      * </pre>
      * 
      * Which would match entries with the common name 
@@ -203,7 +203,7 @@ public class FilterBuilder
      * </pre>
      * would result in the string:
      * <pre>
-     * (sn>=n)
+     * (sn&gt;=n)
      * </pre>
      * 
      * which would match results whose surname starts with the second half of
@@ -228,7 +228,7 @@ public class FilterBuilder
      * </pre>
      * would result in the string:
      * <pre>
-     * (sn<=mzzzzzz)
+     * (sn&lt;=mzzzzzz)
      * </pre>
      * 
      * which would match results whose surname starts with the first half of
@@ -321,7 +321,7 @@ public class FilterBuilder
 
 
     /**
-     * Returns a new FilterBuilder that will construct a SubString filter, with an <em>initial</em part, 
+     * Returns a new FilterBuilder that will construct a SubString filter, with an <em>initial</em> part, 
      * and zero to N <em>any</em> part, but no <em>final</em> part.  
      * 
      * For instance:
@@ -338,7 +338,7 @@ public class FilterBuilder
      * having a <code>Soft</code> and <code>Foun</code> strings in the middle, like 
      * 'The Apache Software Foundation'.
      *
-     * @param builders The filters to or together
+     * @param attribute The attribute to use in the filter
      * @param parts The sub elements to use in the filter
      * @return A new FilterBuilder
      */
@@ -354,13 +354,13 @@ public class FilterBuilder
 
 
     /**
-     * Returns a new FilterBuilder that will construct a SubString filter, with an <em>initial</em part, 
+     * Returns a new FilterBuilder that will construct a SubString filter, with an <em>initial</em> part, 
      * and zero to N <em>any</em> parts, but no <em>final</em> part.  
      * 
      * For instance:
      * 
      * <pre>
-     * startswith( "sn", "Th", "Soft", "Foun" )).toString()
+     * startswith( "sn", "Th", "Soft", "Foun" ).toString()
      * </pre>
      * would result in the string:
      * <pre>
@@ -371,7 +371,7 @@ public class FilterBuilder
      * having a <code>Soft</code> and <code>Foun</code> strings in the middle, like 
      * 'The Apache Software Foundation'.
      *
-     * @param builders The filters to or together
+     * @param attribute The attribute to use in the filter
      * @param parts The sub elements to use in the filter
      * @return A new FilterBuilder
      */
@@ -404,7 +404,7 @@ public class FilterBuilder
      * and <code>Foun</code> strings in the middle, like 
      * 'The Apache Software Foundation'.
      *
-     * @param builders The filters to or together
+     * @param attribute The attribute to use in the filter
      * @param parts The sub elements to use in the filter
      * @return A new FilterBuilder
      */
@@ -447,7 +447,7 @@ public class FilterBuilder
      * (sn=The*ion)
      * </pre>
      * 
-     * @param builders The filters to or together
+     * @param attribute The attribute to use in the filter
      * @param parts The sub elements to use in the filter
      * @return A new FilterBuilder
      */

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/AbstractPasswordPolicyResponder.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/AbstractPasswordPolicyResponder.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/AbstractPasswordPolicyResponder.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/AbstractPasswordPolicyResponder.java Fri Sep  2 14:23:38 2016
@@ -57,8 +57,8 @@ public abstract class AbstractPasswordPo
      * <code>PasswordException</code> to be thrown when 
      * {@link #process(PasswordPolicyOperation)} fails.
      * 
-     * @param e
-     * @return
+     * @param e The exception to set
+     * @return The created PasswordException
      */
     protected PasswordException exception( LdapException e )
     {
@@ -70,10 +70,10 @@ public abstract class AbstractPasswordPo
      * Returns an exception to be thrown in the case of a non SUCCESS 
      * <code>resultCode</code>.
      * 
-     * @param resultResponse
-     * @param passwordPolicy
-     * @param resultCode
-     * @return
+     * @param resultResponse The result response
+     * @param passwordPolicy The password policy in use
+     * @param resultCode The result
+     * @return The created PasswordException
      */
     protected PasswordException fail( ResultResponse resultResponse, 
             PasswordPolicy passwordPolicy, ResultCodeEnum resultCode )
@@ -127,8 +127,8 @@ public abstract class AbstractPasswordPo
      * Returns a <code>PasswordWarning</code>, or <code>null</code> if no 
      * warnings were present in the supplied <code>passwordPolicy</code>.
      * 
-     * @param passwordPolicy
-     * @return
+     * @param passwordPolicy The PasswordPolicy in use
+     * @return The created PasswordWarning
      */
     protected PasswordWarning success( PasswordPolicy passwordPolicy ) 
     {

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/EntryMapper.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/EntryMapper.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/EntryMapper.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/EntryMapper.java Fri Sep  2 14:23:38 2016
@@ -27,6 +27,7 @@ import org.apache.directory.api.ldap.mod
 /**
  * A callback for processing entries from a search result.
  * 
+ * @param <T> The type of the mapped entry
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */
 public interface EntryMapper<T>

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/LdapConnectionOperations.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/LdapConnectionOperations.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/LdapConnectionOperations.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/LdapConnectionOperations.java Fri Sep  2 14:23:38 2016
@@ -86,14 +86,14 @@ public interface LdapConnectionOperation
      * checked for warnings, and if present, a PasswordWarning is returned.
      * Otherwise, null is returned.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param password
-     * @return
-     * @throws PasswordException
-     * @see {@link #authenticate(Dn, char[])}
-     * @see {@link #searchFirst(String, String, SearchScope, EntryMapper)}
+     * @param baseDn The base DN from which to start the search for the user to authenticate
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param password The password
+     * @return A PasswordWarning or null
+     * @throws PasswordException If the authentication failed
+     * @see #authenticate(Dn, char[])
+     * @see #searchFirst(String, String, SearchScope, EntryMapper)
      */
     PasswordWarning authenticate( String baseDn, String filter, SearchScope scope, char[] password )
         throws PasswordException;
@@ -106,14 +106,14 @@ public interface LdapConnectionOperation
      * checked for warnings, and if present, a PasswordWarning is returned.
      * Otherwise, null is returned.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param password
-     * @return
-     * @throws PasswordException
-     * @see {@link #authenticate(Dn, char[])}
-     * @see {@link #searchFirst(Dn, String, SearchScope, EntryMapper)}
+     * @param baseDn The base DN from which to start the search for the user to authenticate
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param password The password
+     * @return A PasswordWarning or null
+     * @throws PasswordException If the authentication failed
+     * @see #authenticate(Dn, char[])
+     * @see #searchFirst(Dn, String, SearchScope, EntryMapper)
      */
     PasswordWarning authenticate( Dn baseDn, String filter, SearchScope scope, char[] password )
         throws PasswordException;
@@ -126,14 +126,12 @@ public interface LdapConnectionOperation
      * checked for warnings, and if present, a PasswordWarning is returned.
      * Otherwise, null is returned.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param password
-     * @return
-     * @throws PasswordException
-     * @see {@link #authenticate(Dn, char[])}
-     * @see {@link #searchFirst(SearchRequest, EntryMapper)}
+     * @param searchRequest The SearchRequst to use to find the user to authenticate
+     * @param password The password
+     * @return A PasswordWarning or null
+     * @throws PasswordException If the authentication failed
+     * @see #authenticate(Dn, char[])
+     * @see #searchFirst(SearchRequest, EntryMapper)
      */
     PasswordWarning authenticate( SearchRequest searchRequest, char[] password ) throws PasswordException;
 
@@ -186,6 +184,7 @@ public interface LdapConnectionOperation
      * connection.
      *
      * @param connectionCallback The callback
+     * @param <T> The type of the mapped entry
      * @return Whatever the callback returns
      */
     <T> T execute( ConnectionCallback<T> connectionCallback );
@@ -197,6 +196,7 @@ public interface LdapConnectionOperation
      *
      * @param dn The distinguished name of the entry
      * @param entryMapper The mapper from entry to model object
+     * @param <T> The type of the mapped entry
      * @return Whatever the <code>entryMapper</code> returns
      */
     <T> T lookup( Dn dn, EntryMapper<T> entryMapper );
@@ -209,6 +209,7 @@ public interface LdapConnectionOperation
      * @param dn The distinguished name of the entry
      * @param attributes The attributes to be fetched
      * @param entryMapper The mapper from entry to model object
+     * @param <T> The type of the mapped entry
      * @return Whatever the <code>entryMapper</code> returns
      */
     <T> T lookup( Dn dn, String[] attributes, EntryMapper<T> entryMapper );
@@ -218,10 +219,10 @@ public interface LdapConnectionOperation
      * Modifies the password for <code>userDn</code> to
      * <code>newPassword</code> using the admin account.
      *
-     * @param userDn
-     * @param newPassword
-     * @throws PasswordException
-     * @see {@link #modifyPassword(Dn, char[], char[], boolean)}
+     * @param userDn The DN of the entry we want to modify the pwassword for
+     * @param newPassword The new password
+     * @throws PasswordException If the password change failed
+     * @see #modifyPassword(Dn, char[], char[], boolean)
      */
     void modifyPassword( Dn userDn, char[] newPassword )
         throws PasswordException;
@@ -231,11 +232,11 @@ public interface LdapConnectionOperation
      * Modifies the password for <code>userDn</code> from 
      * <code>oldPassword</code> to <code>newPassword</code>.
      *
-     * @param userDn
-     * @param oldPassword
-     * @param newPassword
-     * @throws PasswordException
-     * @see {@link #modifyPassword(Dn, char[], char[], boolean)}
+     * @param userDn The DN of the entry we want to modify the pwassword for
+     * @param oldPassword The old password
+     * @param newPassword The new password
+     * @throws PasswordException If the password change failed
+     * @see #modifyPassword(Dn, char[], char[], boolean)
      */
     void modifyPassword( Dn userDn, char[] oldPassword,
         char[] newPassword ) throws PasswordException;
@@ -280,17 +281,16 @@ public interface LdapConnectionOperation
 
     /**
      * Checks the supplied response for its result code, and if not 
-     * {@link ResultCodeEnum#SUCCESS}, an exception is thrown. This method is 
-     * intened to be used inline:
+     * ResultCodeEnum#SUCCESS, an exception is thrown. This method is 
+     * intended to be used inline:
      * 
      * <pre>
      * template.responseOrException( template.delete( dn ) );
      * </pre>
      *
      * @param response The response to check for success
+     * @param <T> The type of response
      * @return The supplied <code>response</code>
-     * @throws LdapRequestUnsuccessfulException If the response is not
-     * {@link ResultCodeEnum#SUCCESS}
      */
     <T extends ResultResponse> T responseOrException( T response );
 
@@ -299,12 +299,13 @@ public interface LdapConnectionOperation
      * Searches for the entries matching the supplied criteria, feeding the 
      * result into the <code>entryMapper</code>.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #search(SearchRequest, EntryMapper)}
+     * @see #search(SearchRequest, EntryMapper)
      */
     <T> List<T> search( String baseDn, FilterBuilder filter, SearchScope scope,
         EntryMapper<T> entryMapper );
@@ -314,12 +315,13 @@ public interface LdapConnectionOperation
      * Searches for the entries matching the supplied criteria, feeding the 
      * result into the <code>entryMapper</code>.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #search(SearchRequest, EntryMapper)}
+     * @see #search(SearchRequest, EntryMapper)
      */
     <T> List<T> search( String baseDn, String filter, SearchScope scope,
         EntryMapper<T> entryMapper );
@@ -329,12 +331,13 @@ public interface LdapConnectionOperation
      * Searches for the entries matching the supplied criteria, feeding the 
      * result into the <code>entryMapper</code>.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #search(SearchRequest, EntryMapper)}
+     * @see #search(SearchRequest, EntryMapper)
      */
     <T> List<T> search( Dn baseDn, FilterBuilder filter, SearchScope scope,
         EntryMapper<T> entryMapper );
@@ -344,12 +347,13 @@ public interface LdapConnectionOperation
      * Searches for the entries matching the supplied criteria, feeding the 
      * result into the <code>entryMapper</code>.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #search(SearchRequest, EntryMapper)}
+     * @see #search(SearchRequest, EntryMapper)
      */
     <T> List<T> search( Dn baseDn, String filter, SearchScope scope,
         EntryMapper<T> entryMapper );
@@ -360,13 +364,14 @@ public interface LdapConnectionOperation
      * result into the <code>entryMapper</code>, querying only the requested 
      * attributes.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #search(SearchRequest, EntryMapper)}
+     * @see #search(SearchRequest, EntryMapper)
      */
     <T> List<T> search( String baseDn, FilterBuilder filter, SearchScope scope,
         String[] attributes, EntryMapper<T> entryMapper );
@@ -377,13 +382,14 @@ public interface LdapConnectionOperation
      * result into the <code>entryMapper</code>, querying only the requested 
      * attributes.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #search(SearchRequest, EntryMapper)}
+     * @see #search(SearchRequest, EntryMapper)
      */
     <T> List<T> search( String baseDn, String filter, SearchScope scope,
         String[] attributes, EntryMapper<T> entryMapper );
@@ -394,13 +400,14 @@ public interface LdapConnectionOperation
      * result into the <code>entryMapper</code>, querying only the requested 
      * attributes.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #search(SearchRequest, EntryMapper)}
+     * @see #search(SearchRequest, EntryMapper)
      */
     <T> List<T> search( Dn baseDn, FilterBuilder filter, SearchScope scope,
         String[] attributes, EntryMapper<T> entryMapper );
@@ -411,13 +418,14 @@ public interface LdapConnectionOperation
      * result into the <code>entryMapper</code>, querying only the requested 
      * attributes.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #search(SearchRequest, EntryMapper)}
+     * @see #search(SearchRequest, EntryMapper)
      */
     <T> List<T> search( Dn baseDn, String filter, SearchScope scope,
         String[] attributes, EntryMapper<T> entryMapper );
@@ -430,6 +438,7 @@ public interface LdapConnectionOperation
      *
      * @param searchRequest The search request
      * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
      */
     <T> List<T> search( SearchRequest searchRequest,
@@ -440,12 +449,13 @@ public interface LdapConnectionOperation
      * Searches for the first entry matching the supplied criteria, feeding the 
      * result into the <code>entryMapper</code>.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #searchFirst(SearchRequest, EntryMapper)}
+     * @see #searchFirst(SearchRequest, EntryMapper)
      */
     <T> T searchFirst( String baseDn, FilterBuilder filter, SearchScope scope,
         EntryMapper<T> entryMapper );
@@ -455,12 +465,13 @@ public interface LdapConnectionOperation
      * Searches for the first entry matching the supplied criteria, feeding the 
      * result into the <code>entryMapper</code>.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #searchFirst(SearchRequest, EntryMapper)}
+     * @see #searchFirst(SearchRequest, EntryMapper)
      */
     <T> T searchFirst( String baseDn, String filter, SearchScope scope,
         EntryMapper<T> entryMapper );
@@ -470,12 +481,13 @@ public interface LdapConnectionOperation
      * Searches for the first entry matching the supplied criteria, feeding the 
      * result into the <code>entryMapper</code>.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #searchFirst(SearchRequest, EntryMapper)}
+     * @see #searchFirst(SearchRequest, EntryMapper)
      */
     <T> T searchFirst( Dn baseDn, FilterBuilder filter, SearchScope scope,
         EntryMapper<T> entryMapper );
@@ -485,12 +497,13 @@ public interface LdapConnectionOperation
      * Searches for the first entry matching the supplied criteria, feeding the 
      * result into the <code>entryMapper</code>.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #searchFirst(SearchRequest, EntryMapper)}
+     * @see #searchFirst(SearchRequest, EntryMapper)
      */
     <T> T searchFirst( Dn baseDn, String filter, SearchScope scope,
         EntryMapper<T> entryMapper );
@@ -501,13 +514,14 @@ public interface LdapConnectionOperation
      * result into the <code>entryMapper</code>, querying only the requested 
      * attributes.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #searchFirst(SearchRequest, EntryMapper)}
+     * @see #searchFirst(SearchRequest, EntryMapper)
      */
     <T> T searchFirst( String baseDn, FilterBuilder filter, SearchScope scope,
         String[] attributes, EntryMapper<T> entryMapper );
@@ -518,13 +532,14 @@ public interface LdapConnectionOperation
      * result into the <code>entryMapper</code>, querying only the requested 
      * attributes.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #searchFirst(SearchRequest, EntryMapper)}
+     * @see #searchFirst(SearchRequest, EntryMapper)
      */
     <T> T searchFirst( String baseDn, String filter, SearchScope scope,
         String[] attributes, EntryMapper<T> entryMapper );
@@ -535,13 +550,14 @@ public interface LdapConnectionOperation
      * result into the <code>entryMapper</code>, querying only the requested 
      * attributes.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #searchFirst(SearchRequest, EntryMapper)}
+     * @see #searchFirst(SearchRequest, EntryMapper)
      */
     <T> T searchFirst( Dn baseDn, FilterBuilder filter, SearchScope scope,
         String[] attributes, EntryMapper<T> entryMapper );
@@ -552,13 +568,14 @@ public interface LdapConnectionOperation
      * result into the <code>entryMapper</code>, querying only the requested 
      * attributes.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @param entryMapper
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entries
-     * @see {@link #searchFirst(SearchRequest, EntryMapper)}
+     * @see #searchFirst(SearchRequest, EntryMapper)
      */
     <T> T searchFirst( Dn baseDn, String filter, SearchScope scope,
         String[] attributes, EntryMapper<T> entryMapper );
@@ -575,6 +592,7 @@ public interface LdapConnectionOperation
      *
      * @param searchRequest The search request
      * @param entryMapper The mapper
+     * @param <T> The type of the mapped entry
      * @return The mapped entry
      */
     <T> T searchFirst( SearchRequest searchRequest,

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/ModelFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/ModelFactory.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/ModelFactory.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/ModelFactory.java Fri Sep  2 14:23:38 2016
@@ -42,8 +42,8 @@ public interface ModelFactory
     /**
      * Returns a new <code>AddRequest</code> for the <code>entry</code>.
      *
-     * @param entry
-     * @return
+     * @param entry The Entry to add
+     * @return The resulting AddRequest
      */
     AddRequest newAddRequest( Entry entry );
 
@@ -53,8 +53,8 @@ public interface ModelFactory
      * a null value.  This is useful for clearing out an Attribute with a
      * ModifyRequest, replace function.
      *
-     * @param name
-     * @return
+     * @param name The attribute's name
+     * @return The resulting Attribute
      */
     Attribute newAttribute( String name );
 
@@ -63,9 +63,9 @@ public interface ModelFactory
      * Returns a new Attribute for with the provided <code>name</code> and
      * <code>value(s)</code>.
      *
-     * @param name
-     * @param values
-     * @return
+     * @param name The attribute's name
+     * @param values The attribute's values
+     * @return The resulting Attribute
      */
     Attribute newAttribute( String name, byte[]... values );
 
@@ -74,9 +74,9 @@ public interface ModelFactory
      * Returns a new Attribute for with the provided <code>name</code> and
      * <code>value(s)</code>.
      *
-     * @param name
-     * @param values
-     * @return
+     * @param name The attribute's name
+     * @param values The attribute's values
+     * @return The resulting Attribute
      */
     Attribute newAttribute( String name, String... values );
 
@@ -85,9 +85,9 @@ public interface ModelFactory
      * Returns a new Attribute for with the provided <code>name</code> and
      * <code>value(s)</code>.
      *
-     * @param name
-     * @param values
-     * @return
+     * @param name The attribute's name
+     * @param values The attribute's values
+     * @return The resulting Attribute
      */
     Attribute newAttribute( String name, Value<?>... values );
 
@@ -95,8 +95,8 @@ public interface ModelFactory
     /**
      * Returns a new <code>DeleteRequest</code> for the <code>dn</code>.
      *
-     * @param dn
-     * @return
+     * @param dn The Dn for the Entry to delete
+     * @return The resulting DeleteRequest
      */
     DeleteRequest newDeleteRequest( Dn dn );
 
@@ -104,8 +104,8 @@ public interface ModelFactory
     /**
      * Returns a <code>Dn</code> that represents <code>dn</code>.
      *
-     * @param dn
-     * @return
+     * @param dn The Entry's Dn
+     * @return The resulting Dn
      */
     Dn newDn( String dn );
 
@@ -113,8 +113,8 @@ public interface ModelFactory
     /**
      * Returns a <code>Entry</code> with the specified <code>dn</code>.
      *
-     * @param dn
-     * @return
+     * @param dn The Entry's Dn
+     * @return The resulting Entry
      */
     Entry newEntry( String dn );
 
@@ -122,8 +122,8 @@ public interface ModelFactory
     /**
      * Returns a <code>Entry</code> with the specified <code>dn</code>.
      *
-     * @param dn
-     * @return
+     * @param dn The Entry's Dn
+     * @return The resulting Entry
      */
     Entry newEntry( Dn dn );
 
@@ -131,8 +131,8 @@ public interface ModelFactory
     /**
      * Returns a new <code>ModifyRequest</code> for the <code>dn</code>.
      *
-     * @param dn 
-     * @return
+     * @param dn  The Dn of the entry to modify
+     * @return The resulting ModifyRequest
      */
     ModifyRequest newModifyRequest( String dn );
 
@@ -140,8 +140,8 @@ public interface ModelFactory
     /**
      * Returns a new <code>ModifyRequest</code> for the <code>dn</code>.
      *
-     * @param dn
-     * @return
+     * @param dn The DN of the entry to modify
+     * @return The resulting ModifyRequest
      */
     ModifyRequest newModifyRequest( Dn dn );
 
@@ -151,10 +151,10 @@ public interface ModelFactory
      * <code>scope</code> matching <code>filter</code> returning 
      * all normal attributes for each matching entry.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @return
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @return The resulting SearchRequest
      */
     SearchRequest newSearchRequest( String baseDn, FilterBuilder filter,
         SearchScope scope );
@@ -165,10 +165,10 @@ public interface ModelFactory
      * <code>scope</code> matching <code>filter</code> returning 
      * all normal attributes for each matching entry.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @return
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @return The resulting SearchRequest
      */
     SearchRequest newSearchRequest( String baseDn, String filter,
         SearchScope scope );
@@ -179,10 +179,10 @@ public interface ModelFactory
      * <code>scope</code> matching <code>filter</code> returning 
      * all normal attributes for each matching entry.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @return
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @return The resulting SearchRequest
      */
     SearchRequest newSearchRequest( Dn baseDn, String filter,
         SearchScope scope );
@@ -193,10 +193,10 @@ public interface ModelFactory
      * <code>scope</code> matching <code>filter</code> returning 
      * all normal attributes for each matching entry.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @return
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @return The resulting SearchRequest
      */
     SearchRequest newSearchRequest( Dn baseDn, FilterBuilder filter,
         SearchScope scope );
@@ -207,11 +207,11 @@ public interface ModelFactory
      * <code>scope</code> matching <code>filter</code> returning 
      * <code>attributes</code> for each matching entry.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @return
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @return The resulting SearchRequest
      */
     SearchRequest newSearchRequest( String baseDn, String filter,
         SearchScope scope, String... attributes );
@@ -222,11 +222,11 @@ public interface ModelFactory
      * <code>scope</code> matching <code>filter</code> returning 
      * <code>attributes</code> for each matching entry.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @return
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @return The resulting SearchRequest
      */
     SearchRequest newSearchRequest( String baseDn, FilterBuilder filter,
         SearchScope scope, String... attributes );
@@ -237,11 +237,11 @@ public interface ModelFactory
      * <code>scope</code> matching <code>filter</code> returning 
      * <code>attributes</code> for each matching entry.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @return
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @return The resulting SearchRequest
      */
     SearchRequest newSearchRequest( Dn baseDn, String filter,
         SearchScope scope, String... attributes );
@@ -252,11 +252,11 @@ public interface ModelFactory
      * <code>scope</code> matching <code>filter</code> returning 
      * <code>attributes</code> for each matching entry.
      *
-     * @param baseDn
-     * @param filter
-     * @param scope
-     * @param attributes
-     * @return
+     * @param baseDn The base DN from which to start the search
+     * @param filter The filter selecting the entries
+     * @param scope The scope to look from
+     * @param attributes The list of AttributeType to return
+     * @return The resulting SearchRequest
      */
     SearchRequest newSearchRequest( Dn baseDn, FilterBuilder filter,
         SearchScope scope, String... attributes );

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/PasswordException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/PasswordException.java?rev=1758963&r1=1758962&r2=1758963&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/PasswordException.java (original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/PasswordException.java Fri Sep  2 14:23:38 2016
@@ -27,7 +27,7 @@ import org.apache.directory.api.ldap.mod
 
 /**
  * Thrown when an attempt to bind or modify a userPassword fails when using
- * {@link LdapConnectionTemplate}.
+ * LdapConnectionTemplate.
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */



Mime
View raw message