Package org.opends.server.replication.protocol

Class DeleteMsg

java.lang.Object

org.opends.server.replication.protocol.ReplicationMsg

org.opends.server.replication.protocol.UpdateMsg

org.opends.server.replication.protocol.LDAPUpdateMsg

org.opends.server.replication.protocol.DeleteMsg

All Implemented Interfaces:

Comparable<UpdateMsg>

public class DeleteMsg
extends LDAPUpdateMsg

Object used when sending delete information to replication servers.

Field Summary

Fields inherited from class org.opends.server.replication.protocol.LDAPUpdateMsg

bytes, dn, encodedEclIncludes, entryUUID

Fields inherited from class org.opends.server.replication.protocol.UpdateMsg

assuredFlag, assuredMode, csn, protocolVersion, safeDataLevel

Fields inherited from class org.opends.server.replication.protocol.ReplicationMsg

MSG_TYPE_DISK_ENCODING

Constructor Summary

Constructors

Constructor	Description
DeleteMsg(DN dn, CSN csn, String entryUUID)	Creates a new delete message.

Method Summary

Modifier and Type	Method	Description
DeleteOperation	createOperation(InternalClientConnection connection, DN newDN)	Create and Operation from the message using the provided DN.
byte[]	getBytes_V1()	Get the byte array representation of this message.
byte[]	getBytes_V23()	Get the byte array representation of this message.
byte[]	getBytes_V45(short protocolVersion)	Get the byte array representation of this message.
String	getInitiatorsName()	Get the initiator's name of this change.
boolean	isSubtreeDelete()	Get the subtree flag.
void	setInitiatorsName(String iname)	Set the initiator's name of this change.
void	setSubtreeDelete(boolean subtreeDelete)	Set the subtree flag.
int	size()	Return the number of bytes used by this message.
String	toString()

Methods inherited from class org.opends.server.replication.protocol.LDAPUpdateMsg

createOperation, encode, encodeHeader, generateMsg, getBytes, getDN, getEclIncludes, getEntryUUID, headerSize, setDN, setEclIncludes

Methods inherited from class org.opends.server.replication.protocol.UpdateMsg

compareTo, contributesToDomainState, decodeHeader, equals, getAssuredMode, getBytes, getCSN, getPayload, getSafeDataLevel, getVersion, hashCode, isAssured, setAssured, setAssuredMode, setSafeDataLevel

Methods inherited from class org.opends.server.replication.protocol.ReplicationMsg

generateMsg, isEncodableFor

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteMsg

public DeleteMsg(DN dn,
                 CSN csn,
                 String entryUUID)

Creates a new delete message.

Parameters:

dn - The dn with which the message must be created.

csn - The CSN with which the message must be created.

entryUUID - The unique id with which the message must be created.

Method Detail

createOperation

public DeleteOperation createOperation(InternalClientConnection connection,
                                       DN newDN)

Create and Operation from the message using the provided DN.

Specified by:

createOperation in class LDAPUpdateMsg

Parameters:

connection - connection to use when creating the message.

newDN - the DN to use when creating the operation.

Returns:

the created Operation.

getBytes_V1

public byte[] getBytes_V1()

Get the byte array representation of this message. This uses the version 1 of the replication protocol (used for compatibility purpose).

Specified by:

getBytes_V1 in class LDAPUpdateMsg

Returns:

The byte array representation of this message.

getBytes_V23

public byte[] getBytes_V23()

Get the byte array representation of this message. This uses the version 2 of the replication protocol (used for compatibility purpose).

Specified by:

getBytes_V23 in class LDAPUpdateMsg

Returns:

The byte array representation of this message.

getBytes_V45

public byte[] getBytes_V45(short protocolVersion)

Get the byte array representation of this message. This uses the provided version number which must be version 4 or newer.

Specified by:

getBytes_V45 in class LDAPUpdateMsg

Parameters:

protocolVersion - the actual protocol version to encode into

Returns:

The byte array representation of this Message.

toString

public String toString()

Overrides:

toString in class Object

size

public int size()

Return the number of bytes used by this message.

Specified by:

size in class LDAPUpdateMsg

Returns:

The number of bytes used by this message.

setInitiatorsName

public void setInitiatorsName(String iname)

Set the initiator's name of this change.

Parameters:

iname - the initiator's name.

getInitiatorsName

public String getInitiatorsName()

Get the initiator's name of this change.

Returns:

the initiator's name.

setSubtreeDelete

public void setSubtreeDelete(boolean subtreeDelete)

Set the subtree flag.

Parameters:

subtreeDelete - the subtree flag.

isSubtreeDelete

public boolean isSubtreeDelete()

Get the subtree flag.

Returns:

the subtree flag.