directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1765013 - in /directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api: LdapConnection.java LdapConnectionWrapper.java LdapNetworkConnection.java future/ResponseFuture.java
Date Sat, 15 Oct 2016 06:21:59 GMT
Author: elecharny
Date: Sat Oct 15 06:21:58 2016
New Revision: 1765013

URL: http://svn.apache.org/viewvc?rev=1765013&view=rev
Log:
Fixed some TODOs

Modified:
    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/LdapConnectionWrapper.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/future/ResponseFuture.java

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=1765013&r1=1765012&r2=1765013&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
Sat Oct 15 06:21:58 2016
@@ -59,9 +59,7 @@ import org.apache.directory.api.ldap.mod
 
 // TODO: all the SASL bind methods are not declared in this interface, but implemented in
LdapNetworkConnection. Is that intended?
 // TODO: why does connect() return a boolean? What is the difference between false and an
Exception?
-// TODO: think about usage of abbrevisions (Dn/Rdn) vs. spelled out (relative distinguished
name) in javadoc
 // TODO: describe better which type of LdapException are thrown in which case?
-// TODO: remove the "we" language in javadoc
 // TODO: does method getCodecService() belong into the interface? It returns a LdapApiService,
should it be renamed?
 // TODO: does method doesFutureExistFor() belong into the interface? Move to LdapAsyncConnection?
 
@@ -73,17 +71,17 @@ import org.apache.directory.api.ldap.mod
 public interface LdapConnection extends Closeable
 {
     /**
-     * Check if we are connected.
+     * Check if the connection is established
      *
-     * @return <code>true</code> if we are connected.
+     * @return <code>true</code> if the connection is established
      */
     boolean isConnected();
 
 
     /**
-     * Check if we are authenticated.
+     * Check if the connection is authenticated.
      *
-     * @return <code>true</code> if we are connected.
+     * @return <code>true</code> if the connection is authenticated
      */
     boolean isAuthenticated();
 
@@ -167,8 +165,8 @@ public interface LdapConnection extends
     /**
      * Unauthenticated authentication bind on a server.
      *
-     * @param name The name we use to authenticate the user. It must be a
-     * valid {@link Dn}
+     * @param name The name used to authenticate the user. It must be a
+     * valid distinguished name.
      * @throws LdapException if some error occurred
      */
     void bind( String name ) throws LdapException;
@@ -177,8 +175,8 @@ public interface LdapConnection extends
     /**
      * Simple bind on a server.
      *
-     * @param name The name we use to authenticate the user. It must be a
-     * valid {@link Dn}
+     * @param name The name used to authenticate the user. It must be a
+     * valid distinguished name.
      * @param credentials The password, it can't be <code>null</code>
      * @throws LdapException if some error occurred
      */
@@ -211,7 +209,7 @@ public interface LdapConnection extends
     /**
      * Unauthenticated authentication bind on a server.
      *
-     * @param name The name we use to authenticate the user.
+     * @param name The name used to authenticate the user.
      * @throws LdapException if some error occurred
      */
     void bind( Dn name ) throws LdapException;
@@ -220,7 +218,7 @@ public interface LdapConnection extends
     /**
      * Simple bind on a server.
      *
-     * @param name The name we use to authenticate the user.
+     * @param name The name used to authenticate the user.
      * @param credentials The password, it can't be null
      * @throws LdapException if some error occurred
      */
@@ -322,7 +320,7 @@ public interface LdapConnection extends
     /**
      * Applies all the modifications to the entry specified by its distinguished name.
      *
-     * @param dn The entry's distinguished name, it must be a valid {@link Dn}
+     * @param dn The entry's distinguished name, it must be a valid distinguished name.
      * @param modifications The list of modifications to be applied
      * @throws LdapException in case of modify operation failure or timeout happens
      */
@@ -351,10 +349,11 @@ public interface LdapConnection extends
 
 
     /**
-     * Renames the given entryDn with new Rdn and deletes the old Rdn.
+     * Renames the given entryDn with new relative distinguished name and deletes the 
+     * old relative distinguished name.
      *
-     * @param entryDn the target Dn
-     * @param newRdn new Rdn for the target Dn
+     * @param entryDn the target distinguished name.
+     * @param newRdn new relative distinguished name for the target distinguished name.
      * @throws LdapException if some error occurred
      * @see #rename(String, String, boolean)
      */
@@ -362,10 +361,11 @@ public interface LdapConnection extends
 
 
     /**
-     * Renames the given entryDn with new Rdn and deletes the old Rdn.
+     * Renames the given entryDn with new relative distinguished name and deletes the 
+     * old relative distinguished name.
      *
-     * @param entryDn the target Dn
-     * @param newRdn new Rdn for the target Dn
+     * @param entryDn the target distinguished name.
+     * @param newRdn new relative distinguished name for the target distinguished name.
      * @throws LdapException if some error occurred
      * @see #rename(Dn, Rdn, boolean)
      */
@@ -373,12 +373,12 @@ public interface LdapConnection extends
 
 
     /**
-     * Renames the given entryDn with new Rdn and deletes the old Rdn if
-     * deleteOldRdn is set to true.
+     * Renames the given entryDn with new relative distinguished name and deletes the 
+     * old relative distinguished name if deleteOldRdn is set to true.
      *
-     * @param entryDn the target Dn
-     * @param newRdn new Rdn for the target Dn
-     * @param deleteOldRdn flag to indicate whether to delete the old Rdn
+     * @param entryDn the target distinguished name.
+     * @param newRdn new relative distinguished name for the target distinguished name.
+     * @param deleteOldRdn flag to indicate whether to delete the old relative distinguished
name
      * @throws LdapException if some error occurred
      * @see #rename(Dn, Rdn, boolean)
      */
@@ -386,22 +386,22 @@ public interface LdapConnection extends
 
 
     /**
-     * Renames the given entryDn with new Rdn and deletes the old Rdn if
-     * deleteOldRdn is set to true.
+     * Renames the given entryDn with new relative distinguished name and deletes the 
+     * old relative distinguished name if deleteOldRdn is set to true.
      *
-     * @param entryDn the target Dn
-     * @param newRdn new Rdn for the target Dn
-     * @param deleteOldRdn flag to indicate whether to delete the old Rdn
+     * @param entryDn the target distinguished name.
+     * @param newRdn new relative distinguished name for the target distinguished name.
+     * @param deleteOldRdn flag to indicate whether to delete the old relative distinguished
name
      * @throws LdapException if some error occurred
      */
     void rename( Dn entryDn, Rdn newRdn, boolean deleteOldRdn ) throws LdapException;
 
 
     /**
-     * Moves the given entry Dn under the new superior Dn.
+     * Moves the given entry distinguished name under the new superior distinguished name.
      *
-     * @param entryDn the Dn of the target entry
-     * @param newSuperiorDn Dn of the new parent/superior
+     * @param entryDn the distinguished name of the target entry
+     * @param newSuperiorDn distinguished name of the new parent/superior
      * @throws LdapException if some error occurred
      * @see #move(Dn, Dn)
      */
@@ -409,20 +409,20 @@ public interface LdapConnection extends
 
 
     /**
-     * Moves the given entry Dn under the new superior Dn.
+     * Moves the given entry distinguished name under the new superior distinguished name.
      *
-     * @param entryDn the Dn of the target entry
-     * @param newSuperiorDn Dn of the new parent/superior
+     * @param entryDn the distinguished name of the target entry
+     * @param newSuperiorDn distinguished name of the new parent/superior
      * @throws LdapException if some error occurred
      */
     void move( Dn entryDn, Dn newSuperiorDn ) throws LdapException;
 
 
     /**
-     * Moves and renames the given entryDn. The old Rdn will be deleted.
+     * Moves and renames the given entryDn. The old relative distinguished name will be deleted.
      *
-     * @param entryDn The original entry Dn
-     * @param newDn The new entry Dn
+     * @param entryDn The original entry distinguished name.
+     * @param newDn The new entry distinguished name.
      * @throws LdapException if some error occurred
      * @see #moveAndRename(Dn, Dn, boolean)
      */
@@ -430,10 +430,11 @@ public interface LdapConnection extends
 
 
     /**
-     * Moves and renames the given entryDn.The old Rdn will be deleted
+     * Moves and renames the given entry distinguished name. The old relative 
+     * distinguished name will be deleted
      *
-     * @param entryDn The original entry Dn
-     * @param newDn The new entry Dn
+     * @param entryDn The original entry distinguished name.
+     * @param newDn The new entry distinguished name.
      * @throws LdapException if some error occurred
      * @see #moveAndRename(Dn, Dn, boolean)
      */
@@ -441,22 +442,22 @@ public interface LdapConnection extends
 
 
     /**
-     * Moves and renames the given entryDn. The old Rdn will be deleted if requested.
+     * Moves and renames the given entryDn. The old relative distinguished name will be deleted
if requested.
      *
-     * @param entryDn The original entry Dn
-     * @param newDn The new entry Dn
-     * @param deleteOldRdn Tells if the old Rdn must be removed
+     * @param entryDn The original entry distinguished name.
+     * @param newDn The new entry distinguished name.
+     * @param deleteOldRdn Tells if the old relative distinguished name must be removed
      * @throws LdapException if some error occurred
      */
     void moveAndRename( Dn entryDn, Dn newDn, boolean deleteOldRdn ) throws LdapException;
 
 
     /**
-     * Moves and renames the given entryDn. The old Rdn will be deleted if requested.
+     * Moves and renames the given entryDn. The old relative distinguished name will be deleted
if requested.
      *
-     * @param entryDn The original entry Dn
-     * @param newDn The new entry Dn
-     * @param deleteOldRdn Tells if the old Rdn must be removed
+     * @param entryDn The original entry distinguished name.
+     * @param newDn The new entry distinguished name.
+     * @param deleteOldRdn Tells if the old relative distinguished name must be removed
      * @throws LdapException if some error occurred
      */
     void moveAndRename( String entryDn, String newDn, boolean deleteOldRdn )
@@ -476,8 +477,8 @@ public interface LdapConnection extends
     /**
      * Deletes the entry with the given distinguished name.
      *
-     * @param dn the target entry's distinguished name, it must be a valid {@link Dn}
-     * @throws LdapException If the Dn is not valid or if the deletion failed
+     * @param dn the target entry's distinguished name, it must be a valid distinguished
name.
+     * @throws LdapException If the distinguished name is not valid or if the deletion failed
      */
     void delete( String dn ) throws LdapException;
 
@@ -486,7 +487,7 @@ public interface LdapConnection extends
      * Deletes the entry with the given distinguished name.
      *
      * @param dn the target entry's distinguished name
-     * @throws LdapException If the Dn is not valid or if the deletion failed
+     * @throws LdapException If the distinguished name is not valid or if the deletion failed
      */
     void delete( Dn dn ) throws LdapException;
 
@@ -496,7 +497,7 @@ public interface LdapConnection extends
      *
      * @param deleteRequest the delete operation's request
      * @return delete operation's response
-     * @throws LdapException If the Dn is not valid or if the deletion failed
+     * @throws LdapException If the distinguished name is not valid or if the deletion failed
      */
     DeleteResponse delete( DeleteRequest deleteRequest ) throws LdapException;
 
@@ -505,7 +506,7 @@ public interface LdapConnection extends
      * Compares whether a given attribute's value matches that of the
      * existing value of the attribute present in the entry with the given distinguished
name.
      *
-     * @param dn the target entry's distinguished name, it must be a valid {@link Dn}
+     * @param dn the target entry's distinguished name, it must be a valid distinguished
name.
      * @param attributeName the attribute's name
      * @param value a String 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
@@ -518,7 +519,7 @@ public interface LdapConnection extends
      * Compares whether a given attribute's value matches that of the
      * existing value of the attribute present in the entry with the given distinguished
name.
      *
-     * @param dn the target entry's distinguished name, it must be a valid {@link Dn}
+     * @param dn the target entry's distinguished name, it must be a valid distinguished
name.
      * @param attributeName the attribute's name
      * @param value a byte[] 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
@@ -531,7 +532,7 @@ public interface LdapConnection extends
      * Compares whether a given attribute's value matches that of the
      * existing value of the attribute present in the entry with the given distinguished
name.
      *
-     * @param dn the target entry's distinguished name, it must be a valid {@link Dn}
+     * @param dn the target entry's distinguished name, it must be a valid distinguished
name.
      * @param attributeName the attribute's name
      * @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
@@ -582,7 +583,8 @@ public interface LdapConnection extends
     /**
      * Compares an entry's attribute's value with that of the given value.
      *
-     * @param compareRequest the compare request which contains the target Dn, attribute
name and value
+     * @param compareRequest the compare request which contains the target distinguished
name, 
+     * attribute name and value
      * @return compare operation's response
      * @throws LdapException if some error occurred
      */
@@ -647,7 +649,7 @@ public interface LdapConnection extends
     /**
      * Tells if an entry exists in the server.
      * 
-     * @param dn The distinguished name of the entry we want to check the existence, must
be a valid {@link Dn}
+     * @param dn The distinguished name of the entry to check for existence, must be a valid
distinguished name.
      * @return <code>true</code> if the entry exists, <code>false</code>
otherwise.
      * Note that if the entry exists but if the user does not have the permission to
      * read it, <code>false</code> will also be returned
@@ -659,7 +661,7 @@ public interface LdapConnection extends
     /**
      * Tells if an Entry exists in the server.
      * 
-     * @param dn The distinguished name of the entry we want to check the existence
+     * @param dn The distinguished name of the entry to check for existence
      * @return <code>true</code> if the entry exists, <code>false</code>
otherwise.
      * Note that if the entry exists but if the user does not have the permission to
      * read it, <code>false</code> will also be returned
@@ -690,71 +692,81 @@ public interface LdapConnection extends
 
 
     /**
-     * Searches for an entry having the given Dn.
+     * Searches for an entry having the given distinguished name.
      *
-     * @param dn the Dn of the entry to be fetched
-     * @return the Entry with the given Dn or null if no entry exists with that Dn
-     * @throws LdapException in case of any problems while searching for the Dn or if the
returned response contains a referral
-     * @see #lookup(org.apache.directory.api.ldap.model.name.Dn, String...)
+     * @param dn the distinguished name of the entry to be fetched
+     * @return the Entry with the given distinguished name or null if no entry exists with
that distinguished name.
+     * @throws LdapException in case of any problems while searching for the distinguished
name or if the returned 
+     * response contains a referral
+     * @see #lookup(Dn, String...)
      */
     Entry lookup( Dn dn ) throws LdapException;
 
 
     /**
-     * Searches for an entry having the given Dn.
+     * Searches for an entry having the given distinguished name.
      *
-     * @param dn the Dn of the entry to be fetched
-     * @return the Entry with the given Dn or null if no entry exists with that Dn
-     * @throws LdapException in case of any problems while searching for the Dn or if the
returned response contains a referral
+     * @param dn the distinguished name of the entry to be fetched
+     * @return the Entry with the given distinguished name or null if no entry exists with
that distinguished name.
+     * @throws LdapException in case of any problems while searching for the distinguished
name or if the returned 
+     * response contains a referral
      * @see #lookup(String, String...)
      */
     Entry lookup( String dn ) throws LdapException;
 
 
     /**
-     * Searches for an entry having the given Dn.
+     * Searches for an entry having the given distinguished name.
      *
-     * @param dn the Dn of the entry to be fetched
+     * @param dn the distinguished name of the entry to be fetched
      * @param attributes the attributes to be returned along with entry
-     * @return the Entry with the given Dn or null if no entry exists with that Dn
-     * @throws LdapException in case of any problems while searching for the Dn or if the
returned response contains a referral
+     * @return the Entry with the given distinguished name or null if no entry exists with

+     * that distinguished name.
+     * @throws LdapException in case of any problems while searching for the distinguished
name 
+     * or if the returned response contains a referral
      */
     Entry lookup( Dn dn, String... attributes ) throws LdapException;
 
 
     /**
-     * Searches for an entry having the given Dn.
+     * Searches for an entry having the given distinguished name.
      *
-     * @param dn the Dn of the entry to be fetched
+     * @param dn the distinguished name of the entry to be fetched
      * @param controls the controls to use
      * @param attributes the attributes to be returned along with entry
-     * @return the Entry with the given Dn or null if no entry exists with that Dn
-     * @throws LdapException in case of any problems while searching for the Dn or if the
returned response contains a referral
+     * @return the Entry with the given distinguished name or null if no entry exists with
+     *  that distinguished name.
+     * @throws LdapException in case of any problems while searching for the distinguished
name
+     *  or if the returned response contains a referral
      */
     Entry lookup( Dn dn, Control[] controls, String... attributes ) throws LdapException;
 
 
     /**
-     * Searches for an entry having the given Dn.
+     * Searches for an entry having the given distinguished name.
      *
-     * @param dn the Dn of the entry to be fetched
+     * @param dn the distinguished name of the entry to be fetched
      * @param attributes the attributes to be returned along with entry
-     * @return the Entry with the given Dn or null if no entry exists with that Dn
-     * @throws LdapException in case of any problems while searching for the Dn or if the
returned response contains a referral
-     * @see #lookup(org.apache.directory.api.ldap.model.name.Dn, String...)
+     * @return the Entry with the given distinguished name or null if no entry exists with

+     * that distinguished name.
+     * @throws LdapException in case of any problems while searching for the distinguished
name
+     *  or if the returned response contains a referral
+     * @see #lookup(Dn, String...)
      */
     Entry lookup( String dn, String... attributes ) throws LdapException;
 
 
     /**
-     * Searches for an entry having the given Dn.
+     * Searches for an entry having the given distinguished name.
      *
-     * @param dn the Dn of the entry to be fetched
+     * @param dn the distinguished name of the entry to be fetched
      * @param controls the controls to use
      * @param attributes the attributes to be returned along with entry
-     * @return the Entry with the given Dn or null if no entry exists with that Dn
-     * @throws LdapException in case of any problems while searching for the Dn or if the
returned response contains a referral
-     * @see #lookup(org.apache.directory.api.ldap.model.name.Dn, String...)
+     * @return the Entry with the given distinguished name or null if no entry exists with

+     * that distinguished name.
+     * @throws LdapException in case of any problems while searching for the distinguished
name
+     *  or if the returned response contains a referral
+     * @see #lookup(Dn, String...)
      */
     Entry lookup( String dn, Control[] controls, String... attributes ) throws LdapException;
 
@@ -813,10 +825,20 @@ public interface LdapConnection extends
 
 
     /**
+     * Checks if a request has been completed, or not. 
+     *
+     * @param messageId ID of the request
+     * @return true if the request has been completed, false is still being processed
+     */
+    boolean isRequestCompleted( int messageId );
+
+
+    /**
      * Checks if there is a ResponseFuture associated with the given message ID.
      *
      * @param messageId ID of the request
      * @return true if there is a non-null future exists, false otherwise
+     * @deprecated Use {@link #isRequestCompleted(int)}
      */
     boolean doesFutureExistFor( int messageId );
 

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionWrapper.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionWrapper.java?rev=1765013&r1=1765012&r2=1765013&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionWrapper.java
(original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionWrapper.java
Sat Oct 15 06:21:58 2016
@@ -541,6 +541,13 @@ public class LdapConnectionWrapper imple
 
 
     @Override
+    public boolean isRequestCompleted( int messageId )
+    {
+        return connection.isRequestCompleted( messageId );
+    }
+
+
+    @Override
     public boolean doesFutureExistFor( int messageId )
     {
         return connection.doesFutureExistFor( messageId );

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=1765013&r1=1765012&r2=1765013&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
Sat Oct 15 06:21:58 2016
@@ -3763,6 +3763,17 @@ public class LdapNetworkConnection exten
 
 
     /**
+     * {@inheritDoc}
+     */
+    public boolean isRequestCompleted( int messageId )
+    {
+        ResponseFuture<?> responseFuture = futureMap.get( messageId );
+        
+        return responseFuture == null;
+    }
+
+
+    /**
      * Adds the connection closed event listener.
      *
      * @param ccListener the connection closed listener

Modified: directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java?rev=1765013&r1=1765012&r2=1765013&view=diff
==============================================================================
--- directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java
(original)
+++ directory/shared/trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java
Sat Oct 15 06:21:58 2016
@@ -84,7 +84,7 @@ public class ResponseFuture<R extends Re
         cancelled = true;
 
         // Send an abandonRequest only if this future exists
-        if ( connection.doesFutureExistFor( messageId ) )
+        if ( !connection.isRequestCompleted( messageId ) )
         {
             connection.abandon( messageId );
         }



Mime
View raw message