org.ldaptive.control

Class PasswordExpiringControl

java.lang.Object

org.ldaptive.control.AbstractControl

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
 

Field Summary

Fields

Modifier and Type	Field and Description
private static int	HASH_CODE_SEED hash code seed.
static java.lang.String	OID OID of this control.
private int	timeBeforeExpiration time in seconds until expiration.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
void	decode(byte[] berValue) Initializes this response control with the supplied BER encoded data.
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.
java.lang.String	toString()

Methods inherited from class org.ldaptive.control.AbstractControl

equals, 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

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

timeBeforeExpiration

private int timeBeforeExpiration

time in seconds until expiration.

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

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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

decode

public void decode(byte[] berValue)

Description copied from interface: ResponseControl

Initializes this response control with the supplied BER encoded data.

Specified by:

decode in interface ResponseControl

Parameters:

berValue - BER encoded response control