com.unboundid.ldap.protocol
Interface ProtocolOp

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbandonRequestProtocolOp, AddRequest, AddRequestProtocolOp, AddResponseProtocolOp, BindRequestProtocolOp, BindResponseProtocolOp, CancelExtendedRequest, CompareRequest, CompareRequestProtocolOp, CompareResponseProtocolOp, DeleteRequest, DeleteRequestProtocolOp, DeleteResponseProtocolOp, EndTransactionExtendedRequest, ExtendedRequest, ExtendedRequestProtocolOp, ExtendedResponseProtocolOp, GenericResponseProtocolOp, IntermediateResponseProtocolOp, ModifyDNRequest, ModifyDNRequestProtocolOp, ModifyDNResponseProtocolOp, ModifyRequest, ModifyRequestProtocolOp, ModifyResponseProtocolOp, PasswordModifyExtendedRequest, SearchRequest, SearchRequestProtocolOp, SearchResultDoneProtocolOp, SearchResultEntryProtocolOp, SearchResultReferenceProtocolOp, SimpleBindRequest, StartTLSExtendedRequest, StartTransactionExtendedRequest, UnbindRequestProtocolOp, WhoAmIExtendedRequest

@InternalUseOnly
@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface ProtocolOp
extends java.io.Serializable

This interface defines a set of methods that should be implemented by all types of LDAP protocol ops.

Method Summary

byte	getProtocolOpType() Retrieves the BER type for this protocol op.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this LDAP protocol op to the provided buffer.
void	writeTo(ASN1Buffer buffer) Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer.

Method Detail

getProtocolOpType

byte getProtocolOpType()

Retrieves the BER type for this protocol op.

Returns:

The BER type for this protocol op.

writeTo

void writeTo(ASN1Buffer buffer)

Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.

Parameters:

buffer - The ASN.1 buffer to which the encoded representation should be written.

toString

void toString(java.lang.StringBuilder buffer)

Appends a string representation of this LDAP protocol op to the provided buffer.

Parameters:

buffer - The buffer to which the string representation should be appended.