Package org.forgerock.opendj.ldap.messages

Classes and interfaces for core LDAP requests/responses.

Interface Summary

Interface	Description
AbandonRequest	The Abandon operation allows a client to request that the server abandon an uncompleted operation.
AddRequest	The Add operation allows a client to request the addition of an entry into the Directory.
BindRequest	The Bind operation allows authentication information to be exchanged between the client and server.
BindResult	A Bind result indicates the status of the client's request for authentication.
CancelExtendedRequest	The cancel extended request as defined in RFC 3909.
CompareRequest	The Compare operation allows a client to compare an assertion value with the values of a particular attribute in a particular entry in the Directory.
CompareResult	An Compare result indicates the final status of an Compare operation.
DeleteRequest	The Delete operation allows a client to request the removal of an entry from the Directory.
ExtendedRequest<S extends ExtendedResult>	The Extended operation allows additional operations to be defined for services not already available in the protocol; for example, to implement an operation which installs transport layer security (see StartTlsExtendedRequest).
ExtendedRequestDecoder<R extends ExtendedRequest<S>,S extends ExtendedResult>	A factory interface for decoding a generic extended request as an extended request of specific type.
ExtendedResult	A Extended result indicates the status of an Extended operation and any additional information associated with the Extended operation, including the optional response name and value.
ExtendedResultDecoder<S extends ExtendedResult>	A factory interface for decoding a generic extended result as an extended result of specific type.
GenericExtendedRequest	A generic Extended request which should be used for unsupported extended operations.
GenericExtendedResult	A Generic Extended result indicates the final status of an Generic Extended operation.
GenericIntermediateResponse	A Generic Intermediate response provides a mechanism for communicating unrecognized or unsupported Intermediate responses to the client.
IntermediateResponse	An Intermediate response provides a general mechanism for defining single-request/multiple-response operations.
ModifyDnRequest	The Modify DN operation allows a client to change the Relative Distinguished Name (RDN) of an entry in the Directory and/or to move a subtree of entries to a new location in the Directory.
ModifyRequest	The Modify operation allows a client to request that a modification of an entry be performed on its behalf by a server.
PasswordModifyExtendedRequest	The password modify extended request as defined in RFC 3062.
PasswordModifyExtendedResult	The password modify extended result as defined in RFC 3062.
ProtocolOp	The base class of all requests and responses provides methods for querying and manipulating the set of Controls.
Request	The base class of all Requests provides methods for querying and manipulating the set of Controls included with a Request.
RequestVisitor<R,P,E extends Exception>	A visitor of Requests, in the style of the visitor design pattern.
Response	The base class of all Responses provides methods for querying and manipulating the set of Controls included with a Response.
Result	A Result is used to indicate the status of an operation performed by the server.
SearchRequest	The Search operation is used to request a server to return, subject to access controls and other restrictions, a set of entries matching a complex search criterion.
SearchResultEntry	A Search Result Entry represents an entry found during a Search operation.
SearchResultReference	A Search Result Reference represents an area not yet explored during a Search operation.
StartTlsExtendedRequest	The start TLS extended request as defined in RFC 4511.
StartTlsExtendedResult	The start tls extended result as defined in RFC 4511.
UnbindRequest	The Unbind operation allows a client to terminate an LDAP session.
WhoAmIExtendedRequest	The who am I extended request as defined in RFC 4532.
WhoAmIExtendedResult	The who am I extended result as defined in RFC 4532.

Class Summary

Class	Description
AbstractExtendedRequest<ER extends ExtendedRequest<S>,S extends ExtendedResult>	An abstract Extended request which can be used as the basis for implementing new Extended operations.
AbstractExtendedResult<S extends ExtendedResult>	An abstract Extended result which can be used as the basis for implementing new Extended operations.
AbstractExtendedResultDecoder<S extends ExtendedResult>	This class provides a skeletal implementation of the ExtendedResultDecoder interface, to minimize the effort required to implement this interface.
AbstractIntermediateResponse<S extends IntermediateResponse>	An abstract Intermediate response which can be used as the basis for implementing new Intermediate responses.
AbstractRequestVisitor<R,P,E extends Exception>	Abstract class that implements the RequestVisitor interface.
InvalidRequest	Represents a request which has been received and decoded but but is invalid according to the LDAP standard because of an invalid DN syntax or an invalid attribute syntax.
LdapMessage	Encapsulates a ProtocolOp with LDAP specific message information.
Requests	This class contains various methods for creating and manipulating requests.
Responses	This class contains various methods for creating and manipulating responses.
UnknownRequest	Wraps a message that the LdapServer was unable to decode because it did not recognize it.

Enum Summary

Enum	Description
Request.RequestType	The type of this request.