Class RetirePasswordRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.RetirePasswordRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RetirePasswordRequestControl extends Control
This class provides a request control that can be included in a modify request or a password modify extended request in order to indicate that if the operation results in changing the password for a user, the user's former password should be marked as "retired", which may allow it to remain in use for a brief period of time (as configured in the password policy governing that user) to allow for applications which may have been configured with that password can be updated to use the new password.
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.31" and does not have a value. The criticality may be either true (in which case the operation will succeed only if the user's password policy allows passwords to be retired by a request control) or false (in which case if the password policy does not allow the use of this control, the operation will be processed as if the control had not been included in the request).
Example
The following example demonstrates the use of the retire password request control to request that a user's current password be retired in the course of a password change.Control[] requestControls = { new RetirePasswordRequestControl(true) }; PasswordModifyExtendedRequest passwordModifyRequest = new PasswordModifyExtendedRequest( "uid=test.user,ou=People,dc=example,dc=com", // The user to update null, // The current password -- we don't know it. "newPassword", // The new password to assign to the user. requestControls); // The controls to include in the request. PasswordModifyExtendedResult passwordModifyResult = (PasswordModifyExtendedResult) connection.processExtendedOperation(passwordModifyRequest);
- See Also:
PurgePasswordRequestControl
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
RETIRE_PASSWORD_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.31) for the retire password request control.
-
Constructor Summary
Constructors Constructor Description RetirePasswordRequestControl(boolean isCritical)
Creates a new retire password request control with the specified criticality.RetirePasswordRequestControl(Control control)
Creates a new retire password request control which is decoded from the provided generic control.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.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, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
-
-
-
-
Field Detail
-
RETIRE_PASSWORD_REQUEST_OID
public static final java.lang.String RETIRE_PASSWORD_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.31) for the retire password request control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RetirePasswordRequestControl
public RetirePasswordRequestControl(boolean isCritical)
Creates a new retire password request control with the specified criticality.- Parameters:
isCritical
- Indicates whether the control should be considered critical.
-
RetirePasswordRequestControl
public RetirePasswordRequestControl(Control control) throws LDAPException
Creates a new retire password request control which is decoded from the provided generic control.- Parameters:
control
- The generic control to be decoded as a retire password request control.- Throws:
LDAPException
- If the provided control cannot be decoded as a retire password request control.
-
-
Method Detail
-
getControlName
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.
-
-