Class LDAPResponse

java.lang.Object

netscape.ldap.LDAPMessage

netscape.ldap.LDAPResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LDAPExtendedResponse

public class LDAPResponse
extends LDAPMessage

Represents the response to a particular LDAP operation.

Version:

1.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class LDAPMessage

ABANDON_REQUEST, ADD_REQUEST, ADD_RESPONSE, BIND_REQUEST, BIND_RESPONSE, COMPARE_REQUEST, COMPARE_RESPONSE, DEL_REQUEST, DEL_RESPONSE, EXTENDED_REQUEST, EXTENDED_RESPONSE, MODIFY_RDN_REQUEST, MODIFY_RDN_RESPONSE, MODIFY_REQUEST, MODIFY_RESPONSE, SEARCH_REQUEST, SEARCH_RESPONSE, SEARCH_RESULT, SEARCH_RESULT_REFERENCE, UNBIND_REQUEST

Modifier and Type	Field	Description
static final int	ABANDON_REQUEST
static final int	ADD_REQUEST
static final int	ADD_RESPONSE
static final int	BIND_REQUEST
static final int	BIND_RESPONSE
static final int	COMPARE_REQUEST
static final int	COMPARE_RESPONSE
static final int	DEL_REQUEST
static final int	DEL_RESPONSE
static final int	EXTENDED_REQUEST
static final int	EXTENDED_RESPONSE
static final int	MODIFY_RDN_REQUEST
static final int	MODIFY_RDN_RESPONSE
static final int	MODIFY_REQUEST
static final int	MODIFY_RESPONSE
static final int	SEARCH_REQUEST
static final int	SEARCH_RESPONSE
static final int	SEARCH_RESULT
static final int	SEARCH_RESULT_REFERENCE
static final int	UNBIND_REQUEST

Method Summary

Modifier and Type	Method	Description
String	getErrorMessage()	Returns any error message in the response.
String	getMatchedDN()	Returns the partially matched DN field, if any, in a server response.
String[]	getReferrals()	Returns all referrals, if any, in a server response.
int	getResultCode()	Returns the result code in a server response.

Methods inherited from class LDAPMessage

getControls, getMessageID, getType, toString

Modifier and Type	Method	Description
LDAPControl[]	getControls()	Retrieves list of controls.
int	getMessageID()	Returns the message identifer.
int	getType()	Returns the LDAP operation type of the message
String	toString()	Returns string representation of an LDAP message.

Methods inherited from class Object

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

Method Details

getErrorMessage

public String getErrorMessage()

Returns any error message in the response.

Returns:

the error message of the last error (or null if no message was set).

getMatchedDN

public String getMatchedDN()

Returns the partially matched DN field, if any, in a server response.

Returns:

the maximal subset of a DN to match, or null.

getReferrals

public String[] getReferrals()

Returns all referrals, if any, in a server response.

Returns:

a list of referrals or null.

getResultCode

public int getResultCode()

Returns the result code in a server response.

Returns:

the result code.