edu.umass.cs.reconfiguration.interfaces

Interface ReconfiguratorDB<NodeIDType>

Type Parameters:

NodeIDType -

All Known Implementing Classes:

AbstractReconfiguratorDB, SQLReconfiguratorDB

public interface ReconfiguratorDB<NodeIDType>

Author:

arun

Method Summary

Modifier and Type	Method and Description
boolean	addActiveReplica(NodeIDType node, java.net.InetSocketAddress sockAddr, int version)
boolean	addReconfigurator(NodeIDType node, java.net.InetSocketAddress sockAddr, int version)
void	clearMerged(java.lang.String name, int epoch) Clear all merged state in RC record.
void	close() Close gracefully.
boolean	closeReadActiveRecords()
ReconfigurationRecord<NodeIDType>	createReconfigurationRecord(ReconfigurationRecord<NodeIDType> record)
boolean	createReconfigurationRecords(java.util.Map<java.lang.String,java.lang.String> nameStates, java.util.Set<NodeIDType> newActives, ReconfigurationConfig.ReconfigureUponActivesChange reconfigureUponActivesChange)
void	delayedDeleteComplete()
boolean	deleteReconfigurationRecord(java.lang.String name, int epoch)
java.lang.String	fetchAndAggregateMergeeStates(java.util.Map<java.lang.String,java.lang.String> finalStates, java.lang.String mergerGroup, int epoch)
void	garbageCollectedDeletedNode(NodeIDType node)
boolean	garbageCollectOldReconfigurators(int version)
java.lang.String	getDemandStats(java.lang.String name)
java.lang.String[]	getPendingReconfigurations() Names for which reconfiguration is incomplete, needed for recovery
java.util.Set<java.lang.String>	getRCGroupNames()
java.util.Map<java.lang.String,java.util.Set<NodeIDType>>	getRCGroups() Get current RC group names from the DB
ReconfigurationRecord<NodeIDType>	getReconfigurationRecord(java.lang.String name)
boolean	initiateReadActiveRecords(NodeIDType active)
boolean	markDeleteReconfigurationRecord(java.lang.String name, int epoch)
boolean	mergeIntent(java.lang.String name, int epoch, java.lang.String mergee)
boolean	mergeState(java.lang.String name, int epoch, java.lang.String mergee, int mergeeEpoch, java.lang.String state) Merge state, i.e., append instead of replacing state, exactly once.
ReconfigurationRecord<NodeIDType>	readNextActiveRecord(boolean add)
void	removePending(java.lang.String name)
void	setCallback(ReconfiguratorCallback callback)
void	setRCEpochs(ReconfigurationRecord<NodeIDType> ncRecord) Sets RC epochs so that we know the epoch numbers for each reconfigurator group.
boolean	setState(java.lang.String name, int epoch, ReconfigurationRecord.RCStates state) Set epoch and state as specified.
boolean	setStateInitReconfiguration(java.util.Map<java.lang.String,java.lang.String> nameStates, int epoch, ReconfigurationRecord.RCStates state, java.util.Set<NodeIDType> newActives)
boolean	setStateInitReconfiguration(java.lang.String name, int epoch, ReconfigurationRecord.RCStates state, java.util.Set<NodeIDType> newActives) Set epoch, state, newActives, primary only if current state is READY
boolean	setStateMerge(java.util.Map<java.lang.String,java.lang.String> nameStates, int epoch, ReconfigurationRecord.RCStates state, java.util.Set<NodeIDType> newActives)
boolean	setStateMerge(java.lang.String name, int epoch, ReconfigurationRecord.RCStates state, java.util.Set<NodeIDType> newActives, java.util.Set<java.lang.String> mergees)
boolean	updateDemandStats(DemandReport<NodeIDType> report) Update demand statistics.

Method Detail

getReconfigurationRecord

ReconfigurationRecord<NodeIDType> getReconfigurationRecord(java.lang.String name)

Parameters:

name -

Returns:

ReconfigurationRecord for name.

createReconfigurationRecord

ReconfigurationRecord<NodeIDType> createReconfigurationRecord(ReconfigurationRecord<NodeIDType> record)

Parameters:

record -

Returns:

ReconfigurationRecord created.

createReconfigurationRecords

boolean createReconfigurationRecords(java.util.Map<java.lang.String,java.lang.String> nameStates,
                                     java.util.Set<NodeIDType> newActives,
                                     ReconfigurationConfig.ReconfigureUponActivesChange reconfigureUponActivesChange)

Parameters:

newActives -

nameStates -

reconfigureUponActivesChange -

Returns:

True if created successfully.

deleteReconfigurationRecord

boolean deleteReconfigurationRecord(java.lang.String name,
                                    int epoch)

Parameters:

name -

epoch -

Returns:

True if record existed and was successfully deleted.

markDeleteReconfigurationRecord

boolean markDeleteReconfigurationRecord(java.lang.String name,
                                        int epoch)

Parameters:

name -

epoch -

Returns:

True if record existed and was successfully marked as pending a deletion.

updateDemandStats

boolean updateDemandStats(DemandReport<NodeIDType> report)

Update demand statistics.

Parameters:

report -

Returns:

True if updated successfully.

getDemandStats

java.lang.String getDemandStats(java.lang.String name)

Parameters:

name -

Returns:

Demand statistics as JSON string.

setState

boolean setState(java.lang.String name,
                 int epoch,
                 ReconfigurationRecord.RCStates state)

Set epoch and state as specified.

Parameters:

name -

epoch -

state -

Returns:

True if successfully set; false if the state transition is not legitimate.

setStateInitReconfiguration

boolean setStateInitReconfiguration(java.lang.String name,
                                    int epoch,
                                    ReconfigurationRecord.RCStates state,
                                    java.util.Set<NodeIDType> newActives)

Set epoch, state, newActives, primary only if current state is READY

Parameters:

name -

epoch -

state -

newActives -

Returns:

True if successfully set; false if the state transition is not legitimate.

setStateInitReconfiguration

boolean setStateInitReconfiguration(java.util.Map<java.lang.String,java.lang.String> nameStates,
                                    int epoch,
                                    ReconfigurationRecord.RCStates state,
                                    java.util.Set<NodeIDType> newActives)

Parameters:

nameStates -

epoch -

state -

newActives -

Returns:

True if successfully set; false if any of the constituent state transitions are not legitimate.

getPendingReconfigurations

java.lang.String[] getPendingReconfigurations()

Names for which reconfiguration is incomplete, needed for recovery

Returns:

Array of names.

removePending

void removePending(java.lang.String name)

Parameters:

name -

getRCGroups

java.util.Map<java.lang.String,java.util.Set<NodeIDType>> getRCGroups()

Get current RC group names from the DB

Returns:

Map of RC group names and their group members.

getRCGroupNames

java.util.Set<java.lang.String> getRCGroupNames()

Returns:

Set of all RC group names maintained locally.

addReconfigurator

boolean addReconfigurator(NodeIDType node,
                          java.net.InetSocketAddress sockAddr,
                          int version)

Parameters:

node -

sockAddr -

version -

Returns:

True if successfully added.

addActiveReplica

boolean addActiveReplica(NodeIDType node,
                         java.net.InetSocketAddress sockAddr,
                         int version)

Parameters:

node -

sockAddr -

version -

Returns:

True if successfully added.

garbageCollectOldReconfigurators

boolean garbageCollectOldReconfigurators(int version)

Parameters:

version -

Returns:

Delete deleted reconfigurators.

mergeState

boolean mergeState(java.lang.String name,
                   int epoch,
                   java.lang.String mergee,
                   int mergeeEpoch,
                   java.lang.String state)

Merge state, i.e., append instead of replacing state, exactly once. The tricky part is to ensure exactly-once semantics, which we ensure by maintaining a "merged" set in ReconfigurationRecord.

Parameters:

name -

epoch -

mergee -

mergeeEpoch -

state -

Returns:

True if merged successfully.

mergeIntent

boolean mergeIntent(java.lang.String name,
                    int epoch,
                    java.lang.String mergee)

Parameters:

name -

epoch -

mergee -

Returns:

True if intent committed successfully.

setStateMerge

boolean setStateMerge(java.lang.String name,
                      int epoch,
                      ReconfigurationRecord.RCStates state,
                      java.util.Set<NodeIDType> newActives,
                      java.util.Set<java.lang.String> mergees)

Parameters:

name -

epoch -

state -

newActives -

mergees -

Returns:

True if state and mergees set successfully.

setStateMerge

boolean setStateMerge(java.util.Map<java.lang.String,java.lang.String> nameStates,
                      int epoch,
                      ReconfigurationRecord.RCStates state,
                      java.util.Set<NodeIDType> newActives)

Parameters:

nameStates -

epoch -

state -

newActives -

Returns:

True is state set successfully.

delayedDeleteComplete

void delayedDeleteComplete()

clearMerged

void clearMerged(java.lang.String name,
                 int epoch)

Clear all merged state in RC record. Invoked when a stop request is executed just before transitioning to the next epoch.

Parameters:

name -

epoch -

setRCEpochs

void setRCEpochs(ReconfigurationRecord<NodeIDType> ncRecord)

Sets RC epochs so that we know the epoch numbers for each reconfigurator group.

Parameters:

ncRecord -

garbageCollectedDeletedNode

void garbageCollectedDeletedNode(NodeIDType node)

Parameters:

node -

initiateReadActiveRecords

boolean initiateReadActiveRecords(NodeIDType active)

Parameters:

active -

Returns:

Whether successfully opened.

readNextActiveRecord

ReconfigurationRecord<NodeIDType> readNextActiveRecord(boolean add)

Parameters:

add -

Returns:

Next name

closeReadActiveRecords

boolean closeReadActiveRecords()

Returns:

Whether successfully closed.

fetchAndAggregateMergeeStates

java.lang.String fetchAndAggregateMergeeStates(java.util.Map<java.lang.String,java.lang.String> finalStates,
                                               java.lang.String mergerGroup,
                                               int epoch)

Parameters:

finalStates -

mergerGroup -

epoch -

Returns:

True if successfully merged.

setCallback

void setCallback(ReconfiguratorCallback callback)

Parameters:

callback -

close

void close()

Close gracefully.