edu.umass.cs.reconfiguration.reconfigurationpackets

Class StartEpoch<NodeIDType>

java.lang.Object

edu.umass.cs.protocoltask.json.ProtocolPacket<NodeIDType,ReconfigurationPacket.PacketType>

edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket<NodeIDType>

edu.umass.cs.reconfiguration.reconfigurationpackets.BasicReconfigurationPacket<NodeIDType>

edu.umass.cs.reconfiguration.reconfigurationpackets.StartEpoch<NodeIDType>

Type Parameters:

NodeIDType - FIXME: This class is increasingly under risk of becoming the kitchen sink for every piece of information needed anywhere in the reconfiguration protocol sequence. A better design may be to carry the causal reconfiguration packet (create, delete, reconfigureRC, etc.) here instead of carrying all fields in all startEpoch packets.

All Implemented Interfaces:

Request, Byteable, ProtocolEvent<ReconfigurationPacket.PacketType,java.lang.String>, ThresholdProtocolEvent<NodeIDType,ReconfigurationPacket.PacketType,java.lang.String>, Keyable<java.lang.String>, Summarizable

public class StartEpoch<NodeIDType>
extends BasicReconfigurationPacket<NodeIDType>

Author:

V. Arun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	StartEpoch.Keys

Nested classes/interfaces inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket

ReconfigurationPacket.PacketType

Field Summary

Fields

Modifier and Type	Field and Description
java.net.InetSocketAddress	creator Sender address.
java.util.Set<NodeIDType>	curEpochGroup Group members in the current epoch being started.
java.lang.String	initialState Initial state of epoch being started.
boolean	isMerge Whether the corresponding reconfiguration is a merge (used in RC group reconfiguration when RC nodes are deleted).
java.util.Set<java.lang.String>	mergees The list of deleted nodes that must be merged with this node.
java.util.Map<NodeIDType,java.net.InetSocketAddress>	newlyAddedNodes Socket address map for new RC nodes being added.
int	prevEpoch For supporting RC group merge or split operations wherein the previous epoch group may have a different name and epoch number.
java.util.Set<NodeIDType>	prevEpochGroup Group members in the epoch just before the one being started.
java.lang.String	prevGroupName For supporting RC group merge or split operations wherein the previous epoch group may have a different name.
java.net.InetSocketAddress	receiver Receiver address.

Fields inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.BasicReconfigurationPacket

epochNumber, serviceName

Fields inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket

clientPacketTypes, HANDLER_METHOD_PREFIX, PACKET_TYPE, serverPacketTypes

Fields inherited from class edu.umass.cs.protocoltask.json.ProtocolPacket

type

Fields inherited from interface edu.umass.cs.gigapaxos.interfaces.Request

NO_OP

Constructor Summary

Constructors

Constructor and Description
StartEpoch(org.json.JSONObject json, Stringifiable<NodeIDType> unstringer)
StartEpoch(NodeIDType initiator, StartEpoch<NodeIDType> startEpoch) Just to reset final field initiator.
StartEpoch(NodeIDType initiator, java.lang.String serviceName, int epochNumber, java.util.Set<NodeIDType> curNodes, boolean passive)
StartEpoch(NodeIDType myID, java.lang.String serviceName, int epochNumber, java.util.Set<NodeIDType> curNodes, java.util.Set<NodeIDType> prevNodes, java.net.InetSocketAddress creator, java.net.InetSocketAddress receiver, java.net.InetSocketAddress forwarder, java.lang.String initialState, java.util.Map<java.lang.String,java.lang.String> nameStates, java.util.Map<NodeIDType,java.net.InetSocketAddress> newlyAddedNodes, ReconfigurationConfig.ReconfigureUponActivesChange policy)
StartEpoch(NodeIDType initiator, java.lang.String serviceName, int epochNumber, java.util.Set<NodeIDType> curNodes, java.util.Set<NodeIDType> prevNodes, java.util.Set<java.lang.String> mergees)
StartEpoch(NodeIDType initiator, java.lang.String serviceName, int epochNumber, java.util.Set<NodeIDType> curNodes, java.util.Set<NodeIDType> prevNodes, java.lang.String prevGroupName, boolean isMerge, int prevEpoch)
StartEpoch(StartEpoch<NodeIDType> startEpoch, java.lang.String initialState) Just to reset final field initialState.

Method Summary

Modifier and Type	Method and Description
java.util.Set<NodeIDType>	getCommonMembers()
java.util.Set<NodeIDType>	getCurEpochGroup()
java.util.Set<NodeIDType>	getDeletedNodes()
NodeIDType	getFirstPrevEpochCandidate()
java.net.InetSocketAddress	getForwarder()
java.lang.String	getInitialState()
java.util.Set<NodeIDType>	getInitiatorAsSet()
long	getInitTime()
java.util.Set<java.lang.String>	getMergees()
java.net.InetSocketAddress	getMyReceiver()
java.util.Map<java.lang.String,java.lang.String>	getNameStates()
java.util.Set<NodeIDType>	getNewlyAddedNodes()
java.util.Set<NodeIDType>	getPrevEpochGroup()
int	getPrevEpochNumber()
java.lang.String	getPrevGroupName()
ReconfigurationConfig.ReconfigureUponActivesChange	getReconfigureUponActivesChangePolicy()
boolean	hasCurEpochGroup()
boolean	hasMergees()
boolean	hasNewlyAddedNodes()
boolean	hasPrevEpochGroup()
boolean	isActiveNodeConfigChange()
boolean	isBatchedCreate()
boolean	isCreateRequest()
boolean	isDeleteRequest()
boolean	isInitEpoch()
boolean	isMerge()
boolean	isNodeConfigChange()
boolean	isPassive()
boolean	isRCNodeConfigChange()
boolean	isSplit()
boolean	isSplitOrMerge()
boolean	noCurEpochGroup()
boolean	noPrevEpochGroup()
StartEpoch<NodeIDType>	setFirstPrevEpochCandidate(NodeIDType node)
org.json.JSONObject	toJSONObjectImpl()

Methods inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.BasicReconfigurationPacket

getEpochNumber, getRequestType, getServiceName, getSummary

Methods inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket

assertPacketTypeChecks, assertPacketTypeChecks, assertPacketTypeChecks, assertPacketTypeChecks, concatenate, getMessage, getPacketType, getPacketTypeCanonicalClassName, getPacketTypeClass, getPacketTypeClassName, getReconfigurationPacket, getReconfigurationPacket, getReconfigurationPacketSuppressExceptions, getReconfigurationPacketSuppressExceptions, getReconfigurationPacketType, getReconfigurationPacketType, isReconfigurationPacket, putPacketType, toBytes, toString

Methods inherited from class edu.umass.cs.protocoltask.json.ProtocolPacket

flip, getInitiator, getKey, getSender, getType, setKey, setSender, setType, toJSONObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.umass.cs.gigapaxos.interfaces.Request

toBytes, toString

Methods inherited from interface edu.umass.cs.utils.Summarizable

getSummary

Field Detail

prevEpochGroup

public final java.util.Set<NodeIDType> prevEpochGroup

Group members in the epoch just before the one being started.

curEpochGroup

public final java.util.Set<NodeIDType> curEpochGroup

Group members in the current epoch being started.

initialState

public final java.lang.String initialState

Initial state of epoch being started.

creator

public final java.net.InetSocketAddress creator

Sender address.

receiver

public final java.net.InetSocketAddress receiver

Receiver address.

prevGroupName

public final java.lang.String prevGroupName

For supporting RC group merge or split operations wherein the previous epoch group may have a different name.

prevEpoch

public final int prevEpoch

For supporting RC group merge or split operations wherein the previous epoch group may have a different name and epoch number.

isMerge

public final boolean isMerge

Whether the corresponding reconfiguration is a merge (used in RC group reconfiguration when RC nodes are deleted).

newlyAddedNodes

public final java.util.Map<NodeIDType,java.net.InetSocketAddress> newlyAddedNodes

Socket address map for new RC nodes being added.

mergees

public final java.util.Set<java.lang.String> mergees

The list of deleted nodes that must be merged with this node. Nonempty only if prevGroupName==curGroupName and this is an RC group record and there are nodes to be merged with this node.

Constructor Detail

StartEpoch

public StartEpoch(NodeIDType initiator,
                  java.lang.String serviceName,
                  int epochNumber,
                  java.util.Set<NodeIDType> curNodes,
                  boolean passive)

Parameters:

initiator -

serviceName -

epochNumber -

curNodes -

passive -

StartEpoch

public StartEpoch(NodeIDType initiator,
                  java.lang.String serviceName,
                  int epochNumber,
                  java.util.Set<NodeIDType> curNodes,
                  java.util.Set<NodeIDType> prevNodes,
                  java.util.Set<java.lang.String> mergees)

Parameters:

initiator -

serviceName -

epochNumber -

curNodes -

prevNodes -

mergees -

StartEpoch

public StartEpoch(NodeIDType initiator,
                  java.lang.String serviceName,
                  int epochNumber,
                  java.util.Set<NodeIDType> curNodes,
                  java.util.Set<NodeIDType> prevNodes,
                  java.lang.String prevGroupName,
                  boolean isMerge,
                  int prevEpoch)

Parameters:

initiator -

serviceName -

epochNumber -

curNodes -

prevNodes -

prevGroupName -

isMerge -

prevEpoch -

StartEpoch

public StartEpoch(NodeIDType myID,
                  java.lang.String serviceName,
                  int epochNumber,
                  java.util.Set<NodeIDType> curNodes,
                  java.util.Set<NodeIDType> prevNodes,
                  java.net.InetSocketAddress creator,
                  java.net.InetSocketAddress receiver,
                  java.net.InetSocketAddress forwarder,
                  java.lang.String initialState,
                  java.util.Map<java.lang.String,java.lang.String> nameStates,
                  java.util.Map<NodeIDType,java.net.InetSocketAddress> newlyAddedNodes,
                  ReconfigurationConfig.ReconfigureUponActivesChange policy)

Parameters:

myID -

serviceName -

epochNumber -

curNodes -

prevNodes -

creator -

receiver -

forwarder -

initialState -

nameStates -

newlyAddedNodes -

policy -

StartEpoch

public StartEpoch(StartEpoch<NodeIDType> startEpoch,
                  java.lang.String initialState)

Just to reset final field initialState.

Parameters:

startEpoch -

initialState -

StartEpoch

public StartEpoch(NodeIDType initiator,
                  StartEpoch<NodeIDType> startEpoch)

Just to reset final field initiator.

Parameters:

initiator -

startEpoch -

StartEpoch

public StartEpoch(org.json.JSONObject json,
                  Stringifiable<NodeIDType> unstringer)
           throws org.json.JSONException

Parameters:

json -

unstringer -

Throws:

org.json.JSONException

Method Detail

toJSONObjectImpl

public org.json.JSONObject toJSONObjectImpl()
                                     throws org.json.JSONException

Overrides:

toJSONObjectImpl in class BasicReconfigurationPacket<NodeIDType>

Throws:

org.json.JSONException

getReconfigureUponActivesChangePolicy

public ReconfigurationConfig.ReconfigureUponActivesChange getReconfigureUponActivesChangePolicy()

Returns:

ReconfigureUponActivesChange policy

getInitTime

public long getInitTime()

Returns:

Time when the reconfiguration began.

getCurEpochGroup

public java.util.Set<NodeIDType> getCurEpochGroup()

Returns:

Current epoch group members.

getPrevEpochGroup

public java.util.Set<NodeIDType> getPrevEpochGroup()

Returns:

Previous epoch group members.

getCommonMembers

public java.util.Set<NodeIDType> getCommonMembers()

Returns:

Set of common members between prev and cur epoch group.

getInitiatorAsSet

public java.util.Set<NodeIDType> getInitiatorAsSet()

Returns:

A single element set containing the initiator node.

isInitEpoch

public boolean isInitEpoch()

Returns:

Whether the epoch being created has no previous epoch group or it is split or merge reconfiguration operation.

isBatchedCreate

public boolean isBatchedCreate()

Returns:

True if this is a batched create request.

noCurEpochGroup

public boolean noCurEpochGroup()

Returns:

True if current epoch group is empty.

noPrevEpochGroup

public boolean noPrevEpochGroup()

Returns:

True if previous epoch group is empty.

hasPrevEpochGroup

public boolean hasPrevEpochGroup()

Returns:

True if previous epoch group is nonempty.

hasCurEpochGroup

public boolean hasCurEpochGroup()

Returns:

True if the new epoch group is nonempty.

isCreateRequest

public boolean isCreateRequest()

Returns:

Whether this is a create request, i.e., there is no previous epoch group and there is a (non-null) creator.

isDeleteRequest

public boolean isDeleteRequest()

Returns:

Whether this is a create request, i.e., there is no previous epoch group and there is a (non-null) creator.

getInitialState

public java.lang.String getInitialState()

Returns:

Initial state.

getNameStates

public java.util.Map<java.lang.String,java.lang.String> getNameStates()

Returns:

Name,state map for batched creates.

getPrevGroupName

public java.lang.String getPrevGroupName()

Returns:

Previous epoch group name.

getPrevEpochNumber

public int getPrevEpochNumber()

Returns:

Previous epoch group number.

isSplitOrMerge

public boolean isSplitOrMerge()

Returns:

True if the start epoch corresponds to a split or merge reconfiguration operation.

isSplit

public boolean isSplit()

Returns:

True if it is a split reconfiguration.

hasNewlyAddedNodes

public boolean hasNewlyAddedNodes()

Returns:

True if new RC nodes are being added.

isMerge

public boolean isMerge()

Returns:

True if it is a merge reconfiguration operation.

getMergees

public java.util.Set<java.lang.String> getMergees()

Returns:

The set of groups to be merged.

hasMergees

public boolean hasMergees()

Returns:

True if the set of mergees is nonempty.

getNewlyAddedNodes

public java.util.Set<NodeIDType> getNewlyAddedNodes()

Returns:

Set of newly added nodes.

setFirstPrevEpochCandidate

public StartEpoch<NodeIDType> setFirstPrevEpochCandidate(NodeIDType node)

Parameters:

node -

Returns:

this

getFirstPrevEpochCandidate

public NodeIDType getFirstPrevEpochCandidate()

Returns:

The first candidate to try while requesting previous epoch final state.

getForwarder

public java.net.InetSocketAddress getForwarder()

Returns:

The forwarder socket address.

isActiveNodeConfigChange

public boolean isActiveNodeConfigChange()

Returns:

True if active node config change.

isRCNodeConfigChange

public boolean isRCNodeConfigChange()

Returns:

True if reconfigurator node config change.

isNodeConfigChange

public boolean isNodeConfigChange()

Returns:

True if either active or reconfigurator node config change.

getDeletedNodes

public java.util.Set<NodeIDType> getDeletedNodes()

Returns:

The subset of nodes in the previous epoch not present in the current (or next) epoch.

getMyReceiver

public java.net.InetSocketAddress getMyReceiver()

Returns:

The socket address on which the initiating request was received.

isPassive

public boolean isPassive()

Returns:

True if passive replica group creation.