netscape.ldap
Class LDAPResponse

java.lang.Object
  extended bynetscape.ldap.LDAPMessage
      extended bynetscape.ldap.LDAPResponse
All Implemented Interfaces:
java.io.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
(package private) static long serialVersionUID
           
 
Fields inherited from class netscape.ldap.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
 
Constructor Summary
(package private) LDAPResponse(int msgid, JDAPProtocolOp rsp, LDAPControl[] controls)
          Constructor
 
Method Summary
 java.lang.String getErrorMessage()
          Returns any error message in the response.
 java.lang.String getMatchedDN()
          Returns the partially matched DN field, if any, in a server response.
 java.lang.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 netscape.ldap.LDAPMessage
getControls, getMessageID, getProtocolOp, getType, parseMessage, toString, toTraceString, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

LDAPResponse

LDAPResponse(int msgid,
             JDAPProtocolOp rsp,
             LDAPControl[] controls)
Constructor

Parameters:
msgid - message identifier
rsp - operation response
controls - array of controls or null
Method Detail

getErrorMessage

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