com.hazelcast.map.impl.proxy

Class NearCachedMapProxyImpl<K,V>

java.lang.Object

com.hazelcast.spi.AbstractDistributedObject<MapService>

com.hazelcast.map.impl.proxy.MapProxyImpl<K,V>

com.hazelcast.map.impl.proxy.NearCachedMapProxyImpl<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>, EventJournalReader<EventJournalMapEvent<K,V>>, LegacyAsyncMap<K,V>, InitializingObject, ConcurrentMap<K,V>, Map<K,V>

public class NearCachedMapProxyImpl<K,V>
extends MapProxyImpl<K,V>

A server-side IMap implementation which is fronted by a Near Cache.

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected LocalMapStatsImpl	localMapStats
protected LockProxySupport	lockSupport
protected MapConfig	mapConfig
protected MapServiceContext	mapServiceContext
protected String	name
protected static String	NULL_AGGREGATOR_IS_NOT_ALLOWED
protected static String	NULL_KEY_IS_NOT_ALLOWED
protected static String	NULL_KEYS_ARE_NOT_ALLOWED
protected static String	NULL_LISTENER_IS_NOT_ALLOWED
protected static String	NULL_PREDICATE_IS_NOT_ALLOWED
protected static String	NULL_PROJECTION_IS_NOT_ALLOWED
protected static String	NULL_VALUE_IS_NOT_ALLOWED
protected MapOperationProvider	operationProvider
protected OperationService	operationService
protected IPartitionService	partitionService
protected PartitioningStrategy	partitionStrategy
protected SerializationService	serializationService
protected boolean	statisticsEnabled
protected Address	thisAddress

Fields inherited from class com.hazelcast.spi.AbstractDistributedObject

PARTITIONING_STRATEGY

Constructor Summary

Constructors

Constructor and Description
NearCachedMapProxyImpl(String name, MapService mapService, NodeEngine nodeEngine, MapConfig mapConfig)

Method Summary

Modifier and Type	Method and Description
protected String	addEntryListenerInternal(Object listener, Data key, boolean includeValue)
protected String	addEntryListenerInternal(Object listener, Predicate predicate, Data key, boolean includeValue)
void	addIndex(String attribute, boolean ordered) Adds an index to this map for the specified entries so that queries can run faster.
String	addLocalEntryListenerInternal(Object listener)
String	addLocalEntryListenerInternal(Object listener, Predicate predicate, Data key, boolean includeValue)
String	addMapInterceptorInternal(MapInterceptor interceptor)
String	addNearCacheInvalidationListener(InvalidationListener listener)
protected String	addPartitionLostListenerInternal(MapPartitionLostListener listener)
void	clearInternal()
protected boolean	containsKeyInternal(Object key)
boolean	containsValueInternal(Data dataValue)
protected Iterable<Data>	convertToData(Iterable<K> keys)
protected void	deleteInternal(Object key)
protected void	evictAllInternal()
protected boolean	evictInternal(Object key) Evicts a key from a map.
void	executeOnEntriesInternal(EntryProcessor entryProcessor, Predicate predicate, List<Data> resultingKeyValuePairs) IMap.executeOnEntries(EntryProcessor, Predicate)
Data	executeOnKeyInternal(Object key, EntryProcessor entryProcessor)
InternalCompletableFuture<Object>	executeOnKeyInternal(Object key, EntryProcessor entryProcessor, ExecutionCallback<Object> callback)
Map<K,Object>	executeOnKeysInternal(Set<K> keys, Set<Data> dataKeys, EntryProcessor entryProcessor)
protected void	finalizePutAll(Map<?,?> map)
void	flush() If this map has a MapStore, this method flushes all the local dirty entries by calling MapStore.storeAll() and/or MapStore.deleteAll().
protected void	getAllInternal(Set<K> keys, List<Data> dataKeys, List<Object> resultingKeyValuePairs)
protected InternalCompletableFuture<Data>	getAsyncInternal(Object key)
protected EntryView	getEntryViewInternal(Data key)
protected V	getInternal(Object key)
LocalMapStats	getLocalMapStats() Returns LocalMapStats for this map.
protected MapQueryEngine	getMapQueryEngine()
String	getName() Returns the unique name for this DistributedObject.
NearCache<Object,Object>	getNearCache()
MapOperationProvider	getOperationProvider()
PartitioningStrategy	getPartitionStrategy()
String	getServiceName() Returns the service name for this object.
int	getTotalBackupCount()
void	initialize()
protected void	invalidateNearCache(Object key)
protected void	invokePutAllOperationFactory(long size, int[] partitions, MapEntries[] entries)
boolean	isEmpty() Returns true if this map contains no entries.
protected boolean	isMapStoreEnabled()
void	loadAllInternal(boolean replaceExistingValues)
protected void	loadInternal(Set<K> keys, Iterable<Data> dataKeys, boolean replaceExistingValues) Maps keys to corresponding partitions and sends operations to them.
protected void	postDestroy()
protected boolean	preDestroy()
protected void	putAllInternal(Map<?,?> map) This method will group all puts per partition and send a PutAllPartitionAwareOperationFactory per member.
protected InternalCompletableFuture<Data>	putAsyncInternal(Object key, Data value, long ttl, TimeUnit timeunit)
protected Data	putIfAbsentInternal(Object key, Data value, long ttl, TimeUnit timeunit)
protected Data	putInternal(Object key, Data value, long ttl, TimeUnit timeunit)
protected void	putTransientInternal(Object key, Data value, long ttl, TimeUnit timeunit)
protected void	removeAllInternal(Predicate predicate)
protected InternalCompletableFuture<Data>	removeAsyncInternal(Object key)
protected boolean	removeEntryListenerInternal(String id)
protected Data	removeInternal(Object key)
protected boolean	removeInternal(Object key, Data value)
void	removeMapInterceptorInternal(String id)
protected boolean	removePartitionLostListenerInternal(String id)
protected Data	replaceInternal(Object key, Data value)
protected boolean	replaceInternal(Object key, Data expect, Data update)
protected InternalCompletableFuture<Data>	setAsyncInternal(Object key, Data value, long ttl, TimeUnit timeunit)
protected void	setInternal(Object key, Data value, long ttl, TimeUnit timeunit)
void	setOperationProvider(MapOperationProvider operationProvider)
int	size() Returns the number of entries in this map.
protected Data	toData(Object object, PartitioningStrategy partitioningStrategy)
protected void	toDataCollectionWithNonNullKeyValidation(Set<K> keys, Collection<Data> dataKeys)
protected Data	toDataWithStrategy(Object object)
protected <T> T	toObject(Object object)
protected boolean	tryPutInternal(Object key, Data value, long timeout, TimeUnit timeunit)
protected boolean	tryRemoveInternal(Object key, long timeout, TimeUnit timeunit)
void	waitUntilLoaded()

Methods inherited from class com.hazelcast.map.impl.proxy.MapProxyImpl

addEntryListener, addEntryListener, addEntryListener, addEntryListener, addEntryListener, addEntryListener, addEntryListener, addEntryListener, addInterceptor, addLocalEntryListener, addLocalEntryListener, addLocalEntryListener, addLocalEntryListener, addLocalEntryListener, addLocalEntryListener, addPartitionLostListener, aggregate, aggregate, aggregate, aggregate, clear, clearMapOnly, containsKey, containsValue, delete, entrySet, entrySet, evict, evictAll, executeOnEntries, executeOnEntries, executeOnKey, executeOnKeys, forceUnlock, get, getAll, getAsync, getEntryView, getQueryCache, getQueryCache, getQueryCache, invoke, isLocked, iterator, iterator, keySet, keySet, loadAll, loadAll, localKeySet, localKeySet, lock, lock, project, project, put, put, putAll, putAsync, putAsync, putIfAbsent, putIfAbsent, putTransient, readFromEventJournal, remove, remove, removeAll, removeAsync, removeEntryListener, removeInterceptor, removePartitionLostListener, replace, replace, set, set, setAsync, setAsync, submitToKey, submitToKey, subscribeToEventJournal, toString, tryLock, tryLock, tryLock, tryPut, tryRemove, unlock, values, values

Methods inherited from class com.hazelcast.spi.AbstractDistributedObject

destroy, equals, getDistributedObjectName, getNameAsPartitionAwareData, getNodeEngine, getOperationService, getPartitionId, getPartitionKey, getService, hashCode, invalidate, invokeOnPartition, throwNotActiveException, toData

Methods inherited from class java.lang.Object

clone, equals, 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, getPartitionKey

Field Detail

NULL_KEY_IS_NOT_ALLOWED

protected static final String NULL_KEY_IS_NOT_ALLOWED

See Also:

Constant Field Values

NULL_KEYS_ARE_NOT_ALLOWED

protected static final String NULL_KEYS_ARE_NOT_ALLOWED

See Also:

Constant Field Values

NULL_VALUE_IS_NOT_ALLOWED

protected static final String NULL_VALUE_IS_NOT_ALLOWED

See Also:

Constant Field Values

NULL_PREDICATE_IS_NOT_ALLOWED

protected static final String NULL_PREDICATE_IS_NOT_ALLOWED

See Also:

Constant Field Values

NULL_LISTENER_IS_NOT_ALLOWED

protected static final String NULL_LISTENER_IS_NOT_ALLOWED

See Also:

Constant Field Values

NULL_AGGREGATOR_IS_NOT_ALLOWED

protected static final String NULL_AGGREGATOR_IS_NOT_ALLOWED

See Also:

Constant Field Values

NULL_PROJECTION_IS_NOT_ALLOWED

protected static final String NULL_PROJECTION_IS_NOT_ALLOWED

See Also:

Constant Field Values

name

protected final String name

localMapStats

protected final LocalMapStatsImpl localMapStats

lockSupport

protected final LockProxySupport lockSupport

partitionStrategy

protected final PartitioningStrategy partitionStrategy

mapServiceContext

protected final MapServiceContext mapServiceContext

partitionService

protected final IPartitionService partitionService

thisAddress

protected final Address thisAddress

operationService

protected final OperationService operationService

serializationService

protected final SerializationService serializationService

statisticsEnabled

protected final boolean statisticsEnabled

mapConfig

protected final MapConfig mapConfig

operationProvider

protected MapOperationProvider operationProvider

Constructor Detail

NearCachedMapProxyImpl

public NearCachedMapProxyImpl(String name,
                              MapService mapService,
                              NodeEngine nodeEngine,
                              MapConfig mapConfig)

Method Detail

getNearCache

public NearCache<Object,Object> getNearCache()

initialize

public void initialize()

Specified by:

initialize in interface InitializingObject

getInternal

protected V getInternal(Object key)

getAsyncInternal

protected InternalCompletableFuture<Data> getAsyncInternal(Object key)

putInternal

protected Data putInternal(Object key,
                           Data value,
                           long ttl,
                           TimeUnit timeunit)

tryPutInternal

protected boolean tryPutInternal(Object key,
                                 Data value,
                                 long timeout,
                                 TimeUnit timeunit)

putIfAbsentInternal

protected Data putIfAbsentInternal(Object key,
                                   Data value,
                                   long ttl,
                                   TimeUnit timeunit)

putTransientInternal

protected void putTransientInternal(Object key,
                                    Data value,
                                    long ttl,
                                    TimeUnit timeunit)

putAsyncInternal

protected InternalCompletableFuture<Data> putAsyncInternal(Object key,
                                                           Data value,
                                                           long ttl,
                                                           TimeUnit timeunit)

setAsyncInternal

protected InternalCompletableFuture<Data> setAsyncInternal(Object key,
                                                           Data value,
                                                           long ttl,
                                                           TimeUnit timeunit)

replaceInternal

protected boolean replaceInternal(Object key,
                                  Data expect,
                                  Data update)

replaceInternal

protected Data replaceInternal(Object key,
                               Data value)

setInternal

protected void setInternal(Object key,
                           Data value,
                           long ttl,
                           TimeUnit timeunit)

evictInternal

protected boolean evictInternal(Object key)

Evicts a key from a map.

Parameters:

key - the key to evict

Returns:

true if eviction was successful, false otherwise

evictAllInternal

protected void evictAllInternal()

clearInternal

public void clearInternal()

loadAllInternal

public void loadAllInternal(boolean replaceExistingValues)

loadInternal

protected void loadInternal(Set<K> keys,
                            Iterable<Data> dataKeys,
                            boolean replaceExistingValues)

Maps keys to corresponding partitions and sends operations to them.

removeInternal

protected Data removeInternal(Object key)

removeAllInternal

protected void removeAllInternal(Predicate predicate)

deleteInternal

protected void deleteInternal(Object key)

removeInternal

protected boolean removeInternal(Object key,
                                 Data value)

tryRemoveInternal

protected boolean tryRemoveInternal(Object key,
                                    long timeout,
                                    TimeUnit timeunit)

removeAsyncInternal

protected InternalCompletableFuture<Data> removeAsyncInternal(Object key)

containsKeyInternal

protected boolean containsKeyInternal(Object key)

getAllInternal

protected void getAllInternal(Set<K> keys,
                              List<Data> dataKeys,
                              List<Object> resultingKeyValuePairs)

invokePutAllOperationFactory

protected void invokePutAllOperationFactory(long size,
                                            int[] partitions,
                                            MapEntries[] entries)
                                     throws Exception

Throws:

Exception

finalizePutAll

protected void finalizePutAll(Map<?,?> map)

executeOnKeyInternal

public Data executeOnKeyInternal(Object key,
                                 EntryProcessor entryProcessor)

executeOnKeysInternal

public Map<K,Object> executeOnKeysInternal(Set<K> keys,
                                           Set<Data> dataKeys,
                                           EntryProcessor entryProcessor)

executeOnKeyInternal

public InternalCompletableFuture<Object> executeOnKeyInternal(Object key,
                                                              EntryProcessor entryProcessor,
                                                              ExecutionCallback<Object> callback)

executeOnEntriesInternal

public void executeOnEntriesInternal(EntryProcessor entryProcessor,
                                     Predicate predicate,
                                     List<Data> resultingKeyValuePairs)

IMap.executeOnEntries(EntryProcessor, Predicate)

postDestroy

protected void postDestroy()

Overrides:

postDestroy in class AbstractDistributedObject<MapService>

invalidateNearCache

protected void invalidateNearCache(Object key)

addNearCacheInvalidationListener

public String addNearCacheInvalidationListener(InvalidationListener listener)

getName

public final String getName()

Description copied from interface: DistributedObject

Returns the unique name for this DistributedObject. The returned value will never be null. The suggested way for getting name is retrieving it through DistributedObjectUtil.getName(DistributedObject) because this might be also a PrefixedDistributedObject.

Specified by:

getName in interface DistributedObject

Returns:

the unique name for this object.

getServiceName

public final String getServiceName()

Description copied from interface: DistributedObject

Returns the service name for this object.

Specified by:

getServiceName in interface DistributedObject

Specified by:

getServiceName in class AbstractDistributedObject<MapService>

Returns:

the service name for this object.

getPartitionStrategy

public PartitioningStrategy getPartitionStrategy()

getOperationProvider

public MapOperationProvider getOperationProvider()

setOperationProvider

public void setOperationProvider(MapOperationProvider operationProvider)

getTotalBackupCount

public int getTotalBackupCount()

getMapQueryEngine

protected MapQueryEngine getMapQueryEngine()

isMapStoreEnabled

protected boolean isMapStoreEnabled()

convertToData

protected Iterable<Data> convertToData(Iterable<K> keys)

waitUntilLoaded

public void waitUntilLoaded()

size

public int size()

Description copied from interface: BaseMap

Returns the number of entries in this map.

Specified by:

size in interface BaseMap<K,V>

Specified by:

size in interface Map<K,V>

Returns:

the number of entries in this map.

containsValueInternal

public boolean containsValueInternal(Data dataValue)

isEmpty

public boolean isEmpty()

Description copied from interface: BaseMap

Returns true if this map contains no entries.

Specified by:

isEmpty in interface BaseMap<K,V>

Specified by:

isEmpty in interface Map<K,V>

Returns:

true if this map contains no entries.

putAllInternal

protected void putAllInternal(Map<?,?> map)

This method will group all puts per partition and send a PutAllPartitionAwareOperationFactory per member.

If there are e.g. five keys for a single member, there will only be a single remote invocation instead of having five remote invocations.

There is also an optional support for batching to send smaller packages. Takes care about null checks for keys and values.

flush

public void flush()

Description copied from interface: IMap

If this map has a MapStore, this method flushes all the local dirty entries by calling MapStore.storeAll() and/or MapStore.deleteAll().

Specified by:

flush in interface IMap<K,V>

addMapInterceptorInternal

public String addMapInterceptorInternal(MapInterceptor interceptor)

removeMapInterceptorInternal

public void removeMapInterceptorInternal(String id)

addLocalEntryListenerInternal

public String addLocalEntryListenerInternal(Object listener)

addLocalEntryListenerInternal

public String addLocalEntryListenerInternal(Object listener,
                                            Predicate predicate,
                                            Data key,
                                            boolean includeValue)

addEntryListenerInternal

protected String addEntryListenerInternal(Object listener,
                                          Data key,
                                          boolean includeValue)

addEntryListenerInternal

protected String addEntryListenerInternal(Object listener,
                                          Predicate predicate,
                                          Data key,
                                          boolean includeValue)

removeEntryListenerInternal

protected boolean removeEntryListenerInternal(String id)

addPartitionLostListenerInternal

protected String addPartitionLostListenerInternal(MapPartitionLostListener listener)

removePartitionLostListenerInternal

protected boolean removePartitionLostListenerInternal(String id)

getEntryViewInternal

protected EntryView getEntryViewInternal(Data key)

toObject

protected <T> T toObject(Object object)

toDataWithStrategy

protected Data toDataWithStrategy(Object object)

toData

protected Data toData(Object object,
                      PartitioningStrategy partitioningStrategy)

addIndex

public void addIndex(String attribute,
                     boolean ordered)

Description copied from interface: IMap

Adds an index to this map for the specified entries so that queries can run faster.

Let's say your map values are Employee objects.

   public class Employee implements Serializable {
     private boolean active = false;
     private int age;
     private String name = null;
     // other fields

     // getters setter
   }
 

If you are querying your values mostly based on age and active then you should consider indexing these fields.

   IMap imap = Hazelcast.getMap("employees");
   imap.addIndex("age", true);        // ordered, since we have ranged queries for this field
   imap.addIndex("active", false);    // not ordered, because boolean field cannot have range
 

Index attribute should either have a getter method or be public. You should also make sure to add the indexes before adding entries to this map.

Time to Index

Indexing time is executed in parallel on each partition by operation threads. The Map is not blocked during this operation.

The time taken in proportional to the size of the Map and the number Members.

Searches while indexes are being built

Until the index finishes being created, any searches for the attribute will use a full Map scan, thus avoiding using a partially built index and returning incorrect results.

Specified by:

addIndex in interface IMap<K,V>

Parameters:

attribute - index attribute of value

ordered - true if index should be ordered, false otherwise.

getLocalMapStats

public LocalMapStats getLocalMapStats()

Description copied from interface: IMap

Returns LocalMapStats for this map.

LocalMapStats are 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>

Returns:

this map's local statistics

preDestroy

protected boolean preDestroy()

Overrides:

preDestroy in class AbstractDistributedObject<MapService>

toDataCollectionWithNonNullKeyValidation

protected void toDataCollectionWithNonNullKeyValidation(Set<K> keys,
                                                        Collection<Data> dataKeys)