com.hazelcast.client.impl.protocol.template

Interface EnterpriseMapCodecTemplate

public interface EnterpriseMapCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	addListener(String listenerName, boolean localOnly)
Object	destroyCache(String mapName, String cacheName)
Object	madePublishable(String mapName, String cacheName)
Object	publisherCreate(String mapName, String cacheName, Data predicate, int batchSize, int bufferSize, long delaySeconds, boolean populate, boolean coalesce)
Object	publisherCreateWithValue(String mapName, String cacheName, Data predicate, int batchSize, int bufferSize, long delaySeconds, boolean populate, boolean coalesce)
Object	setReadCursor(String mapName, String cacheName, long sequence) This method can be used to recover from a possible event loss situation.

Method Detail

publisherCreateWithValue

Object publisherCreateWithValue(String mapName,
                              String cacheName,
                              Data predicate,
                              int batchSize,
                              int bufferSize,
                              long delaySeconds,
                              boolean populate,
                              boolean coalesce)

Parameters:

mapName - Name of the map.

cacheName - Name of the cache for query cache.

predicate - The predicate to filter events which will be applied to the QueryCache.

batchSize - The size of batch. After reaching this minimum size, node immediately sends buffered events to QueryCache.

bufferSize - Maximum number of events which can be stored in a buffer of partition.

delaySeconds - The minimum number of delay seconds which an event waits in the buffer of node.

populate - Flag to enable/disable initial population of the QueryCache.

coalesce - Flag to enable/disable coalescing. If true, then only the last updated value for a key is placed in the batch, otherwise all changed values are included in the update.

Returns:

Array of key-value pairs.

publisherCreate

Object publisherCreate(String mapName,
                     String cacheName,
                     Data predicate,
                     int batchSize,
                     int bufferSize,
                     long delaySeconds,
                     boolean populate,
                     boolean coalesce)

Parameters:

mapName - Name of the map.

cacheName - Name of query cache.

predicate - The predicate to filter events which will be applied to the QueryCache.

batchSize - The size of batch. After reaching this minimum size, node immediately sends buffered events to QueryCache.

bufferSize - Maximum number of events which can be stored in a buffer of partition.

delaySeconds - The minimum number of delay seconds which an event waits in the buffer of node.

populate - Flag to enable/disable initial population of the QueryCache.

coalesce - Flag to enable/disable coalescing. If true, then only the last updated value for a key is placed in the batch, otherwise all changed values are included in the update.

Returns:

Array of keys.

madePublishable

Object madePublishable(String mapName,
                     String cacheName)

Parameters:

mapName - Name of the map.

cacheName - Name of query cache.

Returns:

True if successfully set as publishable, false otherwise.

addListener

Object addListener(String listenerName,
                 boolean localOnly)

Parameters:

listenerName - Name of the MapListener which will be used to listen this QueryCache

localOnly - if true fires events that originated from this node only, otherwise fires all events

Returns:

Registration id for the listener.

setReadCursor

Object setReadCursor(String mapName,
                   String cacheName,
                   long sequence)

This method can be used to recover from a possible event loss situation. This method tries to make consistent the data in this `QueryCache` with the data in the underlying `IMap` by replaying the events after last consistently received ones. As a result of this replaying logic, same event may appear more than once to the `QueryCache` listeners. This method returns `false` if the event is not in the buffer of event publisher side. That means recovery is not possible.

Parameters:

mapName - Name of the map.

cacheName - Name of query cache.

sequence - The cursor position of the accumulator to be set.

Returns:

True if the cursor position could be set, false otherwise.

destroyCache

Object destroyCache(String mapName,
                  String cacheName)

Parameters:

mapName - Name of the map.

cacheName - Name of query cache.

Returns:

True if all cache is destroyed, false otherwise.