directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lucasthei...@apache.org
Subject svn commit: r1561204 - /directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyResponse.java
Date Fri, 24 Jan 2014 21:48:03 GMT
Author: lucastheisen
Date: Fri Jan 24 21:48:03 2014
New Revision: 1561204

URL: http://svn.apache.org/r1561204
Log:
DIRAPI-169: Formalize the contract of PasswordPolicyResponse by stating that -1 is returned
if no value is set.

Modified:
    directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyResponse.java

Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyResponse.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyResponse.java?rev=1561204&r1=1561203&r2=1561204&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyResponse.java
(original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyResponse.java
Fri Jan 24 21:48:03 2014
@@ -21,8 +21,8 @@ package org.apache.directory.api.ldap.ex
 
 
 /**
- * The PasswordPolciy reponse. It contains information about the error if we
- * had one when injecting a bad passsword into the server.
+ * The PasswordPolicy response. It contains information about the error if we
+ * had one when injecting a bad password into the server.
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$, $Date$
@@ -30,40 +30,52 @@ package org.apache.directory.api.ldap.ex
 public interface PasswordPolicyResponse
 {
     /**
-     * @return The  time before expiration of the password
+     * Returns the time before expiration.  Will return -1 if this warning 
+     * was not present in the response.
+     * 
+     * @return The time before expiration of the password, or -1 if not set
      */
     int getTimeBeforeExpiration();
 
 
     /**
-     * Set a date of expiration for the password
+     * Set a date of expiration for the password.
+     * 
      * @param timeBeforeExpiration The time before the password will expire
      */
     void setTimeBeforeExpiration( int timeBeforeExpiration );
 
 
     /**
+     * Returns the number of possible attempts on the password before it's 
+     * locked.  Will return -1 if this warning was not present in the 
+     * response.
+     * 
      * @return The number of possible attempts on the password before it's locked
      */
     int getGraceAuthNRemaining();
 
 
     /**
-     * Sets the number of remaining wrong authentication for this password
+     * Sets the number of remaining wrong authentication for this password.
+     * 
      * @param graceAuthNRemaining The number of remaining attempts
      */
     void setGraceAuthNRemaining( int graceAuthNRemaining );
 
 
     /**
-     * @return The PasswordPolicy error number
+     * Returns the password policy error.
+     * 
+     * @return The PasswordPolicyErrorEnum representing the error
      */
     PasswordPolicyErrorEnum getPasswordPolicyError();
 
 
     /**
-     * Sets the PasswordPolicy error number
-     * @param ppolicyError The error number
+     * Sets the PasswordPolicy error.
+     * 
+     * @param ppolicyError The PasswordPolicyErrorEnum representing the error
      */
     void setPasswordPolicyError( PasswordPolicyErrorEnum ppolicyError );
 }
\ No newline at end of file



Mime
View raw message