Package com.unboundid.ldap.sdk.unboundidds.controls

Class PasswordValidationDetailsRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.PasswordValidationDetailsRequestControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordValidationDetailsRequestControl extends Control
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.
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.30221.2.5.40, and it is recommended that the criticality be false. It does not have a value.
See Also:

  • Field Details

  • Constructor Details

    • 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(@NotNull 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 Details

    • getControlName

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

    • toJSONControl

      @NotNull public JSONObject toJSONControl()
      Retrieves a representation of this password validation details request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither the value-base64 nor value-json fields may be present):
      • oid -- A mandatory string field whose value is the object identifier for this control. For the password validation details request control, the OID is "1.3.6.1.4.1.30221.2.5.40".
      • control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
      • criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static PasswordValidationDetailsRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a password validation details request control.
      Parameters:
      controlObject - The JSON object to be decoded. It must not be null.
      strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.
      Returns:
      The password validation details request control that was decoded from the provided JSON object.
      Throws:
      LDAPException - If the provided JSON object cannot be parsed as a valid password validation details request control.

    • toString

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