com.hazelcast.client.impl.protocol.template

Interface CacheCodecTemplate

public interface CacheCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	addEntryListener(String name, boolean localOnly)
Object	addInvalidationListener(String name, boolean localOnly)
Object	addPartitionLostListener(String name, boolean localOnly) Adds a CachePartitionLostListener.
void	clear(String name) Clears the contents of the cache, without notifying listeners or CacheWriters.
Object	containsKey(String name, Data key) Determines if the Cache contains an entry for the specified key.
Object	createConfig(Data cacheConfig, boolean createAlsoOnOthers)
void	destroy(String name) Closes the cache.
Object	entryProcessor(String name, Data key, Data entryProcessor, List<Data> arguments, int completionId)
Object	get(String name, Data key, Data expiryPolicy) Retrieves the mapped value of the given key using a custom javax.cache.expiry.ExpiryPolicy.
Object	getAll(String name, List<Data> keys, Data expiryPolicy) Gets a collection of entries from the cache with custom expiry policy, returning them as Map of the values associated with the set of keys requested.
Object	getAndRemove(String name, Data key, int completionId) Atomically removes the entry for a key only if currently mapped to some value.
Object	getAndReplace(String name, Data key, Data value, Data expiryPolicy, int completionId) Atomically replaces the assigned value of the given key by the specified value using a custom javax.cache.expiry.ExpiryPolicy and returns the previously assigned value.
Object	getConfig(String name, String simpleName)
Object	iterate(String name, int partitionId, int tableIndex, int batch) The ordering of iteration over entries is undefined.
void	listenerRegistration(String name, Data listenerConfig, boolean shouldRegister, Address address)
void	loadAll(String name, List<Data> keys, boolean replaceExistingValues)
void	managementConfig(String name, boolean isStat, boolean enabled, Address address)
Object	put(String name, Data key, Data value, Data expiryPolicy, boolean get, int completionId)
void	putAll(String name, List<Map.Entry<Data,Data>> entries, Data expiryPolicy, int completionId)
Object	putIfAbsent(String name, Data key, Data value, Data expiryPolicy, int completionId) Associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key.
Object	remove(String name, Data key, Data currentValue, int completionId) Atomically removes the mapping for a key only if currently mapped to the given value.
void	removeAll(String name, int completionId) Removes all of the mappings from this cache.
void	removeAllKeys(String name, List<Data> keys, int completionId) Removes entries for the specified keys.
Object	removeEntryListener(String name, String registrationId)
Object	removeInvalidationListener(String name, String registrationId)
Object	removePartitionLostListener(String name, String registrationId) Removes the specified cache partition lost listener.
Object	replace(String name, Data key, Data oldValue, Data newValue, Data expiryPolicy, int completionId) Atomically replaces the currently assigned value for the given key with the specified newValue if and only if the currently assigned value equals the value of oldValue using a custom javax.cache.expiry.ExpiryPolicy If the cache is configured for write-through operation mode, the underlying configured javax.cache.integration.CacheWriter might be called to store the value of the key to any kind of external resource.
Object	size(String name) Total entry count

Method Detail

addEntryListener

Object addEntryListener(String name,
                      boolean localOnly)

Parameters:

name - Name of the cache.

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

Returns:

Registration id for the registered listener.

addInvalidationListener

Object addInvalidationListener(String name,
                             boolean localOnly)

Parameters:

name - Name of the cache.

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

Returns:

Registration id for the registered listener.

clear

void clear(String name)

Clears the contents of the cache, without notifying listeners or CacheWriters.

Parameters:

name - Name of the cache.

removeAllKeys

void removeAllKeys(String name,
                 List<Data> keys,
                 int completionId)

Removes entries for the specified keys. The order in which the individual entries are removed is undefined. For every entry in the key set, the following are called: any registered CacheEntryRemovedListeners if the cache is a write-through cache, the CacheWriter. If the key set is empty, the CacheWriter is not called.

Parameters:

name - Name of the cache.

keys - The keys to remove.

completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.

removeAll

void removeAll(String name,
             int completionId)

Removes all of the mappings from this cache. The order that the individual entries are removed is undefined. For every mapping that exists the following are called: any registered CacheEntryRemovedListener if the cache is a write-through cache, the CacheWriter.If the cache is empty, the CacheWriter is not called. This is potentially an expensive operation as listeners are invoked. Use #clear() to avoid this.

Parameters:

name - Name of the cache.

completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.

containsKey

Object containsKey(String name,
                 Data key)

Determines if the Cache contains an entry for the specified key. More formally, returns true if and only if this cache contains a mapping for a key k such that key.equals(k). (There can be at most one such mapping.)

Parameters:

name - Name of the cache.

key - The key whose presence in this cache is to be tested.

Returns:

Returns true if cache value for the key exists, false otherwise.

createConfig

Object createConfig(Data cacheConfig,
                  boolean createAlsoOnOthers)

Parameters:

cacheConfig - The cache configuration. Byte-array which is serialized from an object implementing javax.cache.configuration.Configuration interface.

createAlsoOnOthers - True if the configuration shall be created on all members, false otherwise.

Returns:

The created configuration object. Byte-array which is serialized from an object implementing javax.cache.configuration.Configuration interface.

destroy

void destroy(String name)

Closes the cache. Clears the internal content and releases any resource.

Parameters:

name - Name of the cache.

entryProcessor

Object entryProcessor(String name,
                    Data key,
                    Data entryProcessor,
                    List<Data> arguments,
                    int completionId)

Parameters:

name - Name of the cache.

key - the key to the entry

entryProcessor - Entry processor to invoke. Byte-array which is serialized from an object implementing javax.cache.processor.EntryProcessor.

arguments - additional arguments to pass to the EntryProcessor

completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.

Returns:

the result of the processing, if any, defined by the EntryProcessor implementation

getAll

Object getAll(String name,
            List<Data> keys,
            @Nullable
            Data expiryPolicy)

Gets a collection of entries from the cache with custom expiry policy, returning them as Map of the values associated with the set of keys requested. If the cache is configured for read-through operation mode, the underlying configured javax.cache.integration.CacheLoader might be called to retrieve the values of the keys from any kind of external resource.

Parameters:

name - Name of the cache.

keys - The keys whose associated values are to be returned.

expiryPolicy - Expiry policy for the entry. Byte-array which is serialized from an object implementing javax.cache.expiry.ExpiryPolicy interface.

Returns:

A map of entries that were found for the given keys. Keys not found in the cache are not in the returned map.

getAndRemove

Object getAndRemove(String name,
                  Data key,
                  int completionId)

Atomically removes the entry for a key only if currently mapped to some value.

Parameters:

name - Name of the cache.

key - key with which the specified value is associated

completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.

Returns:

the value if one existed or null if no mapping existed for this key

getAndReplace

Object getAndReplace(String name,
                   Data key,
                   Data value,
                   @Nullable
                   Data expiryPolicy,
                   int completionId)

Atomically replaces the assigned value of the given key by the specified value using a custom javax.cache.expiry.ExpiryPolicy and returns the previously assigned value. If the cache is configured for write-through operation mode, the underlying configured javax.cache.integration.CacheWriter might be called to store the value of the key to any kind of external resource.

Parameters:

name - Name of the cache.

key - The key whose value is replaced.

value - The new value to be associated with the specified key.

expiryPolicy - Expiry policy for the entry. Byte-array which is serialized from an object implementing javax.cache.expiry.ExpiryPolicy interface.

completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.

Returns:

The old value previously assigned to the given key.

getConfig

Object getConfig(String name,
               String simpleName)

Parameters:

name - Name of the cache with prefix.

simpleName - Name of the cache without prefix.

Returns:

The cache configuration. Byte-array which is serialized from an object implementing javax.cache.configuration.Configuration interface.

get

Object get(String name,
         Data key,
         @Nullable
         Data expiryPolicy)

Retrieves the mapped value of the given key using a custom javax.cache.expiry.ExpiryPolicy. If no mapping exists null is returned. If the cache is configured for read-through operation mode, the underlying configured javax.cache.integration.CacheLoader might be called to retrieve the value of the key from any kind of external resource.

Parameters:

name - Name of the cache.

key - The key whose mapped value is to be returned.

expiryPolicy - Expiry policy for the entry. Byte-array which is serialized from an object implementing javax.cache.expiry.ExpiryPolicy interface.

Returns:

The value assigned to the given key, or null if not assigned.

iterate

Object iterate(String name,
             int partitionId,
             int tableIndex,
             int batch)

The ordering of iteration over entries is undefined. During iteration, any entries that are a). read will have their appropriate CacheEntryReadListeners notified and b). removed will have their appropriate CacheEntryRemoveListeners notified. java.util.Iterator#next() may return null if the entry is no longer present, has expired or has been evicted.

Parameters:

name - Name of the cache.

partitionId - The partition id which owns this cache store.

tableIndex - The slot number (or index) to start the iterator

batch - The number of items to be batched

Returns:

last index processed and list of data

listenerRegistration

void listenerRegistration(String name,
                        Data listenerConfig,
                        boolean shouldRegister,
                        Address address)

Parameters:

name - Name of the cache.

listenerConfig - The listener configuration. Byte-array which is serialized from an object implementing javax.cache.configuration.CacheEntryListenerConfiguration

shouldRegister - true if the listener is being registered, false if the listener is being unregistered.

address - The address of the member server for which the listener is being registered for.

loadAll

void loadAll(String name,
           List<Data> keys,
           boolean replaceExistingValues)

Parameters:

name - Name of the cache.

keys - the keys to load

replaceExistingValues - when true existing values in the Cache will be replaced by those loaded from a CacheLoader

managementConfig

void managementConfig(String name,
                    boolean isStat,
                    boolean enabled,
                    Address address)

Parameters:

name - Name of the cache.

isStat - true if enabling statistics, false if enabling management.

enabled - true if enabled, false to disable.

address - the address of the host to enable.

putIfAbsent

Object putIfAbsent(String name,
                 Data key,
                 Data value,
                 @Nullable
                 Data expiryPolicy,
                 int completionId)

Associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key. If the cache is configured for write-through operation mode, the underlying configured javax.cache.integration.CacheWriter might be called to store the value of the key to any kind of external resource.

Parameters:

name - Name of the cache.

key - The key that is associated with the specified value.

value - The value that has the specified key associated with it.

expiryPolicy - The custom expiry policy for this operation. A null value is equivalent to put(Object, Object).

completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.

Returns:

true if a value was set, false otherwise.

put

Object put(String name,
         Data key,
         Data value,
         @Nullable
         Data expiryPolicy,
         boolean get,
         int completionId)

Parameters:

name - Name of the cache.

key - The key that has the specified value associated with it.

value - The value to be associated with the key.

expiryPolicy - Expiry policy for the entry. Byte-array which is serialized from an object implementing javax.cache.expiry.ExpiryPolicy interface.

get - boolean flag indicating if the previous value should be retrieved.

completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.

Returns:

The value previously assigned to the given key, or null if not assigned.

removeEntryListener

Object removeEntryListener(String name,
                         String registrationId)

Parameters:

name - Name of the cache.

registrationId - The id assigned during the registration for the listener which shall be removed.

Returns:

true if the listener is de-registered, false otherwise

removeInvalidationListener

Object removeInvalidationListener(String name,
                                String registrationId)

Parameters:

name - Name of the cache.

registrationId - The id assigned during the registration for the listener which shall be removed.

Returns:

true if the listener is de-registered, false otherwise

remove

Object remove(String name,
            Data key,
            @Nullable
            Data currentValue,
            int completionId)

Atomically removes the mapping for a key only if currently mapped to the given value.

Parameters:

name - Name of the cache.

key - key whose mapping is to be removed from the cache

currentValue - value expected to be associated with the specified key.

completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.

Returns:

returns false if there was no matching key

replace

Object replace(String name,
             Data key,
             @Nullable
             Data oldValue,
             Data newValue,
             @Nullable
             Data expiryPolicy,
             int completionId)

Atomically replaces the currently assigned value for the given key with the specified newValue if and only if the currently assigned value equals the value of oldValue using a custom javax.cache.expiry.ExpiryPolicy If the cache is configured for write-through operation mode, the underlying configured javax.cache.integration.CacheWriter might be called to store the value of the key to any kind of external resource.

Parameters:

name - Name of the cache.

key - The key whose value is replaced.

oldValue - Old value to match if exists before removing. Null means "don't try to remove"

newValue - The new value to be associated with the specified key.

expiryPolicy - Expiry policy for the entry. Byte-array which is serialized from an object implementing javax.cache.expiry.ExpiryPolicy interface.

completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.

Returns:

The replaced value.

size

Object size(String name)

Total entry count

Parameters:

name - Name of the cache.

Returns:

total entry count

addPartitionLostListener

Object addPartitionLostListener(String name,
                              boolean localOnly)

Adds a CachePartitionLostListener. The addPartitionLostListener returns a registration ID. This ID is needed to remove the CachePartitionLostListener using the #removePartitionLostListener(String) method. There is no check for duplicate registrations, so if you register the listener twice, it will get events twice.Listeners registered from HazelcastClient may miss some of the cache partition lost events due to design limitations.

Parameters:

name - Name of the cache

localOnly - if true only node that has the partition sends the request, if false sends all partition lost events.

Returns:

returns the registration id for the CachePartitionLostListener.

removePartitionLostListener

Object removePartitionLostListener(String name,
                                 String registrationId)

Removes the specified cache partition lost listener. Returns silently if there is no such listener added before

Parameters:

name - Name of the Cache

registrationId - ID of registered listener.

Returns:

true if registration is removed, false otherwise.

putAll

void putAll(String name,
          List<Map.Entry<Data,Data>> entries,
          @Nullable
          Data expiryPolicy,
          int completionId)

Parameters:

name - name of the cache

entries - entries to be put as batch

expiryPolicy - expiry policy for the entry. Byte-array which is serialized from an object implementing ExpiryPolicy interface.

completionId - user generated id which shall be received as a field of the cache event upon completion of the request in the cluster.