|
|||||||||
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.controls.PasswordExpiringControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordExpiringControl
This class provides an implementation of the expiring expiring control as
described in draft-vchu-ldap-pwd-policy. It may be used to indicate that the
authenticated user's password will expire in the near future. The value of
this control includes the length of time in seconds until the user's
password actually expires.
No request control is required to trigger the server to send the password
expiring response control. If the server supports the use of this control
and the user's password will expire within a time frame that the server
considers to be the near future, then it will be included in the bind
response returned to the client.
See the documentation for the PasswordExpiredControl
to see an
example that demonstrates the use of both the password expiring and password
expired controls.
Field Summary | |
---|---|
static java.lang.String |
PASSWORD_EXPIRING_OID
The OID (2.16.840.1.113730.3.4.5) for the password expiring response control. |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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. |
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_EXPIRING_OID
Constructor Detail |
---|
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.Method Detail |
---|
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
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 |