com.unboundid.ldap.protocol

Class DeleteRequestProtocolOp

java.lang.Object

com.unboundid.ldap.protocol.DeleteRequestProtocolOp

All Implemented Interfaces:

ProtocolOp, java.io.Serializable

@InternalUseOnly
 @NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class DeleteRequestProtocolOp
extends java.lang.Object
implements ProtocolOp

This class provides an implementation of an LDAP delete request protocol op.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeleteRequestProtocolOp(DeleteRequest request) Creates a new delete request protocol op from the provided delete request object.
DeleteRequestProtocolOp(java.lang.String dn) Creates a new delete request protocol op with the provided information.

Method Summary

Modifier and Type	Method and Description
static DeleteRequestProtocolOp	decodeProtocolOp(ASN1Element element) Decodes the provided ASN.1 element as a delete request protocol op.
ASN1Element	encodeProtocolOp() Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.
java.lang.String	getDN() Retrieves the target entry DN for this delete request.
byte	getProtocolOpType() Retrieves the BER type for this protocol op.
DeleteRequest	toDeleteRequest(Control... controls) Creates a delete request from this protocol op.
java.lang.String	toString() Retrieves a string representation of 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteRequestProtocolOp

public DeleteRequestProtocolOp(@NotNull
                               java.lang.String dn)

Creates a new delete request protocol op with the provided information.

Parameters:

dn - The entry DN for this delete request.

DeleteRequestProtocolOp

public DeleteRequestProtocolOp(@NotNull
                               DeleteRequest request)

Creates a new delete request protocol op from the provided delete request object.

Parameters:

request - The delete request object to use to create this protocol op.

Method Detail

getDN

@NotNull
public java.lang.String getDN()

Retrieves the target entry DN for this delete request.

Returns:

The target entry DN for this delete request.

getProtocolOpType

public byte getProtocolOpType()

Retrieves the BER type for this protocol op.

Specified by:

getProtocolOpType in interface ProtocolOp

Returns:

The BER type for this protocol op.

encodeProtocolOp

@NotNull
public ASN1Element encodeProtocolOp()

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

Specified by:

encodeProtocolOp in interface ProtocolOp

Returns:

The ASN.1 element containing the encoded protocol op.

decodeProtocolOp

@NotNull
public static DeleteRequestProtocolOp decodeProtocolOp(@NotNull
                                                                ASN1Element element)
                                                         throws LDAPException

Decodes the provided ASN.1 element as a delete request protocol op.

Parameters:

element - The ASN.1 element to be decoded.

Returns:

The decoded delete request protocol op.

Throws:

LDAPException - If the provided ASN.1 element cannot be decoded as a delete request protocol op.

writeTo

public 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.

Specified by:

writeTo in interface ProtocolOp

Parameters:

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

toDeleteRequest

@NotNull
public DeleteRequest toDeleteRequest(@Nullable
                                              Control... controls)

Creates a delete request from this protocol op.

Parameters:

controls - The set of controls to include in the delete request. It may be empty or null if no controls should be included.

Returns:

The delete request that was created.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this protocol op.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this protocol op.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

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

Specified by:

toString in interface ProtocolOp

Parameters:

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