Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

netscape.ldap.controls

Class LDAPPasswordExpiredControl

Implemented Interfaces:
Cloneable, java.io.Serializable
public class LDAPPasswordExpiredControl
extends netscape.ldap.controls.LDAPStringControl
Represents an LDAP v3 server control that may be returned if a password has expired, and password policy is enabled on the server. The OID for this control is 2.16.840.1.113730.3.4.4.

Version:
1.0
See Also:
LDAPControl, Serialized Form

Field Summary

static String
EXPIRED

Fields inherited from class netscape.ldap.controls.LDAPStringControl

m_msg

Fields inherited from class netscape.ldap.LDAPControl

MANAGEDSAIT, PWEXPIRED, PWEXPIRING, m_critical, m_value

Constructor Summary

LDAPPasswordExpiredControl(String oid, boolean critical, byte[] value)
Contructs an LDAPPasswordExpiredControl object.

Method Summary

String
getMessage()
Gets the message returned by the server with this control.
static String
parseResponse(LDAPControl[] controls)
Deprecated. LDAPPasswordExpiredControl controls are now automatically instantiated.
String
toString()

Methods inherited from class netscape.ldap.controls.LDAPStringControl

parseResponse

Methods inherited from class netscape.ldap.LDAPControl

clone, createControl, flattenBER, getID, getValue, isCritical, lookupControlClass, newInstance, register, toString

Field Details

EXPIRED

public static final String EXPIRED

Constructor Details

LDAPPasswordExpiredControl

public LDAPPasswordExpiredControl(String oid,
                                  boolean critical,
                                  byte[] value)
            throws LDAPException
Contructs an LDAPPasswordExpiredControl object. This constructor is used by LDAPControl.register to instantiate password expired controls.

To retrieve the message from the server, call getMessage.

Parameters:
oid - this parameter must be equal to LDAPPasswordExpiredControl.EXPIRED or an LDAPException is thrown
critical - true if this control is critical
value - the value associated with this control
Throws:
LDAPException - If oid is not LDAPPasswordExpiredControl.EXPIRED.
See Also:
LDAPControl.register(String,Class)

Method Details

getMessage

public String getMessage()
Gets the message returned by the server with this control.
Returns:
the message returned by the server.

parseResponse

public static String parseResponse(LDAPControl[] controls)

Deprecated. LDAPPasswordExpiredControl controls are now automatically instantiated.

Parameters:
controls - an array of LDAPControl objects, representing the controls returned by the server after a search. To get these controls, use the getResponseControls method of the LDAPConnection class.
Returns:
an error message string, or null if none is in the control.
See Also:
LDAPConnection.getResponseControls()

toString

public String toString()
Overrides:
toString in interface LDAPControl

Overview Package Class Use Tree Index Deprecated About