Class PasswordPolicyRequestControl

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class PasswordPolicyRequestControl
    extends Control
    This class provides an implementation of the password policy request control as described in draft-behera-ldap-password-policy. It may be used to request information related to a user's password policy. In the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server, this control may be included with add, bind, compare, modify, and password modify requests.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

    This request control has an OID of 1.3.6.1.4.1.42.2.27.8.5.1. The criticality may be either true or false. It does not have a value.

    The corresponding PasswordPolicyResponseControl may include at most one warning from the set of PasswordPolicyWarningType values and at most one error from the set of PasswordPolicyErrorType values. See the documentation for those classes for more information on the information that may be included.

    Example

    The following example demonstrates the use of the password policy request control in conjunction with a bind operation:
     SimpleBindRequest bindRequest = new SimpleBindRequest(
          "uid=john.doe,ou=People,dc=example,dc=com", "password",
          new PasswordPolicyRequestControl());
    
     BindResult bindResult;
     try
     {
       bindResult = connection.bind(bindRequest);
     }
     catch (LDAPException le)
     {
       // The bind failed.  There may be a password policy response control to
       // help tell us why.
       bindResult = new BindResult(le.toLDAPResult());
     }
    
     PasswordPolicyResponseControl pwpResponse =
          PasswordPolicyResponseControl.get(bindResult);
     if (pwpResponse != null)
     {
       PasswordPolicyErrorType errorType = pwpResponse.getErrorType();
       if (errorType != null)
       {
         // There was a password policy-related error.
       }
    
       PasswordPolicyWarningType warningType = pwpResponse.getWarningType();
       if (warningType != null)
       {
         // There was a password policy-related warning.
         int value = pwpResponse.getWarningValue();
         switch (warningType)
         {
           case TIME_BEFORE_EXPIRATION:
             // The warning value is the number of seconds until the user's
             // password expires.
             break;
           case GRACE_LOGINS_REMAINING:
             // The warning value is the number of grace logins remaining for
             // the user.
         }
       }
     }
     
    See Also:
    Serialized Form
    • Constructor Detail

      • PasswordPolicyRequestControl

        public PasswordPolicyRequestControl()
        Creates a new password policy request control. The control will not be marked critical.
      • PasswordPolicyRequestControl

        public PasswordPolicyRequestControl​(boolean isCritical)
        Creates a new password policy request control.
        Parameters:
        isCritical - Indicates whether the control should be marked critical.
      • PasswordPolicyRequestControl

        public PasswordPolicyRequestControl​(Control control)
                                     throws LDAPException
        Creates a new password policy request control which is decoded from the provided generic control.
        Parameters:
        control - The generic control to be decoded as a password policy request control.
        Throws:
        LDAPException - If the provided control cannot be decoded as a password policy request control.
    • Method Detail

      • getControlName

        public java.lang.String getControlName()
        Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.
        Overrides:
        getControlName in class Control
        Returns:
        The user-friendly name for this control, or the OID if no user-friendly name is available.
      • toString

        public void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of this LDAP control to the provided buffer.
        Overrides:
        toString in class Control
        Parameters:
        buffer - The buffer to which to append the string representation of this buffer.