netscape.ldap
Class LDAPMessage

java.lang.Object
  |
  +--netscape.ldap.LDAPMessage

Direct Known Subclasses:

LDAPResponse, LDAPSearchResult, LDAPSearchResultReference

public class LDAPMessage

extends java.lang.Object

implements java.io.Serializable

Base class for LDAP request and response messages. This class represents the LDAPMessage in RFC2251. The message is the entity that got transferred back and fro between the server and the client interface. Each message has a protocol operation. The protocol operation indicates if it is a request or response.

 LDAPMessage ::= SEQUENCE {
   messageID MessageID,
   protocolOp CHOICE {
     bindRequest BindRequest,
     ...
   }
   controls [0] Controls OPTIONAL
 }
 

See Also:

Serialized Form

Field Summary

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

Method Summary

LDAPControl[]	getControls() Retrieves list of controls.
int	getMessageID() Returns the message identifer.
int	getType() Returns the LDAP operation type of the message
java.lang.String	toString() Returns string representation of an LDAP message.

Methods inherited from class java.lang.Object

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

Field Detail

BIND_REQUEST

public static final int BIND_REQUEST

BIND_RESPONSE

public static final int BIND_RESPONSE

UNBIND_REQUEST

public static final int UNBIND_REQUEST

SEARCH_REQUEST

public static final int SEARCH_REQUEST

SEARCH_RESPONSE

public static final int SEARCH_RESPONSE

SEARCH_RESULT

public static final int SEARCH_RESULT

MODIFY_REQUEST

public static final int MODIFY_REQUEST

MODIFY_RESPONSE

public static final int MODIFY_RESPONSE

ADD_REQUEST

public static final int ADD_REQUEST

ADD_RESPONSE

public static final int ADD_RESPONSE

DEL_REQUEST

public static final int DEL_REQUEST

DEL_RESPONSE

public static final int DEL_RESPONSE

MODIFY_RDN_REQUEST

public static final int MODIFY_RDN_REQUEST

MODIFY_RDN_RESPONSE

public static final int MODIFY_RDN_RESPONSE

COMPARE_REQUEST

public static final int COMPARE_REQUEST

COMPARE_RESPONSE

public static final int COMPARE_RESPONSE

ABANDON_REQUEST

public static final int ABANDON_REQUEST

SEARCH_RESULT_REFERENCE

public static final int SEARCH_RESULT_REFERENCE

EXTENDED_REQUEST

public static final int EXTENDED_REQUEST

EXTENDED_RESPONSE

public static final int EXTENDED_RESPONSE

Method Detail

getMessageID

public int getMessageID()

Returns the message identifer.

Returns:

message identifer.

getType

public int getType()

Returns the LDAP operation type of the message

Returns:

message type.

getControls

public LDAPControl[] getControls()

Retrieves list of controls.

Returns:

controls.

toString

public java.lang.String toString()

Returns string representation of an LDAP message.

Overrides:

toString in class java.lang.Object

Returns:

LDAP message.