directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject [directory-ldap-api] 02/02: Fixed javadoc
Date Wed, 06 Nov 2019 08:23:58 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-ldap-api.git

commit aae4e170f5dbe5b35ed6a9f8abfd28f9357d8135
Author: emmanuel lecharny <emmanuel.lecharny@busit.com>
AuthorDate: Wed Nov 6 09:23:39 2019 +0100

    Fixed javadoc
---
 .../directory/ldap/client/api/LdapNetworkConnection.java      | 11 ++++++++++-
 .../api/ldap/model/message/OpaqueExtendedRequest.java         |  1 +
 .../directory/api/ldap/model/password/PasswordUtil.java       |  1 +
 .../main/java/org/apache/directory/api/util/DateUtils.java    |  4 ++--
 4 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
index 6393f50..10efcb9 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
@@ -654,8 +654,11 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
     
     /**
      * Process the connect. 
+     * 
+     * @exception LdapException If we weren't able to connect
+     * @return A Future that can be used to check the status of the connection
      */
-    private ConnectFuture tryConnect() throws LdapException
+    public ConnectFuture tryConnect() throws LdapException
     {
         // Build the connection address
         SocketAddress address = new InetSocketAddress( config.getLdapHost(), config.getLdapPort()
);
@@ -728,6 +731,8 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
     
     /**
      * Close the connection and generate the appropriate exception
+     * 
+     * @exception LdapException If we weren't able to close the connection
      */
     private void close( ConnectFuture connectionFuture ) throws LdapException
     {
@@ -761,6 +766,8 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
     
     /**
      * Verify that the connection has been secured, otherwise throw a meaningful exception
+     * 
+     * @exception LdapException If we weren't able to check that the connection is secured
      */
     private void checkSecured( ConnectFuture connectionFuture ) throws LdapException
     {
@@ -806,6 +813,8 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
     
     /**
      * Set a listener associated to the closeFuture
+     * 
+     * @param connectionFuture A Future for which we want to set a listener
      */
     private void setCloseListener( ConnectFuture connectionFuture )
     {
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/OpaqueExtendedRequest.java
b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/OpaqueExtendedRequest.java
index 63cdea7..988839b 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/OpaqueExtendedRequest.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/OpaqueExtendedRequest.java
@@ -82,6 +82,7 @@ public class OpaqueExtendedRequest extends AbstractRequest implements ExtendedRe
      * Creates an ExtendedRequest implementing object used to perform
      * extended protocol operation on the server.
      * 
+     * @param requestName The extended request OID
      * @param requestValue the embedded value
      */
     public OpaqueExtendedRequest( String requestName, byte[] requestValue )
diff --git a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/PasswordUtil.java
b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/PasswordUtil.java
index c823062..d4739db 100644
--- a/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/PasswordUtil.java
+++ b/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/PasswordUtil.java
@@ -606,6 +606,7 @@ public final class PasswordUtil
      *
      * @param pwdChangedZtime time when the password was last changed
      * @param pwdMaxAgeSec the max age value in seconds
+     * @param timeProvider The TimeProvider instance to use
      * @return true if expired, false otherwise
      */
     public static boolean isPwdExpired( String pwdChangedZtime, int pwdMaxAgeSec, TimeProvider
timeProvider )
diff --git a/util/src/main/java/org/apache/directory/api/util/DateUtils.java b/util/src/main/java/org/apache/directory/api/util/DateUtils.java
index ad70f1c..85b9b10 100644
--- a/util/src/main/java/org/apache/directory/api/util/DateUtils.java
+++ b/util/src/main/java/org/apache/directory/api/util/DateUtils.java
@@ -73,7 +73,7 @@ public final class DateUtils
 
     /**
      * 
-     * @see #getGeneralizedTime()
+     * @see DateUtils#getGeneralizedTime(TimeProvider)
      *
      * @param date the date to be converted to generalized time string
      * @return given date in the generalized time string format
@@ -86,7 +86,7 @@ public final class DateUtils
 
     /**
      * 
-     * @see #getGeneralizedTime()
+     * @see DateUtils#getGeneralizedTime(TimeProvider)
      *
      * @param time the time value to be converted to generalized time string
      * @return given time in generalized time string format


Mime
View raw message