K
- the type of key.V
- the type of value.public class CacheProxy<K,V> extends AbstractDistributedObject<ICacheService> implements EventJournalReader<EventJournalCacheEvent<K,V>>
This proxy is the implementation of ICache and javax.cache.Cache which is returned by HazelcastServerCacheManager. It represents a cache for server or embedded mode.
Each cache method actually is an operation which is sent to related partition(s) or node(s). Operations are executed on partition's or node's executor pools and the results are delivered to the user.
In order to access a CacheProxy by name, a cacheManager should be used. It's advised to use
ICache
instead.
Modifier and Type | Field and Description |
---|---|
protected CacheConfig<K,V> |
cacheConfig |
protected ICacheService |
cacheService |
protected ILogger |
logger |
protected String |
name |
protected String |
nameWithPrefix |
protected CacheOperationProvider |
operationProvider |
protected IPartitionService |
partitionService |
protected SerializationService |
serializationService |
PARTITIONING_STRATEGY
Modifier and Type | Method and Description |
---|---|
protected void |
addListenerLocally(UUID regId,
javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration) |
UUID |
addPartitionLostListener(CachePartitionLostListener listener)
Adds a CachePartitionLostListener.
|
void |
clear() |
protected void |
clearInternal() |
void |
close() |
boolean |
containsKey(K key) |
void |
countDownCompletionLatch(int countDownLatchId) |
protected void |
createAndSubmitLoadAllTask(Set<Data> keysData,
boolean replaceExistingValues,
javax.cache.integration.CompletionListener completionListener) |
void |
deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration) |
protected void |
ensureOpen() |
boolean |
equals(Object o) |
V |
get(K key) |
V |
get(K key,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Retrieves the mapped value of the given key using a custom
ExpiryPolicy . |
Map<K,V> |
getAll(Set<? extends K> keys) |
Map<K,V> |
getAll(Set<? extends K> keys,
javax.cache.expiry.ExpiryPolicy 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. |
V |
getAndPut(K key,
V value) |
V |
getAndPut(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Associates the specified value with the specified key in this cache using a custom
ExpiryPolicy ,
returning an existing value if one existed. |
InternalCompletableFuture<V> |
getAndPutAsync(K key,
V value)
Asynchronously associates the specified value with the specified key in this cache,
returning an existing value if one existed.
|
InternalCompletableFuture<V> |
getAndPutAsync(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Asynchronously associates the specified value with the specified key in this cache,
returning an existing value if one existed using a custom
ExpiryPolicy . |
V |
getAndRemove(K key) |
InternalCompletableFuture<V> |
getAndRemoveAsync(K key)
Asynchronously removes the entry for a key and returns the previously assigned value or null
if no value was assigned.
|
V |
getAndReplace(K key,
V value) |
V |
getAndReplace(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Atomically replaces the assigned value of the given key by the specified value using a
custom
ExpiryPolicy and returns the previously assigned value. |
InternalCompletableFuture<V> |
getAndReplaceAsync(K key,
V value)
Asynchronously replaces the assigned value of the given key by the specified value and returns
the previously assigned value.
|
InternalCompletableFuture<V> |
getAndReplaceAsync(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Asynchronously replaces the assigned value of the given key by the specified value using a
custom
ExpiryPolicy and returns the previously assigned value. |
InternalCompletableFuture<V> |
getAsync(K key)
Asynchronously retrieves the mapped value of the given key using a custom
ExpiryPolicy . |
InternalCompletableFuture<V> |
getAsync(K key,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Asynchronously gets an entry from cache using a custom
ExpiryPolicy . |
javax.cache.CacheManager |
getCacheManager() |
<C extends javax.cache.configuration.Configuration<K,V>> |
getConfiguration(Class<C> clazz) |
protected String |
getDistributedObjectName() |
protected UUID |
getListenerIdLocal(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration) |
CacheStatistics |
getLocalCacheStatistics()
Directly access local Cache Statistics.
|
String |
getName()
Returns the unique name for this DistributedObject.
|
protected PartitionIdSet |
getPartitionsForKeys(Set<Data> keys) |
String |
getPrefixedName()
Returns the unique prefixed name for this DistributedObject.
|
String |
getServiceName()
Returns the service name for this object.
|
protected List<Data>[] |
groupDataToPartitions(Collection<? extends K> keys,
int partitionCount) |
int |
hashCode() |
protected void |
injectDependencies(Object obj) |
<T> T |
invoke(K key,
javax.cache.processor.EntryProcessor<K,V,T> entryProcessor,
Object... arguments) |
protected <T> InvocationFuture<T> |
invoke(Operation op,
Data keyData,
boolean completionOperation) |
<T> Map<K,javax.cache.processor.EntryProcessorResult<T>> |
invokeAll(Set<? extends K> keys,
javax.cache.processor.EntryProcessor<K,V,T> entryProcessor,
Object... arguments) |
protected <T> T |
invokeInternal(Data keyData,
javax.cache.processor.EntryProcessor<K,V,T> entryProcessor,
Object... arguments) |
boolean |
isClosed() |
boolean |
isDestroyed()
Determines whether this Cache instance has been destroyed.
|
Iterator<javax.cache.Cache.Entry<K,V>> |
iterator() |
Iterator<javax.cache.Cache.Entry<K,V>> |
iterator(int fetchSize)
Creates and returns a cluster wide iterator
to iterate on all entries owned by this cache.
|
Iterator<javax.cache.Cache.Entry<K,V>> |
iterator(int fetchSize,
int partitionId,
boolean prefetchValues)
Cluster-wide iterator for
ICache |
void |
loadAll(Set<? extends K> keys,
boolean replaceExistingValues,
javax.cache.integration.CompletionListener completionListener) |
void |
open()
Opens cache if available (not destroyed).
|
protected void |
postDestroy() |
protected boolean |
preDestroy() |
void |
put(K key,
V value) |
void |
put(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Associates the specified value with the specified key in the cache using a custom
ExpiryPolicy . |
void |
putAll(Map<? extends K,? extends V> map) |
void |
putAll(Map<? extends K,? extends V> map,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Copies all of the entries from the given map to the cache using a custom
ExpiryPolicy . |
InternalCompletableFuture<Void> |
putAsync(K key,
V value)
Asynchronously associates the specified value with the specified key in the cache.
|
InternalCompletableFuture<Void> |
putAsync(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Asynchronously associates the specified value with the specified key in the cache using
a custom
ExpiryPolicy . |
protected <T> InvocationFuture<T> |
putAsyncInternal(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy,
boolean isGet,
boolean withCompletionEvent) |
boolean |
putIfAbsent(K key,
V value) |
boolean |
putIfAbsent(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Associates the specified key with the given value if and only if there is not yet
a mapping defined for the specified key.
|
InternalCompletableFuture<Boolean> |
putIfAbsentAsync(K key,
V value)
Asynchronously associates the specified key with the given value if and only if there is not yet
a mapping defined for the specified key.
|
InternalCompletableFuture<Boolean> |
putIfAbsentAsync(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Asynchronously associates the specified key with the given value if and only if there is not yet
a mapping defined for the specified key.
|
protected InvocationFuture<Boolean> |
putIfAbsentAsyncInternal(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy,
boolean withCompletionEvent) |
protected void |
putToAllPartitionsAndWaitForCompletion(List<Map.Entry<Data,Data>>[] entriesPerPartition,
javax.cache.expiry.ExpiryPolicy expiryPolicy) |
<T> CompletionStage<ReadResultSet<T>> |
readFromEventJournal(long startSequence,
int minSize,
int maxSize,
int partitionId,
Predicate<? super EventJournalCacheEvent<K,V>> predicate,
Function<? super EventJournalCacheEvent<K,V>,? extends T> projection)
Reads from the event journal.
|
void |
registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration) |
void |
registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration,
boolean addToConfig)
Registers the provided listener configuration.
|
boolean |
remove(K key) |
boolean |
remove(K key,
V oldValue) |
void |
removeAll() |
void |
removeAll(Set<? extends K> keys) |
protected void |
removeAllInternal(Set<? extends K> keys) |
InternalCompletableFuture<Boolean> |
removeAsync(K key)
Asynchronously removes the mapping for a key from this cache if it is present.
|
InternalCompletableFuture<Boolean> |
removeAsync(K key,
V oldValue)
Asynchronously removes the mapping for the given key if and only if the
currently mapped value equals to the value of
oldValue . |
protected <T> InvocationFuture<T> |
removeAsyncInternal(K key,
V oldValue,
boolean hasOldValue,
boolean isGet,
boolean withCompletionEvent) |
protected void |
removeListenerLocally(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration) |
boolean |
removePartitionLostListener(UUID id)
Removes the specified cache partition lost listener.
|
boolean |
replace(K key,
V value) |
boolean |
replace(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Atomically replaces the assigned value of the given key by the specified value
using a custom
ExpiryPolicy . |
boolean |
replace(K key,
V oldValue,
V newValue) |
boolean |
replace(K key,
V oldValue,
V newValue,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
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 ExpiryPolicy . |
InternalCompletableFuture<Boolean> |
replaceAsync(K key,
V value)
Asynchronously replaces the assigned value of the given key by the specified value.
|
InternalCompletableFuture<Boolean> |
replaceAsync(K key,
V value,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Asynchronously replaces the assigned value of the given key by the specified value
using a custom
ExpiryPolicy . |
InternalCompletableFuture<Boolean> |
replaceAsync(K key,
V oldValue,
V newValue)
Asynchronously 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 . |
InternalCompletableFuture<Boolean> |
replaceAsync(K key,
V oldValue,
V newValue,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Asynchronously 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 ExpiryPolicy . |
protected <T> InvocationFuture<T> |
replaceAsyncInternal(K key,
V oldValue,
V newValue,
javax.cache.expiry.ExpiryPolicy expiryPolicy,
boolean hasOldValue,
boolean isGet,
boolean withCompletionEvent) |
void |
resetCacheManager()
Reset cache manager of this cache proxy to
null . |
void |
setCacheManager(HazelcastCacheManager cacheManager)
Sets relevant
HazelcastCacheManager to client/server. |
boolean |
setExpiryPolicy(K key,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Associates the specified key with the given
ExpiryPolicy . |
void |
setExpiryPolicy(Set<? extends K> keys,
javax.cache.expiry.ExpiryPolicy expiryPolicy)
Associates the specified key with the given
ExpiryPolicy . |
protected void |
setTTLAllPartitionsAndWaitForCompletion(List<Data>[] keysPerPartition,
Data expiryPolicy) |
int |
size()
Total entry count.
|
CompletionStage<EventJournalInitialSubscriberState> |
subscribeToEventJournal(int partitionId)
Subscribe to the event journal for this reader and a specific partition ID.
|
String |
toString() |
<T> T |
unwrap(Class<T> clazz) |
protected void |
updateCacheListenerConfigOnOtherNodes(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration,
boolean isRegister) |
destroy, getNameAsPartitionAwareData, getNodeEngine, getOperationService, getPartitionId, getPartitionKey, getService, invalidate, invokeOnPartition, isClusterVersionEqualTo, isClusterVersionGreaterOrEqual, isClusterVersionGreaterThan, isClusterVersionLessOrEqual, isClusterVersionLessThan, isClusterVersionUnknown, isClusterVersionUnknownOrGreaterOrEqual, isClusterVersionUnknownOrGreaterThan, isClusterVersionUnknownOrLessOrEqual, isClusterVersionUnknownOrLessThan, throwNotActiveException, toData
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
forEach, spliterator
getPartitionKey
protected final ILogger logger
protected final CacheConfig<K,V> cacheConfig
protected final String name
protected final String nameWithPrefix
protected final ICacheService cacheService
protected final SerializationService serializationService
protected final CacheOperationProvider operationProvider
protected final IPartitionService partitionService
public boolean containsKey(K key)
public void loadAll(Set<? extends K> keys, boolean replaceExistingValues, javax.cache.integration.CompletionListener completionListener)
public <C extends javax.cache.configuration.Configuration<K,V>> C getConfiguration(Class<C> clazz)
public <T> T invoke(K key, javax.cache.processor.EntryProcessor<K,V,T> entryProcessor, Object... arguments) throws javax.cache.processor.EntryProcessorException
public <T> Map<K,javax.cache.processor.EntryProcessorResult<T>> invokeAll(Set<? extends K> keys, javax.cache.processor.EntryProcessor<K,V,T> entryProcessor, Object... arguments)
public void registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
public void registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration, boolean addToConfig)
ICacheInternal
registerCacheEntryListener
in interface ICacheInternal<K,V>
cacheEntryListenerConfiguration
- The cache configuration to be used for registering the entry listeneraddToConfig
- If true, the configuration is added to the existing listeners in the cache config.public void deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
public Iterator<javax.cache.Cache.Entry<K,V>> iterator(int fetchSize)
ICache
Creates and returns a cluster wide iterator to iterate on all entries owned by this cache.
The ordering of iteration over entries is undefined.
During iteration, any entries that are:
Iterator.next()
may return null if the entry is no
longer present, has expired or has been evicted.public Iterator<javax.cache.Cache.Entry<K,V>> iterator(int fetchSize, int partitionId, boolean prefetchValues)
ICacheInternal
ICache
iterator
in interface ICacheInternal<K,V>
fetchSize
- batch fetching sizepartitionId
- partition ID of the entries to iterate onprefetchValues
- prefetch valuespublic UUID addPartitionLostListener(CachePartitionLostListener listener)
ICache
The addPartitionLostListener returns a registration ID. This ID is needed to remove the
CachePartitionLostListener using the
ICache.removePartitionLostListener(UUID)
method.
There is no check for duplicate registrations, so if you register the listener twice, it will get events twice. IMPORTANT: Please @see com.hazelcast.partition.PartitionLostListener for weaknesses. IMPORTANT: Listeners registered from HazelcastClient may miss some of the cache partition lost events due to design limitations.
addPartitionLostListener
in interface ICache<K,V>
listener
- the added CachePartitionLostListener.ICache.removePartitionLostListener(UUID)
public boolean removePartitionLostListener(UUID id)
ICache
removePartitionLostListener
in interface ICache<K,V>
id
- ID of registered listener.public CompletionStage<EventJournalInitialSubscriberState> subscribeToEventJournal(int partitionId)
EventJournalReader
subscribeToEventJournal
in interface EventJournalReader<EventJournalCacheEvent<K,V>>
partitionId
- the partition ID of the entries to which we are subscribingCompletionStage
with the initial subscriber state containing the newest and oldest event journal sequencepublic <T> CompletionStage<ReadResultSet<T>> readFromEventJournal(long startSequence, int minSize, int maxSize, int partitionId, Predicate<? super EventJournalCacheEvent<K,V>> predicate, Function<? super EventJournalCacheEvent<K,V>,? extends T> projection)
EventJournalReader
UnsupportedOperationException
if the cluster version is lower than 3.9 or there is no event journal configured for this data structure.
NOTE:
Configuring evictions may cause unexpected results when reading from the event journal and
there are cluster changes (a backup replica is promoted into a partition owner). See
MapEventJournal
or
CacheEventJournal
for more details.
readFromEventJournal
in interface EventJournalReader<EventJournalCacheEvent<K,V>>
T
- the return type of the projection. It is equal to the journal event type
if the projection is null
or it is the identity projectionstartSequence
- the sequence of the first item to readmaxSize
- the maximum number of items to readpartitionId
- the partition ID of the entries in the journalpredicate
- the predicate which the events must pass to be included in the response.
May be null
in which case all events pass the predicateprojection
- the projection which is applied to the events before returning.
May be null
in which case the event is returned without being projectedCompletionStage
with the filtered and projected journal itemspublic CacheStatistics getLocalCacheStatistics()
ICache
getLocalCacheStatistics
in interface ICache<K,V>
public InternalCompletableFuture<V> getAsync(K key)
ICache
ExpiryPolicy
. If no mapping exists null
is returned.
If the cache is configured for read-through
operation mode, the underlying
configured CacheLoader
might be called to retrieve
the value of the key from any kind of external resource.
The resulting CompletionStage
instance may throw a
ClassCastException
as the operations result if the Cache
is configured to perform runtime-type-checking, and the key or value types are incompatible
with those that have been configured for the Cache
.
public InternalCompletableFuture<V> getAsync(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
If the cache is configured for read-through
operation mode, the underlying
configured CacheLoader
might be called to retrieve
the value of the key from any kind of external resource.
The resulting CompletionStage
instance may throw a
ClassCastException
as the operations result if the Cache
is configured to perform runtime-type-checking, and the key or value types are incompatible
with those that have been configured for the Cache
.
getAsync
in interface ICache<K,V>
key
- The key whose associated value is to be returned.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to ICache.getAsync(Object)
.Cache.get(Object)
public InternalCompletableFuture<Void> putAsync(K key, V value)
ICache
In case a previous assignment already exists, the previous value is overridden by the new given value.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
public InternalCompletableFuture<Void> putAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
In case a previous assignment already exists, the previous value is overridden by the new given value.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
putAsync
in interface ICache<K,V>
key
- The key whose associated value is to be returned.value
- The value to be associated with the specified key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to ICache.putAsync(Object, Object)
.Cache.put(Object, Object)
public InternalCompletableFuture<Boolean> putIfAbsentAsync(K key, V value)
ICache
This is equivalent to:
if (!cache.containsKey(key)) {} cache.put(key, value); return true; } else { return false; }except that the action is performed atomically.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
putIfAbsentAsync
in interface ICache<K,V>
key
- The key that is associated with the specified value.value
- The value to which the specified key is associated.Cache.putIfAbsent(Object, Object)
public InternalCompletableFuture<Boolean> putIfAbsentAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
This is equivalent to:
if (!cache.containsKey(key)) {} cache.put(key, value); return true; } else { return false; }except that the action is performed atomically.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
putIfAbsentAsync
in interface ICache<K,V>
key
- The key that is associated with the specified value.value
- The value to which the specified key is associated.expiryPolicy
- custom expiry policy for this operation,
a null value is equivalent to
ICache.putIfAbsentAsync(Object, Object)
Cache.putIfAbsent(Object, Object)
public InternalCompletableFuture<V> getAndPutAsync(K key, V value)
ICache
In case a previous assignment already exists, the previous value is overridden by
the new given value and the previous value is returned to the caller. This is
equivalent to the Map.put(Object, Object)
operation.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
getAndPutAsync
in interface ICache<K,V>
key
- The key whose associated value is to be returned.value
- The value that is associated with the specified key.Cache.getAndPut(Object, Object)
public InternalCompletableFuture<V> getAndPutAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
In case a previous assignment already exists, the previous value is overridden by
the new given value and the previous value is returned to the caller. This is
equivalent to the Map.put(Object, Object)
operation.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
getAndPutAsync
in interface ICache<K,V>
key
- The key whose associated value is to be returned.value
- The value to associate with the specified key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to ICache.getAndPutAsync(Object, Object)
.Cache.getAndPut(Object, Object)
public InternalCompletableFuture<Boolean> removeAsync(K key)
ICache
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
The resulting CompletionStage
instance may throw a
ClassCastException
as the operations result if the Cache
is configured to perform runtime-type-checking, and the key or value types are incompatible
with those that have been configured for the Cache
.
removeAsync
in interface ICache<K,V>
key
- The key whose mapping is to be removed.Cache.remove(Object)
public InternalCompletableFuture<Boolean> removeAsync(K key, V oldValue)
ICache
oldValue
.
This is equivalent to:
if (cache.containsKey(key) && equals(cache.get(key), oldValue) { cache.remove(key); return true; } else { return false; }except that the action is performed atomically.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
The resulting CompletionStage
instance may throw a
ClassCastException
as the operations result if the Cache
is configured to perform runtime-type-checking, and the key or value types are incompatible
with those that have been configured for the Cache
.
removeAsync
in interface ICache<K,V>
key
- The key whose mapping is to be removed if the mapped value is oldValue.oldValue
- The value expected to be associated with the specified key.Cache.remove(Object, Object)
public InternalCompletableFuture<V> getAndRemoveAsync(K key)
ICache
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
The resulting CompletionStage
instance may throw a
ClassCastException
as the operations result if the Cache
is configured to perform runtime-type-checking, and the key or value types are incompatible
with those that have been configured for the Cache
.
getAndRemoveAsync
in interface ICache<K,V>
key
- The key to be removed and whose associated value is to be returned.Cache.getAndRemove(Object)
public InternalCompletableFuture<Boolean> replaceAsync(K key, V value)
ICache
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
replaceAsync
in interface ICache<K,V>
key
- The key whose associated value is to be replaced.value
- The new value to be associated with the specified key.Cache.replace(Object, Object)
public InternalCompletableFuture<Boolean> replaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
replaceAsync
in interface ICache<K,V>
key
- The key whose assigned value is replaced by the specified value.value
- The specified value to be associated with the given key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to ICache.replaceAsync(Object, Object)
Cache.replace(Object, Object)
public InternalCompletableFuture<Boolean> replaceAsync(K key, V oldValue, V newValue)
ICache
newValue
if and only if the currently assigned value equals the value of
oldValue
.
This is equivalent to:
if (cache.containsKey(key) && equals(cache.get(key), oldValue) { cache.put(key, newValue); return true; } else { return false; }except that the action is performed atomically.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
The resulting CompletionStage
instance may throw a
ClassCastException
as the operations result if the Cache
is configured to perform runtime-type-checking, and the key or value types are incompatible
with those that have been configured for the Cache
.
replaceAsync
in interface ICache<K,V>
key
- The key that will have its assigned value replaced.oldValue
- The old value expected to be associated with the specified key.newValue
- The new value to be associated with the specified key.Cache.replace(Object, Object, Object)
public InternalCompletableFuture<Boolean> replaceAsync(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
newValue
if and only if the currently assigned value equals the value of
oldValue
using a custom ExpiryPolicy
.
This is equivalent to:
if (cache.containsKey(key) && equals(cache.get(key), oldValue) { cache.put(key, newValue); return true; } else { return false; }except that the action is performed atomically.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
The resulting CompletionStage
instance may throw a
ClassCastException
as the operations result if the Cache
is configured to perform runtime-type-checking, and the key or value types are incompatible
with those that have been configured for the Cache
.
replaceAsync
in interface ICache<K,V>
key
- The key that will have its assigned value replaced.oldValue
- The old value expected to be associated with the specified key.newValue
- The new value to be associated with the specified key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to ICache.replaceAsync(Object, Object, Object)
.Cache.replace(Object, Object, Object)
public InternalCompletableFuture<V> getAndReplaceAsync(K key, V value)
ICache
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
getAndReplaceAsync
in interface ICache<K,V>
key
- The key whose value is replaced.value
- The new value to be associated with the specified key.Cache.getAndReplace(Object, Object)
public InternalCompletableFuture<V> getAndReplaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
and returns the previously assigned value.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
getAndReplaceAsync
in interface ICache<K,V>
key
- The key whose value is replaced.value
- The new value to be associated with the specified key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to Cache.getAndReplace(Object, Object)
Cache.getAndReplace(Object, Object)
public V get(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
If no mapping exists null
is returned.
If the cache is configured for read-through
operation mode, the underlying
configured CacheLoader
might be called to retrieve
the value of the key from any kind of external resource.
get
in interface ICache<K,V>
key
- The key whose mapped value is to be returned.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to Cache.get(Object)
.Cache.get(Object)
public Map<K,V> getAll(Set<? extends K> keys, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
Map
of the values associated with the set of keys requested.
If the cache is configured for read-through
operation mode, the underlying
configured CacheLoader
might be called to retrieve
the values of the keys from any kind of external resource.
getAll
in interface ICache<K,V>
keys
- The keys whose associated values are to be returned.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to Cache.getAll(java.util.Set)
.Cache.getAll(java.util.Set)
public void put(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.put
in interface ICache<K,V>
key
- The key that has the specified value associated with it.value
- The value to be associated with the key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to Cache.put(Object, Object)
.Cache.put(Object, Object)
public V getAndPut(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
,
returning an existing value if one existed.getAndPut
in interface ICache<K,V>
key
- The key that has the specified value associated with it.value
- The value to be associated with the key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to Cache.getAndPut(Object, Object)
.Cache.getAndPut(Object, Object)
public void putAll(Map<? extends K,? extends V> map, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
Puts of single entries happen atomically but there is no transactional guarantee over
the complete putAll
operation. If other concurrent operations modify or remove
all or single values of the provided map, the result is undefined.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the values of the keys to any kind of external resource.
public boolean setExpiryPolicy(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
expiryPolicy
takes precedence for this particular key
against any cache wide expiry policy.
If key
does not exist or is already expired, this call makes no changes to entries stored in this cache.
Note: New time-to-live duration is calculated using newly added entry policy's getExpiryForUpdate method
immediately after this operation succeeds.setExpiryPolicy
in interface ICache<K,V>
key
- The key that is associated with the specified expiry policy.expiryPolicy
- custom expiry policy for this operationtrue
if the entry exists and its expiry policy is changed, false
otherwisepublic void setExpiryPolicy(Set<? extends K> keys, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
expiryPolicy
takes precedence for these particular keys
against any cache wide expiry policy.
If some keys in keys
do not exist or are already expired, this call has no effect for those.
Note: New time-to-live duration is calculated using newly added entry policy's getExpiryForUpdate method
immediately after this operation succeeds.setExpiryPolicy
in interface ICache<K,V>
keys
- The keys that are associated with the specified expiry policy.expiryPolicy
- custom expiry policy for this operationpublic boolean putIfAbsent(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
This is equivalent to:
if (!cache.containsKey(key)) {} cache.put(key, value); return true; } else { return false; }except that the action is performed atomically.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
putIfAbsent
in interface ICache<K,V>
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 Cache.putIfAbsent(Object, Object)
.Cache.putIfAbsent(Object, Object)
public boolean replace(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
newValue
if and only if the currently assigned value equals the value of
oldValue
using a custom ExpiryPolicy
.
This is equivalent to:
if (cache.containsKey(key) && equals(cache.get(key), oldValue) { cache.put(key, newValue); return true; } else { return false; }except that the action is performed atomically.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
replace
in interface ICache<K,V>
key
- The key with the value to be replaced.oldValue
- The old value expected to be associated with the specified key.newValue
- The new value to be associated with the specified key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to Cache.replace(Object, Object, Object)
.Cache.replace(Object, Object, Object)
public boolean replace(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
replace
in interface ICache<K,V>
key
- The key whose value is replaced.value
- The new value to be associated with the specified key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to Cache.replace(Object, Object)
Cache.replace(Object, Object)
public V getAndReplace(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)
ICache
ExpiryPolicy
and returns the previously assigned value.
If the cache is configured for write-through
operation mode, the underlying
configured CacheWriter
might be called to store
the value of the key to any kind of external resource.
getAndReplace
in interface ICache<K,V>
key
- The key whose value is replaced.value
- The new value to be associated with the specified key.expiryPolicy
- The custom expiry policy for this operation,
a null value is equivalent to Cache.getAndReplace(Object, Object)
.Cache.getAndReplace(Object, Object)
public int size()
ICache
public String getName()
DistributedObject
DistributedObjectUtil.getName(DistributedObject)
because this might be also a PrefixedDistributedObject
.getName
in interface DistributedObject
getName
in interface javax.cache.Cache<K,V>
protected String getDistributedObjectName()
getDistributedObjectName
in class AbstractDistributedObject<ICacheService>
public String getPrefixedName()
PrefixedDistributedObject
getPrefixedName
in interface PrefixedDistributedObject
public String getServiceName()
DistributedObject
getServiceName
in interface DistributedObject
getServiceName
in class AbstractDistributedObject<ICacheService>
public void open()
ICacheInternal
open
in interface ICacheInternal<K,V>
public void close()
close
in interface Closeable
close
in interface AutoCloseable
close
in interface javax.cache.Cache<K,V>
protected boolean preDestroy()
preDestroy
in class AbstractDistributedObject<ICacheService>
public boolean isClosed()
isClosed
in interface javax.cache.Cache<K,V>
public boolean isDestroyed()
ICache
isDestroyed
in interface ICache<K,V>
true
if this Cache instance is destroyed; false
if it is still open.public boolean equals(Object o)
equals
in class AbstractDistributedObject<ICacheService>
public int hashCode()
hashCode
in class AbstractDistributedObject<ICacheService>
public String toString()
toString
in class AbstractDistributedObject<ICacheService>
public javax.cache.CacheManager getCacheManager()
getCacheManager
in interface javax.cache.Cache<K,V>
public void setCacheManager(HazelcastCacheManager cacheManager)
ICacheInternal
HazelcastCacheManager
to client/server.setCacheManager
in interface ICacheInternal<K,V>
cacheManager
- client or server HazelcastCacheManager
public void resetCacheManager()
ICacheInternal
null
. Whenever a Cache is not managed any more
(for example after Cache.close()
has been called), its CacheManager
should be reset.resetCacheManager
in interface ICacheInternal<K,V>
protected void postDestroy()
postDestroy
in class AbstractDistributedObject<ICacheService>
public void countDownCompletionLatch(int countDownLatchId)
countDownCompletionLatch
in interface CacheSyncListenerCompleter
protected void ensureOpen()
protected void createAndSubmitLoadAllTask(Set<Data> keysData, boolean replaceExistingValues, javax.cache.integration.CompletionListener completionListener)
protected void injectDependencies(Object obj)
protected <T> InvocationFuture<T> invoke(Operation op, Data keyData, boolean completionOperation)
protected <T> InvocationFuture<T> removeAsyncInternal(K key, V oldValue, boolean hasOldValue, boolean isGet, boolean withCompletionEvent)
protected <T> InvocationFuture<T> replaceAsyncInternal(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy, boolean hasOldValue, boolean isGet, boolean withCompletionEvent)
protected <T> InvocationFuture<T> putAsyncInternal(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy, boolean isGet, boolean withCompletionEvent)
protected InvocationFuture<Boolean> putIfAbsentAsyncInternal(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy, boolean withCompletionEvent)
protected void clearInternal()
protected void removeAllInternal(Set<? extends K> keys)
protected void addListenerLocally(UUID regId, javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
protected void removeListenerLocally(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
protected UUID getListenerIdLocal(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
protected <T> T invokeInternal(Data keyData, javax.cache.processor.EntryProcessor<K,V,T> entryProcessor, Object... arguments) throws javax.cache.processor.EntryProcessorException
javax.cache.processor.EntryProcessorException
protected void updateCacheListenerConfigOnOtherNodes(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration, boolean isRegister)
protected List<Data>[] groupDataToPartitions(Collection<? extends K> keys, int partitionCount)
protected void putToAllPartitionsAndWaitForCompletion(List<Map.Entry<Data,Data>>[] entriesPerPartition, javax.cache.expiry.ExpiryPolicy expiryPolicy) throws Exception
Exception
protected void setTTLAllPartitionsAndWaitForCompletion(List<Data>[] keysPerPartition, Data expiryPolicy)
protected PartitionIdSet getPartitionsForKeys(Set<Data> keys)
Copyright © 2019 Hazelcast, Inc.. All rights reserved.