akka.persistence

Interface PersistentRepr

All Superinterfaces:

Message, java.io.Serializable

All Known Implementing Classes:

PersistentImpl

public interface PersistentRepr
extends Message

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

See Also:

AsyncWriteJournal, AsyncRecovery

Method Summary

Modifier and Type	Method and Description
boolean	deleted() Not used in new records stored with Akka v2.4, but old records from v2.3 may have this as true if it was a non-permanent delete.
java.lang.String	manifest() Returns the persistent payload's manifest if available
java.lang.Object	payload() This persistent message's payload.
java.lang.String	persistenceId() Persistent id that journals a persistent message
ActorRef	sender() Sender of this message.
long	sequenceNr() This persistent message's sequence number.
PersistentRepr	update(long sequenceNr, java.lang.String persistenceId, boolean deleted, ActorRef sender, java.lang.String writerUuid) Creates a new copy of this PersistentRepr.
PersistentRepr	withManifest(java.lang.String manifest) Creates a new persistent message with the specified manifest.
PersistentRepr	withPayload(java.lang.Object payload) Creates a new persistent message with the specified payload.
java.lang.String	writerUuid() Unique identifier of the writing persistent actor.

Method Detail

payload

java.lang.Object payload()

This persistent message's payload.

Returns:

(undocumented)

manifest

java.lang.String manifest()

Returns the persistent payload's manifest if available

Returns:

(undocumented)

persistenceId

java.lang.String persistenceId()

Persistent id that journals a persistent message

Returns:

(undocumented)

sequenceNr

long sequenceNr()

This persistent message's sequence number.

Returns:

(undocumented)

writerUuid

java.lang.String writerUuid()

Unique identifier of the writing persistent actor. Used to detect anomalies with overlapping writes from multiple persistent actors, which can result in inconsistent replays.

Returns:

(undocumented)

withPayload

PersistentRepr withPayload(java.lang.Object payload)

Creates a new persistent message with the specified payload.

Parameters:

payload - (undocumented)

Returns:

(undocumented)

withManifest

PersistentRepr withManifest(java.lang.String manifest)

Creates a new persistent message with the specified manifest.

Parameters:

manifest - (undocumented)

Returns:

(undocumented)

deleted

boolean deleted()

Not used in new records stored with Akka v2.4, but old records from v2.3 may have this as true if it was a non-permanent delete.

Returns:

(undocumented)

sender

ActorRef sender()

Sender of this message.

Returns:

(undocumented)

update

PersistentRepr update(long sequenceNr,
                      java.lang.String persistenceId,
                      boolean deleted,
                      ActorRef sender,
                      java.lang.String writerUuid)

Creates a new copy of this PersistentRepr.

Parameters:

sequenceNr - (undocumented)

persistenceId - (undocumented)

deleted - (undocumented)

sender - (undocumented)

writerUuid - (undocumented)

Returns:

(undocumented)