@PublicAPI(stability=PRIVATE)

Package org.opends.server.replication.protocol

This package contains the code used by the replication server and by the code running on the Directory Server side to exchange their information.

The main classes of this packages are :

• Session implements the session and protocol that is used by the replication server and the directory server to communicate. This is done by using the innate encoding/decoding capabilities of the ReplicationMessages objects. This class is used by both the server and the plugin package.
• ReplicationMessage This class and the class that inherit from it contain the messages that are used for communication between the replication server and the Directory Server as well as the methods fro encoding/decoding them.

Class Summary

Class	Description
AckMsg	AckMsg messages are used for acknowledging an update that has been sent requesting an ack: update sent in Assured Mode, either safe data or safe read sub mode.
AddContext	This class describes the context that is attached to Add Operation.
AddMsg	This class is used to exchange Add operation between LDAP servers and replication servers.
ByteArrayBuilder	Byte array builder class encodes data into byte arrays to send messages over the replication protocol.
ByteArrayScanner	Byte array scanner class helps decode data from byte arrays received via messages over the replication protocol.
ChangeStatusMsg	This message is used by the DS to tell the RS he is changing his status (new status field used), or by the RS to tell the DS he must change his status (requested status field used).
ChangeTimeHeartbeatMsg	Class that define messages sent by a replication domain (DS) to the replication server to let the RS know the DS current change time.
DeleteContext	This class is used to describe the context attached to a Delete Operation.
DeleteMsg	Object used when sending delete information to replication servers.
DoneMsg	This message is part of the replication protocol.
EntryMsg	This message is part of the replication protocol.
ErrorMsg	This message is part of the replication protocol.
HeartbeatMsg	This message is sent at regular intervals by the replication server when it is sending no other messages.
HeartbeatThread	This thread publishes a HeartbeatMsg on a given protocol session at regular intervals when there are no other replication messages being published.
InitializeRcvAckMsg	This message is used by LDAP server or by Replication Servers to update the send window of the remote entities.
InitializeRequestMsg	This message is part of the replication protocol.
InitializeTargetMsg	This message is part of the replication protocol.
LDAPUpdateMsg	Abstract class that must be extended to define a message used for sending Updates between servers.
ModifyCommonMsg	This class holds every common code for the modify messages (mod, moddn).
ModifyContext	This class describe the replication context that is attached to Modify operation.
ModifyDnContext	This class describe the replication context that is attached to ModifyDN operation.
ModifyDNMsg	Message used to send Modify DN information.
ModifyMsg	Message used to send Modify information.
MonitorMsg	This message is part of the replication protocol.
MonitorRequestMsg	This message is part of the replication protocol.
OperationContext	This class describe the replication context that is attached to each Operation using the SYNCHROCONTEXT key.
ProtocolVersion	The version utility class for the replication protocol.
ReplicaOfflineMsg	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.
ReplicationMsg	Abstract class that must be used when defining messages that can be sent for replication purpose between servers.
ReplServerStartDSMsg	Message sent by a replication server to a directory server in reply to the ServerStartMsg.
ReplServerStartMsg	Message sent by a replication server to another replication server at Startup.
ReplSessionSecurity	This class represents the security configuration for replication protocol sessions.
ResetGenerationIdMsg	This message is used by an LDAP server to communicate to the topology that the generation must be reset for the domain.
RoutableMsg	This is an abstract class of messages of the replication protocol for message that needs to contain information about the server that send them and the destination servers to which they should be sent.
ServerStartMsg	This message is used by LDAP server when they first connect.
Session	This class defines a replication session using TLS.
StartMsg	This abstract message class is the superclass for start messages used by LDAP servers and Replication servers to initiate their communications.
StartSessionMsg	This message is used by DS to confirm a RS he wants to connect to him (open a session): Handshake sequence between DS and RS is like this: DS --- ServerStartMsg ---> RS DS <--- ReplServerStartMsg --- RS DS --- StartSessionMsg ---> RS DS <--- TopologyMsg --- RS This message contains: - status: the status we are entering the topology with - referrals URLs: the referrals URLs we allow peer DSs to use to refer to our domain when needed.
StopMsg	This message is part of the replication protocol.
TopologyMsg	This class defines a message that is sent: - By a RS to the other RSs in the topology, containing: - the DSs directly connected to the RS in the DS infos - only this RS in the RS infos - By a RS to his connected DSs, containing every DSs and RSs he knows.
UpdateMsg	Abstract class that must be extended to define a message used for sending Updates between servers.
WindowMsg	This message is used by LDAP server or by Replication Servers to update the send window of the remote entities.
WindowProbeMsg	This message is used by LDAP or Replication Server that have been out of credit for a while and want to check if the remote servers is able to accept more messages.

Exception Summary

Exception

Description

NotSupportedOldVersionPDUException

This exception should be raised by the un-serialization code of a PDU (typically the constructor code with a byte[] parameter), when the detected PDU type (deduced from the first received byte of the message) is a PDU used in an older version of the replication protocol than the current one, and we do not support translation from this old version PDU to his matching PDU in the current protocol version (if it exists).