Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.hazelcast.client.cache.impl.AbstractClientCacheProxy Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2020, Hazelcast, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hazelcast.client.cache.impl;
import com.hazelcast.cache.CacheStatistics;
import com.hazelcast.client.impl.clientside.ClientMessageDecoder;
import com.hazelcast.client.impl.protocol.ClientMessage;
import com.hazelcast.client.impl.protocol.codec.CacheGetAllCodec;
import com.hazelcast.client.impl.protocol.codec.CacheGetCodec;
import com.hazelcast.client.impl.protocol.codec.CachePutAllCodec;
import com.hazelcast.client.impl.protocol.codec.CacheSetExpiryPolicyCodec;
import com.hazelcast.client.impl.protocol.codec.CacheSizeCodec;
import com.hazelcast.client.spi.ClientContext;
import com.hazelcast.client.spi.ClientPartitionService;
import com.hazelcast.client.spi.impl.ClientInvocation;
import com.hazelcast.client.spi.impl.ClientInvocationFuture;
import com.hazelcast.client.util.ClientDelegatingFuture;
import com.hazelcast.config.CacheConfig;
import com.hazelcast.core.ExecutionCallback;
import com.hazelcast.core.ICompletableFuture;
import com.hazelcast.nio.serialization.Data;
import com.hazelcast.spi.InternalCompletableFuture;
import com.hazelcast.util.FutureUtil;
import javax.cache.CacheException;
import javax.cache.expiry.ExpiryPolicy;
import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import static com.hazelcast.cache.impl.CacheProxyUtil.NULL_KEY_IS_NOT_ALLOWED;
import static com.hazelcast.cache.impl.CacheProxyUtil.validateNotNull;
import static com.hazelcast.cache.impl.operation.MutableOperation.IGNORE_COMPLETION;
import static com.hazelcast.util.CollectionUtil.objectToDataCollection;
import static com.hazelcast.util.ExceptionUtil.rethrow;
import static com.hazelcast.util.ExceptionUtil.rethrowAllowedTypeFirst;
import static com.hazelcast.util.MapUtil.createHashMap;
import static com.hazelcast.util.Preconditions.checkNotNull;
import static java.util.Collections.emptyMap;
/**
* Hazelcast provides extension functionality to default spec interface {@link javax.cache.Cache}.
* {@link com.hazelcast.cache.ICache} is the designated interface.
*
* AbstractCacheProxyExtension provides implementation of various {@link com.hazelcast.cache.ICache} methods.
*
* Note: this partial implementation is used by client.
*
* @param the type of key
* @param the type of value
*/
@SuppressWarnings("checkstyle:npathcomplexity")
abstract class AbstractClientCacheProxy extends AbstractClientInternalCacheProxy {
@SuppressWarnings("unchecked")
private static final ClientMessageDecoder CACHE_GET_RESPONSE_DECODER = new ClientMessageDecoder() {
@Override
public T decodeClientMessage(ClientMessage clientMessage) {
return (T) CacheGetCodec.decodeResponse(clientMessage).response;
}
};
AbstractClientCacheProxy(CacheConfig cacheConfig, ClientContext context) {
super(cacheConfig, context);
}
protected V getSyncInternal(Object key, ExpiryPolicy expiryPolicy) {
long startNanos = nowInNanosOrDefault();
try {
ClientDelegatingFuture future = getInternal(key, expiryPolicy, false);
V value = future.get();
if (statisticsEnabled) {
statsHandler.onGet(startNanos, value != null);
}
return value;
} catch (Throwable e) {
throw rethrowAllowedTypeFirst(e, CacheException.class);
}
}
@Override
public ICompletableFuture getAsync(K key) {
return getAsync(key, null);
}
@Override
public ICompletableFuture getAsync(K key, ExpiryPolicy expiryPolicy) {
long startNanos = nowInNanosOrDefault();
ensureOpen();
validateNotNull(key);
ExecutionCallback callback = !statisticsEnabled ? null : statsHandler.newOnGetCallback(startNanos);
return getAsyncInternal(key, expiryPolicy, callback);
}
protected InternalCompletableFuture getAsyncInternal(Object key, ExpiryPolicy expiryPolicy,
ExecutionCallback callback) {
Data dataKey = toData(key);
ClientDelegatingFuture future = getInternal(dataKey, expiryPolicy, true);
addCallback(future, callback);
return future;
}
private ClientDelegatingFuture getInternal(Object key, ExpiryPolicy expiryPolicy, boolean deserializeResponse) {
Data keyData = toData(key);
Data expiryPolicyData = toData(expiryPolicy);
ClientMessage request = CacheGetCodec.encodeRequest(nameWithPrefix, keyData, expiryPolicyData);
int partitionId = getContext().getPartitionService().getPartitionId(keyData);
ClientInvocation clientInvocation = new ClientInvocation(getClient(), request, name, partitionId);
ClientInvocationFuture future = clientInvocation.invoke();
return newDelegatingFuture(future, CACHE_GET_RESPONSE_DECODER, deserializeResponse);
}
@Override
public ICompletableFuture putAsync(K key, V value) {
return putAsync(key, value, null);
}
@Override
public ICompletableFuture putAsync(K key, V value, ExpiryPolicy expiryPolicy) {
return (ICompletableFuture) putAsyncInternal(key, value, expiryPolicy, false, true, newStatsCallbackOrNull(false));
}
@Override
public ICompletableFuture putIfAbsentAsync(K key, V value) {
return (ICompletableFuture) putIfAbsentInternal(key, value, null, false, true);
}
@Override
public ICompletableFuture putIfAbsentAsync(K key, V value, ExpiryPolicy expiryPolicy) {
return (ICompletableFuture) putIfAbsentInternal(key, value, expiryPolicy, false, true);
}
@Override
public ICompletableFuture getAndPutAsync(K key, V value) {
return getAndPutAsync(key, value, null);
}
@Override
public ICompletableFuture getAndPutAsync(K key, V value, ExpiryPolicy expiryPolicy) {
return putAsyncInternal(key, value, expiryPolicy, true, false, newStatsCallbackOrNull(true));
}
@Override
public ICompletableFuture removeAsync(K key) {
return (ICompletableFuture) removeAsyncInternal(key, null, false, false, true);
}
@Override
public ICompletableFuture removeAsync(K key, V oldValue) {
return (ICompletableFuture) removeAsyncInternal(key, oldValue, true, false, true);
}
@Override
public ICompletableFuture getAndRemoveAsync(K key) {
return getAndRemoveAsyncInternal(key);
}
@Override
public ICompletableFuture replaceAsync(K key, V value) {
return replaceAsyncInternal(key, null, value, null, false, false, true);
}
@Override
public ICompletableFuture replaceAsync(K key, V value, ExpiryPolicy expiryPolicy) {
return replaceAsyncInternal(key, null, value, expiryPolicy, false, false, true);
}
@Override
public ICompletableFuture replaceAsync(K key, V oldValue, V newValue) {
return replaceAsyncInternal(key, oldValue, newValue, null, true, false, true);
}
@Override
public ICompletableFuture replaceAsync(K key, V oldValue, V newValue, ExpiryPolicy expiryPolicy) {
return replaceAsyncInternal(key, oldValue, newValue, expiryPolicy, true, false, true);
}
@Override
public ICompletableFuture getAndReplaceAsync(K key, V value) {
return replaceAndGetAsyncInternal(key, null, value, null, false, false, true);
}
@Override
public ICompletableFuture getAndReplaceAsync(K key, V value, ExpiryPolicy expiryPolicy) {
return replaceAndGetAsyncInternal(key, null, value, expiryPolicy, false, false, true);
}
@Override
public V get(K key, ExpiryPolicy expiryPolicy) {
ensureOpen();
validateNotNull(key);
return toObject(getSyncInternal(key, expiryPolicy));
}
@Override
public Map getAll(Set keys, ExpiryPolicy expiryPolicy) {
long startNanos = nowInNanosOrDefault();
ensureOpen();
checkNotNull(keys, NULL_KEY_IS_NOT_ALLOWED);
if (keys.isEmpty()) {
return emptyMap();
}
int keysSize = keys.size();
List dataKeys = new LinkedList();
List resultingKeyValuePairs = new ArrayList(keysSize * 2);
getAllInternal(keys, dataKeys, expiryPolicy, resultingKeyValuePairs, startNanos);
Map result = createHashMap(keysSize);
for (int i = 0; i < resultingKeyValuePairs.size(); ) {
K key = toObject(resultingKeyValuePairs.get(i++));
V value = toObject(resultingKeyValuePairs.get(i++));
result.put(key, value);
}
return result;
}
protected void getAllInternal(Set keys, Collection dataKeys, ExpiryPolicy expiryPolicy,
List resultingKeyValuePairs, long startNanos) {
if (dataKeys.isEmpty()) {
objectToDataCollection(keys, dataKeys, getSerializationService(), NULL_KEY_IS_NOT_ALLOWED);
}
Data expiryPolicyData = toData(expiryPolicy);
ClientMessage request = CacheGetAllCodec.encodeRequest(nameWithPrefix, dataKeys, expiryPolicyData);
ClientMessage responseMessage = invoke(request);
List> response = CacheGetAllCodec.decodeResponse(responseMessage).response;
for (Map.Entry entry : response) {
resultingKeyValuePairs.add(entry.getKey());
resultingKeyValuePairs.add(entry.getValue());
}
if (statisticsEnabled) {
statsHandler.onBatchGet(startNanos, response.size());
}
}
@Override
public void put(K key, V value, ExpiryPolicy expiryPolicy) {
putSyncInternal(key, value, expiryPolicy, false);
}
@Override
public V getAndPut(K key, V value, ExpiryPolicy expiryPolicy) {
return putSyncInternal(key, value, expiryPolicy, true);
}
@Override
@SuppressWarnings("unchecked")
public void putAll(Map map, ExpiryPolicy expiryPolicy) {
long startNanos = nowInNanosOrDefault();
ensureOpen();
checkNotNull(map, "map is null");
if (map.isEmpty()) {
return;
}
putAllInternal(map, expiryPolicy, null, new List[partitionCount], startNanos);
}
@Override
public void setExpiryPolicy(Set keys, ExpiryPolicy policy) {
ensureOpen();
checkNotNull(keys);
checkNotNull(policy);
if (keys.isEmpty()) {
return;
}
setExpiryPolicyInternal(keys, policy);
}
@Override
public boolean setExpiryPolicy(K key, ExpiryPolicy expiryPolicy) {
return setExpiryPolicyInternal(key, expiryPolicy);
}
protected void setExpiryPolicyInternal(Set keys, ExpiryPolicy policy) {
setExpiryPolicyInternal(keys, policy, null);
}
protected void setExpiryPolicyInternal(Set keys, ExpiryPolicy policy, Set serializedKeys) {
try {
List[] keysByPartition = groupKeysToPartitions(keys, serializedKeys);
setExpiryPolicyAndWaitForCompletion(keysByPartition, policy);
} catch (Exception e) {
throw rethrow(e);
}
}
protected void putAllInternal(Map map, ExpiryPolicy expiryPolicy, Map keyMap,
List>[] entriesPerPartition, long startNanos) {
try {
// first we fill entry set per partition
groupDataToPartitions(map, getContext().getPartitionService(), keyMap, entriesPerPartition);
// then we invoke the operations and sync on completion of these operations
putToAllPartitionsAndWaitForCompletion(entriesPerPartition, expiryPolicy, startNanos);
} catch (Exception t) {
throw rethrow(t);
}
}
private void groupDataToPartitions(Map map, ClientPartitionService partitionService,
Map keyMap, List>[] entriesPerPartition) {
for (Map.Entry entry : map.entrySet()) {
K key = entry.getKey();
V value = entry.getValue();
validateNotNull(key, value);
Data keyData = toData(key);
Data valueData = toData(value);
if (keyMap != null) {
keyMap.put(key, keyData);
}
int partitionId = partitionService.getPartitionId(keyData);
List> entries = entriesPerPartition[partitionId];
if (entries == null) {
entries = new ArrayList>();
entriesPerPartition[partitionId] = entries;
}
entries.add(new AbstractMap.SimpleImmutableEntry(keyData, valueData));
}
}
private List[] groupKeysToPartitions(Set keys, Set serializedKeys) {
List[] keysByPartition = new List[partitionCount];
ClientPartitionService partitionService = getContext().getPartitionService();
for (K key: keys) {
Data keyData = getSerializationService().toData(key);
if (serializedKeys != null) {
serializedKeys.add(keyData);
}
int partitionId = partitionService.getPartitionId(keyData);
List partition = keysByPartition[partitionId];
if (partition == null) {
partition = new ArrayList();
keysByPartition[partitionId] = partition;
}
partition.add(keyData);
}
return keysByPartition;
}
private static final class FutureEntriesTuple {
private final Future future;
private final List> entries;
private FutureEntriesTuple(Future future, List> entries) {
this.future = future;
this.entries = entries;
}
}
private void putToAllPartitionsAndWaitForCompletion(List>[] entriesPerPartition,
ExpiryPolicy expiryPolicy, long startNanos)
throws ExecutionException, InterruptedException {
Data expiryPolicyData = toData(expiryPolicy);
List futureEntriesTuples = new ArrayList(entriesPerPartition.length);
for (int partitionId = 0; partitionId < entriesPerPartition.length; partitionId++) {
List> entries = entriesPerPartition[partitionId];
if (entries != null) {
int completionId = nextCompletionId();
// TODO: if there is a single entry, we could make use of a put operation since that is a bit cheaper
ClientMessage request = CachePutAllCodec.encodeRequest(nameWithPrefix, entries, expiryPolicyData, completionId);
Future future = invoke(request, partitionId, completionId);
futureEntriesTuples.add(new FutureEntriesTuple(future, entries));
}
}
waitResponseFromAllPartitionsForPutAll(futureEntriesTuples, startNanos);
}
private void setExpiryPolicyAndWaitForCompletion(List[] keysByPartition, ExpiryPolicy expiryPolicy) {
List futures = new ArrayList(keysByPartition.length);
Data policyData = toData(expiryPolicy);
for (int partitionId = 0; partitionId < keysByPartition.length; partitionId++) {
List keys = keysByPartition[partitionId];
if (keys != null) {
ClientMessage request = CacheSetExpiryPolicyCodec.encodeRequest(nameWithPrefix, keys, policyData);
futures.add(invoke(request, partitionId, IGNORE_COMPLETION));
}
}
List throwables = FutureUtil.waitUntilAllResponded(futures);
if (throwables.size() > 0) {
throw rethrow(throwables.get(0));
}
}
private void waitResponseFromAllPartitionsForPutAll(List futureEntriesTuples, long startNanos) {
Throwable error = null;
for (FutureEntriesTuple tuple : futureEntriesTuples) {
Future future = tuple.future;
List> entries = tuple.entries;
try {
future.get();
// Note that we count the batch put only if there is no exception while putting to target partition.
// In case of error, some of the entries might have been put and others might fail.
// But we simply ignore the actual put count here if there is an error.
if (statisticsEnabled) {
statsHandler.getStatistics().increaseCachePuts(entries.size());
}
} catch (Throwable t) {
logger.finest("Error occurred while putting entries as batch!", t);
if (error == null) {
error = t;
}
}
}
if (statisticsEnabled) {
statsHandler.getStatistics().addPutTimeNanos(nowInNanosOrDefault() - startNanos);
}
if (error != null) {
/*
* There maybe multiple exceptions but we throw only the first one.
* There are some ideas to throw all exceptions to caller but all of them have drawbacks:
* - `Thread::addSuppressed` can be used to add other exceptions to the first one
* but it is available since JDK 7.
* - `Thread::initCause` can be used but this is wrong as semantic
* since the other exceptions are not cause of the first one.
* - We may wrap all exceptions in our custom exception (such as `MultipleCacheException`)
* but in this case caller may wait different exception type and this idea causes problem.
* For example see this TCK test:
* `org.jsr107.tck.integration.CacheWriterTest::shouldWriteThoughUsingPutAll_partialSuccess`
* In this test exception is thrown at `CacheWriter` and caller side expects this exception.
* So as a result, we only throw the first exception and others are suppressed by only logging.
*/
throw rethrow(error);
}
}
@Override
public boolean putIfAbsent(K key, V value, ExpiryPolicy expiryPolicy) {
return (Boolean) putIfAbsentInternal(key, value, expiryPolicy, true, false);
}
@Override
public boolean replace(K key, V oldValue, V newValue, ExpiryPolicy expiryPolicy) {
return replaceSyncInternal(key, oldValue, newValue, expiryPolicy, true);
}
@Override
public boolean replace(K key, V value, ExpiryPolicy expiryPolicy) {
return replaceSyncInternal(key, null, value, expiryPolicy, false);
}
@Override
public V getAndReplace(K key, V value, ExpiryPolicy expiryPolicy) {
long startNanos = nowInNanosOrDefault();
Future future = replaceAndGetAsyncInternal(key, null, value, expiryPolicy, false, true, false);
try {
V oldValue = future.get();
if (statisticsEnabled) {
statsHandler.onReplace(true, startNanos, oldValue);
}
return oldValue;
} catch (Throwable e) {
throw rethrowAllowedTypeFirst(e, CacheException.class);
}
}
@Override
public int size() {
ensureOpen();
try {
ClientMessage request = CacheSizeCodec.encodeRequest(nameWithPrefix);
ClientMessage resultMessage = invoke(request);
return CacheSizeCodec.decodeResponse(resultMessage).response;
} catch (Throwable t) {
throw rethrowAllowedTypeFirst(t, CacheException.class);
}
}
@Override
public CacheStatistics getLocalCacheStatistics() {
return statsHandler.getStatistics();
}
}
