com.hazelcast.cache.impl.journal

Class RingbufferCacheEventJournalImpl

java.lang.Object

com.hazelcast.cache.impl.journal.RingbufferCacheEventJournalImpl

All Implemented Interfaces:

CacheEventJournal, EventJournal<InternalEventJournalCacheEvent>

public class RingbufferCacheEventJournalImpl
extends Object
implements CacheEventJournal

The cache event journal implementation based on the Ringbuffer. It will add all journal events into a RingbufferContainer with the provided namespace and partition ID and allows checking if the cache has a configured event journal. Adapts the EventJournalConfig to the RingbufferConfig when creating the ringbuffer.

Constructor Summary

Constructors

Constructor and Description
RingbufferCacheEventJournalImpl(NodeEngine engine)

Method Summary

Modifier and Type	Method and Description
void	cleanup(ObjectNamespace namespace, int partitionId) Cleans up the event journal by removing any expired items.
void	destroy(ObjectNamespace namespace, int partitionId) Destroys the event journal for the given object and partition ID.
EventJournalConfig	getEventJournalConfig(ObjectNamespace namespace) Returns the event journal configuration or null if there is none or the journal is disabled for the given namespace.
WaitNotifyKey	getWaitNotifyKey(ObjectNamespace namespace, int partitionId) Return the WaitNotifyKey for objects waiting and notifying on the event journal.
boolean	hasEventJournal(ObjectNamespace namespace) Returns true if the object has a configured and enabled event journal.
void	isAvailableOrNextSequence(ObjectNamespace namespace, int partitionId, long sequence) Checks if the sequence is of an item that can be read immediately or is the sequence of the next item to be added into the event journal.
boolean	isNextAvailableSequence(ObjectNamespace namespace, int partitionId, long sequence) Checks if the sequence is the sequence of the next event to be added to the event journal.
boolean	isPersistenceEnabled(ObjectNamespace namespace, int partitionId) Returns true if the event journal has persistence enabled and can be queried for events older than the EventJournal.oldestSequence(ObjectNamespace, int).
long	newestSequence(ObjectNamespace namespace, int partitionId) Returns the sequence of the newest event stored in the event journal.
long	oldestSequence(ObjectNamespace namespace, int partitionId) Returns the sequence of the oldest event stored in the event journal.
<T> long	readMany(ObjectNamespace namespace, int partitionId, long beginSequence, ReadResultSetImpl<InternalEventJournalCacheEvent,T> resultSet) Reads events from the journal in batches.
protected Data	toData(Object val)
RingbufferConfig	toRingbufferConfig(EventJournalConfig config, ObjectNamespace namespace) Creates a new RingbufferConfig for a ringbuffer that will keep event journal events for a single partition.
void	writeCreatedEvent(EventJournalConfig journalConfig, ObjectNamespace namespace, int partitionId, Data key, Object value) Writes an CacheEventType.CREATED to the event journal.
void	writeEvictEvent(EventJournalConfig journalConfig, ObjectNamespace namespace, int partitionId, Data key, Object value) Writes an CacheEventType.EVICTED to the event journal.
void	writeExpiredEvent(EventJournalConfig journalConfig, ObjectNamespace namespace, int partitionId, Data key, Object value) Writes an CacheEventType.EXPIRED to the event journal.
void	writeRemoveEvent(EventJournalConfig journalConfig, ObjectNamespace namespace, int partitionId, Data key, Object value) Writes an CacheEventType.REMOVED to the event journal.
void	writeUpdateEvent(EventJournalConfig journalConfig, ObjectNamespace namespace, int partitionId, Data key, Object oldValue, Object newValue) Writes an CacheEventType.UPDATED to the event journal.

Methods inherited from class java.lang.Object

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

Constructor Detail

RingbufferCacheEventJournalImpl

public RingbufferCacheEventJournalImpl(NodeEngine engine)

Method Detail

writeUpdateEvent

public void writeUpdateEvent(EventJournalConfig journalConfig,
                             ObjectNamespace namespace,
                             int partitionId,
                             Data key,
                             Object oldValue,
                             Object newValue)

Description copied from interface: CacheEventJournal

Writes an CacheEventType.UPDATED to the event journal. If there is no event journal configured for this cache, the method will do nothing. If an event is added to the event journal, all parked operations waiting for new events on that journal will be unparked.

Specified by:

writeUpdateEvent in interface CacheEventJournal

Parameters:

journalConfig - the event journal config for the cache in which the event occurred

namespace - the cache namespace, containing the full prefixed cache name

partitionId - the entry key partition

key - the entry key

oldValue - the old value

newValue - the new value

writeCreatedEvent

public void writeCreatedEvent(EventJournalConfig journalConfig,
                              ObjectNamespace namespace,
                              int partitionId,
                              Data key,
                              Object value)

Description copied from interface: CacheEventJournal

Writes an CacheEventType.CREATED to the event journal. If there is no event journal configured for this cache, the method will do nothing. If an event is added to the event journal, all parked operations waiting for new events on that journal will be unparked.

Specified by:

writeCreatedEvent in interface CacheEventJournal

Parameters:

journalConfig - the event journal config for the cache in which the event occurred

namespace - the cache namespace, containing the full prefixed cache name

partitionId - the entry key partition

key - the entry key

value - the entry value

writeRemoveEvent

public void writeRemoveEvent(EventJournalConfig journalConfig,
                             ObjectNamespace namespace,
                             int partitionId,
                             Data key,
                             Object value)

Description copied from interface: CacheEventJournal

Writes an CacheEventType.REMOVED to the event journal. If there is no event journal configured for this cache, the method will do nothing. If an event is added to the event journal, all parked operations waiting for new events on that journal will be unparked.

Specified by:

writeRemoveEvent in interface CacheEventJournal

Parameters:

journalConfig - the event journal config for the cache in which the event occurred

namespace - the cache namespace, containing the full prefixed cache name

partitionId - the entry key partition

key - the entry key

value - the entry value

writeEvictEvent

public void writeEvictEvent(EventJournalConfig journalConfig,
                            ObjectNamespace namespace,
                            int partitionId,
                            Data key,
                            Object value)

Description copied from interface: CacheEventJournal

Writes an CacheEventType.EVICTED to the event journal. If there is no event journal configured for this cache, the method will do nothing. If an event is added to the event journal, all parked operations waiting for new events on that journal will be unparked.

Specified by:

writeEvictEvent in interface CacheEventJournal

Parameters:

journalConfig - the event journal config for the cache in which the event occurred

namespace - the cache namespace, containing the full prefixed cache name

partitionId - the entry key partition

key - the entry key

value - the entry value

writeExpiredEvent

public void writeExpiredEvent(EventJournalConfig journalConfig,
                              ObjectNamespace namespace,
                              int partitionId,
                              Data key,
                              Object value)

Description copied from interface: CacheEventJournal

Writes an CacheEventType.EXPIRED to the event journal. If there is no event journal configured for this cache, the method will do nothing. If an event is added to the event journal, all parked operations waiting for new events on that journal will be unparked.

Specified by:

writeExpiredEvent in interface CacheEventJournal

Parameters:

journalConfig - the event journal config for the cache in which the event occurred

namespace - the cache namespace, containing the full prefixed cache name

partitionId - the entry key partition

key - the entry key

value - the entry value

newestSequence

public long newestSequence(ObjectNamespace namespace,
                           int partitionId)

Description copied from interface: EventJournal

Returns the sequence of the newest event stored in the event journal.

Specified by:

newestSequence in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the object namespace

partitionId - the partition ID of the event journal

Returns:

the sequence of the last stored event

oldestSequence

public long oldestSequence(ObjectNamespace namespace,
                           int partitionId)

Description copied from interface: EventJournal

Returns the sequence of the oldest event stored in the event journal.

Specified by:

oldestSequence in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the object namespace

partitionId - the partition ID of the event journal

Returns:

the sequence of the oldest stored event

isPersistenceEnabled

public boolean isPersistenceEnabled(ObjectNamespace namespace,
                                    int partitionId)

Description copied from interface: EventJournal

Returns true if the event journal has persistence enabled and can be queried for events older than the EventJournal.oldestSequence(ObjectNamespace, int). If the journal is not backed by a persistent store, this method will return false.

Specified by:

isPersistenceEnabled in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the object namespace

partitionId - the partition ID of the event journal

Returns:

if the journal is backed by a persistent store and can serve events older than the oldest sequence

destroy

public void destroy(ObjectNamespace namespace,
                    int partitionId)

Description copied from interface: EventJournal

Destroys the event journal for the given object and partition ID.

Specified by:

destroy in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the object namespace

partitionId - the partition ID of the entries in the journal

isAvailableOrNextSequence

public void isAvailableOrNextSequence(ObjectNamespace namespace,
                                      int partitionId,
                                      long sequence)

Description copied from interface: EventJournal

Checks if the sequence is of an item that can be read immediately or is the sequence of the next item to be added into the event journal. Since this method allows the sequence to be one larger than the EventJournal.newestSequence(ObjectNamespace, int), the caller can use this method to check the sequence before performing a possibly blocking read.

Specified by:

isAvailableOrNextSequence in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the object namespace

partitionId - the partition ID of the entries in the journal

sequence - the sequence wanting to be read

isNextAvailableSequence

public boolean isNextAvailableSequence(ObjectNamespace namespace,
                                       int partitionId,
                                       long sequence)

Description copied from interface: EventJournal

Checks if the sequence is the sequence of the next event to be added to the event journal.

Specified by:

isNextAvailableSequence in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the object namespace

partitionId - the partition ID of the entries in the journal

sequence - the sequence to be checked

Returns:

true if the sequence is one greater than the sequence of the last event, false otherwise

getWaitNotifyKey

public WaitNotifyKey getWaitNotifyKey(ObjectNamespace namespace,
                                      int partitionId)

Description copied from interface: EventJournal

Return the WaitNotifyKey for objects waiting and notifying on the event journal.

Specified by:

getWaitNotifyKey in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the object namespace

partitionId - the partition ID of the entries in the journal

Returns:

the key for a wait notify object

readMany

public <T> long readMany(ObjectNamespace namespace,
                         int partitionId,
                         long beginSequence,
                         ReadResultSetImpl<InternalEventJournalCacheEvent,T> resultSet)

Description copied from interface: EventJournal

Reads events from the journal in batches. It will read up to the maximum number that the set can hold - see ReadResultSetImpl.isMaxSizeReached() or until the journal is exhausted. The resultSet allows filtering and projections on journal items so that the caller can control which data is returned.

If the set has reached its max size, the returned sequence is one greater than the sequence of the last item in the set. In other cases it means that the set hasn't reached its full size because we have reached the end of the event journal. In this case the returned sequence is one greater than the sequence of the last stored event.

Specified by:

readMany in interface EventJournal<InternalEventJournalCacheEvent>

Type Parameters:

T - the return type of the projected events

Parameters:

namespace - the object namespace

partitionId - the partition ID of the entries in the journal

beginSequence - the sequence of the first item to read.

resultSet - the container for read, filtered and projected events

Returns:

returns the sequenceId of the next item to read

See Also:

EventJournal.isAvailableOrNextSequence(ObjectNamespace, int, long)

cleanup

public void cleanup(ObjectNamespace namespace,
                    int partitionId)

Description copied from interface: EventJournal

Cleans up the event journal by removing any expired items. Items are considered expired according to the configured expiration policy.

Specified by:

cleanup in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the object namespace

partitionId - the partition ID of the entries in the journal

hasEventJournal

public boolean hasEventJournal(ObjectNamespace namespace)

Returns true if the object has a configured and enabled event journal. NOTE: The cache config should have already been created in the cache service before invoking this method.

Specified by:

hasEventJournal in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the cache namespace, containing the full prefixed cache name

Returns:

true if the object has a configured and enabled event journal, false otherwise

Throws:

CacheNotExistsException - if the cache configuration was not found

getEventJournalConfig

public EventJournalConfig getEventJournalConfig(ObjectNamespace namespace)

Returns the event journal configuration or null if there is none or the journal is disabled for the given namespace.

Specified by:

getEventJournalConfig in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

namespace - the object namespace of the specific distributed object

Returns:

the journal configuration or null if the journal is not enabled or available

Throws:

CacheNotExistsException - if the cache configuration was not found

toRingbufferConfig

public RingbufferConfig toRingbufferConfig(EventJournalConfig config,
                                           ObjectNamespace namespace)

Creates a new RingbufferConfig for a ringbuffer that will keep event journal events for a single partition.

Specified by:

toRingbufferConfig in interface EventJournal<InternalEventJournalCacheEvent>

Parameters:

config - the event journal config

namespace - the object namespace

Returns:

the ringbuffer config for a single partition of the event journal

Throws:

CacheNotExistsException - if the cache configuration was not found

toData

protected Data toData(Object val)