Package org.opendaylight.controller.cluster.raft

Class RaftActorContextImpl

java.lang.Object

org.opendaylight.controller.cluster.raft.RaftActorContextImpl

All Implemented Interfaces:

RaftActorContext

public class RaftActorContextImpl
extends Object
implements RaftActorContext

Implementation of the RaftActorContext interface.

Author:

Moiz Raja, Thomas Pantelis

Constructor Summary

Constructors

Constructor	Description
RaftActorContextImpl(org.apache.pekko.actor.ActorRef actor, org.apache.pekko.actor.ActorContext context, @NonNull LocalAccess localStore, @NonNull Map<String,String> peerAddresses, @NonNull ConfigParams configParams, short payloadVersion, @NonNull PersistenceProvider persistenceProvider, @NonNull ApplyEntryMethod applyEntryMethod, @NonNull Executor executor)

Method Summary

Modifier and Type	Method	Description
void	addToPeers(String peerId, String address, VotingState votingState)	Adds a new peer.
boolean	anyVotingPeers()	Determines if there are any voting peers.
ApplyEntryMethod	applyEntryMethod()	Returns the consumer of ApplyState operations.
final org.apache.pekko.cluster.Cluster	cluster()	The Pekko Cluster singleton for the actor system if one is configured.
EntryStore	entryStore()	Returns the EntryStore.
org.apache.pekko.actor.ActorRef	getActor()	Returns the reference to the RaftActor.
org.apache.pekko.actor.ActorSystem	getActorSystem()	Returns the The ActorSystem associated with this context.
ConfigParams	getConfigParams()	Returns the ConfigParams instance.
RaftActorBehavior	getCurrentBehavior()	Returns the current behavior attached to the RaftActor.
final Executor	getExecutor()	Return an Executor which is guaranteed to run tasks in the context of RaftActorContext.getActor().
FileBackedOutputStreamFactory	getFileBackedOutputStreamFactory()	Returns the FileBackedOutputStreamFactory instance with a common configuration.
String	getId()	Returns the identifier for the RaftActor.
short	getPayloadVersion()	Returns the payload version to be used when replicating data.
final org.apache.pekko.actor.ActorSelection	getPeerActorSelection(String peerId)	Returns an ActorSelection for a peer.
String	getPeerAddress(String peerId)	Gets the address of a peer as a String.
Collection<String>	getPeerIds()	Returns the id's for each peer.
PeerInfo	getPeerInfo(String peerId)	Returns the PeerInfo for the given peer.
Collection<PeerInfo>	getPeers()	Returns the PeerInfo instances for each peer.
VotingConfig	getPeerServerInfo(boolean includeSelf)	Returns the peer information as a ClusterConfig if dynamic server configurations have been applied.
PersistenceProvider	getPersistenceProvider()	Deprecated, for removal: This API element is subject to removal in a future version.
RaftActorLeadershipTransferCohort	getRaftActorLeadershipTransferCohort()	Returns the RaftActorLeadershipTransferCohort if leadership transfer is in progress.
RaftPolicy	getRaftPolicy()	Returns the RaftPolicy used to determine certain Raft behaviors.
ReplicatedLog	getReplicatedLog()	Returns the ReplicatedLog instance.
SnapshotManager	getSnapshotManager()	Returns the SnapshotManager instance.
long	getTotalMemory()	Returns the total available memory for use in calculations.
boolean	hasFollowers()	Determines if there are any peer followers.
boolean	isDynamicServerConfigurationInUse()	Determines if there have been any dynamic server configuration changes applied.
boolean	isVotingMember()	Determines if this peer is a voting member of the cluster.
void	persistTermInfo(TermInfo newElectionInfo)	Sets and persists a TermInfo, so that RaftActorContext.termInfo() returns it, even if we undergo recovery.
void	removePeer(String name)	Removes a peer.
final void	resetReplicatedLog(@NonNull ReplicatedLog newState)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setConfigParams(ConfigParams configParams)
void	setDynamicServerConfigurationInUse()	Sets that dynamic server configuration changes have been applied.
void	setPeerAddress(String peerId, String peerAddress)	Sets the address of a peer.
void	setRaftActorLeadershipTransferCohort(RaftActorLeadershipTransferCohort leadershipTransferCohort)	Sets the RaftActorLeadershipTransferCohort for transferring leadership.
void	setTermInfo(TermInfo newElectionInfo)	Sets, but does not persist, a TermInfo, so that RaftActorContext.termInfo() returns it, unless we undergo recovery, in which case a prior TermInfo may be returned.
void	setTotalMemoryRetriever(LongSupplier retriever)	Sets the retriever of the total memory metric.
SnapshotStore	snapshotStore()	Returns the SnapshotStore.
TermInfo	termInfo()	Returns the current term TermInfo.
void	updateVotingConfig(VotingConfig votingConfig)	Updates the peers and information to match the given VotingConfig.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.controller.cluster.raft.RaftActorContext

currentTerm

Constructor Details

RaftActorContextImpl

public RaftActorContextImpl(org.apache.pekko.actor.ActorRef actor,
 org.apache.pekko.actor.ActorContext context,
 @NonNull LocalAccess localStore,
 @NonNull Map<String,String> peerAddresses,
 @NonNull ConfigParams configParams,
 short payloadVersion,
 @NonNull PersistenceProvider persistenceProvider,
 @NonNull ApplyEntryMethod applyEntryMethod,
 @NonNull Executor executor)

Method Details

getPayloadVersion

public short getPayloadVersion()

Description copied from interface: RaftActorContext

Returns the payload version to be used when replicating data.

Specified by:

getPayloadVersion in interface RaftActorContext

Returns:

the payload version.

setConfigParams

public void setConfigParams(ConfigParams configParams)

getId

public String getId()

Description copied from interface: RaftActorContext

Returns the identifier for the RaftActor. This identifier represents the name of the actor whose common state is being shared.

Specified by:

getId in interface RaftActorContext

Returns:

the identifier

getActor

public org.apache.pekko.actor.ActorRef getActor()

Description copied from interface: RaftActorContext

Returns the reference to the RaftActor.

Specified by:

getActor in interface RaftActorContext

Returns:

the reference to the RaftActor itself. This can be used to send messages to the RaftActor

getExecutor

public final Executor getExecutor()

Description copied from interface: RaftActorContext

Return an Executor which is guaranteed to run tasks in the context of RaftActorContext.getActor().

Specified by:

getExecutor in interface RaftActorContext

Returns:

An executor.

cluster

public final org.apache.pekko.cluster.Cluster cluster()

Description copied from interface: RaftActorContext

The Pekko Cluster singleton for the actor system if one is configured.

Specified by:

cluster in interface RaftActorContext

Returns:

the Cluster instance, or null

termInfo

public TermInfo termInfo()

Description copied from interface: RaftActorContext

Returns the current term TermInfo.

Specified by:

termInfo in interface RaftActorContext

Returns:

the TermInfo

setTermInfo

public void setTermInfo(TermInfo newElectionInfo)

Description copied from interface: RaftActorContext

Sets, but does not persist, a TermInfo, so that RaftActorContext.termInfo() returns it, unless we undergo recovery, in which case a prior TermInfo may be returned.

Specified by:

setTermInfo in interface RaftActorContext

Parameters:

newElectionInfo - TermInfo to set

persistTermInfo

public void persistTermInfo(TermInfo newElectionInfo)
                     throws IOException

Description copied from interface: RaftActorContext

Sets and persists a TermInfo, so that RaftActorContext.termInfo() returns it, even if we undergo recovery.

Specified by:

persistTermInfo in interface RaftActorContext

Parameters:

newElectionInfo - TermInfo to persist

Throws:

IOException - when an I/O error occurs

resetReplicatedLog

@Deprecated(forRemoval=true)
public final void resetReplicatedLog(@NonNull ReplicatedLog newState)

Deprecated, for removal: This API element is subject to removal in a future version.

getReplicatedLog

public ReplicatedLog getReplicatedLog()

Description copied from interface: RaftActorContext

Returns the ReplicatedLog instance.

Specified by:

getReplicatedLog in interface RaftActorContext

Returns:

the ReplicatedLog instance.

getActorSystem

public org.apache.pekko.actor.ActorSystem getActorSystem()

Description copied from interface: RaftActorContext

Returns the The ActorSystem associated with this context.

Specified by:

getActorSystem in interface RaftActorContext

Returns:

the ActorSystem.

getPeerIds

public Collection<String> getPeerIds()

Description copied from interface: RaftActorContext

Returns the id's for each peer.

Specified by:

getPeerIds in interface RaftActorContext

Returns:

the list of peer id's.

getPeers

public Collection<PeerInfo> getPeers()

Description copied from interface: RaftActorContext

Returns the PeerInfo instances for each peer.

Specified by:

getPeers in interface RaftActorContext

Returns:

list of PeerInfo

getPeerInfo

public PeerInfo getPeerInfo(String peerId)

Description copied from interface: RaftActorContext

Returns the PeerInfo for the given peer.

Specified by:

getPeerInfo in interface RaftActorContext

Parameters:

peerId - the id of the peer

Returns:

the PeerInfo or null if not found

getPeerAddress

public String getPeerAddress(String peerId)

Description copied from interface: RaftActorContext

Gets the address of a peer as a String. This is the same format in which a consumer would provide the address.

Specified by:

getPeerAddress in interface RaftActorContext

Parameters:

peerId - the id of the peer.

Returns:

the address of the peer or null if the address has not yet been resolved.

updateVotingConfig

public void updateVotingConfig(VotingConfig votingConfig)

Description copied from interface: RaftActorContext

Updates the peers and information to match the given VotingConfig.

Specified by:

updateVotingConfig in interface RaftActorContext

Parameters:

votingConfig - the VotingConfig

getConfigParams

public ConfigParams getConfigParams()

Description copied from interface: RaftActorContext

Returns the ConfigParams instance.

Specified by:

getConfigParams in interface RaftActorContext

Returns:

the ConfigParams instance.

addToPeers

public void addToPeers(String peerId,
 String address,
 VotingState votingState)

Description copied from interface: RaftActorContext

Adds a new peer.

Specified by:

addToPeers in interface RaftActorContext

Parameters:

peerId - the id of the new peer.

address - the address of the new peer.

votingState - the VotingState of the new peer.

removePeer

public void removePeer(String name)

Description copied from interface: RaftActorContext

Removes a peer.

Specified by:

removePeer in interface RaftActorContext

Parameters:

name - the id of the peer to remove.

getPeerActorSelection

public final org.apache.pekko.actor.ActorSelection getPeerActorSelection(String peerId)

Description copied from interface: RaftActorContext

Returns an ActorSelection for a peer.

Specified by:

getPeerActorSelection in interface RaftActorContext

Parameters:

peerId - the id of the peer.

Returns:

the actorSelection corresponding to the peer or null if the address has not yet been resolved.

setPeerAddress

public void setPeerAddress(String peerId,
 String peerAddress)

Description copied from interface: RaftActorContext

Sets the address of a peer.

Specified by:

setPeerAddress in interface RaftActorContext

Parameters:

peerId - the id of the peer.

peerAddress - the address of the peer.

getSnapshotManager

public SnapshotManager getSnapshotManager()

Description copied from interface: RaftActorContext

Returns the SnapshotManager instance.

Specified by:

getSnapshotManager in interface RaftActorContext

Returns:

the SnapshotManager instance.

getTotalMemory

public long getTotalMemory()

Description copied from interface: RaftActorContext

Returns the total available memory for use in calculations. Normally this returns JVM's max memory but can be overridden for unit tests.

Specified by:

getTotalMemory in interface RaftActorContext

Returns:

the total memory.

setTotalMemoryRetriever

public void setTotalMemoryRetriever(LongSupplier retriever)

Description copied from interface: RaftActorContext

Sets the retriever of the total memory metric.

Specified by:

setTotalMemoryRetriever in interface RaftActorContext

Parameters:

retriever - a supplier of the total memory metric.

hasFollowers

public boolean hasFollowers()

Description copied from interface: RaftActorContext

Determines if there are any peer followers.

Specified by:

hasFollowers in interface RaftActorContext

Returns:

true if there are followers otherwise false.

getPersistenceProvider

@Deprecated(since="11.0.0",
            forRemoval=true)
public PersistenceProvider getPersistenceProvider()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: RaftActorContext

Returns the DataPersistenceProvider instance.

Specified by:

getPersistenceProvider in interface RaftActorContext

Returns:

the DataPersistenceProvider instance.

entryStore

public EntryStore entryStore()

Description copied from interface: RaftActorContext

Returns the EntryStore.

Specified by:

entryStore in interface RaftActorContext

Returns:

the EntryStore

snapshotStore

public SnapshotStore snapshotStore()

Description copied from interface: RaftActorContext

Returns the SnapshotStore.

Specified by:

snapshotStore in interface RaftActorContext

Returns:

the SnapshotStore

getRaftPolicy

public RaftPolicy getRaftPolicy()

Description copied from interface: RaftActorContext

Returns the RaftPolicy used to determine certain Raft behaviors.

Specified by:

getRaftPolicy in interface RaftActorContext

Returns:

the RaftPolicy instance.

isDynamicServerConfigurationInUse

public boolean isDynamicServerConfigurationInUse()

Description copied from interface: RaftActorContext

Determines if there have been any dynamic server configuration changes applied.

Specified by:

isDynamicServerConfigurationInUse in interface RaftActorContext

Returns:

true if dynamic server configuration changes have been applied, false otherwise, meaning that static peer configuration is still in use.

setDynamicServerConfigurationInUse

public void setDynamicServerConfigurationInUse()

Description copied from interface: RaftActorContext

Sets that dynamic server configuration changes have been applied.

Specified by:

setDynamicServerConfigurationInUse in interface RaftActorContext

getPeerServerInfo

public VotingConfig getPeerServerInfo(boolean includeSelf)

Description copied from interface: RaftActorContext

Returns the peer information as a ClusterConfig if dynamic server configurations have been applied.

Specified by:

getPeerServerInfo in interface RaftActorContext

Parameters:

includeSelf - include this peer's info.

Returns:

the peer information as a ClusterConfig or null if no dynamic server configurations have been applied.

isVotingMember

public boolean isVotingMember()

Description copied from interface: RaftActorContext

Determines if this peer is a voting member of the cluster.

Specified by:

isVotingMember in interface RaftActorContext

Returns:

true if this peer is a voting member, false otherwise.

anyVotingPeers

public boolean anyVotingPeers()

Description copied from interface: RaftActorContext

Determines if there are any voting peers.

Specified by:

anyVotingPeers in interface RaftActorContext

Returns:

true if there are any voting peers, false otherwise.

getCurrentBehavior

public RaftActorBehavior getCurrentBehavior()

Description copied from interface: RaftActorContext

Returns the current behavior attached to the RaftActor.

Specified by:

getCurrentBehavior in interface RaftActorContext

Returns:

current behavior.

applyEntryMethod

public ApplyEntryMethod applyEntryMethod()

Description copied from interface: RaftActorContext

Returns the consumer of ApplyState operations. This is invoked by a behavior when a log entry needs to be applied to the state.

Specified by:

applyEntryMethod in interface RaftActorContext

Returns:

the ApplyEntryMethod

getFileBackedOutputStreamFactory

public FileBackedOutputStreamFactory getFileBackedOutputStreamFactory()

Description copied from interface: RaftActorContext

Returns the FileBackedOutputStreamFactory instance with a common configuration.

Specified by:

getFileBackedOutputStreamFactory in interface RaftActorContext

Returns:

the FileBackedOutputStreamFactory

getRaftActorLeadershipTransferCohort

public RaftActorLeadershipTransferCohort getRaftActorLeadershipTransferCohort()

Description copied from interface: RaftActorContext

Returns the RaftActorLeadershipTransferCohort if leadership transfer is in progress.

Specified by:

getRaftActorLeadershipTransferCohort in interface RaftActorContext

Returns:

the RaftActorLeadershipTransferCohort if leadership transfer is in progress, null otherwise

setRaftActorLeadershipTransferCohort

public void setRaftActorLeadershipTransferCohort(RaftActorLeadershipTransferCohort leadershipTransferCohort)

Description copied from interface: RaftActorContext

Sets the RaftActorLeadershipTransferCohort for transferring leadership.

Specified by:

setRaftActorLeadershipTransferCohort in interface RaftActorContext

Parameters:

leadershipTransferCohort - the RaftActorLeadershipTransferCohort or null to clear the existing one