com.unboundid.ldap.sdk.unboundidds.controls

Class GetPasswordPolicyStateIssuesResponseControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.unboundidds.controls.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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GET_PASSWORD_POLICY_STATE_ISSUES_RESPONSE_OID The OID (1.3.6.1.4.1.30221.2.5.47) for the get password policy state issues response control.

Constructor Summary

Constructors

Constructor and Description
GetPasswordPolicyStateIssuesResponseControl(java.util.List<PasswordPolicyStateAccountUsabilityNotice> notices, java.util.List<PasswordPolicyStateAccountUsabilityWarning> warnings, java.util.List<PasswordPolicyStateAccountUsabilityError> errors) Creates a new instance of this control with the provided information.
GetPasswordPolicyStateIssuesResponseControl(java.util.List<PasswordPolicyStateAccountUsabilityNotice> notices, java.util.List<PasswordPolicyStateAccountUsabilityWarning> warnings, java.util.List<PasswordPolicyStateAccountUsabilityError> errors, AuthenticationFailureReason authFailureReason) Creates a new instance of this control with the provided information.
GetPasswordPolicyStateIssuesResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) Creates a new instance of this control that is decoded from the provided generic control.

Method Summary

Modifier and Type	Method and Description
GetPasswordPolicyStateIssuesResponseControl	decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) Creates a new instance of this decodeable control from the provided information.
static GetPasswordPolicyStateIssuesResponseControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of a get password policy state issues response control.
static GetPasswordPolicyStateIssuesResponseControl	get(BindResult bindResult) Extracts a get password policy state issues response control from the provided bind result.
static GetPasswordPolicyStateIssuesResponseControl	get(LDAPException ldapException) Extracts a get password policy state issues response control from the provided LDAP exception.
AuthenticationFailureReason	getAuthenticationFailureReason() Retrieves the authentication failure reason for the bind operation, if available.
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
java.util.List<PasswordPolicyStateAccountUsabilityError>	getErrors() Retrieves the set of account usability errors for the user.
java.util.List<PasswordPolicyStateAccountUsabilityNotice>	getNotices() Retrieves the set of account usability notices for the user.
java.util.List<PasswordPolicyStateAccountUsabilityWarning>	getWarnings() Retrieves the set of account usability warnings for the user.
JSONObject	toJSONControl() Retrieves a representation of this get password policy state issues response control as a JSON object.
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, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GET_PASSWORD_POLICY_STATE_ISSUES_RESPONSE_OID

@NotNull
public static final java.lang.String GET_PASSWORD_POLICY_STATE_ISSUES_RESPONSE_OID

The OID (1.3.6.1.4.1.30221.2.5.47) for the get password policy state issues response control.

See Also:

Constant Field Values

Constructor Detail

GetPasswordPolicyStateIssuesResponseControl

public GetPasswordPolicyStateIssuesResponseControl(@Nullable
                                                   java.util.List<PasswordPolicyStateAccountUsabilityNotice> notices,
                                                   @Nullable
                                                   java.util.List<PasswordPolicyStateAccountUsabilityWarning> warnings,
                                                   @Nullable
                                                   java.util.List<PasswordPolicyStateAccountUsabilityError> errors)

Creates a new instance of this control with the provided information.

Parameters:

notices - The set of password policy state usability notices to include. It may be null or empty if there are no notices.

warnings - The set of password policy state usability warnings to include. It may be null or empty if there are no warnings.

errors - The set of password policy state usability errors to include. It may be null or empty if there are no errors.

GetPasswordPolicyStateIssuesResponseControl

public GetPasswordPolicyStateIssuesResponseControl(@Nullable
                                                   java.util.List<PasswordPolicyStateAccountUsabilityNotice> notices,
                                                   @Nullable
                                                   java.util.List<PasswordPolicyStateAccountUsabilityWarning> warnings,
                                                   @Nullable
                                                   java.util.List<PasswordPolicyStateAccountUsabilityError> errors,
                                                   @Nullable
                                                   AuthenticationFailureReason authFailureReason)

Creates a new instance of this control with the provided information.

Parameters:

notices - The set of password policy state usability notices to include. It may be null or empty if there are no notices.

warnings - The set of password policy state usability warnings to include. It may be null or empty if there are no warnings.

errors - The set of password policy state usability errors to include. It may be null or empty if there are no errors.

authFailureReason - The authentication failure reason for the bind operation. It may be null if there is no authentication failure reason.

GetPasswordPolicyStateIssuesResponseControl

public GetPasswordPolicyStateIssuesResponseControl(@NotNull
                                                   java.lang.String oid,
                                                   boolean isCritical,
                                                   @Nullable
                                                   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

@NotNull
public GetPasswordPolicyStateIssuesResponseControl decodeControl(@NotNull
                                                                          java.lang.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.

getNotices

@NotNull
public java.util.List<PasswordPolicyStateAccountUsabilityNotice> getNotices()

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.

getWarnings

@NotNull
public java.util.List<PasswordPolicyStateAccountUsabilityWarning> getWarnings()

Retrieves the set of account usability warnings for the user.

Returns:

The set of account usability warnings for the user, or an empty list if there are no warnings.

getErrors

@NotNull
public java.util.List<PasswordPolicyStateAccountUsabilityError> getErrors()

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.

getAuthenticationFailureReason

@Nullable
public AuthenticationFailureReason getAuthenticationFailureReason()

Retrieves the authentication failure reason for the bind operation, if available.

Returns:

The authentication failure reason for the bind operation, or null if none was provided.

get

@Nullable
public static GetPasswordPolicyStateIssuesResponseControl get(@NotNull
                                                                        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

@Nullable
public static GetPasswordPolicyStateIssuesResponseControl get(@NotNull
                                                                        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

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

toJSONControl

@NotNull
public JSONObject toJSONControl()

Retrieves a representation of this get password policy state issues 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 get password policy state issues response control, the OID is "1.3.6.1.4.1.30221.2.5.47".
• 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 get password policy state issues 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 get password policy state issues 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:
  • notices -- An optional array field containing JSON objects with information about any PasswordPolicyStateAccountUsabilityNotice values for the user. Each JSON object will use the following fields:
    • id -- An integer field whose value is a numeric identifier for the account usability notice.
    • name -- A string field whose value is the name for the account usability notice.
    • message -- An optional string field whose value is a human-readable message with additional information about the account usability notice.
  • warnings -- An optional array field containing JSON objects with information about any PasswordPolicyStateAccountUsabilityWarning values for the user. Each JSON object will use the following fields:
    • id -- An integer field whose value is a numeric identifier for the account usability warning.
    • name -- A string field whose value is the name for the account usability warning.
    • message -- An optional string field whose value is a human-readable message with additional information about the account usability warning.
  • errors -- An optional array field containing JSON objects with information about any PasswordPolicyStateAccountUsabilityError values for the user. Each JSON object will use the following fields:
    • id -- An integer field whose value is a numeric identifier for the account usability error.
    • name -- A string field whose value is the name for the account usability error.
    • message -- An optional string field whose value is a human-readable message with additional information about the account usability error.
  • authentication-failure-reason -- An optional JSON object field that represents an AuthenticationFailureReason with information about the reason that the authentication attempt failed. If present, this JSON object will use the following fields:
    • id -- An integer field whose value is a numeric identifier for the authentication failure reason.
    • name -- A string field whose value is the name for the authentication failure reason.
    • message -- An optional string field whose value is a human-readable message with additional information about the authentication failure.

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

@NotNull
public static GetPasswordPolicyStateIssuesResponseControl decodeJSONControl(@NotNull
                                                                                     JSONObject controlObject,
                                                                                     boolean strict)
                                                                              throws LDAPException

Attempts to decode the provided object as a JSON representation of a get password policy state issues 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 get password policy state issues response control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid get password policy state issues response control.

toString

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