|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.PasswordPolicyRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordPolicyRequestControl
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.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 UnboundID Directory Server, this control may be included with add, bind, compare, modify, and password modify requests.
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. } } }
Field Summary | |
---|---|
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 | |
---|---|
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 | |
---|---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PASSWORD_POLICY_REQUEST_OID
Constructor Detail |
---|
public PasswordPolicyRequestControl()
public PasswordPolicyRequestControl(boolean isCritical)
isCritical
- Indicates whether the control should be marked
critical.public PasswordPolicyRequestControl(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.Method Detail |
---|
public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |