com.unboundid.ldap.protocol
Class ModifyDNRequestProtocolOp

java.lang.Object
  extended by com.unboundid.ldap.protocol.ModifyDNRequestProtocolOp
All Implemented Interfaces:
ProtocolOp, java.io.Serializable

@InternalUseOnly
public final class ModifyDNRequestProtocolOp
extends java.lang.Object
implements ProtocolOp

This class provides an implementation of an LDAP modify DN request protocol op.

See Also:
Serialized Form

Field Summary
static byte TYPE_NEW_SUPERIOR
          The BER type for the newSuperior element.
 
Constructor Summary
ModifyDNRequestProtocolOp(ModifyDNRequest request)
          Creates a new modify DN request protocol op from the provided modify DN request object.
ModifyDNRequestProtocolOp(java.lang.String dn, java.lang.String newRDN, boolean deleteOldRDN, java.lang.String newSuperiorDN)
          Creates a new modify DN request protocol op with the provided information.
 
Method Summary
static ModifyDNRequestProtocolOp decodeProtocolOp(ASN1Element element)
          Decodes the provided ASN.1 element as a modify DN request protocol op.
 boolean deleteOldRDN()
          Indicates whether to delete the old RDN values from the target entry.
 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 modify DN request.
 java.lang.String getNewRDN()
          Retrieves the new RDN for this modify DN request.
 java.lang.String getNewSuperiorDN()
          Retrieves the new superior DN for this modify DN request, if any.
 byte getProtocolOpType()
          Retrieves the BER type for this protocol op.
 ModifyDNRequest toModifyDNRequest(Control... controls)
          Creates a modify DN 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
 

Field Detail

TYPE_NEW_SUPERIOR

public static final byte TYPE_NEW_SUPERIOR
The BER type for the newSuperior element.

See Also:
Constant Field Values
Constructor Detail

ModifyDNRequestProtocolOp

public ModifyDNRequestProtocolOp(java.lang.String dn,
                                 java.lang.String newRDN,
                                 boolean deleteOldRDN,
                                 java.lang.String newSuperiorDN)
Creates a new modify DN request protocol op with the provided information.

Parameters:
dn - The entry DN for this modify DN request.
newRDN - The new RDN for this modify DN request.
deleteOldRDN - Indicates whether to delete the old RDN values.
newSuperiorDN - The new superior DN for this modify DN request, or null if there is none.

ModifyDNRequestProtocolOp

public ModifyDNRequestProtocolOp(ModifyDNRequest request)
Creates a new modify DN request protocol op from the provided modify DN request object.

Parameters:
request - The modify DN request object to use to create this protocol op.
Method Detail

getDN

public java.lang.String getDN()
Retrieves the target entry DN for this modify DN request.

Returns:
The target entry DN for this modify DN request.

getNewRDN

public java.lang.String getNewRDN()
Retrieves the new RDN for this modify DN request.

Returns:
The new RDN for this modify DN request.

deleteOldRDN

public boolean deleteOldRDN()
Indicates whether to delete the old RDN values from the target entry.

Returns:
true if the old RDN values should be removed from the entry, or false if not.

getNewSuperiorDN

public java.lang.String getNewSuperiorDN()
Retrieves the new superior DN for this modify DN request, if any.

Returns:
The new superior DN for this modify DN request, or null if there is none.

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

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

public static ModifyDNRequestProtocolOp decodeProtocolOp(ASN1Element element)
                                                  throws LDAPException
Decodes the provided ASN.1 element as a modify DN request protocol op.

Parameters:
element - The ASN.1 element to be decoded.
Returns:
The decoded modify DN request protocol op.
Throws:
LDAPException - If the provided ASN.1 element cannot be decoded as a modify DN request protocol op.

writeTo

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

Specified by:
writeTo in interface ProtocolOp
Parameters:
buffer - The ASN.1 buffer to which the encoded representation should be written.

toModifyDNRequest

public ModifyDNRequest toModifyDNRequest(Control... controls)
Creates a modify DN request from this protocol op.

Parameters:
controls - The set of controls to include in the modify DN request. It may be empty or null if no controls should be included.
Returns:
The modify DN request that was created.

toString

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