org.opends.server.controls
Class PasswordExpiringControl

java.lang.Object
  org.opends.server.types.Control
      org.opends.server.controls.PasswordExpiringControl

public class PasswordExpiringControl
extends Control

This class implements the Netscape password expiring control, which 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.

Constructor Summary

PasswordExpiringControl(int secondsUntilExpiration)
Creates a new instance of the password expiring control with the provided information.

PasswordExpiringControl(java.lang.String oid, boolean isCritical, int secondsUntilExpiration)
Creates a new instance of the password expiring control with the provided information.

Method Summary

static PasswordExpiringControl	decodeControl(Control control) Creates a new password expiring control from the contents of the provided control.
int	getSecondsUntilExpiration() Retrieves the length of time in seconds until the password actually expires.
java.lang.String	toString() Retrieves a string representation of this password expiring control.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this password expiring control to the provided buffer.

Methods inherited from class org.opends.server.types.Control

getOID, getValue, hasValue, isCritical, setCritical, setOID, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

PasswordExpiringControl

public PasswordExpiringControl(int secondsUntilExpiration)

Creates a new instance of the password expiring control with the provided information.

Parameters:

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

PasswordExpiringControl

public PasswordExpiringControl(java.lang.String oid,
                               boolean isCritical,
                               int secondsUntilExpiration)

Creates a new instance of the password expiring control with the provided information.

Parameters:

oid - The OID to use for this control.

isCritical - Indicates whether support for this control should be considered a critical part of the client processing.

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

Method Detail

decodeControl

public static PasswordExpiringControl decodeControl(Control control)
                                             throws LDAPException

Creates a new password expiring control from the contents of the provided control.

Parameters:

control - The generic control containing the information to use to create this password expiring control.

Returns:

The password expiring control decoded from the provided control.

Throws:

LDAPException - If this control cannot be decoded as a valid password expiring control.

getSecondsUntilExpiration

public int getSecondsUntilExpiration()

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

Returns:

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

toString

public java.lang.String toString()

Retrieves a string representation of this password expiring control.

Overrides:

toString in class Control

Returns:

A string representation of this password expiring control.

toString

public void toString(java.lang.StringBuilder buffer)

Appends a string representation of this password expiring control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which the information should be appended.