org.opends.server.controls
Class PasswordExpiredControl

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

public class PasswordExpiredControl
extends Control

This class implements the Netscape password expired control. The value for this control should be a string that indicates the length of time until the password expires, but because it is already expired it will always be "0".

Constructor Summary

PasswordExpiredControl()
Creates a new instance of the password expired control with the default settings.

PasswordExpiredControl(java.lang.String oid, boolean isCritical)
Creates a new instance of the password expired control with the provided information.

Method Summary

static PasswordExpiredControl	decodeControl(Control control) Creates a new password expired control from the contents of the provided control.
java.lang.String	toString() Retrieves a string representation of this password expired control.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this password expired 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

PasswordExpiredControl

public PasswordExpiredControl()

Creates a new instance of the password expired control with the default settings.

PasswordExpiredControl

public PasswordExpiredControl(java.lang.String oid,
                              boolean isCritical)

Creates a new instance of the password expired 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.

Method Detail

decodeControl

public static PasswordExpiredControl decodeControl(Control control)
                                            throws LDAPException

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

Parameters:

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

Returns:

The password expired control decoded from the provided control.

Throws:

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

toString

public java.lang.String toString()

Retrieves a string representation of this password expired control.

Overrides:

toString in class Control

Returns:

A string representation of this password expired control.

toString

public void toString(java.lang.StringBuilder buffer)

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

Overrides:

toString in class Control

Parameters:

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