Package org.opends.server.replication.protocol

Class ModifyMsg

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

org.opends.server.replication.protocol.ModifyMsg

All Implemented Interfaces:

Comparable<UpdateMsg>

public class ModifyMsg
extends ModifyCommonMsg

Message used to send Modify information.

Field Summary

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

encodedMods

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
ModifyMsg(CSN csn, DN dn, List<Modification> mods, String entryUUID)	Creates a new Modify message using the provided information.

Method Summary

Modifier and Type	Method	Description
ModifyOperation	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.
int	size()	Return the number of bytes used by this message.
String	toString()

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

decodeMods, decodeRawMods, encodeMods, getMods, setMods

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

ModifyMsg

public ModifyMsg(CSN csn,
                 DN dn,
                 List<Modification> mods,
                 String entryUUID)

Creates a new Modify message using the provided information.

Parameters:

csn - The CSN for the operation.

dn - The baseDN of the operation.

mods - The mod of the operation.

entryUUID - The unique id of the entry on which the modification needs to apply.

Method Detail

createOperation

public ModifyOperation createOperation(InternalClientConnection connection,
                                       DN newDN)
                                throws LDAPException,
                                       IOException,
                                       DataFormatException

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.

Throws:

LDAPException - In case of LDAP decoding exception.

IOException - In case of ASN1 decoding exception.

DataFormatException - In case of bad msg format.

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.

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.