Package org.opendaylight.controller.cluster.raft.spi

Class PropertiesTermInfoStore

java.lang.Object

org.opendaylight.controller.cluster.raft.spi.PropertiesTermInfoStore

All Implemented Interfaces:

TermInfoStore

@NonNullByDefault
public final class PropertiesTermInfoStore
extends Object
implements TermInfoStore

A TermInfoStore based on an atomic Properties file.

Constructor Summary

Constructors

Constructor	Description
PropertiesTermInfoStore(String logId, Path directory)

Method Summary

Modifier and Type	Method	Description
TermInfo	currentTerm()	Returns TermInfo for current term.
@Nullable TermInfo	loadAndSetTerm()	Attempt to load the last persisted TermInfo, if available.
void	setTerm(TermInfo newTerm)	This method updates the in-memory election term state.
void	storeAndSetTerm(TermInfo newTerm)	This method updates the in-memory election term state and persists it so it can be recovered on next restart.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PropertiesTermInfoStore

public PropertiesTermInfoStore(String logId,
 Path directory)

Method Details

currentTerm

public TermInfo currentTerm()

Description copied from interface: TermInfoStore

Returns TermInfo for current term. Freshly-initialized instances return TermInfo.INITIAL.

Specified by:

currentTerm in interface TermInfoStore

Returns:

TermInfo for current term

setTerm

public void setTerm(TermInfo newTerm)

Description copied from interface: TermInfoStore

This method updates the in-memory election term state. This method should be called when recovering election state from persistent storage.

Specified by:

setTerm in interface TermInfoStore

Parameters:

newTerm - new TermInfo

storeAndSetTerm

public void storeAndSetTerm(TermInfo newTerm)
                     throws IOException

Description copied from interface: TermInfoStore

This method updates the in-memory election term state and persists it so it can be recovered on next restart. This method should be called when starting a new election or when a Raft RPC message is received with a higher term.

Specified by:

storeAndSetTerm in interface TermInfoStore

Parameters:

newTerm - new TermInfo

Throws:

IOException - if an I/O error occurs

loadAndSetTerm

public @Nullable TermInfo loadAndSetTerm()
                                  throws IOException

Description copied from interface: TermInfoStore

Attempt to load the last persisted TermInfo, if available. If successful, TermInfoStore.currentTerm() is updated.

Specified by:

loadAndSetTerm in interface TermInfoStore

Returns:

the persisted TermInfo, or null of none is available

Throws:

IOException - if an I/O error occurs

toString

public String toString()

Overrides:

toString in class Object