@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordPolicyResponseControl extends Control implements DecodeableControl
PasswordPolicyWarningType
values and at most
one error from the set of PasswordPolicyErrorType
values. See the
documentation for those classes for more information on the information that
may be included. See the PasswordPolicyRequestControl
documentation
for an example that demonstrates the use of the password policy request and
response controls.
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.
PasswordPolicyResponseValue ::= SEQUENCE { warning [0] CHOICE { timeBeforeExpiration [0] INTEGER (0 .. maxInt), graceAuthNsRemaining [1] INTEGER (0 .. maxInt) } OPTIONAL, error [1] ENUMERATED { passwordExpired (0), accountLocked (1), changeAfterReset (2), passwordModNotAllowed (3), mustSupplyOldPassword (4), insufficientPasswordQuality (5), passwordTooShort (6), passwordTooYoung (7), passwordInHistory (8) } OPTIONAL }
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PASSWORD_POLICY_RESPONSE_OID
The OID (1.3.6.1.4.1.42.2.27.8.5.1) for the password policy response
control.
|
Constructor and Description |
---|
PasswordPolicyResponseControl(PasswordPolicyWarningType warningType,
int warningValue,
PasswordPolicyErrorType errorType)
Creates a new password policy response control with the provided
information.
|
PasswordPolicyResponseControl(PasswordPolicyWarningType warningType,
int warningValue,
PasswordPolicyErrorType errorType,
boolean isCritical)
Creates a new password policy response control with the provided
information.
|
PasswordPolicyResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new password policy response control with the provided
information.
|
Modifier and Type | Method and Description |
---|---|
PasswordPolicyResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided
information.
|
static PasswordPolicyResponseControl |
get(LDAPResult result)
Extracts a password policy response control from the provided result.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
PasswordPolicyErrorType |
getErrorType()
Retrieves the error type for this password policy response control, if
available.
|
PasswordPolicyWarningType |
getWarningType()
Retrieves the warning type for this password policy response control, if
available.
|
int |
getWarningValue()
Retrieves the warning value for this password policy response control, if
available.
|
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 PASSWORD_POLICY_RESPONSE_OID
public PasswordPolicyResponseControl(@Nullable PasswordPolicyWarningType warningType, int warningValue, @Nullable PasswordPolicyErrorType errorType)
warningType
- The password policy warning type for this response
control, or null
if there should be no
warning type.warningValue
- The value for the password policy warning type, or -1
if there is no warning type.errorType
- The password policy error type for this response
control, or null
if there should be no error
type.public PasswordPolicyResponseControl(@Nullable PasswordPolicyWarningType warningType, int warningValue, @Nullable PasswordPolicyErrorType errorType, boolean isCritical)
warningType
- The password policy warning type for this response
control, or null
if there should be no
warning type.warningValue
- The value for the password policy warning type, or -1
if there is no warning type.errorType
- The password policy error type for this response
control, or null
if there should be no error
type.isCritical
- Indicates whether this control should be marked
critical. Response controls should generally not be
critical.public PasswordPolicyResponseControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
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 control cannot be decoded as a
password policy response control.@NotNull public PasswordPolicyResponseControl 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.@Nullable public static PasswordPolicyResponseControl get(@NotNull LDAPResult result) throws LDAPException
result
- The result from which to retrieve the password policy
response control.null
if the result did not contain a password
policy response control.LDAPException
- If a problem is encountered while attempting to
decode the password policy response control
contained in the provided result.@Nullable public PasswordPolicyWarningType getWarningType()
null
if there is no warning type.public int getWarningValue()
@Nullable public PasswordPolicyErrorType getErrorType()
null
if there is no error type.@NotNull public java.lang.String getControlName()
getControlName
in class Control