@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordPolicyRequestControl extends Control
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.
PasswordPolicyResponseControl
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.
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. } } }
Modifier and Type | Field and 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 and 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.
|
Modifier and Type | Method and 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.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String PASSWORD_POLICY_REQUEST_OID
public PasswordPolicyRequestControl()
public PasswordPolicyRequestControl(boolean isCritical)
isCritical
- Indicates whether the control should be marked
critical.public PasswordPolicyRequestControl(@NotNull Control control) throws LDAPException
control
- The generic control to be decoded as a password policy
request control.LDAPException
- If the provided control cannot be decoded as a
password policy request control.@NotNull public java.lang.String getControlName()
getControlName
in class Control