com.unboundid.ldap.sdk.unboundidds.controls
Class PasswordValidationDetailsRequestControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.PasswordValidationDetailsRequestControl
All Implemented Interfaces:
java.io.Serializable

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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides an implementation for a request control that can be included in an add, modify, or password modify request. Its presence in one of those requests will indicate that the server should provide a response control with information about the password quality requirements that are in effect for the operation and information about whether the password included in the request satisfies each of those requirements.

This request control has an OID of 1.3.6.1.4.1.30221.2.5.40, and it is recommended that the criticality be false. It does not have a value.

See Also:
Serialized Form

Field Summary
static java.lang.String PASSWORD_VALIDATION_DETAILS_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.2.5.40) for the password validation details request control.
 
Constructor Summary
PasswordValidationDetailsRequestControl()
          Creates a new password validation details request control with a criticality of false.
PasswordValidationDetailsRequestControl(boolean isCritical)
          Creates a new password validation details request control with the specified criticality.
PasswordValidationDetailsRequestControl(Control control)
          Creates a new password validation details request control which is decoded from the provided generic control.
 
Method Summary
 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, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

PASSWORD_VALIDATION_DETAILS_REQUEST_OID

public static final java.lang.String PASSWORD_VALIDATION_DETAILS_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.40) for the password validation details request control.

See Also:
Constant Field Values
Constructor Detail

PasswordValidationDetailsRequestControl

public PasswordValidationDetailsRequestControl()
Creates a new password validation details request control with a criticality of false.


PasswordValidationDetailsRequestControl

public PasswordValidationDetailsRequestControl(boolean isCritical)
Creates a new password validation details request control with the specified criticality.

Parameters:
isCritical - Indicates whether this control should be considered critical.

PasswordValidationDetailsRequestControl

public PasswordValidationDetailsRequestControl(Control control)
                                        throws LDAPException
Creates a new password validation details request control which is decoded from the provided generic control.

Parameters:
control - The generic control to be decoded as a password validation details request control.
Throws:
LDAPException - If the provided control cannot be decoded as a password validation details 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.