org.modeshape.jcr.journal

Class ClusteredJournal

java.lang.Object

org.modeshape.jcr.clustering.MessageConsumer<ClusteredJournal.DeltaMessage>

org.modeshape.jcr.journal.ClusteredJournal

All Implemented Interfaces:

ChangeSetListener, ChangeJournal

@ThreadSafe
public class ClusteredJournal
extends MessageConsumer<ClusteredJournal.DeltaMessage>
implements ChangeJournal

A ChangeJournal implementation which runs in a cluster and which attempts to reconcile with other members of the cluster on startup in order to retrieve missed/lost records.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ClusteredJournal.DeltaMessage

Nested classes/interfaces inherited from interface org.modeshape.jcr.journal.ChangeJournal

ChangeJournal.Records

Constructor Summary

Constructors

Modifier	Constructor and Description
	ClusteredJournal(LocalJournal localJournal, ClusteringService clusteringService) Creates a new clustered journal
protected	ClusteredJournal(LocalJournal localJournal, ClusteringService clusteringService, int reconciliationMaxWaitTime)

Method Summary

Modifier and Type	Method and Description
void	addRecords(JournalRecord... records) Adds one or more journal records to a journal.
ChangeJournal.Records	allRecords(boolean descendingOrder) Returns all the records this journal holds
Iterator<NodeKey>	changedNodesSince(long timestamp) Returns the node keys which are part of change sets that are newer or equal to a given timestamp.
protected ClusteringService	clusteringService()
protected String	clusterName()
void	consume(ClusteredJournal.DeltaMessage message) Consumes a payload of the given type.
String	journalId() Returns the id of this change journal.
JournalRecord	lastRecord() Returns the last record from the journal.
protected LocalJournal	localJournal()
void	notify(ChangeSet changeSet) Notifies a listener of the given changes.
protected boolean	reconciliationCompleted()
ChangeJournal.Records	recordsNewerThan(LocalDateTime changeSetTime, boolean inclusive, boolean descendingOrder) Returns all records that have changesets which are newer than a given timestamp.
void	removeOldRecords() Removes older entries.
void	shutdown() Stops the journal.
void	start() Starts this journal instance.
boolean	started() Checks if this journal is active (i.e. can accept requests) or not.

Methods inherited from class org.modeshape.jcr.clustering.MessageConsumer

getPayloadType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClusteredJournal

public ClusteredJournal(LocalJournal localJournal,
                        ClusteringService clusteringService)

Creates a new clustered journal

Parameters:

localJournal - the local ChangeJournal which will

clusteringService - an ClusteringService instance.

ClusteredJournal

protected ClusteredJournal(LocalJournal localJournal,
                           ClusteringService clusteringService,
                           int reconciliationMaxWaitTime)

Method Detail

notify

public void notify(ChangeSet changeSet)

Description copied from interface: ChangeSetListener

Notifies a listener of the given changes.

Specified by:

notify in interface ChangeSetListener

Parameters:

changeSet - a non-null ChangeSet

start

public void start()
           throws Exception

Description copied from interface: ChangeJournal

Starts this journal instance.

Specified by:

start in interface ChangeJournal

Throws:

Exception - if anything fails during start

shutdown

public void shutdown()

Description copied from interface: ChangeJournal

Stops the journal.

Specified by:

shutdown in interface ChangeJournal

removeOldRecords

public void removeOldRecords()

Description copied from interface: ChangeJournal

Removes older entries. Each journal is free to decide the semantics behind "old".

Specified by:

removeOldRecords in interface ChangeJournal

allRecords

public ChangeJournal.Records allRecords(boolean descendingOrder)

Description copied from interface: ChangeJournal

Returns all the records this journal holds

Specified by:

allRecords in interface ChangeJournal

Parameters:

descendingOrder - flag which indicates whether the entries

Returns:

a ChangeJournal.Records instance

lastRecord

public JournalRecord lastRecord()

Description copied from interface: ChangeJournal

Returns the last record from the journal.

Specified by:

lastRecord in interface ChangeJournal

Returns:

either a JournalRecord instance or null if the journal is empty.

recordsNewerThan

public ChangeJournal.Records recordsNewerThan(LocalDateTime changeSetTime,
                                              boolean inclusive,
                                              boolean descendingOrder)

Description copied from interface: ChangeJournal

Returns all records that have changesets which are newer than a given timestamp.

Specified by:

recordsNewerThan in interface ChangeJournal

Parameters:

changeSetTime - the LocalDateTime of the changes representing the lower bound; may be null indicating that *all the records* should be returned.

inclusive - flag indicating whether the timestamp should be used inclusively or exclusively

descendingOrder - flag indicating if the records should be returned in ascending order (oldest to newest) or descending order (newest to oldest)

Returns:

a ChangeJournal.Records instance; never null

changedNodesSince

public Iterator<NodeKey> changedNodesSince(long timestamp)

Description copied from interface: ChangeJournal

Returns the node keys which are part of change sets that are newer or equal to a given timestamp.

Specified by:

changedNodesSince in interface ChangeJournal

Parameters:

timestamp - the timestamp of the changes representing the lower bound;

Returns:

an Iterator of NodeKeyinstances; never null, but may contain duplicate keys if the underl

addRecords

public void addRecords(JournalRecord... records)

Description copied from interface: ChangeJournal

Adds one or more journal records to a journal.

Specified by:

addRecords in interface ChangeJournal

Parameters:

records - a JournalRecord array.

journalId

public String journalId()

Description copied from interface: ChangeJournal

Returns the id of this change journal.

Specified by:

journalId in interface ChangeJournal

Returns:

a String, never null

started

public boolean started()

Description copied from interface: ChangeJournal

Checks if this journal is active (i.e. can accept requests) or not.

Specified by:

started in interface ChangeJournal

Returns:

true if the journal has started, false otherwise

consume

public void consume(ClusteredJournal.DeltaMessage message)

Description copied from class: MessageConsumer

Consumes a payload of the given type.

Specified by:

consume in class MessageConsumer<ClusteredJournal.DeltaMessage>

Parameters:

message - a Serializable payload.

reconciliationCompleted

protected boolean reconciliationCompleted()

clusteringService

protected ClusteringService clusteringService()

localJournal

protected LocalJournal localJournal()

clusterName

protected String clusterName()