Uses of Interface
org.forgerock.opendj.ldap.messages.ProtocolOp

Packages that use ProtocolOp

Package	Description
org.forgerock.opendj.ldap.messages	Classes and interfaces for core LDAP requests/responses.
org.forgerock.opendj.ldif	Classes and interfaces for reading and writing LDIF.

Uses of ProtocolOp in org.forgerock.opendj.ldap.messages

Subinterfaces of ProtocolOp in org.forgerock.opendj.ldap.messages

Modifier and Type	Interface	Description
interface	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).
interface	ExtendedResult	An 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.
interface	Request	The base class of all Requests provides methods for querying and manipulating the set of Controls included with a Request.
interface	Response	The base class of all Responses provides methods for querying and manipulating the set of Controls included with a Response.
interface	Result	A Result is used to indicate the status of an operation performed by the server.

Classes in org.forgerock.opendj.ldap.messages that implement ProtocolOp

Modifier and Type	Class	Description
final record	AbandonRequest	The Abandon operation allows a client to request that the server abandon an uncompleted operation.
final record	AddRequest	The Add operation allows a client to request the addition of an entry into the Directory.
final record	BindRequest	The Bind operation allows authentication information to be exchanged between the client and server.
final record	BindResult	A Bind result indicates the status of the client's request for authentication.
final record	CancelExtendedRequest	The cancel extended request as defined in RFC 3909.
final record	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.
final record	CompareResult	A Compare result indicates the final status of a Compare operation.
final record	DeleteRequest	The Delete request allows a client to request the removal of an entry from the Directory.
final record	GenericExtendedRequest	A generic Extended request which should be used for unsupported extended operations.
final record	GenericExtendedResult	A Generic Extended result indicates the final status of a Generic Extended operation.
final record	IntermediateResponse	Provides a mechanism for communicating intermediate responses to the client.
final record	InvalidRequest	Represents a request which has been received and decoded but is invalid according to the LDAP standard because of an invalid DN syntax or an invalid attribute syntax.
final record	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.
final record	ModifyRequest	The Modify operation allows a client to request that a modification of an entry be performed on its behalf by a server.
final record	PasswordModifyExtendedRequest	The password modify extended request as defined in RFC 3062.
final record	PasswordModifyExtendedResult	The password modify extended result as defined in RFC 3062.
final record	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.
final record	SearchResultEntry	A Search Result Entry represents an entry found during a Search operation.
final record	SearchResultReference	A Search Result Reference represents an area not yet explored during a Search operation.
final record	StartTlsExtendedRequest	The start TLS extended request as defined in RFC 4511.
final record	StartTlsExtendedResult	The start tls extended result as defined in RFC 4511.
final record	UnbindRequest	The Unbind operation allows a client to terminate an LDAP session.
final record	UnknownRequest	Wraps a message that the LdapServer was unable to decode because it did not recognize it.
final record	WhoAmIExtendedRequest	The who am I extended request as defined in RFC 4532.
final record	WhoAmIExtendedResult	The who am I extended result as defined in RFC 4532.

Methods in org.forgerock.opendj.ldap.messages that return ProtocolOp

Modifier and Type	Method	Description
default ProtocolOp	ProtocolOp.addControl(Control control)	Adds the provided control to this protocol-op.
default ProtocolOp	ProtocolOp.addControls(Iterable<? extends Control> controls)	Adds the provided controls to this protocol-op.
ProtocolOp	LdapMessage.protocolOp()	Returns the value of the protocolOp record component.
default ProtocolOp	ProtocolOp.removeControls(String oid)	Removes all the controls having the specified OID.

Constructors in org.forgerock.opendj.ldap.messages with parameters of type ProtocolOp

Modifier	Constructor	Description
	LdapMessage(int messageId, byte protocolOpType, ProtocolOp protocolOp)	Creates an instance of a LdapMessage record class.

Uses of ProtocolOp in org.forgerock.opendj.ldif

Subinterfaces of ProtocolOp in org.forgerock.opendj.ldif

Modifier and Type	Interface	Description
interface	ChangeRecord	A request to modify the content of the Directory in some way.