org.opendaylight.controller.cluster.example

Class ExampleActor

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.example.ExampleActor

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, ExecuteInSelfActor, RaftActorRecoveryCohort, RaftActorSnapshotCohort

public class ExampleActor
extends RaftActor
implements RaftActorRecoveryCohort, RaftActorSnapshotCohort

A sample actor showing how the RaftActor is to be extended.

Nested Class Summary

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 inherited from class org.opendaylight.controller.cluster.common.actor.AbstractUntypedPersistentActor

LOG

Constructor Summary

Constructors

Constructor and Description
ExampleActor(String id, Map<String,String> peerAddresses, com.google.common.base.Optional<ConfigParams> configParams)

Method Summary

Modifier and Type	Method and Description
void	appendRecoveredLogEntry(Payload data) This method is called during recovery to append state data to the current batch.
void	applyCurrentLogRecoveryBatch() This method is called during recovery at the end of a batch to apply the current batched log entries.
void	applyRecoverySnapshot(Snapshot.State snapshotState) This method is called during recovery to reconstruct the state of the actor.
void	applySnapshot(Snapshot.State snapshotState) This method is called to apply a snapshot installed by the leader.
protected void	applyState(akka.actor.ActorRef clientActor, org.opendaylight.yangtools.concepts.Identifier identifier, Object data) The applyState method will be called by the RaftActor when some data needs to be applied to the actor's state.
com.google.common.base.Optional<akka.actor.ActorRef>	createRoleChangeNotifier(String actorId)
void	createSnapshot(akka.actor.ActorRef actorRef, Optional<OutputStream> installSnapshotStream) This method is called by the RaftActor when a snapshot needs to be created.
Snapshot.State	deserializeSnapshot(com.google.common.io.ByteSource snapshotBytes) This method is called to de-serialize snapshot data that was previously serialized via RaftActorSnapshotCohort.createSnapshot(akka.actor.ActorRef, java.util.Optional<java.io.OutputStream>) to a State instance.
protected RaftActorRecoveryCohort	getRaftActorRecoveryCohort() Returns the RaftActorRecoveryCohort to participate in persistence recovery.
protected RaftActorSnapshotCohort	getRaftActorSnapshotCohort() Returns the RaftActorSnapshotCohort to participate in snapshot captures.
protected String	getReplicatedLogState()
Snapshot	getRestoreFromSnapshot() Returns the snapshot to restore from on recovery.
protected com.google.common.base.Optional<akka.actor.ActorRef>	getRoleChangeNotifier() Notifier Actor for this RaftActor to notify when a role change happens.
protected void	handleNonRaftCommand(Object message) Method exposed for subclasses to plug-in their logic.
void	onRecoveryComplete() This method is called when recovery is complete.
protected void	onStateChanged() This method will be called by the RaftActor when the state of the RaftActor changes.
String	persistenceId()
static akka.actor.Props	props(String id, Map<String,String> peerAddresses, com.google.common.base.Optional<ConfigParams> configParams)
void	startLogRecoveryBatch(int maxBatchSize) This method is called during recovery at the start of a batch of state entries.

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

changeCurrentBehavior, getCurrentBehavior, getCurrentTerm, getId, getLeader, getLeaderId, getRaftActorContext, getRaftState, handleCommand, handleRecover, hasFollowers, isLeader, isLeaderActive, isLeadershipTransferInProgress, newLeaderStateChanged, newOnDemandRaftStateBuilder, newRaftActorRecoverySupport, onLeaderChanged, onVotingStateChangeComplete, pauseLeader, persistData, persistence, postStop, preStart, setPeerAddress, setPersistence, setPersistence, snapshotSequenceNr, unpauseLeader, 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$

Constructor Detail

ExampleActor

public ExampleActor(String id,
                    Map<String,String> peerAddresses,
                    com.google.common.base.Optional<ConfigParams> configParams)

Method Detail

props

public static akka.actor.Props props(String id,
                                     Map<String,String> peerAddresses,
                                     com.google.common.base.Optional<ConfigParams> configParams)

handleNonRaftCommand

protected void handleNonRaftCommand(Object message)

Description copied from class: RaftActor

Method exposed for subclasses to plug-in their logic. This method is invoked by RaftActor.handleCommand(Object) for messages which are not handled by this class. Subclasses overriding this class should fall back to this implementation for messages which they do not handle

Overrides:

handleNonRaftCommand in class RaftActor

Parameters:

message - Incoming command message

getReplicatedLogState

protected String getReplicatedLogState()

createRoleChangeNotifier

public com.google.common.base.Optional<akka.actor.ActorRef> createRoleChangeNotifier(String actorId)

getRoleChangeNotifier

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

Description copied from class: RaftActor

Notifier Actor for this RaftActor to notify when a role change happens.

Specified by:

getRoleChangeNotifier in class RaftActor

Returns:

ActorRef - ActorRef of the notifier or Optional.absent if none.

applyState

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

Description copied from class: RaftActor

The applyState method will be called by the RaftActor when some data needs to be applied to the actor's state.

Specified by:

applyState in class RaftActor

Parameters:

clientActor - A reference to the client who sent this message. This is the same reference that was passed to persistData by the derived actor. clientActor may be null when the RaftActor is behaving as a follower or during recovery.

identifier - The identifier of the persisted data. This is also the same identifier that was passed to persistData by the derived actor. identifier may be null when the RaftActor is behaving as a follower or during recovery

data - A piece of data that was persisted by the persistData call. This should NEVER be null.

createSnapshot

public void createSnapshot(akka.actor.ActorRef actorRef,
                           Optional<OutputStream> installSnapshotStream)

Description copied from interface: RaftActorSnapshotCohort

This method is called by the RaftActor when a snapshot needs to be created. The implementation should send a CaptureSnapshotReply to the given actor.

Specified by:

createSnapshot in interface RaftActorSnapshotCohort

Parameters:

actorRef - the actor to which to respond

installSnapshotStream - Optional OutputStream that is present if the snapshot is to also be installed on a follower. The implementation must serialize its state to the OutputStream and return the installSnapshotStream instance in the CaptureSnapshotReply along with the snapshot State instance. The snapshot State is serialized directly to the snapshot store while the OutputStream is used to send the state data to follower(s) in chunks. The RaftActorSnapshotCohort.deserializeSnapshot(com.google.common.io.ByteSource) method is used to convert the serialized data back to a State instance on the follower end. The serialization for snapshot install is passed off so the cost of serialization is not charged to the raft actor's thread.

applySnapshot

public void applySnapshot(Snapshot.State snapshotState)

Description copied from interface: RaftActorSnapshotCohort

This method is called to apply a snapshot installed by the leader.

Specified by:

applySnapshot in interface RaftActorSnapshotCohort

Parameters:

snapshotState - a snapshot of the state of the actor

onStateChanged

protected void onStateChanged()

Description copied from class: RaftActor

This method will be called by the RaftActor when the state of the RaftActor changes. The derived actor can then use methods like isLeader or getLeader to do something useful

Specified by:

onStateChanged in class RaftActor

persistenceId

public String persistenceId()

Specified by:

persistenceId in interface akka.persistence.PersistenceIdentity

getRaftActorRecoveryCohort

@Nonnull
protected RaftActorRecoveryCohort getRaftActorRecoveryCohort()

Description copied from class: RaftActor

Returns the RaftActorRecoveryCohort to participate in persistence recovery.

Specified by:

getRaftActorRecoveryCohort in class RaftActor

startLogRecoveryBatch

public void startLogRecoveryBatch(int maxBatchSize)

Description copied from interface: RaftActorRecoveryCohort

This method is called during recovery at the start of a batch of state entries. Derived classes should perform any initialization needed to start a batch.

Specified by:

startLogRecoveryBatch in interface RaftActorRecoveryCohort

Parameters:

maxBatchSize - the maximum batch size.

appendRecoveredLogEntry

public void appendRecoveredLogEntry(Payload data)

Description copied from interface: RaftActorRecoveryCohort

This method is called during recovery to append state data to the current batch. This method is called 1 or more times after RaftActorRecoveryCohort.startLogRecoveryBatch(int).

Specified by:

appendRecoveredLogEntry in interface RaftActorRecoveryCohort

Parameters:

data - the state data

applyCurrentLogRecoveryBatch

public void applyCurrentLogRecoveryBatch()

Description copied from interface: RaftActorRecoveryCohort

This method is called during recovery at the end of a batch to apply the current batched log entries. This method is called after RaftActorRecoveryCohort.appendRecoveredLogEntry(org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload).

Specified by:

applyCurrentLogRecoveryBatch in interface RaftActorRecoveryCohort

onRecoveryComplete

public void onRecoveryComplete()

Description copied from class: RaftActor

This method is called when recovery is complete.

Specified by:

onRecoveryComplete in class RaftActor

applyRecoverySnapshot

public void applyRecoverySnapshot(Snapshot.State snapshotState)

Description copied from interface: RaftActorRecoveryCohort

This method is called during recovery to reconstruct the state of the actor.

Specified by:

applyRecoverySnapshot in interface RaftActorRecoveryCohort

Parameters:

snapshotState - A snapshot of the state of the actor

getRaftActorSnapshotCohort

protected RaftActorSnapshotCohort getRaftActorSnapshotCohort()

Description copied from class: RaftActor

Returns the RaftActorSnapshotCohort to participate in snapshot captures.

Specified by:

getRaftActorSnapshotCohort in class RaftActor

getRestoreFromSnapshot

public Snapshot getRestoreFromSnapshot()

Description copied from interface: RaftActorRecoveryCohort

Returns the snapshot to restore from on recovery.

Specified by:

getRestoreFromSnapshot in interface RaftActorRecoveryCohort

Returns:

the snapshot or null if there's no snapshot to restore

deserializeSnapshot

public Snapshot.State deserializeSnapshot(com.google.common.io.ByteSource snapshotBytes)

Description copied from interface: RaftActorSnapshotCohort

This method is called to de-serialize snapshot data that was previously serialized via RaftActorSnapshotCohort.createSnapshot(akka.actor.ActorRef, java.util.Optional<java.io.OutputStream>) to a State instance.

Specified by:

deserializeSnapshot in interface RaftActorSnapshotCohort

Parameters:

snapshotBytes - the ByteSource containing the serialized data

Returns:

the converted snapshot State