Class PasswordPolicyRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.PasswordPolicyRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordPolicyRequestControl extends Control
This class provides an implementation of the password policy request control as described in draft-behera-ldap-password-policy. It may be used to request information related to a user's password policy. In the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server, this control may be included with add, bind, compare, modify, and password modify requests.
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.42.2.27.8.5.1. The criticality may be either true or false. It does not have a value.
The correspondingPasswordPolicyResponseControl
may include at most one warning from the set ofPasswordPolicyWarningType
values and at most one error from the set ofPasswordPolicyErrorType
values. See the documentation for those classes for more information on the information that may be included.
Example
The following example demonstrates the use of the password policy request control in conjunction with a bind operation:SimpleBindRequest bindRequest = new SimpleBindRequest( "uid=john.doe,ou=People,dc=example,dc=com", "password", new PasswordPolicyRequestControl()); BindResult bindResult; try { bindResult = connection.bind(bindRequest); } catch (LDAPException le) { // The bind failed. There may be a password policy response control to // help tell us why. bindResult = new BindResult(le.toLDAPResult()); } PasswordPolicyResponseControl pwpResponse = PasswordPolicyResponseControl.get(bindResult); if (pwpResponse != null) { PasswordPolicyErrorType errorType = pwpResponse.getErrorType(); if (errorType != null) { // There was a password policy-related error. } PasswordPolicyWarningType warningType = pwpResponse.getWarningType(); if (warningType != null) { // There was a password policy-related warning. int value = pwpResponse.getWarningValue(); switch (warningType) { case TIME_BEFORE_EXPIRATION: // The warning value is the number of seconds until the user's // password expires. break; case GRACE_LOGINS_REMAINING: // The warning value is the number of grace logins remaining for // the user. } } }
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PASSWORD_POLICY_REQUEST_OID
The OID (1.3.6.1.4.1.42.2.27.8.5.1) for the password policy request control.
-
Constructor Summary
Constructors Constructor Description PasswordPolicyRequestControl()
Creates a new password policy request control.PasswordPolicyRequestControl(boolean isCritical)
Creates a new password policy request control.PasswordPolicyRequestControl(Control control)
Creates a new password policy 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 PasswordPolicyRequestControl
decodeJSONControl(JSONObject controlObject, boolean strict)
Attempts to decode the provided object as a JSON representation of a password policy request control.java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.JSONObject
toJSONControl()
Retrieves a representation of this password policy 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_POLICY_REQUEST_OID
@NotNull public static final java.lang.String PASSWORD_POLICY_REQUEST_OID
The OID (1.3.6.1.4.1.42.2.27.8.5.1) for the password policy request control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PasswordPolicyRequestControl
public PasswordPolicyRequestControl()
Creates a new password policy request control. The control will not be marked critical.
-
PasswordPolicyRequestControl
public PasswordPolicyRequestControl(boolean isCritical)
Creates a new password policy request control.- Parameters:
isCritical
- Indicates whether the control should be marked critical.
-
PasswordPolicyRequestControl
public PasswordPolicyRequestControl(@NotNull Control control) throws LDAPException
Creates a new password policy request control which is decoded from the provided generic control.- Parameters:
control
- The generic control to be decoded as a password policy request control.- Throws:
LDAPException
- If the provided control cannot be decoded as a password policy 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 policy 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 policy request 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, 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 PasswordPolicyRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
Attempts to decode the provided object as a JSON representation of a password policy 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 policy request control that was decoded from the provided JSON object.
- Throws:
LDAPException
- If the provided JSON object cannot be parsed as a valid password policy request control.
-
-