akka.persistence
Interface PersistentRepr

All Superinterfaces:

Message, PersistentId, Resequenceable, java.io.Serializable

All Known Implementing Classes:

ConfirmablePersistentImpl, PersistentImpl

public interface PersistentRepr
extends Resequenceable, PersistentId, Message

Plugin API: representation of a persistent message in the journal plugin API.

See Also:

SyncWriteJournal, AsyncWriteJournal, AsyncRecovery

Method Summary

boolean	confirmable() true only if this message has been delivered by a channel.
Delivered	confirmMessage() Delivery confirmation message.
scala.collection.immutable.Seq<java.lang.String>	confirms() Channel ids of delivery confirmations that are available for this message.
ActorRef	confirmTarget() Delivery confirmation message.
boolean	deleted() true if this message is marked as deleted.
java.util.List<java.lang.String>	getConfirms() Java API, Plugin API: channel ids of delivery confirmations that are available for this message.
java.lang.Object	payload() This persistent message's payload.
PersistentRepr	prepareWrite(ActorContext context) INTERNAL API.
PersistentRepr	prepareWrite(ActorRef sender) INTERNAL API.
int	redeliveries() Number of redeliveries.
ActorRef	sender() Sender of this message.
PersistentRepr	update(long sequenceNr, java.lang.String persistenceId, boolean deleted, int redeliveries, scala.collection.immutable.Seq<java.lang.String> confirms, Delivered confirmMessage, ActorRef confirmTarget, ActorRef sender) Creates a new copy of this PersistentRepr.

Methods inherited from interface akka.persistence.PersistentId

persistenceId, processorId, sequenceNr

Method Detail

payload

java.lang.Object payload()

This persistent message's payload.

Specified by:

payload in interface Resequenceable

Returns:

(undocumented)

deleted

boolean deleted()

true if this message is marked as deleted.

Returns:

(undocumented)

redeliveries

int redeliveries()

Number of redeliveries. Only greater than zero if message has been redelivered by a Channel or PersistentChannel.

Returns:

(undocumented)

confirms

scala.collection.immutable.Seq<java.lang.String> confirms()

Channel ids of delivery confirmations that are available for this message. Only non-empty for replayed messages.

Returns:

(undocumented)

getConfirms

java.util.List<java.lang.String> getConfirms()

Java API, Plugin API: channel ids of delivery confirmations that are available for this message. Only non-empty for replayed messages.

Returns:

(undocumented)

confirmable

boolean confirmable()

true only if this message has been delivered by a channel.

Returns:

(undocumented)

confirmMessage

Delivered confirmMessage()

Delivery confirmation message.

Returns:

(undocumented)

confirmTarget

ActorRef confirmTarget()

Delivery confirmation message.

Returns:

(undocumented)

sender

ActorRef sender()

Sender of this message.

Specified by:

sender in interface Resequenceable

Returns:

(undocumented)

prepareWrite

PersistentRepr prepareWrite(ActorRef sender)

INTERNAL API.

Parameters:

sender - (undocumented)

Returns:

(undocumented)

prepareWrite

PersistentRepr prepareWrite(ActorContext context)

INTERNAL API.

Parameters:

context - (undocumented)

Returns:

(undocumented)

update

PersistentRepr update(long sequenceNr,
                      java.lang.String persistenceId,
                      boolean deleted,
                      int redeliveries,
                      scala.collection.immutable.Seq<java.lang.String> confirms,
                      Delivered confirmMessage,
                      ActorRef confirmTarget,
                      ActorRef sender)

Creates a new copy of this PersistentRepr.

Parameters:

sequenceNr - (undocumented)

persistenceId - (undocumented)

deleted - (undocumented)

redeliveries - (undocumented)

confirms - (undocumented)

confirmMessage - (undocumented)

confirmTarget - (undocumented)

sender - (undocumented)

Returns:

(undocumented)