Package org.opends.server.replication.protocol

Class StartMsg

java.lang.Object

org.opends.server.replication.protocol.ReplicationMsg

org.opends.server.replication.protocol.StartMsg

Direct Known Subclasses:

ReplServerStartDSMsg, ReplServerStartMsg, ServerStartMsg

public abstract class StartMsg
extends ReplicationMsg

This abstract message class is the superclass for start messages used by LDAP servers and Replication servers to initiate their communications. This class specifies a message header that contains the Replication Protocol version.

Field Summary

Fields

Modifier and Type	Field	Description
protected GenerationId	generationId	Generation id of data set we want to work with.
protected com.forgerock.opendj.discovery.GroupId	groupId	Group id of the replicated domain.
static final int	MAX_WINDOW_SIZE	The window size that will be sent to remote peers.
protected short	protocolVersion	Protocol version.

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

Modifier	Constructor	Description
protected	StartMsg()	Create a new StartMsg.

Method Summary

Modifier and Type	Method	Description
GenerationId	getGenerationId()	Get the generationId from this message.
com.forgerock.opendj.discovery.GroupId	getGroupId()	Get the group id in this message.
short	getVersion()	Get the version included in the Start message mean the replication protocol version used by the server that created the message.
void	setGroupId(com.forgerock.opendj.discovery.GroupId groupId)	Set the group id in this message (For test purpose).

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

decodeMsg, getBytes, isRetryable

Methods inherited from class java.lang.Object

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

Field Details

MAX_WINDOW_SIZE

public static final int MAX_WINDOW_SIZE

The window size that will be sent to remote peers. The parameter is ignored from protocol version 9 onwards.

See Also:

• Constant Field Values

protocolVersion

protected short protocolVersion

Protocol version.

generationId

protected GenerationId generationId

Generation id of data set we want to work with.

groupId

protected com.forgerock.opendj.discovery.GroupId groupId

Group id of the replicated domain.

Constructor Details

StartMsg

protected StartMsg()

Create a new StartMsg.

Method Details

getVersion

public short getVersion()

Get the version included in the Start message mean the replication protocol version used by the server that created the message.

Returns:

The version used by the server that created the message.

getGenerationId

public GenerationId getGenerationId()

Get the generationId from this message.

Returns:

The generationId.

getGroupId

public com.forgerock.opendj.discovery.GroupId getGroupId()

Get the group id in this message.

Returns:

The group id in this message

setGroupId

public void setGroupId(com.forgerock.opendj.discovery.GroupId groupId)

Set the group id in this message (For test purpose).

Parameters:

groupId - The group id to set.