public final class PasswordExpiringResponseControl extends Object implements Control
Connection connection = ...;
String DN = ...;
char[] password = ...;
BindResult result = connection.bind(DN, password);
try {
PasswordExpiringResponseControl control =
result.getControl(PasswordExpiringResponseControl.DECODER,
new DecodeOptions());
if (!(control == null) && control.hasValue()) {
// Password expires in control.getSecondsUntilExpiration() seconds
}
} catch (DecodeException de) {
// Failed to decode the response control.
}
Modifier and Type | Field and Description |
---|---|
static ControlDecoder<PasswordExpiringResponseControl> |
DECODER
A decoder which can be used for decoding the password expiring response control.
|
static String |
OID
The OID for the Netscape password expiring response control.
|
Modifier and Type | Method and Description |
---|---|
String |
getOid()
Returns the numeric OID associated with this control.
|
int |
getSecondsUntilExpiration()
Returns the length of time in seconds until the password actually
expires.
|
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 PasswordExpiringResponseControl |
newControl(int secondsUntilExpiration)
Creates a new Netscape password expiring response control with the
provided amount of time until expiration.
|
String |
toString() |
public static final String OID
public static final ControlDecoder<PasswordExpiringResponseControl> DECODER
public static PasswordExpiringResponseControl newControl(int secondsUntilExpiration)
secondsUntilExpiration
- The length of time in seconds until the password actually
expires.public String getOid()
Control
public int getSecondsUntilExpiration()
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.