Class PasswordValidationDetailsRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.PasswordValidationDetailsRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordValidationDetailsRequestControl extends Control
This class provides an implementation for a request control that can be included in an add, modify, or password modify request. Its presence in one of those requests will indicate that the server should provide a response control with information about the password quality requirements that are in effect for the operation and information about whether the password included in the request satisfies each of those requirements.
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 request control has an OID of 1.3.6.1.4.1.30221.2.5.40, and it is recommended that the criticality befalse
. It does not have a value.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PASSWORD_VALIDATION_DETAILS_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.40) for the password validation details request control.
-
Constructor Summary
Constructors Constructor Description PasswordValidationDetailsRequestControl()
Creates a new password validation details request control with a criticality offalse
.PasswordValidationDetailsRequestControl(boolean isCritical)
Creates a new password validation details request control with the specified criticality.PasswordValidationDetailsRequestControl(Control control)
Creates a new password validation details request control which is decoded from the provided generic control.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PasswordValidationDetailsRequestControl
decodeJSONControl(JSONObject controlObject, boolean strict)
Attempts to decode the provided object as a JSON representation of a password validation details request control.java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.JSONObject
toJSONControl()
Retrieves a representation of this password validation details 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
-
-
-
-
Field Detail
-
PASSWORD_VALIDATION_DETAILS_REQUEST_OID
@NotNull public static final java.lang.String PASSWORD_VALIDATION_DETAILS_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.40) for the password validation details request control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PasswordValidationDetailsRequestControl
public PasswordValidationDetailsRequestControl()
Creates a new password validation details request control with a criticality offalse
.
-
PasswordValidationDetailsRequestControl
public PasswordValidationDetailsRequestControl(boolean isCritical)
Creates a new password validation details request control with the specified criticality.- Parameters:
isCritical
- Indicates whether this control should be considered critical.
-
PasswordValidationDetailsRequestControl
public PasswordValidationDetailsRequestControl(@NotNull Control control) throws LDAPException
Creates a new password validation details request control which is decoded from the provided generic control.- Parameters:
control
- The generic control to be decoded as a password validation details request control.- Throws:
LDAPException
- If the provided control cannot be decoded as a password validation details 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 classControl
- 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 validation details request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither thevalue-base64
norvalue-json
fields may be present):-
oid
-- A mandatory string field whose value is the object identifier for this control. For the password validation details request control, the OID is "1.3.6.1.4.1.30221.2.5.40". -
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, theoid
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 classControl
- Returns:
- A JSON object that contains a representation of this control.
-
-
decodeJSONControl
@NotNull public static PasswordValidationDetailsRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
Attempts to decode the provided object as a JSON representation of a password validation details request control.- Parameters:
controlObject
- The JSON object to be decoded. It must not benull
.strict
- Indicates whether to use strict mode when decoding the provided JSON object. If this istrue
, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this isfalse
, then unrecognized fields will be ignored.- Returns:
- The password validation details request control that was decoded from the provided JSON object.
- Throws:
LDAPException
- If the provided JSON object cannot be parsed as a valid password validation details request control.
-
-