org.opends.server.replication.protocol

Class AddMsg

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

All Implemented Interfaces:

Comparable<UpdateMsg>

public class AddMsg
extends LDAPUpdateMsg

This class is used to exchange Add operation between LDAP servers and replication servers.

Field Summary

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

MSG_TYPE_DISK_ENCODING

Constructor Summary

Constructors

Constructor and Description
AddMsg(byte[] in) Creates a new Add message from a byte[].
AddMsg(CSN csn, Entry entry, String entryUuid, String parentEntryUuid) Creates a new AddMessage.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String name, Object value) Add the specified attribute/attribute value in the entry contained in this AddMsg.
AddRequest	createRequest(Dn newDN) Create a request from this message using the provided DN.
List<Attribute>	getAttributes() Get the attributes of this add msg.
byte[]	getBytesV1() Get the byte array representation of this message.
byte[]	getBytesV23() Get the byte array representation of this message.
byte[]	getBytesV4ToLatest(short protocolVersion) Get the byte array representation of this message.
String	getParentEntryUUID() Get the parent unique id of this add msg.
void	setParentEntryUUID(String entryUUID) Set the parent unique id of this add msg.
int	size() Return the number of bytes used by this message.
String	toString()

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

createRequest, generateMsg, getBytes, getDN, getEclIncludes, getEntryUUID, setDN, setEclIncludes

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

compareTo, equals, getBytes, getCSN, getVersion, hashCode

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

decodeMsg, isRetryable

Methods inherited from class java.lang.Object

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

Constructor Detail

AddMsg

public AddMsg(CSN csn,
              Entry entry,
              String entryUuid,
              String parentEntryUuid)

Creates a new AddMessage.

Parameters:

csn - CSN of the add.

entry - the added entry.

entryUuid - The Unique identifier of the added entry.

parentEntryUuid - The unique Id of the parent of the added entry.

AddMsg

public AddMsg(byte[] in)
       throws DataFormatException

Creates a new Add message from a byte[].

Parameters:

in - The byte[] from which the operation must be read.

Throws:

DataFormatException - The input byte[] is not a valid AddMsg

Method Detail

createRequest

public AddRequest createRequest(Dn newDN)

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

getBytesV1

public byte[] getBytesV1()

Description copied from class: LDAPUpdateMsg

Get the byte array representation of this message.

This uses the version 1 of the replication protocol (used for compatibility).

Specified by:

getBytesV1 in class LDAPUpdateMsg

Returns:

The byte array representation of this message.

getBytesV23

public byte[] getBytesV23()

Description copied from class: LDAPUpdateMsg

Get the byte array representation of this message.

This uses the version 2 of the replication protocol (used for compatibility).

Specified by:

getBytesV23 in class LDAPUpdateMsg

Returns:

The byte array representation of this message.

getBytesV4ToLatest

public byte[] getBytesV4ToLatest(short protocolVersion)

Description copied from class: LDAPUpdateMsg

Get the byte array representation of this message.

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

Specified by:

getBytesV4ToLatest 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 UpdateMsg

addAttribute

public void addAttribute(String name,
                         Object value)

Add the specified attribute/attribute value in the entry contained in this AddMsg.

Parameters:

name - The name of the attribute to add.

value - The value of the attribute to add.

getAttributes

public List<Attribute> getAttributes()

Get the attributes of this add msg.

Returns:

the list of attributes

setParentEntryUUID

public void setParentEntryUUID(String entryUUID)

Set the parent unique id of this add msg.

Parameters:

entryUUID - the parent unique id.

getParentEntryUUID

public String getParentEntryUUID()

Get the parent unique id of this add msg.

Returns:

the parent unique id.

size

public int size()

Description copied from class: UpdateMsg

Return the number of bytes used by this message.

Specified by:

size in class LDAPUpdateMsg

Returns:

The number of bytes used by this message.