org.forgerock.opendj.ldap.controls

Class PasswordExpiringResponseControl

java.lang.Object

org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl

All Implemented Interfaces:

Control

public final class PasswordExpiringResponseControl
extends Object
implements Control

The Netscape password expiring response control as defined in draft-vchu-ldap-pwd-policy. This control serves as a warning to clients that the user's password is about to expire. The only element contained in the control value is a string representation of the number of seconds until expiration.

 
 Connection connection = ...;
 String DN = ...;
 char[] password = ...;

 BindResult result = connection.bind(DN, password);
 try {
     PasswordExpiringResponseControl control =
             result.getControl(PasswordExpiringResponseControl.DECODER,
                     new DecodeOptions());
     if (!(control == null) && control.hasValue()) {
         // Password expires in control.getSecondsUntilExpiration() seconds
     }
 } catch (DecodeException de) {
     // Failed to decode the response control.
 }
 
 

See Also:

draft-vchu-ldap-pwd-policy - Password Policy for LDAP Directories

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<PasswordExpiringResponseControl>	DECODER A decoder which can be used for decoding the password expiring response control.
static String	OID The OID for the Netscape password expiring response control.

Method Summary

Modifier and Type	Method and Description
String	getOid() Returns the numeric OID associated with this control.
int	getSecondsUntilExpiration() Returns the length of time in seconds until the password actually expires.
ByteString	getValue() Returns the value, if any, associated with this control.
boolean	hasValue() Returns true if this control has a value.
boolean	isCritical() Returns true if it is unacceptable to perform the operation without applying the semantics of this control.
static PasswordExpiringResponseControl	newControl(int secondsUntilExpiration) Creates a new Netscape password expiring response control with the provided amount of time until expiration.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OID

public static final String OID

The OID for the Netscape password expiring response control.

See Also:

Constant Field Values

DECODER

public static final ControlDecoder<PasswordExpiringResponseControl> DECODER

A decoder which can be used for decoding the password expiring response control.

Method Detail

newControl

public static PasswordExpiringResponseControl newControl(int secondsUntilExpiration)

Creates a new Netscape password expiring response control with the provided amount of time until expiration.

Parameters:

secondsUntilExpiration - The length of time in seconds until the password actually expires.

Returns:

The new control.

getOid

public String getOid()

Description copied from interface: Control

Returns the numeric OID associated with this control.

Specified by:

getOid in interface Control

Returns:

The numeric OID associated with this control.

getSecondsUntilExpiration

public int getSecondsUntilExpiration()

Returns the length of time in seconds until the password actually expires.

Returns:

The length of time in seconds until the password actually expires.

getValue

public ByteString getValue()

Description copied from interface: Control

Returns the value, if any, associated with this control. Its format is defined by the specification of this control.

Specified by:

getValue in interface Control

Returns:

The value associated with this control, or null if there is no value.

hasValue

public boolean hasValue()

Description copied from interface: Control

Returns true if this control has a value. In some circumstances it may be useful to determine if a control has a value, without actually calculating the value and incurring any performance costs.

Specified by:

hasValue in interface Control

Returns:

true if this control has a value, or false if there is no value.

isCritical

public boolean isCritical()

Description copied from interface: Control

Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be false, and MUST be ignored by the receiving protocol peer. A value of true indicates that it is unacceptable to perform the operation without applying the semantics of the control.

Specified by:

isCritical in interface Control

Returns:

true if this control must be processed by the Directory Server, or false if it can be ignored.

toString

public String toString()

Overrides:

toString in class Object