public final class PasswordPolicyRequestControl extends Object implements Control
This control may be sent with any request in order to convey to the server that this client is aware of, and can process the password policy response control. When a server receives this control, it will return the password policy response control when appropriate and with the proper data.
Connection connection = ...;
String DN = ...;
char[] password = ...;
try {
BindRequest request = Requests.newSimpleBindRequest(DN, password)
.addControl(PasswordPolicyRequestControl.newControl(true));
BindResult result = connection.bind(request);
PasswordPolicyResponseControl control =
result.getControl(PasswordPolicyResponseControl.DECODER,
new DecodeOptions());
if (!(control == null) && !(control.getWarningType() == null)) {
// Password policy warning, use control.getWarningType(),
// and control.getWarningValue().
}
} catch (LdapException e) {
Result result = e.getResult();
try {
PasswordPolicyResponseControl control =
result.getControl(PasswordPolicyResponseControl.DECODER,
new DecodeOptions());
if (!(control == null)) {
// Password policy error, use control.getErrorType().
}
} catch (DecodeException de) {
// Failed to decode the response control.
}
} catch (DecodeException e) {
// Failed to decode the response control.
}
Modifier and Type | Field and Description |
---|---|
static ControlDecoder<PasswordPolicyRequestControl> |
DECODER
A decoder which can be used for decoding the password policy request control.
|
static String |
OID
The OID for the password policy control from draft-behera-ldap-password-policy.
|
Modifier and Type | Method and Description |
---|---|
String |
getOid()
Returns the numeric OID associated with this control.
|
ByteString |
getValue()
Returns the value, if any, associated with this control.
|
boolean |
hasValue()
Returns
true if this control has a value. |
boolean |
isCritical()
Returns
true if it is unacceptable to perform the operation
without applying the semantics of this control. |
static PasswordPolicyRequestControl |
newControl(boolean isCritical)
Creates a new password policy request control having the provided
criticality.
|
String |
toString() |
public static final String OID
public static final ControlDecoder<PasswordPolicyRequestControl> DECODER
public static PasswordPolicyRequestControl newControl(boolean isCritical)
isCritical
- true
if it is unacceptable to perform the operation
without applying the semantics of this control, or
false
if it can be ignored.public String getOid()
Control
public ByteString getValue()
Control
public boolean hasValue()
Control
true
if this control has a value. In some circumstances
it may be useful to determine if a control has a value, without actually
calculating the value and incurring any performance costs.public boolean isCritical()
Control
true
if it is unacceptable to perform the operation
without applying the semantics of this control.
The criticality field only has meaning in controls attached to request
messages (except UnbindRequest). For controls attached to response
messages and the UnbindRequest, the criticality field SHOULD be
false
, and MUST be ignored by the receiving protocol peer. A
value of true
indicates that it is unacceptable to perform the
operation without applying the semantics of the control.
isCritical
in interface Control
true
if this control must be processed by the Directory
Server, or false
if it can be ignored.Copyright 2010-2022 ForgeRock AS.