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 final class ModifyMsg
extends ModifyCommonMsg

Message used to send Modify information.

Field Summary

Fields inherited from class ReplicationMsg

MSG_TYPE_DISK_ENCODING

Constructor Summary

Constructors

Constructor	Description
ModifyMsg(Csn csn, Dn dn, UUID entryUUID, byte[] encodedMods, byte[] encodedEclIncludes)	Creates a new Modify message using the provided information.
ModifyMsg(Csn csn, Dn dn, UUID entryUUID, List<Modification> mods)	Creates a new Modify message using the provided information.

Method Summary

Modifier and Type	Method	Description
<E extends Exception> void	accept(UpdateMsgVisitor<E> visitor)	Applies an UpdateMsgVisitor to this UpdateMsg.
ModifyRequest	createRequest(Dn newDN)	Create a request from this message using the provided DN.
byte[]	getBytesLatest(short protocolVersion)	Returns the byte array representation of this message.
int	size()	Returns the number of bytes used by this message.

Methods inherited from class ModifyCommonMsg

appendEncodedMods, getMods, setMods

Methods inherited from class LdapUpdateMsg

appendEclIncludes, createRequest, generateMsg, getBytes, getDN, getEclIncludes, getEntryUUID, setDN, setEclIncludes, toJson, toString

Methods inherited from class UpdateMsg

compareTo, equals, getBytes, getCsn, getVersion, hashCode

Methods inherited from class ReplicationMsg

decodeMsg, isRetryable

Methods inherited from class Object

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

Constructor Details

ModifyMsg

public ModifyMsg(Csn csn,
 Dn dn,
 UUID entryUUID,
 List<Modification> mods)

Creates a new Modify message using the provided information.

Parameters:

csn - The CSN for the operation.

dn - The baseDN of the operation.

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

mods - The mod of the operation.

ModifyMsg

public ModifyMsg(Csn csn,
 Dn dn,
 UUID entryUUID,
 byte[] encodedMods,
 byte[] encodedEclIncludes)

Creates a new Modify message using the provided information.

Parameters:

csn - The CSN for the operation.

dn - The baseDN of the operation.

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

encodedMods - The encodedMods of the operation.

encodedEclIncludes - The encodedEclIncludes of the operation.

Method Details

accept

public <E extends Exception> void accept(UpdateMsgVisitor<E> visitor)
                                  throws E

Description copied from class: UpdateMsg

Applies an UpdateMsgVisitor to this UpdateMsg.

Specified by:

accept in class UpdateMsg

Type Parameters:

E - The type of the exception thrown by the visitor method if it fails, or NeverThrowsException if the visitor cannot fail.

Parameters:

visitor - The message visitor.

Throws:

E - If the visitor failed.

createRequest

public ModifyRequest createRequest(Dn newDN)
                            throws IOException

Description copied from class: LdapUpdateMsg

Create a request from this message using the provided DN.

Specified by:

createRequest in class LdapUpdateMsg

Parameters:

newDN - the DN to use when creating the request.

Returns:

the created request

Throws:

IOException - In case of ASN1 decoding exception

size

public int size()

Description copied from class: UpdateMsg

Returns the number of bytes used by this message.

Specified by:

size in class LdapUpdateMsg

Returns:

the number of bytes used by this message

getBytesLatest

public byte[] getBytesLatest(short protocolVersion)

Description copied from class: LdapUpdateMsg

Returns the byte array representation of this message.

This uses the provided version number which must be at least version 4.

Specified by:

getBytesLatest in class LdapUpdateMsg

Parameters:

protocolVersion - the actual protocol version to encode into

Returns:

the byte array representation of this message