Package netscape.ldap.controls

Class LDAPPasswordExpiredControl

java.lang.Object

netscape.ldap.LDAPControl

netscape.ldap.controls.LDAPPasswordExpiredControl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LDAPPasswordExpiredControl
extends LDAPControl

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.

See Also:

LDAPControl, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EXPIRED
protected java.lang.String	m_msg

Fields inherited from class netscape.ldap.LDAPControl

m_critical, m_value, MANAGEDSAIT, PWEXPIRED, PWEXPIRING

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getMessage()	Gets the message returned by the server with this control.
static java.lang.String	parseResponse(LDAPControl[] controls)	Deprecated. LDAPPasswordExpiredControl controls are now automatically instantiated.
static java.lang.String	parseResponse(LDAPControl[] controls, java.lang.String type)	Parses a response control sent by the server and retrieves a string.
java.lang.String	toString()	Return a string representation of the control for debugging

Methods inherited from class netscape.ldap.LDAPControl

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

Methods inherited from class java.lang.Object

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

Field Detail

EXPIRED

public static final java.lang.String EXPIRED

See Also:

Constant Field Values

m_msg

protected java.lang.String m_msg

Constructor Detail

LDAPPasswordExpiredControl

public LDAPPasswordExpiredControl(java.lang.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(java.lang.String, java.lang.Class)

Method Detail

parseResponse

public static java.lang.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()

getMessage

public java.lang.String getMessage()

Gets the message returned by the server with this control.

Returns:

the message returned by the server.

toString

public java.lang.String toString()

Description copied from class: LDAPControl

Return a string representation of the control for debugging

Overrides:

toString in class LDAPControl

Returns:

a string representation of the control.

parseResponse

public static java.lang.String parseResponse(LDAPControl[] controls,
                                             java.lang.String type)

Parses a response control sent by the server and retrieves a string.

You can get the controls returned by the server by using the getResponseControls method of the LDAPConnection class.

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.

type - the OID of the control to look for

Returns:

a message string, or null if the server did not return a string.

See Also:

LDAPConnection.getResponseControls()