Package akka.cluster.sharding

Class PersistentShard

    • Constructor Detail

      • PersistentShard

        public PersistentShard​(java.lang.String typeName,
                       java.lang.String shardId,
                       scala.Function1<java.lang.String,​Props> entityProps,
                       ClusterShardingSettings settings,
                       scala.PartialFunction<java.lang.Object,​scala.Tuple2<java.lang.String,​java.lang.Object>> extractEntityId,
                       scala.Function1<java.lang.Object,​java.lang.String> extractShardId,
                       java.lang.Object handOffStopMessage)

    • Method Detail

      • journalPluginId

        public java.lang.String journalPluginId()
        Description copied from interface: PersistenceIdentity
        Configuration id of the journal plugin servicing this persistent actor. When empty, looks in akka.persistence.journal.plugin to find configuration entry path. When configured, uses journalPluginId as absolute path to the journal configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.
        Specified by:
        journalPluginId in interface PersistenceIdentity
        Returns:
        (undocumented)

      • persistenceId

        public java.lang.String persistenceId()
        Description copied from interface: PersistenceIdentity
        Id of the persistent entity for which messages should be replayed.
        Specified by:
        persistenceId in interface PersistenceIdentity
        Returns:
        (undocumented)

      • preStart

        public void preStart()
        Description copied from interface: Actor
        User overridable callback.

        Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.
        Specified by:
        preStart in interface Actor
        Overrides:
        preStart in class Shard

      • processChange

        public <E extends Shard.StateChange> void processChange​(E event,
                                                        scala.Function1<E,​scala.runtime.BoxedUnit> handler)
        Overrides:
        processChange in class Shard

      • receive

        public scala.PartialFunction<java.lang.Object,​scala.runtime.BoxedUnit> receive()
        Description copied from interface: Actor
        Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
        Specified by:
        receive in interface Actor
        Specified by:
        receive in interface PersistentActor
        Overrides:
        receive in class Shard
        Returns:
        (undocumented)

      • receiveCommand

        public scala.PartialFunction<java.lang.Object,​scala.runtime.BoxedUnit> receiveCommand()
        Description copied from interface: Eventsourced
        Command handler. Typically validates commands against current state (and/or by communication with other actors). On successful validation, one or more events are derived from a command and these events are then persisted by calling persist.
        Specified by:
        receiveCommand in interface Eventsourced
        Overrides:
        receiveCommand in class Shard
        Returns:
        (undocumented)

      • receiveRecover

        public scala.PartialFunction<java.lang.Object,​scala.runtime.BoxedUnit> receiveRecover()
        Description copied from interface: Eventsourced
        Recovery handler that receives persisted events during recovery. If a state snapshot has been captured and saved, this handler will receive a SnapshotOffer message followed by events that are younger than the offered snapshot.

        This handler must not have side-effects other than changing persistent actor state i.e. it should not perform actions that may fail, such as interacting with external services, for example.

        If there is a problem with recovering the state of the actor from the journal, the error will be logged and the actor will be stopped.

        Specified by:
        receiveRecover in interface Eventsourced
        Returns:
        (undocumented)
        See Also:
        Recovery

      • saveSnapshotWhenNeeded

        public void saveSnapshotWhenNeeded()

      • snapshotPluginId

        public java.lang.String snapshotPluginId()
        Description copied from interface: PersistenceIdentity
        Configuration id of the snapshot plugin servicing this persistent actor. When empty, looks in akka.persistence.snapshot-store.plugin to find configuration entry path. When configured, uses snapshotPluginId as absolute path to the snapshot store configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.
        Specified by:
        snapshotPluginId in interface PersistenceIdentity
        Returns:
        (undocumented)