Class GeneratePasswordRequestControl

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class GeneratePasswordRequestControl
    extends Control
    This class provides a request control that can be included in an add request to indicate that the server should generate a password for the new account. If the add operation is processed successfully, then the generated password will be included in the GeneratePasswordResponseControl in the add result.
    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.

    The OID for this control is 1.3.6.1.4.1.30221.2.5.58, the criticality may be either true or false, and it does not have a value.
    See Also:
    GeneratePasswordResponseControl, Serialized Form
    • Constructor Detail

      • GeneratePasswordRequestControl

        public GeneratePasswordRequestControl()
        Creates a new generate password request control. It will be marked critical.
      • GeneratePasswordRequestControl

        public GeneratePasswordRequestControl​(boolean isCritical)
        Creates a new generate password request control with the specified criticality.
        Parameters:
        isCritical - Indicates whether this control should be marked critical.
      • GeneratePasswordRequestControl

        public GeneratePasswordRequestControl​(Control control)
                                       throws LDAPException
        Creates a new generate password request control which is decoded from the provided generic control.
        Parameters:
        control - The generic control to be decoded as a generate password request control.
        Throws:
        LDAPException - If the provided control cannot be decoded as a generate password 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.