com.hazelcast.client.impl.querycache.subscriber

Class ClientQueryCacheEventService

java.lang.Object

com.hazelcast.client.impl.querycache.subscriber.ClientQueryCacheEventService

All Implemented Interfaces:

QueryCacheEventService

public class ClientQueryCacheEventService
extends Object
implements QueryCacheEventService

Client side event service implementation for query cache.

See Also:

QueryCacheEventService

Constructor Summary

Constructors

Constructor and Description
ClientQueryCacheEventService(ClientContext clientContext)

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 adapter) Adds the listener to listen underlying IMap on all nodes.
ConcurrentMap<String,QueryCacheToListenerMapper>	getRegistrations()
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, Object 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientQueryCacheEventService

public ClientQueryCacheEventService(ClientContext clientContext)

Method Detail

hasListener

public boolean hasListener(String mapName,
                           String cacheId)

Description copied from interface: QueryCacheEventService

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

Specified by:

hasListener in interface QueryCacheEventService

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

getRegistrations

public ConcurrentMap<String,QueryCacheToListenerMapper> getRegistrations()

sendEventToSubscriber

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

Description copied from interface: QueryCacheEventService

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

Specified by:

sendEventToSubscriber in interface QueryCacheEventService

Parameters:

name - listener name

eventData - the event data

orderKey - the order key for the event

publish

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

Description copied from interface: QueryCacheEventService

Publishes query-cache events locally.

Specified by:

publish in interface QueryCacheEventService

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

public String addPublisherListener(String mapName,
                                   String cacheId,
                                   ListenerAdapter adapter)

Description copied from interface: QueryCacheEventService

Adds the listener to listen underlying IMap on all nodes.

Specified by:

addPublisherListener in interface QueryCacheEventService

Parameters:

mapName - underlying map name of query cache

cacheId - ID of the query cache

adapter - listener adapter for the query-cache

Returns:

ID of registered event listener

removePublisherListener

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

Description copied from interface: QueryCacheEventService

Removes listener from underlying IMap

Specified by:

removePublisherListener in interface QueryCacheEventService

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

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

Description copied from interface: QueryCacheEventService

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

Specified by:

addListener in interface QueryCacheEventService

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

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

Description copied from interface: QueryCacheEventService

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

Specified by:

addListener in interface QueryCacheEventService

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

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

Description copied from interface: QueryCacheEventService

Removes listener from this event service.

Specified by:

removeListener in interface QueryCacheEventService

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

public void removeAllListeners(String mapName,
                               String cacheId)

Description copied from interface: QueryCacheEventService

Removes all user defined listeners associated to supplied cacheId

Specified by:

removeAllListeners in interface QueryCacheEventService

Parameters:

mapName - underlying IMap name of query-cache

cacheId - ID of the query cache