netscape.ldap

Class LDAPMessage

Implemented Interfaces:
java.io.Serializable
Known Direct 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
 }
 
Version:
1.0
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
String
toString()
Returns string representation of an LDAP message.

Field Details

ABANDON_REQUEST

public static final int ABANDON_REQUEST
Field Value:
16

ADD_REQUEST

public static final int ADD_REQUEST
Field Value:
8

ADD_RESPONSE

public static final int ADD_RESPONSE
Field Value:
9

BIND_REQUEST

public static final int BIND_REQUEST
Field Value:
0

BIND_RESPONSE

public static final int BIND_RESPONSE
Field Value:
1

COMPARE_REQUEST

public static final int COMPARE_REQUEST
Field Value:
14

COMPARE_RESPONSE

public static final int COMPARE_RESPONSE
Field Value:
15

DEL_REQUEST

public static final int DEL_REQUEST
Field Value:
10

DEL_RESPONSE

public static final int DEL_RESPONSE
Field Value:
11

EXTENDED_REQUEST

public static final int EXTENDED_REQUEST
Field Value:
23

EXTENDED_RESPONSE

public static final int EXTENDED_RESPONSE
Field Value:
24

MODIFY_RDN_REQUEST

public static final int MODIFY_RDN_REQUEST
Field Value:
12

MODIFY_RDN_RESPONSE

public static final int MODIFY_RDN_RESPONSE
Field Value:
13

MODIFY_REQUEST

public static final int MODIFY_REQUEST
Field Value:
6

MODIFY_RESPONSE

public static final int MODIFY_RESPONSE
Field Value:
7

SEARCH_REQUEST

public static final int SEARCH_REQUEST
Field Value:
3

SEARCH_RESPONSE

public static final int SEARCH_RESPONSE
Field Value:
4

SEARCH_RESULT

public static final int SEARCH_RESULT
Field Value:
5

SEARCH_RESULT_REFERENCE

public static final int SEARCH_RESULT_REFERENCE
Field Value:
19

UNBIND_REQUEST

public static final int UNBIND_REQUEST
Field Value:
2

Method Details

getControls

public LDAPControl[] getControls()
Retrieves list of controls.
Returns:
controls.

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.

toString

public String toString()
Returns string representation of an LDAP message.
Returns:
LDAP message.