com.atlassian.confluence.api.model.journal

Class JournalEntry

java.lang.Object

com.atlassian.confluence.api.model.journal.JournalEntry

@PublicApi
 @ParametersAreNonnullByDefault
public class JournalEntry
extends Object

Entry in a journal. Journal entries contain a message that should be processed by all nodes at some point of time in the future.

Typical user of journal entries is indexing subsystem, where it's important that indexes on all cluster nodes will be kept in sync. When a document changes, indexing subsystem would create a new journal entry with details of the change. Later on nodes will ask for these entries and then update their indexes accordingly.

Since:

5.6

Constructor Summary

Constructors

Constructor and Description
JournalEntry(JournalIdentifier journalId, String type, String message) Creates a new journal entry for persisting.
JournalEntry(long id, JournalIdentifier journalId, Date creationDate, String type, String message) Creates a new journal entry describing an entry that has been persisted

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Date	getCreationDate()
long	getId()
JournalIdentifier	getJournalId()
String	getMessage()
String	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JournalEntry

public JournalEntry(JournalIdentifier journalId,
                    String type,
                    @Nullable
                    String message)

Creates a new journal entry for persisting.

Parameters:

journalId - id of journal the entry belongs to

type - journal specific type of the entry (max length 255)

message - entry payload (max length 2047)

JournalEntry

public JournalEntry(long id,
                    JournalIdentifier journalId,
                    Date creationDate,
                    String type,
                    @Nullable
                    String message)

Creates a new journal entry describing an entry that has been persisted

Parameters:

id - id of the entry

journalId - id of journal the entry belongs to

creationDate - date when the entry was persisted

type - journal specific type of the entry (max length 255)

message - entry payload (max length 2047)

Method Detail

getId

public long getId()

getJournalId

public JournalIdentifier getJournalId()

getCreationDate

public Date getCreationDate()

getType

public String getType()

getMessage

public String getMessage()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object