Class GetPasswordPolicyStateIssuesResponseControl

  • All Implemented Interfaces:
    DecodeableControl, java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class GetPasswordPolicyStateIssuesResponseControl
    extends Control
    implements DecodeableControl
    This class provides an implementation of a response control that can be included in a bind response with information about any password policy state notices, warnings, and/or errors for the user.
    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.47, a criticality of false, and a value with the following encoding:
       GetPasswordPolicyStateIssuesResponse ::= SEQUENCE {
            notices               [0] SEQUENCE OF SEQUENCE {
                 type        INTEGER,
                 name        OCTET STRING,
                 message     OCTET STRING OPTIONAL } OPTIONAL,
            warnings              [1] SEQUENCE OF SEQUENCE {
                 type        INTEGER,
                 name        OCTET STRING,
                 message     OCTET STRING OPTIONAL } OPTIONAL,
            errors                [2] SEQUENCE OF SEQUENCE {
                 type        INTEGER,
                 name        OCTET STRING,
                 message     OCTET STRING OPTIONAL } OPTIONAL,
            authFailureReason     [3] SEQUENCE {
                 type        INTEGER,
                 name        OCTET STRING,
                 message     OCTET STRING OPTIONAL } OPTIONAL,
            ... }
     
    See Also:
    Serialized Form
    • Constructor Detail

      • GetPasswordPolicyStateIssuesResponseControl

        public GetPasswordPolicyStateIssuesResponseControl​(java.lang.String oid,
                                                           boolean isCritical,
                                                           ASN1OctetString value)
                                                    throws LDAPException
        Creates a new instance of this control that is decoded from the provided generic control.
        Parameters:
        oid - The OID for the control.
        isCritical - Indicates whether this control should be marked critical.
        value - The encoded value for the control.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the provided control as a get password policy state issues response control.
    • Method Detail

      • decodeControl

        public GetPasswordPolicyStateIssuesResponseControl decodeControl​(java.lang.String oid,
                                                                         boolean isCritical,
                                                                         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.
      • getNotices

        public java.util.List<PasswordPolicyStateAccountUsabilityNoticegetNotices()
        Retrieves the set of account usability notices for the user.
        Returns:
        The set of account usability notices for the user, or an empty list if there are no notices.
      • getErrors

        public java.util.List<PasswordPolicyStateAccountUsabilityErrorgetErrors()
        Retrieves the set of account usability errors for the user.
        Returns:
        The set of account usability errors for the user, or an empty list if there are no errors.
      • get

        public static GetPasswordPolicyStateIssuesResponseControl get​(BindResult bindResult)
                                                               throws LDAPException
        Extracts a get password policy state issues response control from the provided bind result.
        Parameters:
        bindResult - The bind result from which to retrieve the get password policy state issues response control.
        Returns:
        The get password policy state issues response control contained in the provided bind result, or null if the bind result did not contain a get password policy state issues response control.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the get password policy state issues response control contained in the provided bind result.
      • get

        public static GetPasswordPolicyStateIssuesResponseControl get​(LDAPException ldapException)
                                                               throws LDAPException
        Extracts a get password policy state issues response control from the provided LDAP exception.
        Parameters:
        ldapException - The LDAP exception from which to retrieve the get password policy state issues response control.
        Returns:
        The get password policy state issues response control contained in the provided LDAP exception, or null if the exception did not contain a get password policy state issues response control.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the get password policy state issues response control contained in the provided LDAP exception.
      • 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.