@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetPasswordPolicyStateIssuesResponseControl extends Control implements DecodeableControl
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.
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, ... }
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 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.
|
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 |
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.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided
buffer.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String GET_PASSWORD_POLICY_STATE_ISSUES_RESPONSE_OID
public GetPasswordPolicyStateIssuesResponseControl(@Nullable java.util.List<PasswordPolicyStateAccountUsabilityNotice> notices, @Nullable java.util.List<PasswordPolicyStateAccountUsabilityWarning> warnings, @Nullable java.util.List<PasswordPolicyStateAccountUsabilityError> errors)
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.public GetPasswordPolicyStateIssuesResponseControl(@Nullable java.util.List<PasswordPolicyStateAccountUsabilityNotice> notices, @Nullable java.util.List<PasswordPolicyStateAccountUsabilityWarning> warnings, @Nullable java.util.List<PasswordPolicyStateAccountUsabilityError> errors, @Nullable AuthenticationFailureReason authFailureReason)
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.public GetPasswordPolicyStateIssuesResponseControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether this control should be marked
critical.value
- The encoded value for the control.LDAPException
- If a problem is encountered while attempting to
decode the provided control as a get password
policy state issues response control.@NotNull public GetPasswordPolicyStateIssuesResponseControl decodeControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
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.LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.@NotNull public java.util.List<PasswordPolicyStateAccountUsabilityNotice> getNotices()
@NotNull public java.util.List<PasswordPolicyStateAccountUsabilityWarning> getWarnings()
@NotNull public java.util.List<PasswordPolicyStateAccountUsabilityError> getErrors()
@Nullable public AuthenticationFailureReason getAuthenticationFailureReason()
null
if none was provided.@Nullable public static GetPasswordPolicyStateIssuesResponseControl get(@NotNull BindResult bindResult) throws LDAPException
bindResult
- The bind result from which to retrieve the get password
policy state issues response control.null
if the bind result did
not contain a get password policy state issues response control.LDAPException
- If a problem is encountered while attempting to
decode the get password policy state issues
response control contained in the provided bind
result.@Nullable public static GetPasswordPolicyStateIssuesResponseControl get(@NotNull LDAPException ldapException) throws LDAPException
ldapException
- The LDAP exception from which to retrieve the get
password policy state issues response control.null
if the exception did
not contain a get password policy state issues response control.LDAPException
- If a problem is encountered while attempting to
decode the get password policy state issues
response control contained in the provided LDAP
exception.@NotNull public java.lang.String getControlName()
getControlName
in class Control