Package org.opends.server.protocols.ldap

Class ModifyDNRequestProtocolOp

java.lang.Object

org.opends.server.protocols.ldap.ProtocolOp

org.opends.server.protocols.ldap.ModifyDNRequestProtocolOp

public class ModifyDNRequestProtocolOp
extends ProtocolOp

This class defines the structures and methods for an LDAP modify DN request protocol op, which is used to move or rename an entry or subtree within the Directory Server.

Constructor Summary

Constructors

Constructor	Description
ModifyDNRequestProtocolOp(ByteString entryDN, ByteString newRDN, boolean deleteOldRDN)	Creates a new modify DN request protocol op with the provided information.
ModifyDNRequestProtocolOp(ByteString entryDN, ByteString newRDN, boolean deleteOldRDN, ByteString newSuperior)	Creates a new modify DN request protocol op with the provided information.

Method Summary

Modifier and Type	Method	Description
boolean	deleteOldRDN()	Indicates whether the current RDN value(s) should be deleted.
ByteString	getEntryDN()	Retrieves the current entry DN for this modify DN request.
ByteString	getNewRDN()	Retrieves the new RDN for this modify DN request.
ByteString	getNewSuperior()	Retrieves the new superior DN for this modify DN request.
String	getProtocolOpName()	Retrieves the name for this protocol op type.
byte	getType()	Retrieves the BER type for this protocol op.
void	toString(StringBuilder buffer)	Appends a string representation of this LDAP protocol op to the provided buffer.
void	toString(StringBuilder buffer, int indent)	Appends a multi-line string representation of this LDAP protocol op to the provided buffer.
void	write(ASN1Writer stream)	Writes this protocol op to an ASN.1 output stream.

Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyDNRequestProtocolOp

public ModifyDNRequestProtocolOp(ByteString entryDN,
                                 ByteString newRDN,
                                 boolean deleteOldRDN)

Creates a new modify DN request protocol op with the provided information.

Parameters:

entryDN - The current entry DN for this modify DN request.

newRDN - The new RDN for this modify DN request.

deleteOldRDN - Indicates whether to delete the current RDN value(s).

ModifyDNRequestProtocolOp

public ModifyDNRequestProtocolOp(ByteString entryDN,
                                 ByteString newRDN,
                                 boolean deleteOldRDN,
                                 ByteString newSuperior)

Creates a new modify DN request protocol op with the provided information.

Parameters:

entryDN - The current entry DN for this modify DN request.

newRDN - The new RDN for this modify DN request.

deleteOldRDN - Indicates whether to delete the current RDN value(s).

newSuperior - The new superior DN for this modify DN request.

Method Detail

getEntryDN

public ByteString getEntryDN()

Retrieves the current entry DN for this modify DN request.

Returns:

The current entry DN for this modify DN request.

getNewRDN

public ByteString 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 the current RDN value(s) should be deleted.

Returns:

true if the current RDN value(s) should be deleted, or false if not.

getNewSuperior

public ByteString getNewSuperior()

Retrieves the new superior DN for this modify DN request.

Returns:

The new superior DN for this modify DN request, or null if none was provided.

getType

public byte getType()

Retrieves the BER type for this protocol op.

Specified by:

getType in class ProtocolOp

Returns:

The BER type for this protocol op.

getProtocolOpName

public String getProtocolOpName()

Retrieves the name for this protocol op type.

Specified by:

getProtocolOpName in class ProtocolOp

Returns:

The name for this protocol op type.

write

public void write(ASN1Writer stream)
           throws IOException

Writes this protocol op to an ASN.1 output stream.

Specified by:

write in class ProtocolOp

Parameters:

stream - The ASN.1 output stream to write to.

Throws:

IOException - If a problem occurs while writing to the stream.

toString

public void toString(StringBuilder buffer)

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

Specified by:

toString in class ProtocolOp

Parameters:

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

toString

public void toString(StringBuilder buffer,
                     int indent)

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

Specified by:

toString in class ProtocolOp

Parameters:

buffer - The buffer to which the information should be appended.

indent - The number of spaces from the margin that the lines should be indented.