com.unboundid.ldap.sdk.unboundidds.controls

Class PasswordPolicyResponseControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.unboundidds.controls.PasswordPolicyResponseControl

All Implemented Interfaces:

DecodeableControl, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class PasswordPolicyResponseControl
extends Control
implements DecodeableControl

This class provides an implementation of the password policy response control as described in draft-behera-ldap-password-policy. It may be used to provide information related to a user's password policy. It may include at most one warning from the set of 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.

The control has an OID of 1.3.6.1.4.1.42.2.27.8.5.1 and a criticality of false. It must have a value with the following encoding:

   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 }
 

See Also:

Serialized Form

Field Summary

Fields

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 Summary

Constructors

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.

Method Summary

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	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of a password policy response control.
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.
JSONObject	toJSONControl() Retrieves a representation of this password policy 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

PASSWORD_POLICY_RESPONSE_OID

@NotNull
public static final 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.

See Also:

Constant Field Values

Constructor Detail

PasswordPolicyResponseControl

public PasswordPolicyResponseControl(@Nullable
                                     PasswordPolicyWarningType warningType,
                                     int warningValue,
                                     @Nullable
                                     PasswordPolicyErrorType errorType)

Creates a new password policy response control with the provided information. It will not be critical.

Parameters:

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.

PasswordPolicyResponseControl

public PasswordPolicyResponseControl(@Nullable
                                     PasswordPolicyWarningType warningType,
                                     int warningValue,
                                     @Nullable
                                     PasswordPolicyErrorType errorType,
                                     boolean isCritical)

Creates a new password policy response control with the provided information.

Parameters:

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.

PasswordPolicyResponseControl

public PasswordPolicyResponseControl(@NotNull
                                     java.lang.String oid,
                                     boolean isCritical,
                                     @Nullable
                                     ASN1OctetString value)
                              throws LDAPException

Creates a new password policy response control with the provided information.

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.

Throws:

LDAPException - If the provided control cannot be decoded as a password policy response control.

Method Detail

decodeControl

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

get

@Nullable
public static PasswordPolicyResponseControl get(@NotNull
                                                          LDAPResult result)
                                                   throws LDAPException

Extracts a password policy response control from the provided result.

Parameters:

result - The result from which to retrieve the password policy response control.

Returns:

The password policy response control contained in the provided result, or null if the result did not contain a password policy response control.

Throws:

LDAPException - If a problem is encountered while attempting to decode the password policy response control contained in the provided result.

getWarningType

@Nullable
public PasswordPolicyWarningType getWarningType()

Retrieves the warning type for this password policy response control, if available.

Returns:

The warning type for this password policy response control, or null if there is no warning type.

getWarningValue

public int getWarningValue()

Retrieves the warning value for this password policy response control, if available.

Returns:

The warning value for this password policy response control, or -1 if there is no warning type.

getErrorType

@Nullable
public PasswordPolicyErrorType getErrorType()

Retrieves the error type for this password policy response control, if available.

Returns:

The error type for this password policy response control, or null if there is no error type.

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 password policy 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 password policy response control, the OID is "1.3.6.1.4.1.42.2.27.8.5.1".
• 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 password policy 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 password policy 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:
  • warning -- An optional JSON object field whose value represents a warning about the user's password policy state. If present, the JSON object must contain exactly one of the following fields:
    • seconds-until-expiration -- An integer field whose value is the number of seconds until the user's password expires.
    • grace-logins-remaining -- An integer field whose value value is the number of grace login attempts that the user has left.
  • error-type -- An optional string field whose value represents a password policy error condition that applies to the associated operation. If present, its value will be one of the following:
    • password-expired
    • account-locked
    • change-after-reset
    • password-mod-not-allowed
    • must-supply-old-password
    • insufficient-password-quality
    • password-too-short
    • password-too-young
    • password-in-history

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

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

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

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid password policy 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.