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

Class GeneratePasswordResponseControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.GeneratePasswordResponseControl
All Implemented Interfaces:
DecodeableControl, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GeneratePasswordResponseControl extends Control implements DecodeableControl
This class provides a response control that may be used to convey the password (and other associated information) generated in response to a GeneratePasswordRequestControl.
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 control has an OID of "1.3.6.1.4.1.30221.2.5.59", a criticality of false, and a value with the following encoding: 
   GeneratePasswordResponse ::= SEQUENCE {
        generatedPassword          OCTET STRING,
        mustChangePassword         BOOLEAN,
        secondsUntilExpiration     [0] INTEGER OPTIONAL,
        ... }
See Also:

  • Field Details

  • Constructor Details

    • GeneratePasswordResponseControl

      public GeneratePasswordResponseControl(@NotNull String generatedPassword, boolean mustChangePassword, @Nullable Long secondsUntilExpiration)
      Creates a new generate password response control with the provided information.
      Parameters:
      generatedPassword - The password generated by the server. It must not be null.
      mustChangePassword - Indicates whether the user will be required to choose a new password the first time they authenticate.
      secondsUntilExpiration - The number of seconds until the new password will expire. It may be null if the new password will not expire.

    • GeneratePasswordResponseControl

      public GeneratePasswordResponseControl(@NotNull byte[] generatedPassword, boolean mustChangePassword, @Nullable Long secondsUntilExpiration)
      Creates a new generate password response control with the provided information.
      Parameters:
      generatedPassword - The password generated by the server. It must not be null.
      mustChangePassword - Indicates whether the user will be required to choose a new password the first time they authenticate.
      secondsUntilExpiration - The number of seconds until the new password will expire. It may be null if the new password will not expire.

    • GeneratePasswordResponseControl

      public GeneratePasswordResponseControl(@NotNull String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
      Creates a new generate password response control with the provided information.
      Parameters:
      oid - The OID for the control.
      isCritical - Indicates whether the control should be marked critical.
      value - The encoded value for the control. This may be null if no value was provided.
      Throws:
      LDAPException - If the provided control cannot be decoded as a generate password response control.

  • Method Details

    • decodeControl

      @NotNull public GeneratePasswordResponseControl decodeControl(@NotNull String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
      Creates a new instance of this decodeable control from the provided information.
      Specified by:
      decodeControl in interface DecodeableControl
      Parameters:
      oid - The OID for the control.
      isCritical - Indicates whether the control should be marked critical.
      value - The encoded value for the control. This may be null if no value was provided.
      Returns:
      The decoded representation of this control.
      Throws:
      LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.

    • get

      @Nullable public static GeneratePasswordResponseControl get(@NotNull LDAPResult result) throws LDAPException
      Extracts a generate password response control from the provided result.
      Parameters:
      result - The result from which to retrieve the generate password response control.
      Returns:
      The generate password response control contained in the provided result, or null if the result did not contain a generate password response control.
      Throws:
      LDAPException - If a problem is encountered while attempting to decode the generate password response control contained in the provided result.

    • getGeneratedPassword

      @NotNull public ASN1OctetString getGeneratedPassword()
      Retrieves the password that was generated by the server.
      Returns:
      The password that was generated by the server.

    • getGeneratedPasswordString

      @NotNull public String getGeneratedPasswordString()
      Retrieves a string representation of the password that was generated by the server.
      Returns:
      A string representation of the password that was generated by the server.

    • getGeneratedPasswordBytes

      @NotNull public byte[] getGeneratedPasswordBytes()
      Retrieves the bytes that comprise the password that was generated by the server.
      Returns:
      The bytes that comprise the password that was generated by the server.

    • mustChangePassword

      public boolean mustChangePassword()
      Indicates whether the user will be required to change their password the first time they authenticate.
      Returns:
      true if the user will be required to change their password the first time they authenticate, or false if not.

    • getSecondsUntilExpiration

      @Nullable public Long getSecondsUntilExpiration()
      Retrieves the length of time, in seconds, until the generated password will expire.
      Returns:
      The length of time, in seconds, until the generated password will expire, or null if this is not available (e.g., because the generated password will not expire).

    • 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 generate password response control as a JSON object. The JSON object uses the following fields:
      • oid -- A mandatory string field whose value is the object identifier for this control. For the generate password response control, the OID is "1.3.6.1.4.1.30221.2.5.59".
      • 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.
      • value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this generate password response control. Exactly one of the value-base64 and value-json fields must be present.
      • value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this generate password response control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
        • generated-password -- A string field whose value is the password that was generated for the entry.
        • must-change-password -- A Boolean field that indicates whether the user must choose a new password before they will be allowed to request any other operations.
        • seconds-until-expiration -- An optional integer field whose value is the number of seconds until the generated password expires.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static GeneratePasswordResponseControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a generate password response 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 generate password response control that was decoded from the provided JSON object.
      Throws:
      LDAPException - If the provided JSON object cannot be parsed as a valid generate password response 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.