com.unboundid.ldap.sdk.unboundidds.controls

Class GetPasswordPolicyStateIssuesRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.unboundidds.controls.GetPasswordPolicyStateIssuesRequestControl

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetPasswordPolicyStateIssuesRequestControl
extends Control

This class provides an implementation of a request control that can be included in a bind request to indicate that the server should include a control in the 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.46 and no value. It must only be used in a bind request that also includes the RetainIdentityRequestControl, and the authentication identify of the connection prior to sending the bind request must have the permit-get-password-policy-state-issues privilege.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GET_PASSWORD_POLICY_STATE_ISSUES_REQUEST_OID The OID (1.3.6.1.4.1.30221.2.5.46) for the get password policy state issues request control.

Constructor Summary

Constructors

Constructor and Description
GetPasswordPolicyStateIssuesRequestControl() Creates a new instance of this control.
GetPasswordPolicyStateIssuesRequestControl(boolean isCritical) Creates a new instance of this control with the specified criticality.
GetPasswordPolicyStateIssuesRequestControl(Control control) Creates a new instance of this control that is decoded from the provided generic control.

Method Summary

Modifier and Type	Method and Description
static GetPasswordPolicyStateIssuesRequestControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of a get password policy state issues request control.
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
JSONObject	toJSONControl() Retrieves a representation of this get password policy state issues request 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_REQUEST_OID

@NotNull
public static final java.lang.String GET_PASSWORD_POLICY_STATE_ISSUES_REQUEST_OID

The OID (1.3.6.1.4.1.30221.2.5.46) for the get password policy state issues request control.

See Also:

Constant Field Values

Constructor Detail

GetPasswordPolicyStateIssuesRequestControl

public GetPasswordPolicyStateIssuesRequestControl()

Creates a new instance of this control. It will not be considered critical.

GetPasswordPolicyStateIssuesRequestControl

public GetPasswordPolicyStateIssuesRequestControl(boolean isCritical)

Creates a new instance of this control with the specified criticality.

Parameters:

isCritical - Indicates whether the control should be considered critical.

GetPasswordPolicyStateIssuesRequestControl

public GetPasswordPolicyStateIssuesRequestControl(@NotNull
                                                  Control control)
                                           throws LDAPException

Creates a new instance of this control that is decoded from the provided generic control.

Parameters:

control - The control to decode as a get password policy state issues request control.

Throws:

LDAPException - If a problem is encountered while attempting to decode the provided control as a get password policy state issues request control.

Method Detail

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 request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither the value-base64 nor value-json fields may be present):

• oid -- A mandatory string field whose value is the object identifier for this control. For the get password policy state issues request control, the OID is "1.3.6.1.4.1.30221.2.5.46".
• 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.

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

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