org.opendaylight.controller.cluster.datastore

Class Shard

java.lang.Object

akka.actor.UntypedActor

akka.persistence.UntypedPersistentActor

org.opendaylight.controller.cluster.common.actor.AbstractUntypedPersistentActor

org.opendaylight.controller.cluster.raft.RaftActor

org.opendaylight.controller.cluster.datastore.Shard

All Implemented Interfaces:

akka.actor.Actor, akka.actor.Stash, akka.actor.StashFactory, akka.actor.StashSupport, akka.actor.UnrestrictedStash, akka.dispatch.RequiresMessageQueue<akka.dispatch.DequeBasedMessageQueueSemantics>, akka.persistence.Eventsourced, akka.persistence.PersistenceIdentity, akka.persistence.PersistenceRecovery, akka.persistence.PersistenceStash, akka.persistence.Snapshotter, org.opendaylight.controller.cluster.common.actor.ExecuteInSelfActor

public class Shard
extends org.opendaylight.controller.cluster.raft.RaftActor

A Shard represents a portion of the logical data tree.

Our Shard uses InMemoryDataTree as it's internal representation and delegates all requests it

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Shard.AbstractBuilder<T extends Shard.AbstractBuilder<T,S>,S extends Shard>
static class	Shard.Builder

Nested classes/interfaces inherited from interface akka.persistence.Eventsourced

akka.persistence.Eventsourced.AsyncHandlerInvocation, akka.persistence.Eventsourced.AsyncHandlerInvocation$, akka.persistence.Eventsourced.PendingHandlerInvocation, akka.persistence.Eventsourced.ProcessingState, akka.persistence.Eventsourced.RecoveryTick, akka.persistence.Eventsourced.RecoveryTick$, akka.persistence.Eventsourced.StashingHandlerInvocation, akka.persistence.Eventsourced.StashingHandlerInvocation$, akka.persistence.Eventsourced.State

Nested classes/interfaces inherited from interface akka.actor.Actor

akka.actor.Actor.emptyBehavior$, akka.actor.Actor.ignoringBehavior$

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME

Fields inherited from class org.opendaylight.controller.cluster.common.actor.AbstractUntypedPersistentActor

LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Shard(Shard.AbstractBuilder<?,?> builder)

Method Summary

Modifier and Type	Method and Description
protected void	applyState(akka.actor.ActorRef clientActor, org.opendaylight.yangtools.concepts.Identifier identifier, Object data)
static Shard.Builder	builder()
Collection<?>	convertPendingTransactionsToMessages() Clears all pending transactions and converts them to messages to be forwarded to a new leader.
int	getCohortCacheSize()
ShardDataTree	getDataStore()
DatastoreContext	getDatastoreContext()
int	getPendingTxCommitQueueSize()
protected org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort	getRaftActorRecoveryCohort()
org.opendaylight.controller.cluster.raft.RaftActorSnapshotCohort	getRaftActorSnapshotCohort()
protected com.google.common.base.Optional<akka.actor.ActorRef>	getRoleChangeNotifier()
protected void	handleBatchedModificationsLocal(BatchedModifications batched, akka.actor.ActorRef sender)
protected void	handleNonRaftCommand(Object message)
protected void	handleRecover(Object message)
protected boolean	isIsolatedLeader()
protected org.opendaylight.controller.cluster.notifications.LeaderStateChanged	newLeaderStateChanged(String memberId, String leaderId, short leaderPayloadVersion)
protected org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder<?,?>	newOnDemandRaftStateBuilder()
protected void	onDatastoreContext(DatastoreContext context)
protected void	onLeaderChanged(String oldLeader, String newLeader)
protected void	onRecoveryComplete()
protected void	onStateChanged()
protected void	pauseLeader(Runnable operation)
String	persistenceId()
void	postStop()
protected void	unpauseLeader()

Methods inherited from class org.opendaylight.controller.cluster.raft.RaftActor

changeCurrentBehavior, getCurrentBehavior, getCurrentTerm, getId, getLeader, getLeaderId, getRaftActorContext, getRaftState, handleCommand, hasFollowers, isLeader, isLeaderActive, isLeadershipTransferInProgress, newRaftActorRecoverySupport, onVotingStateChangeComplete, persistData, persistence, preStart, setPeerAddress, setPersistence, setPersistence, snapshotSequenceNr, updateConfigParams

Methods inherited from class org.opendaylight.controller.cluster.common.actor.AbstractUntypedPersistentActor

executeInSelf, ignoreMessage, onReceiveCommand, onReceiveRecover, unknownMessage

Methods inherited from class akka.persistence.UntypedPersistentActor

akka$actor$StashSupport$_setter_$akka$actor$StashSupport$$capacity_$eq, akka$actor$StashSupport$_setter_$mailbox_$eq, akka$actor$StashSupport$$capacity, akka$actor$StashSupport$$theStash_$eq, akka$actor$StashSupport$$theStash, akka$persistence$Eventsourced$_setter_$akka$persistence$Eventsourced$$extension_$eq, akka$persistence$Eventsourced$_setter_$akka$persistence$Eventsourced$$instanceId_$eq, akka$persistence$Eventsourced$_setter_$akka$persistence$Eventsourced$$internalStash_$eq, akka$persistence$Eventsourced$_setter_$akka$persistence$Eventsourced$$maxMessageBatchSize_$eq, akka$persistence$Eventsourced$_setter_$akka$persistence$Eventsourced$$pendingInvocations_$eq, akka$persistence$Eventsourced$_setter_$akka$persistence$Eventsourced$$persistingEvents_$eq, akka$persistence$Eventsourced$_setter_$akka$persistence$Eventsourced$$processingCommands_$eq, akka$persistence$Eventsourced$_setter_$akka$persistence$Eventsourced$$unstashFilterPredicate_$eq, akka$persistence$Eventsourced$_setter_$akka$persistence$Eventsourced$$writerUuid_$eq, akka$persistence$Eventsourced$$_lastSequenceNr_$eq, akka$persistence$Eventsourced$$_lastSequenceNr, akka$persistence$Eventsourced$$currentState_$eq, akka$persistence$Eventsourced$$currentState, akka$persistence$Eventsourced$$eventBatch_$eq, akka$persistence$Eventsourced$$eventBatch, akka$persistence$Eventsourced$$extension, akka$persistence$Eventsourced$$instanceId, akka$persistence$Eventsourced$$internalStash, akka$persistence$Eventsourced$$journalBatch_$eq, akka$persistence$Eventsourced$$journalBatch, akka$persistence$Eventsourced$$maxMessageBatchSize, akka$persistence$Eventsourced$$pendingInvocations, akka$persistence$Eventsourced$$pendingStashingPersistInvocations_$eq, akka$persistence$Eventsourced$$pendingStashingPersistInvocations, akka$persistence$Eventsourced$$persistingEvents, akka$persistence$Eventsourced$$processingCommands, akka$persistence$Eventsourced$$sequenceNr_$eq, akka$persistence$Eventsourced$$sequenceNr, akka$persistence$Eventsourced$$unstashFilterPredicate, akka$persistence$Eventsourced$$writeInProgress_$eq, akka$persistence$Eventsourced$$writeInProgress, akka$persistence$Eventsourced$$writerUuid, aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, clearStash, createStash, deferAsync, deleteMessages, deleteSnapshot, deleteSnapshots, internalDeferAsync, internalPersist, internalPersistAll, internalPersistAllAsync, internalPersistAsync, internalStashOverflowStrategy, journal, journalPluginId, lastSequenceNr, loadSnapshot, mailbox, onPersistFailure, onPersistRejected, onReceive, onRecoveryFailure, onReplaySuccess, persist, persistAll, persistAllAsync, persistAsync, prepend, preRestart, receiveCommand, receiveRecover, recovery, recoveryFinished, recoveryRunning, saveSnapshot, snapshotPluginId, snapshotStore, snapshotterId, stash, unhandled, unstash, unstashAll, unstashAll

Methods inherited from class akka.actor.UntypedActor

akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, context, getContext, getSelf, getSender, postRestart, receive, self, sender, supervisorStrategy

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.persistence.Eventsourced

$init$, akka$persistence$Eventsourced$$changeState, akka$persistence$Eventsourced$$flushBatch, akka$persistence$Eventsourced$$flushJournalBatch, akka$persistence$Eventsourced$$peekApplyHandler, akka$persistence$Eventsourced$$recovering, akka$persistence$Eventsourced$$setLastSequenceNr, akka$persistence$Eventsourced$$startRecovery, akka$persistence$Eventsourced$$stashInternally, akka$persistence$Eventsourced$$unstashInternally, akka$persistence$Eventsourced$$updateLastSequenceNr

Methods inherited from interface akka.persistence.Snapshotter

$init$

Methods inherited from interface akka.persistence.PersistenceStash

$init$

Methods inherited from interface akka.actor.UnrestrictedStash

$init$

Methods inherited from interface akka.actor.Actor

$init$, akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, context, noSender, postRestart, receive, self, sender, supervisorStrategy

Methods inherited from interface akka.actor.StashSupport

$init$, context, self

Methods inherited from interface akka.actor.StashFactory

$init$

Methods inherited from interface akka.persistence.PersistenceIdentity

$init$

Methods inherited from interface akka.persistence.PersistenceRecovery

$init$

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

Constant Field Values

Constructor Detail

Shard

protected Shard(Shard.AbstractBuilder<?,?> builder)

Method Detail

postStop

public void postStop()

Specified by:

postStop in interface akka.actor.Actor

Specified by:

postStop in interface akka.actor.UnrestrictedStash

Overrides:

postStop in class org.opendaylight.controller.cluster.raft.RaftActor

handleRecover

protected void handleRecover(Object message)

Overrides:

handleRecover in class org.opendaylight.controller.cluster.raft.RaftActor

handleNonRaftCommand

protected void handleNonRaftCommand(Object message)

Overrides:

handleNonRaftCommand in class org.opendaylight.controller.cluster.raft.RaftActor

getPendingTxCommitQueueSize

public int getPendingTxCommitQueueSize()

getCohortCacheSize

public int getCohortCacheSize()

getRoleChangeNotifier

protected com.google.common.base.Optional<akka.actor.ActorRef> getRoleChangeNotifier()

Specified by:

getRoleChangeNotifier in class org.opendaylight.controller.cluster.raft.RaftActor

newLeaderStateChanged

protected org.opendaylight.controller.cluster.notifications.LeaderStateChanged newLeaderStateChanged(String memberId,
                                                                                                     String leaderId,
                                                                                                     short leaderPayloadVersion)

Overrides:

newLeaderStateChanged in class org.opendaylight.controller.cluster.raft.RaftActor

onDatastoreContext

protected void onDatastoreContext(DatastoreContext context)

handleBatchedModificationsLocal

protected void handleBatchedModificationsLocal(BatchedModifications batched,
                                               akka.actor.ActorRef sender)

isIsolatedLeader

protected boolean isIsolatedLeader()

getRaftActorSnapshotCohort

public org.opendaylight.controller.cluster.raft.RaftActorSnapshotCohort getRaftActorSnapshotCohort()

Specified by:

getRaftActorSnapshotCohort in class org.opendaylight.controller.cluster.raft.RaftActor

getRaftActorRecoveryCohort

@Nonnull
protected org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort getRaftActorRecoveryCohort()

Specified by:

getRaftActorRecoveryCohort in class org.opendaylight.controller.cluster.raft.RaftActor

onRecoveryComplete

protected void onRecoveryComplete()

Specified by:

onRecoveryComplete in class org.opendaylight.controller.cluster.raft.RaftActor

applyState

protected void applyState(akka.actor.ActorRef clientActor,
                          org.opendaylight.yangtools.concepts.Identifier identifier,
                          Object data)

Specified by:

applyState in class org.opendaylight.controller.cluster.raft.RaftActor

onStateChanged

protected void onStateChanged()

Specified by:

onStateChanged in class org.opendaylight.controller.cluster.raft.RaftActor

onLeaderChanged

protected void onLeaderChanged(String oldLeader,
                               String newLeader)

Overrides:

onLeaderChanged in class org.opendaylight.controller.cluster.raft.RaftActor

convertPendingTransactionsToMessages

public Collection<?> convertPendingTransactionsToMessages()

Clears all pending transactions and converts them to messages to be forwarded to a new leader.

Returns:

the converted messages

pauseLeader

protected void pauseLeader(Runnable operation)

Overrides:

pauseLeader in class org.opendaylight.controller.cluster.raft.RaftActor

unpauseLeader

protected void unpauseLeader()

Overrides:

unpauseLeader in class org.opendaylight.controller.cluster.raft.RaftActor

newOnDemandRaftStateBuilder

protected org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder<?,?> newOnDemandRaftStateBuilder()

Overrides:

newOnDemandRaftStateBuilder in class org.opendaylight.controller.cluster.raft.RaftActor

persistenceId

public String persistenceId()

getDatastoreContext

public DatastoreContext getDatastoreContext()

getDataStore

public ShardDataTree getDataStore()

builder

public static Shard.Builder builder()