org.opends.server.replication.protocol

Class ErrorMsg

java.lang.Object

org.opends.server.replication.protocol.ReplicationMsg

org.opends.server.replication.protocol.RoutableMsg

org.opends.server.replication.protocol.ErrorMsg

public class ErrorMsg
extends RoutableMsg

This message is part of the replication protocol.

This message is sent by a server or a replication server when an error is detected in the context of a total update.

Field Summary

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

destination, senderId

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

MSG_TYPE_DISK_ENCODING

Constructor Summary

Constructors

Constructor and Description
ErrorMsg(ReplicaId destination, LocalizableMessage details) Creates an ErrorMsg.
ErrorMsg(ServerId<?> sender, ReplicaId destination, LocalizableMessage details) Creates an ErrorMsg providing the destination server.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes(short version) Serializes the PDU using the provided replication protocol version.
long	getCreationTime() Get the creation time of this message.
LocalizableMessage	getDetails() Get the details from this message.
String	getMsgID() Get the msgID from this message.
void	setCreationTime(long creationTime) Get the creation time of this message.
String	toString() Returns a string representation of the message.

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

getDestination, getSenderID

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

decodeMsg, isRetryable

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorMsg

public ErrorMsg(ServerId<?> sender,
                ReplicaId destination,
                LocalizableMessage details)

Creates an ErrorMsg providing the destination server.

Both a replica and a replication server can send an error message, so sender must be able to represent either a ReplicaId or a ReplicationServerId.

Parameters:

sender - The server ID of the server that send this message.

destination - The destination server or servers of this message.

details - The message containing the details of the error.

ErrorMsg

public ErrorMsg(ReplicaId destination,
                LocalizableMessage details)

Creates an ErrorMsg.

Parameters:

destination - replication server id

details - details of the error

Method Detail

getDetails

public LocalizableMessage getDetails()

Get the details from this message.

Returns:

the details from this message.

getMsgID

public String getMsgID()

Get the msgID from this message.

Returns:

the msgID from this message.

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.

toString

public String toString()

Returns a string representation of the message.

Overrides:

toString in class RoutableMsg

Returns:

the string representation of this message.

getCreationTime

public long getCreationTime()

Get the creation time of this message. When several attempts of initialization are done sequentially, it helps sorting the good ones, from the ones that relate to ended initialization when they are received.

Returns:

the creation time of this message.

setCreationTime

public void setCreationTime(long creationTime)

Get the creation time of this message.

Parameters:

creationTime - the creation time of this message.