com.hazelcast.map.impl.event

Interface MapEventPublisher

All Known Implementing Classes:

MapEventPublisherImpl

public interface MapEventPublisher

Helper methods for publishing events related to map actions. The implementation may delegate to other parts of the system, for instance the WAN or event subsystem.

See Also:

MapEventPublisherImpl

Method Summary

Modifier and Type	Method and Description
void	addEventToQueryCache(Object eventData) Notifies QueryCache subscribers directly, without publishing an event to other map listeners.
boolean	hasEventListener(String mapName) Returns true if there is at least one listener registered for the specified mapName.
void	hintMapEvent(Address caller, String mapName, EntryEventType eventType, int numberOfEntriesAffected, int partitionId) Only gives a hint which indicates that a map-wide operation has just been executed on this partition.
void	publishEvent(Address caller, String mapName, EntryEventType eventType, Data dataKey, Object dataOldValue, Object dataValue) Publish an event to the event subsystem.
void	publishEvent(Address caller, String mapName, EntryEventType eventType, Data dataKey, Object dataOldValue, Object dataValue, Object dataMergingValue) Publish an event to the event subsystem.
void	publishMapEvent(Address caller, String mapName, EntryEventType eventType, int numberOfEntriesAffected)
void	publishMapPartitionLostEvent(Address caller, String mapName, int partitionId)
void	publishWanReplicationRemove(String mapName, Data key, long removeTime) Notifies the WAN subsystem of a map entry removal on a replica owner.
void	publishWanReplicationRemoveBackup(String mapName, Data key, long removeTime) Notifies the WAN subsystem of a map entry removal on a backup replica.
void	publishWanReplicationUpdate(String mapName, EntryView entryView) Notifies the WAN subsystem of a map update on a replica owner.
void	publishWanReplicationUpdateBackup(String mapName, EntryView entryView) Notifies the WAN subsystem of a map update on a backup replica.

Method Detail

publishWanReplicationUpdate

void publishWanReplicationUpdate(String mapName,
                                 EntryView entryView)

Notifies the WAN subsystem of a map update on a replica owner.

Parameters:

mapName - the map name

entryView - the updated entry

publishWanReplicationRemove

void publishWanReplicationRemove(String mapName,
                                 Data key,
                                 long removeTime)

Notifies the WAN subsystem of a map entry removal on a replica owner.

Parameters:

mapName - the map name

key - the key of the removed entry

removeTime - the clock time for the remove event

See Also:

Clock.currentTimeMillis()

publishWanReplicationUpdateBackup

void publishWanReplicationUpdateBackup(String mapName,
                                       EntryView entryView)

Notifies the WAN subsystem of a map update on a backup replica.

Parameters:

mapName - the map name

entryView - the updated entry

publishWanReplicationRemoveBackup

void publishWanReplicationRemoveBackup(String mapName,
                                       Data key,
                                       long removeTime)

Notifies the WAN subsystem of a map entry removal on a backup replica.

Parameters:

mapName - the map name

key - the key of the removed entry

removeTime - the clock time for the remove event

See Also:

Clock.currentTimeMillis()

publishMapEvent

void publishMapEvent(Address caller,
                     String mapName,
                     EntryEventType eventType,
                     int numberOfEntriesAffected)

publishEvent

void publishEvent(Address caller,
                  String mapName,
                  EntryEventType eventType,
                  Data dataKey,
                  Object dataOldValue,
                  Object dataValue)

Publish an event to the event subsystem.

Parameters:

caller - the address of the caller that caused the event

mapName - the map name

eventType - the event type

dataKey - the key of the event map entry

dataOldValue - the old value of the map entry

dataValue - the new value of the map entry

publishEvent

void publishEvent(Address caller,
                  String mapName,
                  EntryEventType eventType,
                  Data dataKey,
                  Object dataOldValue,
                  Object dataValue,
                  Object dataMergingValue)

Publish an event to the event subsystem. This method can be used for a merge event since it also accepts the value which was used in the merge process.

Parameters:

caller - the address of the caller that caused the event

mapName - the map name

eventType - the event type

dataKey - the key of the event map entry

dataOldValue - the old value of the map entry

dataValue - the new value of the map entry

dataMergingValue - the value used when performing a merge operation in case of a EntryEventType.MERGED event. This value together with the old value produced the new value.

publishMapPartitionLostEvent

void publishMapPartitionLostEvent(Address caller,
                                  String mapName,
                                  int partitionId)

hintMapEvent

void hintMapEvent(Address caller,
                  String mapName,
                  EntryEventType eventType,
                  int numberOfEntriesAffected,
                  int partitionId)

Only gives a hint which indicates that a map-wide operation has just been executed on this partition. This method should not publish an event.

Currently a map event is published by the end which calls map#clear or map#evictAll and there is not any order guarantee between events fired after map#put and map#clear, as a result of that, we may clear a put after a map#clear, to tackle with that kind of possible anomalies, this hint may be used under some conditions internally.

addEventToQueryCache

void addEventToQueryCache(Object eventData)

Notifies QueryCache subscribers directly, without publishing an event to other map listeners. This is necessary in certain cases, such as when loading entries into a map.

Parameters:

eventData - the event to publish to query caches

hasEventListener

boolean hasEventListener(String mapName)

Returns true if there is at least one listener registered for the specified mapName.