org.opends.server.replication.protocol
Class DoneMessage

java.lang.Object
  org.opends.server.replication.protocol.ReplicationMessage
      org.opends.server.replication.protocol.RoutableMessage
          org.opends.server.replication.protocol.DoneMessage

All Implemented Interfaces:

java.io.Serializable

public class DoneMessage
extends RoutableMessage
implements java.io.Serializable

This message is part of the replication protocol. This message is sent by a server to one or several other servers after the last entry sent in the context of a total update and signals to the server that receives it that the export is now finished.

See Also:

Serialized Form

Field Summary

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

ALL_SERVERS, destination, senderID, THE_CLOSEST_SERVER, UNKNOWN_SERVER

Constructor Summary

DoneMessage(byte[] in)
Creates a new message by decoding the provided byte array.

DoneMessage(short sender, short destination)
Creates a message.

Method Summary

byte[]

getBytes() Return the byte[] representation of this message.

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

getDestination, getsenderID, toString

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

addByteArray, generateMsg, getNextLength

Methods inherited from class java.lang.Object

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

Constructor Detail

DoneMessage

public DoneMessage(short sender,
                   short destination)

Creates a message.

Parameters:

sender - The sender server of this message.

destination - The server or servers targetted by this message.

DoneMessage

public DoneMessage(byte[] in)
            throws java.util.zip.DataFormatException

Creates a new message by decoding the provided byte array.

Parameters:

in - A byte array containing the encoded information for the message,

Throws:

java.util.zip.DataFormatException - If the in does not contain a properly, encoded message.

Method Detail

getBytes

public byte[] getBytes()

Return the byte[] representation of this message. Depending on the message type, the first byte of the byte[] must be. MSG_TYPE_MODIFY_REQUEST MSG_TYPE_ADD_REQUEST MSG_TYPE_DELETE_REQUEST MSG_TYPE_MODIFY_DN_REQUEST MSG_TYPE_ACK MSG_TYPE_SERVER_START MSG_TYPE_REPL_SERVER_START MSG_TYPE_WINDOW MSG_TYPE_HEARTBEAT MSG_TYPE_INITIALIZE MSG_TYPE_INITIALIZE_TARGET MSG_TYPE_ENTRY MSG_TYPE_DONE MSG_TYPE_ERROR MSG_TYPE_WINDOW_PROBE MSG_TYPE_REPL_SERVER_INFO MSG_TYPE_RESET_GENERATION_ID MSG_TYPE_REPL_SERVER_MONITOR_REQUEST MSG_TYPE_REPL_SERVER_MONITOR

Specified by:

getBytes in class ReplicationMessage

Returns:

the byte[] representation of this message.