@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordExpiringControl extends Control implements DecodeableControl
PasswordExpiredControl
to see an
example that demonstrates the use of both the password expiring and password
expired controls.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PASSWORD_EXPIRING_OID
The OID (2.16.840.1.113730.3.4.5) for the password expiring response
control.
|
Constructor and Description |
---|
PasswordExpiringControl(int secondsUntilExpiration)
Creates a new password expiring control with the provided information.
|
PasswordExpiringControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new password expiring control with the provided information.
|
Modifier and Type | Method and Description |
---|---|
PasswordExpiringControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided
information.
|
static PasswordExpiringControl |
get(LDAPResult result)
Extracts a password expiring control from the provided result.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
int |
getSecondsUntilExpiration()
Retrieves the length of time in seconds until the password expires.
|
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, toString, writeTo
public static final java.lang.String PASSWORD_EXPIRING_OID
public PasswordExpiringControl(int secondsUntilExpiration)
secondsUntilExpiration
- The length of time in seconds until the
password expires.public PasswordExpiringControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided control cannot be decoded as a
password expiring response control.public PasswordExpiringControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static PasswordExpiringControl get(LDAPResult result) throws LDAPException
result
- The result from which to retrieve the password expiring
control.null
if the result did not contain a password expiring
control.LDAPException
- If a problem is encountered while attempting to
decode the password expiring control contained in
the provided result.public int getSecondsUntilExpiration()
public java.lang.String getControlName()
getControlName
in class Control