com.unboundid.ldap.protocol

Interface ProtocolOp

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbandonRequestProtocolOp, AddRequest, AddRequestProtocolOp, AddResponseProtocolOp, BindRequestProtocolOp, BindResponseProtocolOp, CancelExtendedRequest, ClearMissedNotificationChangesAlarmExtendedRequest, CollectSupportDataExtendedRequest, CompareRequest, CompareRequestProtocolOp, CompareResponseProtocolOp, ConsumeSingleUseTokenExtendedRequest, DeleteNotificationDestinationExtendedRequest, DeleteNotificationSubscriptionExtendedRequest, DeleteRequest, DeleteRequestProtocolOp, DeleteResponseProtocolOp, DeliverOneTimePasswordExtendedRequest, DeliverPasswordResetTokenExtendedRequest, DeliverSingleUseTokenExtendedRequest, DeregisterYubiKeyOTPDeviceExtendedRequest, EndAdministrativeSessionExtendedRequest, EndBatchedTransactionExtendedRequest, EndTransactionExtendedRequest, ExtendedRequest, ExtendedRequestProtocolOp, ExtendedResponseProtocolOp, GeneratePasswordExtendedRequest, GenerateTOTPSharedSecretExtendedRequest, GenericResponseProtocolOp, GetBackupCompatibilityDescriptorExtendedRequest, GetChangelogBatchExtendedRequest, GetConfigurationExtendedRequest, GetConnectionIDExtendedRequest, GetPasswordQualityRequirementsExtendedRequest, GetSubtreeAccessibilityExtendedRequest, GetSupportedOTPDeliveryMechanismsExtendedRequest, IdentifyBackupCompatibilityProblemsExtendedRequest, IntermediateResponseProtocolOp, ListConfigurationsExtendedRequest, ListNotificationSubscriptionsExtendedRequest, ModifyDNRequest, ModifyDNRequestProtocolOp, ModifyDNResponseProtocolOp, ModifyRequest, ModifyRequestProtocolOp, ModifyResponseProtocolOp, MultiUpdateExtendedRequest, PasswordModifyExtendedRequest, PasswordPolicyStateExtendedRequest, PurgeRetiredInterServerCertificatesExtendedRequest, PurgeRetiredListenerCertificatesExtendedRequest, RegisterYubiKeyOTPDeviceExtendedRequest, ReplaceInterServerCertificateExtendedRequest, ReplaceListenerCertificateExtendedRequest, RevokeTOTPSharedSecretExtendedRequest, SearchRequest, SearchRequestProtocolOp, SearchResultDoneProtocolOp, SearchResultEntryProtocolOp, SearchResultReferenceProtocolOp, SetNotificationDestinationExtendedRequest, SetNotificationSubscriptionExtendedRequest, SetSubtreeAccessibilityExtendedRequest, SimpleBindRequest, StartAdministrativeSessionExtendedRequest, StartBatchedTransactionExtendedRequest, StartTLSExtendedRequest, StartTransactionExtendedRequest, StreamDirectoryValuesExtendedRequest, StreamProxyValuesExtendedRequest, UnbindRequestProtocolOp, ValidateTOTPPasswordExtendedRequest, VerifyPasswordExtendedRequest, 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

Modifier and Type	Method and Description
ASN1Element	encodeProtocolOp() Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.
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.

encodeProtocolOp

@NotNull
ASN1Element encodeProtocolOp()

Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.

Returns:

The ASN.1 element containing the encoded protocol op.

writeTo

void writeTo(@NotNull
             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(@NotNull
              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.