Package org.opends.server.replication.protocol

Class ReplicaOfflineMsg

java.lang.Object

org.opends.server.replication.protocol.ReplicationMsg

org.opends.server.replication.protocol.UpdateMsg

org.opends.server.replication.protocol.ReplicaOfflineMsg

All Implemented Interfaces:

Comparable<UpdateMsg>

public final class ReplicaOfflineMsg
extends UpdateMsg

Class that define messages sent by a replica (DS) to the replication server (RS) to let the RS know the date at which a replica went offline.

Field Summary

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

COMPACT_MASK, COMPACT_TYPE_ADD, COMPACT_TYPE_DELETE, COMPACT_TYPE_MODIFY, COMPACT_TYPE_MODIFY_DN, COMPACT_TYPE_REPLICA_OFFLINE, MSG_TYPE_DISK_ENCODING

Constructor Summary

Constructors

Constructor	Description
ReplicaOfflineMsg(byte[] in)	Creates a message by deserializing it from the provided byte array.
ReplicaOfflineMsg(CSN offlineCSN)	Constructor of a replica offline message providing the offline timestamp in a CSN.

Method Summary

Modifier and Type	Method	Description
<E extends Exception> void	accept(UpdateMsgVisitor<E> visitor)	Applies an UpdateMsgVisitor to this UpdateMsg.
byte[]	getBytes(short protocolVersion)	Serializes the PDU using the provided replication protocol version.
int	size()	Return the number of bytes used by this message.

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

compareTo, equals, getBytes, getCSN, getVersion, hashCode, toJson, toString

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 Details

ReplicaOfflineMsg

public ReplicaOfflineMsg(CSN offlineCSN)

Constructor of a replica offline message providing the offline timestamp in a CSN.

Parameters:

offlineCSN - the provided offline CSN

ReplicaOfflineMsg

public ReplicaOfflineMsg(byte[] in)
                  throws DataFormatException

Creates a message by deserializing it from the provided byte array.

Parameters:

in - The provided byte array.

Throws:

DataFormatException - When an error occurs during decoding .

Method Details

getBytes

public byte[] getBytes(short protocolVersion)

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 UpdateMsg

Parameters:

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

size

public int size()

Description copied from class: UpdateMsg

Return the number of bytes used by this message.

Specified by:

size in class UpdateMsg

Returns:

The number of bytes used by this message.

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.