Package org.opends.server.replication.protocol

Class ExtendedStartMsg

java.lang.Object

org.opends.server.replication.protocol.ReplicationMsg

org.opends.server.replication.protocol.ExtendedStartMsg

public final class ExtendedStartMsg
extends ReplicationMsg

Added in protocol V10 to exchange additional information during handshake.

ASN.1 definition of the message is:

 ExtendedStartMsg ::= [APPLICATION 0] CHOICE {
      v10 PayloadV10
 }

 PayloadV10 ::= SEQUENCE {
      serverId ::= CHOICE {
           replicaId           [0] IMPLICIT PrintableString
           replicationServerId [1] IMPLICIT PrintableString
      },
      groupId PrintableString,
      processId ::= SEQUENCE OF {
          msb INTEGER,
          lsb INTEGER
      },
      serverState ::= SET OF {
          csn OCTET STRING
      }
 }
 

Field Summary

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
ExtendedStartMsg(Asn1Reader asn1)	Constructs a ExtendedStartMsg from a replication message.
ExtendedStartMsg(ServerId<?> serverId, com.forgerock.opendj.discovery.GroupId groupId, ProcessId processId, ServerState state)	Constructs an ExtendedStartMsg replication message for sending.

Method Summary

Modifier and Type	Method	Description
byte[]	getBytes(short protocolVersion)	Serializes the PDU using the provided replication protocol version.
com.forgerock.opendj.discovery.GroupId	getGroupId()	Returns the groupID in this message.
ProcessId	getProcessId()	Returns the processID in this message.
ServerId<?>	getServerId()	Returns the serverID in this message.
ServerState	getServerState()	Returns the ServerState in this message.

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, toString, wait, wait, wait

Constructor Detail

ExtendedStartMsg

public ExtendedStartMsg(ServerId<?> serverId,
                        com.forgerock.opendj.discovery.GroupId groupId,
                        ProcessId processId,
                        ServerState state)

Constructs an ExtendedStartMsg replication message for sending.

Parameters:

serverId - the serverID to send

groupId - the groupID to send

processId - the processID to send

state - the ServerState to send

ExtendedStartMsg

public ExtendedStartMsg(Asn1Reader asn1)
                 throws IOException,
                        DataFormatException

Constructs a ExtendedStartMsg from a replication message.

Parameters:

asn1 - the data from a received message

Throws:

IOException - if the message does not apply to this protocol version.

DataFormatException - aost

Method Detail

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.

getGroupId

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

Returns the groupID in this message.

Returns:

the groupID in this message

getServerId

public ServerId<?> getServerId()

Returns the serverID in this message.

Returns:

the serverID in this message

getProcessId

public ProcessId getProcessId()

Returns the processID in this message.

Returns:

the processID in this message

getServerState

public ServerState getServerState()

Returns the ServerState in this message.

Returns:

the ServerState in this message