com.hazelcast.map.impl.event

Class MapEventPublisherImpl

java.lang.Object

com.hazelcast.map.impl.event.MapEventPublisherImpl

All Implemented Interfaces:

MapEventPublisher

public class MapEventPublisherImpl
extends Object
implements MapEventPublisher

Field Summary

Fields

Modifier and Type	Field and Description
protected EventService	eventService
protected FilteringStrategy	filteringStrategy
static HazelcastProperty	LISTENER_WITH_PREDICATE_PRODUCES_NATURAL_EVENT_TYPES When true, enables processing of entry events for listeners with predicates to fit with "query cache" concept: for example when the original event indicates an update from an old value that does not match the predicate to a new value that does match, then the entry listener will be notified with an ADDED event.
protected MapServiceContext	mapServiceContext
protected NodeEngine	nodeEngine
protected IPartitionService	partitionService
protected QueryCacheEventPublisher	queryCacheEventPublisher
protected SerializationService	serializationService

Constructor Summary

Constructors

Constructor and Description
MapEventPublisherImpl(MapServiceContext mapServiceContext)

Method Summary

Modifier and Type	Method and Description
void	addEventToQueryCache(Object eventData) Notifies QueryCache subscribers directly, without publishing an event to other map listeners.
protected Collection<EventRegistration>	getRegistrations(String mapName) Return all listener registrations for the map with mapName.
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.
protected void	postPublishEvent(Collection<EntryEventData> eventDataIncludingValues, Collection<EntryEventData> eventDataExcludingValues) Hook for actions to perform after any of publishEvent(com.hazelcast.nio.Address, java.lang.String, com.hazelcast.core.EntryEventType, com.hazelcast.nio.serialization.Data, java.lang.Object, java.lang.Object) methods is executed and if there were any registrations for the event.
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 oldValue, Object value, Object mergingValue) Publish an event to the event subsystem.
protected void	publishEventInternal(Collection<EventRegistration> registrations, Object eventData, int orderKey)
void	publishLoadedOrAdded(Address caller, String mapName, Data dataKey, Object dataOldValue, Object dataValue) This method tries to publish events after a load happened in a backward compatible manner by choosing one of the two ways below: - As ADD events if listener implements only EntryAddedListener but not EntryLoadedListener, this is for the backward compatibility.
void	publishMapEvent(Address caller, String mapName, EntryEventType eventType, int numberOfEntriesAffected)
void	publishMapPartitionLostEvent(Address caller, String mapName, int partitionId)
protected void	publishWanEvent(String mapName, ReplicationEventObject event) Publishes the event to the WanReplicationPublisher configured for this map.
void	publishWanRemove(String mapName, Data key) Notifies the WAN subsystem of a map entry removal on a replica owner.
void	publishWanUpdate(String mapName, EntryView<Data,Data> entryView, boolean hasLoadProvenance) Notifies the WAN subsystem of a map update on a replica owner.

Methods inherited from class java.lang.Object

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

Field Detail

LISTENER_WITH_PREDICATE_PRODUCES_NATURAL_EVENT_TYPES

public static final HazelcastProperty LISTENER_WITH_PREDICATE_PRODUCES_NATURAL_EVENT_TYPES

When true, enables processing of entry events for listeners with predicates to fit with "query cache" concept: for example when the original event indicates an update from an old value that does not match the predicate to a new value that does match, then the entry listener will be notified with an ADDED event. This affects only map listeners with predicates and the way entry updates are handled. Put/remove operations are not affected, neither are listeners without predicates. Default value is false, to maintain compatible behavior with previous Hazelcast versions.

nodeEngine

protected final NodeEngine nodeEngine

eventService

protected final EventService eventService

partitionService

protected final IPartitionService partitionService

mapServiceContext

protected final MapServiceContext mapServiceContext

filteringStrategy

protected final FilteringStrategy filteringStrategy

serializationService

protected final SerializationService serializationService

queryCacheEventPublisher

protected final QueryCacheEventPublisher queryCacheEventPublisher

Constructor Detail

MapEventPublisherImpl

public MapEventPublisherImpl(MapServiceContext mapServiceContext)

Method Detail

publishWanUpdate

public void publishWanUpdate(String mapName,
                             EntryView<Data,Data> entryView,
                             boolean hasLoadProvenance)

Description copied from interface: MapEventPublisher

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

Specified by:

publishWanUpdate in interface MapEventPublisher

Parameters:

mapName - the map name

entryView - the updated entry

hasLoadProvenance - true to indicate the provenance of update is a load from map-loader, otherwise set false

publishWanRemove

public void publishWanRemove(String mapName,
                             Data key)

Description copied from interface: MapEventPublisher

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

Specified by:

publishWanRemove in interface MapEventPublisher

Parameters:

mapName - the map name

key - the key of the removed entry

publishWanEvent

protected void publishWanEvent(String mapName,
                               ReplicationEventObject event)

Publishes the event to the WanReplicationPublisher configured for this map.

Parameters:

mapName - the map name

event - the event

publishMapEvent

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

Specified by:

publishMapEvent in interface MapEventPublisher

publishEvent

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

Description copied from interface: MapEventPublisher

Publish an event to the event subsystem.

Specified by:

publishEvent in interface MapEventPublisher

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

public void publishEvent(Address caller,
                         String mapName,
                         EntryEventType eventType,
                         Data dataKey,
                         Object oldValue,
                         Object value,
                         Object mergingValue)

Description copied from interface: MapEventPublisher

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.

Specified by:

publishEvent in interface MapEventPublisher

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

oldValue - the old value of the map entry

value - the new value of the map entry

mergingValue - 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.

publishLoadedOrAdded

public void publishLoadedOrAdded(Address caller,
                                 String mapName,
                                 Data dataKey,
                                 Object dataOldValue,
                                 Object dataValue)

Description copied from interface: MapEventPublisher

This method tries to publish events after a load happened in a backward compatible manner by choosing one of the two ways below: - As ADD events if listener implements only EntryAddedListener but not EntryLoadedListener, this is for the backward compatibility. Old listener implementation will continue to receive ADD events after loads happened. - As LOAD events if listener implements EntryLoadedListener

Specified by:

publishLoadedOrAdded in interface MapEventPublisher

Parameters:

caller - the address of the caller that caused the event

mapName - the map name

dataKey - the key of the event map entry

dataOldValue - the old value of the map entry

dataValue - the new value of the map entry

postPublishEvent

protected void postPublishEvent(Collection<EntryEventData> eventDataIncludingValues,
                                Collection<EntryEventData> eventDataExcludingValues)

Hook for actions to perform after any of publishEvent(com.hazelcast.nio.Address, java.lang.String, com.hazelcast.core.EntryEventType, com.hazelcast.nio.serialization.Data, java.lang.Object, java.lang.Object) methods is executed and if there were any registrations for the event. This method will be invoked once per unique EntryEventData generated by publishEvent, regardless of the number of registrations on which the event is published.

Parameters:

eventDataIncludingValues - the event data including all of the entry values (old, new, merging)

eventDataExcludingValues - the event data without entry values

publishMapPartitionLostEvent

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

Specified by:

publishMapPartitionLostEvent in interface MapEventPublisher

hintMapEvent

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

Description copied from interface: MapEventPublisher

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.

Specified by:

hintMapEvent in interface MapEventPublisher

addEventToQueryCache

public void addEventToQueryCache(Object eventData)

Description copied from interface: MapEventPublisher

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.

Specified by:

addEventToQueryCache in interface MapEventPublisher

Parameters:

eventData - the event to publish to query caches

hasEventListener

public boolean hasEventListener(String mapName)

Description copied from interface: MapEventPublisher

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

Specified by:

hasEventListener in interface MapEventPublisher

getRegistrations

protected Collection<EventRegistration> getRegistrations(String mapName)

Return all listener registrations for the map with mapName.

Parameters:

mapName - the map name

Returns:

the collection of listener registrations

publishEventInternal

protected void publishEventInternal(Collection<EventRegistration> registrations,
                                    Object eventData,
                                    int orderKey)