Package org.ldaptive.control
Class PasswordPolicyControl
- java.lang.Object
-
- org.ldaptive.control.AbstractControl
-
- org.ldaptive.control.PasswordPolicyControl
-
- All Implemented Interfaces:
Control
,RequestControl
,ResponseControl
public class PasswordPolicyControl extends AbstractControl implements RequestControl, ResponseControl
Request/response control for password policy. See http://tools.ietf.org/html/draft-behera-ldap-password-policy-10. Control is defined as:PasswordPolicyResponseValue ::= SEQUENCE { warning [0] CHOICE { timeBeforeExpiration [0] INTEGER (0 .. maxInt), graceAuthNsRemaining [1] INTEGER (0 .. maxInt) } OPTIONAL, error [1] ENUMERATED { passwordExpired (0), accountLocked (1), changeAfterReset (2), passwordModNotAllowed (3), mustSupplyOldPassword (4), insufficientPasswordQuality (5), passwordTooShort (6), passwordTooYoung (7), passwordInHistory (8) } OPTIONAL }
- Author:
- Middleware Services
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PasswordPolicyControl.Error
Enum for ppolicy errors.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
OID
OID of this control.-
Fields inherited from class org.ldaptive.control.AbstractControl
logger
-
-
Constructor Summary
Constructors Constructor Description PasswordPolicyControl()
Default constructor.PasswordPolicyControl(boolean critical)
Creates a new password policy control.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
decode(DERBuffer encoded)
Initializes this response control with the supplied BER encoded data.byte[]
encode()
Provides the BER encoding of this control.boolean
equals(java.lang.Object o)
PasswordPolicyControl.Error
getError()
Returns the password policy error.int
getGraceAuthNsRemaining()
Returns the number of grace authentications remaining.int
getTimeBeforeExpiration()
Returns the time before expiration in seconds.int
hashCode()
Returns the hash code for this object.boolean
hasValue()
Returns whether the control has a value associated with it.void
setError(PasswordPolicyControl.Error e)
Sets the password policy error.void
setGraceAuthNsRemaining(int count)
Sets the number of grace authentications remaining.void
setTimeBeforeExpiration(int time)
Sets the time before expiration in seconds.java.lang.String
toString()
-
Methods inherited from class org.ldaptive.control.AbstractControl
getCriticality, getOID
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.ldaptive.control.Control
getCriticality, getOID
-
-
-
-
Field Detail
-
OID
public static final java.lang.String OID
OID of this control.- See Also:
- Constant Field Values
-
-
Method Detail
-
hasValue
public boolean hasValue()
Description copied from interface:RequestControl
Returns whether the control has a value associated with it.- Specified by:
hasValue
in interfaceRequestControl
- Returns:
- whether the control has a value
-
getTimeBeforeExpiration
public int getTimeBeforeExpiration()
Returns the time before expiration in seconds.- Returns:
- time before expiration
-
setTimeBeforeExpiration
public void setTimeBeforeExpiration(int time)
Sets the time before expiration in seconds.- Parameters:
time
- before expiration
-
getGraceAuthNsRemaining
public int getGraceAuthNsRemaining()
Returns the number of grace authentications remaining.- Returns:
- number of grace authentications remaining
-
setGraceAuthNsRemaining
public void setGraceAuthNsRemaining(int count)
Sets the number of grace authentications remaining.- Parameters:
count
- number of grace authentications remaining
-
getError
public PasswordPolicyControl.Error getError()
Returns the password policy error.- Returns:
- password policy error
-
setError
public void setError(PasswordPolicyControl.Error e)
Sets the password policy error.- Parameters:
e
- password policy error
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classAbstractControl
-
hashCode
public int hashCode()
Description copied from class:AbstractControl
Returns the hash code for this object.- Specified by:
hashCode
in classAbstractControl
- Returns:
- hash code
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractControl
-
encode
public byte[] encode()
Description copied from interface:RequestControl
Provides the BER encoding of this control.- Specified by:
encode
in interfaceRequestControl
- Returns:
- BER encoded request control
-
decode
public void decode(DERBuffer encoded)
Description copied from interface:ResponseControl
Initializes this response control with the supplied BER encoded data.- Specified by:
decode
in interfaceResponseControl
- Parameters:
encoded
- BER encoded response control
-
-