@PublicAPI(stability=PRIVATE)

Package org.opends.server.protocols.ldap

Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using LDAPv3.

See: Description

Class Summary

Class	Description
AbandonRequestProtocolOp	This class defines the structures and methods for an LDAP abandon request protocol op, which is used to indicate that the server should stop processing a previously requested operation.
AddRequestProtocolOp	This class defines the structures and methods for an LDAP add request protocol op, which is used to add a new entry to the Directory Server.
AddResponseProtocolOp	This class defines the structures and methods for an LDAP add response protocol op, which is used to provide information about the result of processing an add request.
BindRequestProtocolOp	This class defines the structures and methods for an LDAP bind request protocol op, which is used to authenticate a user to the Directory Server.
BindResponseProtocolOp	This class defines the structures and methods for an LDAP delete response protocol op, which is used to provide information about the result of processing a delete request.
CompareRequestProtocolOp	This class defines the structures and methods for an LDAP compare request protocol op, which is used to determine whether a particular entry contains a specified attribute value.
CompareResponseProtocolOp	This class defines the structures and methods for an LDAP compare response protocol op, which is used to provide information about the result of processing a compare request.
DeleteRequestProtocolOp	This class defines the structures and methods for an LDAP delete request protocol op, which is used to remove an entry from the Directory Server.
DeleteResponseProtocolOp	This class defines the structures and methods for an LDAP delete response protocol op, which is used to provide information about the result of processing a delete request.
ExtendedRequestProtocolOp	This class defines the structures and methods for an LDAP extended request protocol op, which is used to request some special type of processing defined in an extension to the LDAP protocol.
ExtendedResponseProtocolOp	This class defines the structures and methods for an LDAP extended response protocol op, which is used to provide information about the result of processing a extended request.
IntermediateResponseProtocolOp	This class defines the structures and methods for an LDAP intermediate response protocol op, which is used to provide information to a client before the final response for an operation.
LDAPAttribute	This class defines the data structures and methods to use when interacting with an LDAP attribute, which is the basic unit of information in an LDAP entry.
LdapClientConnection	This class defines an LDAP client connection, which is a type of client connection that will be accepted by an instance of the LDAP connection handler and have its requests decoded by an LDAP request handler.
LDAPConnectionHandler	This class defines a connection handler that will be used for communicating with clients over LDAP.
LDAPConstants	This class defines a number of constants used in the LDAP protocol.
LDAPControl	This class defines the data structures and methods to use when interacting with a generic LDAP control.
LDAPFilter	This class defines the data structures and methods to use when interacting with an LDAP search filter, which defines a set of criteria for locating entries in a search request.
LDAPMessage	This class defines the data structures and methods to use when interacting with an LDAP message, which is the basic envelope used to hold LDAP requests and responses.
LDAPModification	This class defines the data structures and methods to use when interacting with an LDAP modification, which describes a change that should be made to an attribute.
LDAPReader	Utility class used to decode LDAP messages from an ASN1Reader.
LDAPResultCode	This class defines a set of constants that correspond to the result codes defined in the LDAP protocol.
LDAPStatistics	This class defines a data structure that will be used to keep track of various metrics related to LDAP communication that the server has conducted.
LdapStatisticsFilter	Reactive Filter collecting request statistics for cn=monitor reports.
ModifyDNRequestProtocolOp	This class defines the structures and methods for an LDAP modify DN request protocol op, which is used to move or rename an entry or subtree within the Directory Server.
ModifyDNResponseProtocolOp	This class defines the structures and methods for an LDAP modify DN response protocol op, which is used to provide information about the result of processing a modify DN request.
ModifyRequestProtocolOp	This class defines the structures and methods for an LDAP modify request protocol op, which is used to alter the contents of an entry in the Directory Server.
ModifyResponseProtocolOp	This class defines the structures and methods for an LDAP modify response protocol op, which is used to provide information about the result of processing a modify request.
ProtocolOp	This class defines the structures and methods for an LDAP protocol op, which is the core of an LDAP message.
SearchRequestProtocolOp	This class defines the structures and methods for an LDAP search request protocol op, which is used to locate entries based on a set of criteria.
SearchResultDoneProtocolOp	This class defines the structures and methods for an LDAP search result done protocol op, which is used to provide information about the result of processing a search request.
SearchResultEntryProtocolOp	This class defines the structures and methods for an LDAP search result entry protocol op, which is used to return entries that match the associated search criteria.
SearchResultReferenceProtocolOp	This class defines the structures and methods for an LDAP search result reference protocol op, which is used to indicate to the client that an alternate location or server may hold more matching entries.
UnbindRequestProtocolOp	This class defines the structures and methods for an LDAP unbind request protocol op, which is used to indicate that the client wishes to disconnect from the Directory Server.

Package org.opends.server.protocols.ldap Description

Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using LDAPv3. The LDAP implementation in this package is actually comprised of three primary components:

• The LDAP connection handler which is purely responsible for accepting new connections from clients. Once a connection has been accepted, it is associated with a request handler for further processing.
• One or more LDAP request handlers, which are intended to read requests from the clients and convert them into operations that are placed in the work queue for further processing. It is possible to have multiple LDAP request handlers for a single LDAP connection handler, which can provide better performance and scalability on systems allowing a high degree of parallel processing because it can help avoid the scenario in which the performance is constrained to the rate at which a single thread can read and process requests from clients.
• The data structures that comprise the LDAPMessage envelope, the various types of protocol op elements, and other classes needed to represent LDAP protocol data units (PDUs).