org.ldaptive.control
Class PasswordExpiringControl

java.lang.Object
  extended by org.ldaptive.control.AbstractControl
      extended by org.ldaptive.control.PasswordExpiringControl
All Implemented Interfaces:
Control, ResponseControl

public class PasswordExpiringControl
extends AbstractControl
implements ResponseControl

Response control indicating a password that will expire. See http://tools.ietf.org/html/draft-vchu-ldap-pwd-policy-00. Control is defined as:

   controlValue ::= secondsUntilExpiration  OCTET STRING
 

Version:
$Revision: 3189 $ $Date: 2016-11-01 17:21:43 -0400 (Tue, 01 Nov 2016) $
Author:
Middleware Services

Field Summary
static String OID
          OID of this control.
 
Fields inherited from class org.ldaptive.control.AbstractControl
logger
 
Constructor Summary
PasswordExpiringControl()
          Default constructor.
PasswordExpiringControl(boolean critical)
          Creates a new password expiring control.
PasswordExpiringControl(int time)
          Creates a new password expiring control.
PasswordExpiringControl(int time, boolean critical)
          Creates a new password expiring control.
 
Method Summary
 void decode(byte[] berValue)
          Initializes this response control with the supplied BER encoded data.
 boolean equals(Object o)
          
 int getTimeBeforeExpiration()
          Returns the time in seconds until password expiration.
 int hashCode()
          Returns the hash code for this object.
 void setTimeBeforeExpiration(int time)
          Sets the time in seconds until password expiration.
 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 String OID
OID of this control.

See Also:
Constant Field Values
Constructor Detail

PasswordExpiringControl

public PasswordExpiringControl()
Default constructor.


PasswordExpiringControl

public PasswordExpiringControl(boolean critical)
Creates a new password expiring control.

Parameters:
critical - whether this control is critical

PasswordExpiringControl

public PasswordExpiringControl(int time)
Creates a new password expiring control.

Parameters:
time - in seconds until expiration

PasswordExpiringControl

public PasswordExpiringControl(int time,
                               boolean critical)
Creates a new password expiring control.

Parameters:
time - in seconds until expiration
critical - whether this control is critical
Method Detail

getTimeBeforeExpiration

public int getTimeBeforeExpiration()
Returns the time in seconds until password expiration.

Returns:
time in seconds until expiration

setTimeBeforeExpiration

public void setTimeBeforeExpiration(int time)
Sets the time in seconds until password expiration.

Parameters:
time - in seconds until expiration

equals

public boolean equals(Object o)

Overrides:
equals in class AbstractControl

hashCode

public int hashCode()
Description copied from class: AbstractControl
Returns the hash code for this object.

Specified by:
hashCode in class AbstractControl
Returns:
hash code

toString

public String toString()

Overrides:
toString in class Object

decode

public void decode(byte[] berValue)
Initializes this response control with the supplied BER encoded data.

Specified by:
decode in interface ResponseControl
Parameters:
berValue - BER encoded response control


Copyright © 2003-2017 Virginia Tech. All Rights Reserved.