com.hazelcast.client.proxy

Class NearCachedClientMapProxy<K,V>

java.lang.Object

com.hazelcast.client.spi.ClientProxy

com.hazelcast.client.proxy.ClientMapProxy<K,V>

com.hazelcast.client.proxy.NearCachedClientMapProxy<K,V>

Type Parameters:

K - the key type for this IMap proxy.

V - the value type for this IMap proxy.

All Implemented Interfaces:

BaseMap<K,V>, DistributedObject, IMap<K,V>, LegacyAsyncMap<K,V>, ConcurrentMap<K,V>, Map<K,V>

public class NearCachedClientMapProxy<K,V>
extends ClientMapProxy<K,V>

A Client-side IMap implementation which is fronted by a near-cache.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	NearCachedClientMapProxy.ClientMapAddNearCacheEventHandler

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	invalidationListenerId
protected KeyStateMarker	keyStateMarker
protected NearCache<Data,Object>	nearCache

Fields inherited from class com.hazelcast.client.proxy.ClientMapProxy

NULL_KEY_IS_NOT_ALLOWED, NULL_LISTENER_IS_NOT_ALLOWED, NULL_PREDICATE_IS_NOT_ALLOWED, NULL_VALUE_IS_NOT_ALLOWED

Fields inherited from class com.hazelcast.client.spi.ClientProxy

name

Constructor Summary

Constructors

Constructor and Description
NearCachedClientMapProxy(String serviceName, String name)

Method Summary

Modifier and Type	Method and Description
protected void	addNearCacheInvalidateListener()
void	addNearCacheInvalidateListener(EventHandler handler)
void	clear() This method clears the map and invokes MapStore.deleteAll(java.util.Collection<K>)deleteAll on MapStore which, if connected to a database, will delete the records from that database.
protected boolean	containsKeyInternal(Data keyData)
protected void	deleteInternal(Data keyData)
void	evictAll() Evicts all keys from this map except the locked ones.
protected boolean	evictInternal(Data keyData)
Object	executeOnKeyInternal(Data keyData, EntryProcessor entryProcessor)
protected List<com.hazelcast.client.impl.protocol.codec.MapGetAllCodec.ResponseParameters>	getAllInternal(Map<Integer,List<Data>> pIdToKeyData, Map<K,V> result)
ICompletableFuture<V>	getAsyncInternal(Data key)
protected V	getInternal(Data key)
KeyStateMarker	getKeyStateMarker()
LocalMapStats	getLocalMapStats() Returns LocalMapStats for this map.
NearCache<Data,Object>	getNearCache()
protected void	init()
protected void	invalidateNearCache(Collection<Data> keys)
protected void	invalidateNearCache(Data key)
void	loadAll(boolean replaceExistingValues) Loads all keys into the store.
protected void	loadAllInternal(boolean replaceExistingValues, Collection<Data> dataKeys)
protected void	onDestroy() Called before proxy is destroyed.
protected void	onInitialize() Called when proxy is created.
protected void	onShutdown() Called before client shutdown.
protected Map<K,Object>	prepareResult(Collection<Map.Entry<Data,Data>> entrySet)
protected void	putAllInternal(Map<Integer,List<Map.Entry<Data,Data>>> entryMap)
protected ICompletableFuture<V>	putAsyncInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)
protected V	putIfAbsentInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)
protected V	putInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)
protected void	putTransientInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)
protected ICompletableFuture<V>	removeAsyncInternal(Data keyData)
protected com.hazelcast.client.impl.protocol.codec.MapRemoveCodec.ResponseParameters	removeInternal(Data keyData)
protected boolean	removeInternal(Data keyData, Data valueData)
protected void	removeNearCacheInvalidationListener()
protected boolean	replaceIfSameInternal(Data keyData, Data oldValueData, Data newValueData)
protected V	replaceInternal(Data keyData, Data valueData)
protected ICompletableFuture<Void>	setAsyncInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)
protected void	setInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)
ICompletableFuture	submitToKeyInternal(Data keyData, EntryProcessor entryProcessor)
void	submitToKeyInternal(Data keyData, EntryProcessor entryProcessor, ExecutionCallback callback)
protected boolean	tryPutInternal(long timeout, TimeUnit timeunit, Data keyData, Data valueData)
protected boolean	tryRemoveInternal(long timeout, TimeUnit timeunit, Data keyData)

Methods inherited from class com.hazelcast.client.proxy.ClientMapProxy

addEntryListener, addEntryListener, addEntryListener, addEntryListener, addEntryListener, addEntryListener, addEntryListener, addEntryListener, addIndex, addInterceptor, addLocalEntryListener, addLocalEntryListener, addLocalEntryListener, addLocalEntryListener, addLocalEntryListener, addLocalEntryListener, addPartitionLostListener, aggregate, aggregate, containsKey, containsValue, delete, entrySet, entrySet, entrySetWithPagingPredicate, evict, executeOnEntries, executeOnEntries, executeOnKey, executeOnKeys, flush, forceUnlock, get, getAll, getAsync, getEntryView, getTimeInMillis, isEmpty, isLocked, iterator, keySet, keySet, loadAll, localKeySet, localKeySet, lock, lock, put, put, putAll, putAsync, putAsync, putIfAbsent, putIfAbsent, putTransient, remove, remove, removeAsync, removeEntryListener, removeInterceptor, removePartitionLostListener, replace, replace, set, set, setAsync, setAsync, size, submitToKey, submitToKey, toString, tryLock, tryLock, tryLock, tryPut, tryRemove, unlock, values, values

Methods inherited from class com.hazelcast.client.spi.ClientProxy

deregisterListener, destroy, equals, getClient, getContext, getDistributedObjectName, getId, getName, getPartitionKey, getSerializationService, getServiceName, hashCode, invoke, invoke, invokeOnPartition, invokeOnPartitionInterruptibly, postDestroy, preDestroy, registerListener, setContext, toData, toObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

Methods inherited from interface java.util.Map

equals, hashCode

Methods inherited from interface com.hazelcast.core.DistributedObject

destroy, getName, getPartitionKey, getServiceName

Field Detail

nearCache

protected NearCache<Data,Object> nearCache

keyStateMarker

protected KeyStateMarker keyStateMarker

invalidationListenerId

protected volatile String invalidationListenerId

Constructor Detail

NearCachedClientMapProxy

public NearCachedClientMapProxy(String serviceName,
                                String name)

Method Detail

onInitialize

protected void onInitialize()

Description copied from class: ClientProxy

Called when proxy is created. Overriding implementations can add initialization specific logic into this method like registering a listener, creating a cleanup task etc.

Overrides:

onInitialize in class ClientMapProxy<K,V>

init

protected void init()

containsKeyInternal

protected boolean containsKeyInternal(Data keyData)

Overrides:

containsKeyInternal in class ClientMapProxy<K,V>

getInternal

protected V getInternal(Data key)

Overrides:

getInternal in class ClientMapProxy<K,V>

removeInternal

protected com.hazelcast.client.impl.protocol.codec.MapRemoveCodec.ResponseParameters removeInternal(Data keyData)

Overrides:

removeInternal in class ClientMapProxy<K,V>

removeInternal

protected boolean removeInternal(Data keyData,
                                 Data valueData)

Overrides:

removeInternal in class ClientMapProxy<K,V>

deleteInternal

protected void deleteInternal(Data keyData)

Overrides:

deleteInternal in class ClientMapProxy<K,V>

getAsyncInternal

public ICompletableFuture<V> getAsyncInternal(Data key)

Overrides:

getAsyncInternal in class ClientMapProxy<K,V>

putAsyncInternal

protected ICompletableFuture<V> putAsyncInternal(long ttl,
                                                 TimeUnit timeunit,
                                                 Data keyData,
                                                 Data valueData)

Overrides:

putAsyncInternal in class ClientMapProxy<K,V>

setAsyncInternal

protected ICompletableFuture<Void> setAsyncInternal(long ttl,
                                                    TimeUnit timeunit,
                                                    Data keyData,
                                                    Data valueData)

Overrides:

setAsyncInternal in class ClientMapProxy<K,V>

removeAsyncInternal

protected ICompletableFuture<V> removeAsyncInternal(Data keyData)

Overrides:

removeAsyncInternal in class ClientMapProxy<K,V>

tryRemoveInternal

protected boolean tryRemoveInternal(long timeout,
                                    TimeUnit timeunit,
                                    Data keyData)

Overrides:

tryRemoveInternal in class ClientMapProxy<K,V>

tryPutInternal

protected boolean tryPutInternal(long timeout,
                                 TimeUnit timeunit,
                                 Data keyData,
                                 Data valueData)

Overrides:

tryPutInternal in class ClientMapProxy<K,V>

putInternal

protected V putInternal(long ttl,
                        TimeUnit timeunit,
                        Data keyData,
                        Data valueData)

Overrides:

putInternal in class ClientMapProxy<K,V>

putTransientInternal

protected void putTransientInternal(long ttl,
                                    TimeUnit timeunit,
                                    Data keyData,
                                    Data valueData)

Overrides:

putTransientInternal in class ClientMapProxy<K,V>

putIfAbsentInternal

protected V putIfAbsentInternal(long ttl,
                                TimeUnit timeunit,
                                Data keyData,
                                Data valueData)

Overrides:

putIfAbsentInternal in class ClientMapProxy<K,V>

replaceIfSameInternal

protected boolean replaceIfSameInternal(Data keyData,
                                        Data oldValueData,
                                        Data newValueData)

Overrides:

replaceIfSameInternal in class ClientMapProxy<K,V>

replaceInternal

protected V replaceInternal(Data keyData,
                            Data valueData)

Overrides:

replaceInternal in class ClientMapProxy<K,V>

setInternal

protected void setInternal(long ttl,
                           TimeUnit timeunit,
                           Data keyData,
                           Data valueData)

Overrides:

setInternal in class ClientMapProxy<K,V>

evictInternal

protected boolean evictInternal(Data keyData)

Overrides:

evictInternal in class ClientMapProxy<K,V>

evictAll

public void evictAll()

Description copied from interface: IMap

Evicts all keys from this map except the locked ones.

If a MapStore is defined for this map, deleteAll is not called by this method. If you do want to deleteAll to be called use the IMap.clear() method.

The EVICT_ALL event is fired for any registered listeners. See MapEvictedListener.mapEvicted(MapEvent) .

Specified by:

evictAll in interface IMap<K,V>

Overrides:

evictAll in class ClientMapProxy<K,V>

See Also:

IMap.clear()

loadAll

public void loadAll(boolean replaceExistingValues)

Description copied from interface: IMap

Loads all keys into the store. This is a batch load operation so that an implementation can optimize the multiple loads.

Specified by:

loadAll in interface IMap<K,V>

Overrides:

loadAll in class ClientMapProxy<K,V>

Parameters:

replaceExistingValues - when true, existing values in the Map will be replaced by those loaded from the MapLoader void loadAll(boolean replaceExistingValues));

loadAllInternal

protected void loadAllInternal(boolean replaceExistingValues,
                               Collection<Data> dataKeys)

Overrides:

loadAllInternal in class ClientMapProxy<K,V>

getAllInternal

protected List<com.hazelcast.client.impl.protocol.codec.MapGetAllCodec.ResponseParameters> getAllInternal(Map<Integer,List<Data>> pIdToKeyData,
                                                                                                          Map<K,V> result)

Overrides:

getAllInternal in class ClientMapProxy<K,V>

getLocalMapStats

public LocalMapStats getLocalMapStats()

Description copied from interface: IMap

Returns LocalMapStats for this map. LocalMapStats is the statistics for the local portion of this distributed map and contains information such as ownedEntryCount backupEntryCount, lastUpdateTime, lockedEntryCount.

Since this stats are only for the local portion of this map, if you need the cluster-wide MapStats then you need to get the LocalMapStats from all members of the cluster and combine them.

Specified by:

getLocalMapStats in interface IMap<K,V>

Overrides:

getLocalMapStats in class ClientMapProxy<K,V>

Returns:

this map's local statistics.

executeOnKeyInternal

public Object executeOnKeyInternal(Data keyData,
                                   EntryProcessor entryProcessor)

Overrides:

executeOnKeyInternal in class ClientMapProxy<K,V>

submitToKeyInternal

public ICompletableFuture submitToKeyInternal(Data keyData,
                                              EntryProcessor entryProcessor)

Overrides:

submitToKeyInternal in class ClientMapProxy<K,V>

submitToKeyInternal

public void submitToKeyInternal(Data keyData,
                                EntryProcessor entryProcessor,
                                ExecutionCallback callback)

Overrides:

submitToKeyInternal in class ClientMapProxy<K,V>

prepareResult

protected Map<K,Object> prepareResult(Collection<Map.Entry<Data,Data>> entrySet)

Overrides:

prepareResult in class ClientMapProxy<K,V>

putAllInternal

protected void putAllInternal(Map<Integer,List<Map.Entry<Data,Data>>> entryMap)

Overrides:

putAllInternal in class ClientMapProxy<K,V>

clear

public void clear()

Description copied from interface: IMap

This method clears the map and invokes MapStore.deleteAll(java.util.Collection<K>)deleteAll on MapStore which, if connected to a database, will delete the records from that database.

The MAP_CLEARED event is fired for any registered listeners. See MapClearedListener.mapCleared(MapEvent).

To clear a map without calling MapStore.deleteAll(java.util.Collection<K>), use IMap.evictAll().

Specified by:

clear in interface IMap<K,V>

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class ClientMapProxy<K,V>

See Also:

IMap.evictAll()

onDestroy

protected void onDestroy()

Description copied from class: ClientProxy

Called before proxy is destroyed. Overriding implementations should clean/release resources created during initialization.

Overrides:

onDestroy in class ClientProxy

onShutdown

protected void onShutdown()

Description copied from class: ClientProxy

Called before client shutdown. Overriding implementations can add shutdown specific logic here.

Overrides:

onShutdown in class ClientProxy

getNearCache

public NearCache<Data,Object> getNearCache()

invalidateNearCache

protected void invalidateNearCache(Data key)

invalidateNearCache

protected void invalidateNearCache(Collection<Data> keys)

addNearCacheInvalidateListener

protected void addNearCacheInvalidateListener()

addNearCacheInvalidateListener

public void addNearCacheInvalidateListener(EventHandler handler)

removeNearCacheInvalidationListener

protected void removeNearCacheInvalidationListener()

getKeyStateMarker

public KeyStateMarker getKeyStateMarker()