Package org.opends.server.replication.protocol

Class EntryMsg

java.lang.Object

org.opends.server.replication.protocol.ReplicationMsg

org.opends.server.replication.protocol.InitializationMsg

org.opends.server.replication.protocol.EntryMsg

public final class EntryMsg
extends InitializationMsg

This message is part of the replication protocol. This message is sent by a server to one or several other servers and contain one entry to be sent over the protocol in the context of an import/export over the protocol.

Field Summary

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

destination, senderId

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

MSG_TYPE_DISK_ENCODING

Constructor Summary

Constructors

Constructor	Description
EntryMsg(ReplicaId sender, ReplicaId destination, byte[] entryBytes, int msgId)	Creates a new EntryMsg.
EntryMsg(ReplicaId sender, ReplicaId destination, byte[] entryBytes, int startPos, int length, int msgId)	Creates a new EntryMsg.

Method Summary

Modifier and Type	Method	Description
byte[]	getBytes(short version)	Serializes the PDU using the provided replication protocol version.
byte[]	getEntryBytes()	Returns the entry bytes.
int	getMsgId()	Return the msg id.
ReplicaId	getSenderID()	Get the server ID of the server that sent this message.
boolean	isRetryable()	Returns if in case of I/O error we should try to send this message again.

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

getDestination, toString

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

decodeMsg

Methods inherited from class java.lang.Object

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

Constructor Details

EntryMsg

public EntryMsg(ReplicaId sender,
 ReplicaId destination,
 byte[] entryBytes,
 int msgId)

Creates a new EntryMsg.

Parameters:

sender - The sender of this message.

destination - The destination of this message.

entryBytes - The bytes of the entry.

msgId - Message counter.

EntryMsg

public EntryMsg(ReplicaId sender,
 ReplicaId destination,
 byte[] entryBytes,
 int startPos,
 int length,
 int msgId)

Creates a new EntryMsg.

Parameters:

sender - The sender of this message.

destination - The destination of this message.

entryBytes - The bytes of the entry.

startPos - The starting Position in the array.

length - Number of array elements to be copied.

msgId - Message counter.

Method Details

getEntryBytes

public byte[] getEntryBytes()

Returns the entry bytes.

Returns:

The entry bytes.

getBytes

public byte[] getBytes(short version)

Description copied from class: ReplicationMsg

Serializes the PDU using the provided replication protocol version. WARNING: should be overwritten by a PDU (sub class) we want to support older protocol version serialization for.

Specified by:

getBytes in class ReplicationMsg

Parameters:

version - The protocol version to use for serialization. The version should normally be older than the current one.

Returns:

The encoded PDU, or null if the message isn't supported in that protocol version.

getMsgId

public int getMsgId()

Return the msg id.

Returns:

The msg id.

getSenderID

public ReplicaId getSenderID()

Description copied from class: InitializationMsg

Get the server ID of the server that sent this message.

Overrides:

getSenderID in class InitializationMsg

Returns:

the server id

isRetryable

public boolean isRetryable()

Description copied from class: ReplicationMsg

Returns if in case of I/O error we should try to send this message again.

Overrides:

isRetryable in class ReplicationMsg

Returns:

if in case of I/O error we should try to send this message again