com.unboundid.ldap.sdk.experimental

Class DraftBeheraLDAPPasswordPolicy10RequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.experimental.DraftBeheraLDAPPasswordPolicy10RequestControl

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class DraftBeheraLDAPPasswordPolicy10RequestControl
extends Control

This class provides an implementation of the password policy request control as described in draft-behera-ldap-password-policy-10. 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.

The corresponding DraftBeheraLDAPPasswordPolicy10ResponseControl may include at most one warning from the set of DraftBeheraLDAPPasswordPolicy10WarningType values and at most one error from the set of DraftBeheraLDAPPasswordPolicy10ErrorType 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 DraftBeheraLDAPPasswordPolicy10RequestControl());

 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());
 }

 DraftBeheraLDAPPasswordPolicy10ResponseControl pwpResponse =
      DraftBeheraLDAPPasswordPolicy10ResponseControl.get(bindResult);
 if (pwpResponse != null)
 {
   DraftBeheraLDAPPasswordPolicy10ErrorType errorType =
        pwpResponse.getErrorType();
   if (errorType != null)
   {
     // There was a password policy error.
   }

   DraftBeheraLDAPPasswordPolicy10WarningType warningType =
        pwpResponse.getWarningType();
   if (warningType != null)
   {
     // There was a password policy warning.
     int value = pwpResponse.getWarningValue();
     switch (warningType)
     {
       case TIME_BEFORE_EXPIRATION:
         // The warning value is the number of seconds until expiration.
         break;
       case GRACE_LOGINS_REMAINING:
         // The warning value is the number of grace logins remaining.
     }
   }
 }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PASSWORD_POLICY_REQUEST_OID The OID (1.3.6.1.4.1.42.2.27.8.5.1) for the password policy request control.

Constructor Summary

Constructors

Constructor and Description
DraftBeheraLDAPPasswordPolicy10RequestControl() Creates a new password policy request control.
DraftBeheraLDAPPasswordPolicy10RequestControl(boolean isCritical) Creates a new password policy request control.
DraftBeheraLDAPPasswordPolicy10RequestControl(Control control) Creates a new password policy request control which is decoded from the provided generic control.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this LDAP control to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.Control

decode, decode, decodeControls, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toJSONControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PASSWORD_POLICY_REQUEST_OID

@NotNull
public static final java.lang.String PASSWORD_POLICY_REQUEST_OID

The OID (1.3.6.1.4.1.42.2.27.8.5.1) for the password policy request control.

See Also:

Constant Field Values

Constructor Detail

DraftBeheraLDAPPasswordPolicy10RequestControl

public DraftBeheraLDAPPasswordPolicy10RequestControl()

Creates a new password policy request control. The control will not be marked critical.

DraftBeheraLDAPPasswordPolicy10RequestControl

public DraftBeheraLDAPPasswordPolicy10RequestControl(boolean isCritical)

Creates a new password policy request control.

Parameters:

isCritical - Indicates whether the control should be marked critical.

DraftBeheraLDAPPasswordPolicy10RequestControl

public DraftBeheraLDAPPasswordPolicy10RequestControl(@NotNull
                                             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

@NotNull
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(@NotNull
            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.