Package org.opends.server.replication.protocol

Class ServerStartMsg

java.lang.Object

org.opends.server.replication.protocol.ReplicationMsg

org.opends.server.replication.protocol.StartMsg

org.opends.server.replication.protocol.ServerStartMsg

public final class ServerStartMsg
extends StartMsg

This message is used by LDAP server when they first connect. to a replication server to let them know who they are and what is their state (their RUV)

Field Summary

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

generationId, groupId, MAX_WINDOW_SIZE, protocolVersion

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
ServerStartMsg(ReplicaId replicaId, com.forgerock.opendj.util.HostPort adminEndpoint, Dn baseDN, long heartbeatInterval, ServerState serverState, GenerationId generationId, boolean sslEncryption, com.forgerock.opendj.discovery.GroupId groupId)	Creates a new ServerStartMsg.

Method Summary

Modifier and Type	Method	Description
com.forgerock.opendj.util.HostPort	getAdminEndpoint()	Get the server host port from the message.
Dn	getBaseDN()	Get the baseDN.
byte[]	getBytes(short protocolVersion)	Serializes the PDU using the provided replication protocol version.
long	getHeartbeatInterval()	Get the heartbeat interval requested by the ldap server that created the message.
ReplicaId	getReplicaId()	Get the replica ID from the message.
ServerState	getServerState()	Get the ServerState.
boolean	getSSLEncryption()	Get the SSL encryption value for the ldap server that created the message.
String	toString()

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

getGenerationId, getGroupId, getVersion, setGroupId

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

ServerStartMsg

public ServerStartMsg(ReplicaId replicaId,
                      com.forgerock.opendj.util.HostPort adminEndpoint,
                      Dn baseDN,
                      long heartbeatInterval,
                      ServerState serverState,
                      GenerationId generationId,
                      boolean sslEncryption,
                      com.forgerock.opendj.discovery.GroupId groupId)

Creates a new ServerStartMsg. This message is to be sent by an LDAP Server after being connected to a replication server for a given replication domain.

Parameters:

replicaId - The replicaId of the server for which the ServerStartMsg is created.

adminEndpoint - directory server host port

baseDN - The base DN.

heartbeatInterval - The requested heartbeat interval.

serverState - The state of this server.

generationId - The generationId for this server.

sslEncryption - Whether to continue using SSL to encrypt messages after the start messages have been exchanged.

groupId - The group id of the DS for this DN

Method Detail

getReplicaId

public ReplicaId getReplicaId()

Get the replica ID from the message.

Returns:

the replica ID

getAdminEndpoint

public com.forgerock.opendj.util.HostPort getAdminEndpoint()

Get the server host port from the message.

Returns:

the server host port

getBaseDN

public Dn getBaseDN()

Get the baseDN.

Returns:

Returns the baseDN.

getServerState

public ServerState getServerState()

Get the ServerState.

Returns:

The ServerState.

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 ReplicationMsg

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.

getHeartbeatInterval

public long getHeartbeatInterval()

Get the heartbeat interval requested by the ldap server that created the message.

Returns:

The heartbeat interval requested by the ldap server that created the message.

getSSLEncryption

public boolean getSSLEncryption()

Get the SSL encryption value for the ldap server that created the message.

Returns:

The SSL encryption value for the ldap server that created the message.

toString

public String toString()

Overrides:

toString in class Object