com.hazelcast.map.impl.querycache

Interface QueryCacheEventService<E>

Type Parameters:

E - type of event to be published.

All Known Implementing Classes:

ClientQueryCacheEventService, NodeQueryCacheEventService

public interface QueryCacheEventService<E>

Event service abstraction to allow different type of implementations on query cache subscriber and query cache publisher sides. Runs locally on query-cache subscriber side which may be node or client. Responsible for registering/removing listeners and publishing events locally etc.

Method Summary

Modifier and Type	Method and Description
String	addListener(String mapName, String cacheId, MapListener listener) Adds a user-defined listener to a query-cache.
String	addListener(String mapName, String cacheId, MapListener listener, EventFilter filter) Adds a user-defined listener to a query-cache.
String	addPublisherListener(String mapName, String cacheId, ListenerAdapter listenerAdapter) Adds the listener to listen underlying IMap on all nodes.
boolean	hasListener(String mapName, String cacheId) Returns true if this query-cache has at least one registered user defined listener otherwise returns false.
void	publish(String mapName, String cacheId, E event, int orderKey, Extractors extractors) Publishes query-cache events locally.
void	removeAllListeners(String mapName, String cacheId) Removes all user defined listeners associated to supplied cacheId
boolean	removeListener(String mapName, String cacheId, String listenerId) Removes listener from this event service.
boolean	removePublisherListener(String mapName, String cacheId, String listenerId) Removes listener from underlying IMap
void	sendEventToSubscriber(String name, Object eventData, int orderKey) Only sends events which wrap data to be put in a query cache.

Method Detail

publish

void publish(String mapName,
             String cacheId,
             E event,
             int orderKey,
             Extractors extractors)

Publishes query-cache events locally.

Parameters:

mapName - underlying map name of query cache

cacheId - ID of the query cache

event - event to publish

orderKey - use same order key for events which are required to be ordered

extractors - extractors for the query cache

addPublisherListener

String addPublisherListener(String mapName,
                            String cacheId,
                            ListenerAdapter listenerAdapter)

Adds the listener to listen underlying IMap on all nodes.

Parameters:

mapName - underlying map name of query cache

cacheId - ID of the query cache

listenerAdapter - listener adapter for the query-cache

Returns:

ID of registered event listener

removePublisherListener

boolean removePublisherListener(String mapName,
                                String cacheId,
                                String listenerId)

Removes listener from underlying IMap

Parameters:

mapName - underlying map name which query cache listens

cacheId - ID of the query cache

listenerId - ID of registered listener

Returns:

true if listener is de-registered, false otherwise

addListener

String addListener(String mapName,
                   String cacheId,
                   MapListener listener)

Adds a user-defined listener to a query-cache. This listener is registered as a local listener on subscriber side.

Parameters:

mapName - underlying IMap name of query-cache

cacheId - ID of the query-cache

listener - listener for receiving events

Returns:

ID of registered event listener

addListener

String addListener(String mapName,
                   String cacheId,
                   MapListener listener,
                   EventFilter filter)

Adds a user-defined listener to a query-cache. This listener is registered as a local listener on subscriber side.

Parameters:

mapName - underlying IMap name of query-cache

cacheId - ID of the query-cache

listener - listener for receiving events

filter - used to filter events

Returns:

ID of registered event listener

removeListener

boolean removeListener(String mapName,
                       String cacheId,
                       String listenerId)

Removes listener from this event service.

Parameters:

mapName - underlying IMap name of query-cache

cacheId - ID of the query cache

listenerId - registration ID of listener

Returns:

true if listener is removed successfully, false otherwise

removeAllListeners

void removeAllListeners(String mapName,
                        String cacheId)

Removes all user defined listeners associated to supplied cacheId

Parameters:

mapName - underlying IMap name of query-cache

cacheId - ID of the query cache

hasListener

boolean hasListener(String mapName,
                    String cacheId)

Returns true if this query-cache has at least one registered user defined listener otherwise returns false.

Parameters:

mapName - underlying IMap name of query-cache

cacheId - ID of the query-cache

Returns:

true if this query-cache has at least one registered listener otherwise returns false

sendEventToSubscriber

void sendEventToSubscriber(String name,
                           Object eventData,
                           int orderKey)

Only sends events which wrap data to be put in a query cache.

Parameters:

name - listener name

eventData - the event data

orderKey - the order key for the event