/*
* Copyright (c) 2008-2017, 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.cache.impl;
import com.hazelcast.cache.impl.event.CachePartitionLostEventFilter;
import com.hazelcast.cache.impl.event.CachePartitionLostListener;
import com.hazelcast.cache.impl.event.InternalCachePartitionLostListenerAdapter;
import com.hazelcast.cache.impl.operation.CacheListenerRegistrationOperation;
import com.hazelcast.config.CacheConfig;
import com.hazelcast.core.Member;
import com.hazelcast.logging.ILogger;
import com.hazelcast.nio.serialization.Data;
import com.hazelcast.spi.EventFilter;
import com.hazelcast.spi.EventRegistration;
import com.hazelcast.spi.InternalCompletableFuture;
import com.hazelcast.spi.NodeEngine;
import com.hazelcast.spi.Operation;
import com.hazelcast.spi.OperationService;
import javax.cache.CacheException;
import javax.cache.configuration.CacheEntryListenerConfiguration;
import javax.cache.configuration.Configuration;
import javax.cache.expiry.ExpiryPolicy;
import javax.cache.integration.CompletionListener;
import javax.cache.processor.EntryProcessor;
import javax.cache.processor.EntryProcessorException;
import javax.cache.processor.EntryProcessorResult;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import static com.hazelcast.cache.impl.CacheProxyUtil.validateNotNull;
import static com.hazelcast.util.ExceptionUtil.rethrowAllowedTypeFirst;
import static com.hazelcast.util.Preconditions.checkNotNull;
/**
* <h1>ICache implementation</h1>
* <p>
* 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.
* </p>
* <p>
* 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.
* </p>
* <p>
* In order to access a {@linkplain CacheProxy} by name, a cacheManager should be used. It's advised to use
* {@link com.hazelcast.cache.ICache} instead.
* </p>
*
* @param <K> the type of key.
* @param <V> the type of value.
*/
public class CacheProxy<K, V>
extends AbstractCacheProxy<K, V> {
protected final ILogger logger;
CacheProxy(CacheConfig<K, V> cacheConfig, NodeEngine nodeEngine, ICacheService cacheService) {
super(cacheConfig, nodeEngine, cacheService);
logger = getNodeEngine().getLogger(getClass());
}
@Override
public V get(K key) {
return get(key, null);
}
@Override
public Map<K, V> getAll(Set<? extends K> keys) {
return getAll(keys, null);
}
@Override
public boolean containsKey(K key) {
ensureOpen();
validateNotNull(key);
Data dataKey = serializationService.toData(key);
Operation operation = operationProvider.createContainsKeyOperation(dataKey);
OperationService operationService = getNodeEngine().getOperationService();
int partitionId = getPartitionId(dataKey);
InternalCompletableFuture<Boolean> future = operationService.invokeOnPartition(getServiceName(), operation, partitionId);
return future.join();
}
@Override
public void loadAll(Set<? extends K> keys, boolean replaceExistingValues, CompletionListener completionListener) {
ensureOpen();
validateNotNull(keys);
for (K key : keys) {
CacheProxyUtil.validateConfiguredTypes(cacheConfig, key);
}
HashSet<Data> keysData = new HashSet<Data>(keys.size());
for (K key : keys) {
keysData.add(serializationService.toData(key));
}
LoadAllTask loadAllTask = new LoadAllTask(operationProvider, keysData, replaceExistingValues, completionListener);
try {
submitLoadAllTask(loadAllTask);
} catch (Exception e) {
if (completionListener != null) {
completionListener.onException(e);
}
throw new CacheException(e);
}
}
@Override
public void put(K key, V value) {
put(key, value, null);
}
@Override
public V getAndPut(K key, V value) {
return getAndPut(key, value, null);
}
@Override
public void putAll(Map<? extends K, ? extends V> map) {
putAll(map, null);
}
@Override
public boolean putIfAbsent(K key, V value) {
return putIfAbsent(key, value, null);
}
@Override
public boolean remove(K key) {
try {
InternalCompletableFuture<Boolean> future = removeAsyncInternal(key, null, false, false, true);
return future.get();
} catch (Throwable e) {
throw rethrowAllowedTypeFirst(e, CacheException.class);
}
}
@Override
public boolean remove(K key, V oldValue) {
try {
InternalCompletableFuture<Boolean> future = removeAsyncInternal(key, oldValue, true, false, true);
return future.get();
} catch (Throwable e) {
throw rethrowAllowedTypeFirst(e, CacheException.class);
}
}
@Override
public V getAndRemove(K key) {
try {
InternalCompletableFuture<V> future = removeAsyncInternal(key, null, false, true, true);
return future.get();
} catch (Throwable e) {
throw rethrowAllowedTypeFirst(e, CacheException.class);
}
}
@Override
public boolean replace(K key, V oldValue, V newValue) {
return replace(key, oldValue, newValue, null);
}
@Override
public boolean replace(K key, V value) {
return replace(key, value, (ExpiryPolicy) null);
}
@Override
public V getAndReplace(K key, V value) {
return getAndReplace(key, value, null);
}
@Override
public void removeAll(Set<? extends K> keys) {
ensureOpen();
validateNotNull(keys);
removeAllInternal(keys);
}
@Override
public void removeAll() {
ensureOpen();
removeAllInternal(null);
}
@Override
public void clear() {
ensureOpen();
clearInternal();
}
@Override
public <C extends Configuration<K, V>> C getConfiguration(Class<C> clazz) {
if (clazz.isInstance(cacheConfig)) {
return clazz.cast(cacheConfig.getAsReadOnly());
}
throw new IllegalArgumentException("The configuration class " + clazz + " is not supported by this implementation");
}
@Override
public <T> T invoke(K key, EntryProcessor<K, V, T> entryProcessor, Object... arguments) throws EntryProcessorException {
ensureOpen();
validateNotNull(key);
checkNotNull(entryProcessor, "Entry Processor is null");
Data keyData = serializationService.toData(key);
Integer completionId = registerCompletionLatch(1);
Operation op = operationProvider.createEntryProcessorOperation(keyData, completionId, entryProcessor, arguments);
try {
OperationService operationService = getNodeEngine().getOperationService();
int partitionId = getPartitionId(keyData);
InternalCompletableFuture<T> future = operationService.invokeOnPartition(getServiceName(), op, partitionId);
T safely = future.join();
waitCompletionLatch(completionId);
return safely;
} catch (CacheException ce) {
deregisterCompletionLatch(completionId);
throw ce;
} catch (Exception e) {
deregisterCompletionLatch(completionId);
throw new EntryProcessorException(e);
}
}
@Override
public <T> Map<K, EntryProcessorResult<T>> invokeAll(Set<? extends K> keys, EntryProcessor<K, V, T> entryProcessor,
Object... arguments) {
// TODO: implement a multiple (batch) invoke operation and its factory
ensureOpen();
validateNotNull(keys);
checkNotNull(entryProcessor, "Entry Processor is null");
Map<K, EntryProcessorResult<T>> allResult = new HashMap<K, EntryProcessorResult<T>>();
for (K key : keys) {
CacheEntryProcessorResult<T> ceResult;
try {
T result = invoke(key, entryProcessor, arguments);
ceResult = result != null ? new CacheEntryProcessorResult<T>(result) : null;
} catch (Exception e) {
ceResult = new CacheEntryProcessorResult<T>(e);
}
if (ceResult != null) {
allResult.put(key, ceResult);
}
}
return allResult;
}
@Override
public <T> T unwrap(Class<T> clazz) {
if (clazz.isAssignableFrom(((Object) this).getClass())) {
return clazz.cast(this);
}
throw new IllegalArgumentException("Unwrapping to " + clazz + " is not supported by this implementation");
}
@Override
public void registerCacheEntryListener(CacheEntryListenerConfiguration<K, V> cacheEntryListenerConfiguration) {
registerCacheEntryListener(cacheEntryListenerConfiguration, true);
}
@Override
public void registerCacheEntryListener(CacheEntryListenerConfiguration<K, V> cacheEntryListenerConfiguration,
boolean addToConfig) {
ensureOpen();
checkNotNull(cacheEntryListenerConfiguration, "CacheEntryListenerConfiguration can't be null");
CacheEventListenerAdaptor<K, V> entryListener = new CacheEventListenerAdaptor<K, V>(this,
cacheEntryListenerConfiguration,
getNodeEngine().getSerializationService(),
getNodeEngine().getHazelcastInstance());
String regId = getService().registerListener(getDistributedObjectName(), entryListener, entryListener, false);
if (regId != null) {
if (addToConfig) {
cacheConfig.addCacheEntryListenerConfiguration(cacheEntryListenerConfiguration);
}
addListenerLocally(regId, cacheEntryListenerConfiguration);
if (addToConfig) {
updateCacheListenerConfigOnOtherNodes(cacheEntryListenerConfiguration, true);
}
}
}
@Override
public void deregisterCacheEntryListener(CacheEntryListenerConfiguration<K, V> cacheEntryListenerConfiguration) {
checkNotNull(cacheEntryListenerConfiguration, "CacheEntryListenerConfiguration can't be null");
String regId = getListenerIdLocal(cacheEntryListenerConfiguration);
if (regId != null) {
if (getService().deregisterListener(getDistributedObjectName(), regId)) {
removeListenerLocally(cacheEntryListenerConfiguration);
cacheConfig.removeCacheEntryListenerConfiguration(cacheEntryListenerConfiguration);
updateCacheListenerConfigOnOtherNodes(cacheEntryListenerConfiguration, false);
}
}
}
private void updateCacheListenerConfigOnOtherNodes(CacheEntryListenerConfiguration<K, V> cacheEntryListenerConfiguration,
boolean isRegister) {
OperationService operationService = getNodeEngine().getOperationService();
Collection<Member> members = getNodeEngine().getClusterService().getMembers();
for (Member member : members) {
if (!member.localMember()) {
Operation op = new CacheListenerRegistrationOperation(getDistributedObjectName(), cacheEntryListenerConfiguration,
isRegister);
operationService.invokeOnTarget(CacheService.SERVICE_NAME, op, member.getAddress());
}
}
}
@Override
public Iterator<Entry<K, V>> iterator() {
ensureOpen();
return new ClusterWideIterator<K, V>(this, false);
}
@Override
public Iterator<Entry<K, V>> iterator(int fetchSize) {
ensureOpen();
return new ClusterWideIterator<K, V>(this, fetchSize, false);
}
@Override
public Iterator<Entry<K, V>> iterator(int fetchSize, int partitionId, boolean prefetchValues) {
ensureOpen();
return new CachePartitionIterator<K, V>(this, fetchSize, partitionId, prefetchValues);
}
@Override
public String addPartitionLostListener(CachePartitionLostListener listener) {
checkNotNull(listener, "CachePartitionLostListener can't be null");
EventFilter filter = new CachePartitionLostEventFilter();
InternalCachePartitionLostListenerAdapter listenerAdapter = new InternalCachePartitionLostListenerAdapter(listener);
injectDependencies(listener);
EventRegistration registration = getService().getNodeEngine().getEventService()
.registerListener(AbstractCacheService.SERVICE_NAME, name, filter, listenerAdapter);
return registration.getId();
}
@Override
public boolean removePartitionLostListener(String id) {
checkNotNull(id, "Listener id should not be null!");
return getService().getNodeEngine().getEventService()
.deregisterListener(AbstractCacheService.SERVICE_NAME, name, id);
}
}