/*
* JBoss, Home of Professional Open Source
* Copyright 2009 Red Hat Inc. and/or its affiliates and other
* contributors as indicated by the @author tags. All rights reserved.
* See the copyright.txt in the distribution for a full listing of
* individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.infinispan.interceptors;
import org.infinispan.Metadata;
import org.infinispan.commands.FlagAffectedCommand;
import org.infinispan.commands.MetadataAwareCommand;
import org.infinispan.commands.read.GetKeyValueCommand;
import org.infinispan.commands.write.*;
import org.infinispan.configuration.cache.CacheStoreConfiguration;
import org.infinispan.container.EntryFactory;
import org.infinispan.container.entries.CacheEntry;
import org.infinispan.container.entries.InternalCacheEntry;
import org.infinispan.context.Flag;
import org.infinispan.context.InvocationContext;
import org.infinispan.factories.annotations.Inject;
import org.infinispan.factories.annotations.Start;
import org.infinispan.interceptors.base.JmxStatsCommandInterceptor;
import org.infinispan.jmx.annotations.DisplayType;
import org.infinispan.jmx.annotations.MBean;
import org.infinispan.jmx.annotations.ManagedAttribute;
import org.infinispan.jmx.annotations.ManagedOperation;
import org.infinispan.jmx.annotations.MeasurementType;
import org.infinispan.jmx.annotations.Parameter;
import org.infinispan.loaders.CacheLoader;
import org.infinispan.loaders.CacheLoaderManager;
import org.infinispan.loaders.CacheStore;
import org.infinispan.loaders.decorators.ChainingCacheStore;
import org.infinispan.notifications.cachelistener.CacheNotifier;
import org.infinispan.util.InfinispanCollections;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Set;
import java.util.concurrent.atomic.AtomicLong;
import static org.infinispan.loaders.decorators.AbstractDelegatingStore.undelegateCacheLoader;
@MBean(objectName = "CacheLoader", description = "Component that handles loading entries from a CacheStore into memory.")
public class CacheLoaderInterceptor extends JmxStatsCommandInterceptor {
private final AtomicLong cacheLoads = new AtomicLong(0);
private final AtomicLong cacheMisses = new AtomicLong(0);
protected CacheLoaderManager clm;
protected CacheNotifier notifier;
protected CacheLoader loader;
protected volatile boolean enabled = true;
private EntryFactory entryFactory;
private static final Log log = LogFactory.getLog(CacheLoaderInterceptor.class);
@Override
protected Log getLog() {
return log;
}
@Inject
protected void injectDependencies(CacheLoaderManager clm, EntryFactory entryFactory, CacheNotifier notifier) {
this.clm = clm;
this.notifier = notifier;
this.entryFactory = entryFactory;
}
@Start(priority = 15)
protected void startInterceptor() {
loader = clm.getCacheLoader();
}
@Override
public Object visitApplyDeltaCommand(InvocationContext ctx, ApplyDeltaCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeeded(ctx, key, false, command);
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitPutKeyValueCommand(InvocationContext ctx, PutKeyValueCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeeded(ctx, key, false, command);
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitGetKeyValueCommand(InvocationContext ctx, GetKeyValueCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeededAndUpdateStats(ctx, key, true, command);
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitInvalidateCommand(InvocationContext ctx, InvalidateCommand command) throws Throwable {
if (enabled) {
Object[] keys;
if ((keys = command.getKeys()) != null && keys.length > 0) {
for (Object key : command.getKeys()) {
loadIfNeeded(ctx, key, false, command);
}
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitRemoveCommand(InvocationContext ctx, RemoveCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeededAndUpdateStats(ctx, key, false, command);
}
}
return invokeNextInterceptor(ctx, command);
}
@Override
public Object visitReplaceCommand(InvocationContext ctx, ReplaceCommand command) throws Throwable {
if (enabled) {
Object key;
if ((key = command.getKey()) != null) {
loadIfNeededAndUpdateStats(ctx, key, false, command);
}
}
return invokeNextInterceptor(ctx, command);
}
protected boolean forceLoad(Object key, Set<Flag> flags) {
return false;
}
/**
* Indicates whether the operation is a delta write. If it is, the
* previous value needs to be loaded from the cache store so that
* it can be merged.
*/
protected boolean isDeltaWrite(Set<Flag> flags) {
return flags != null && flags.contains(Flag.DELTA_WRITE);
}
private boolean loadIfNeeded(InvocationContext ctx, Object key, boolean isRetrieval, FlagAffectedCommand cmd) throws Throwable {
if (cmd.hasFlag(Flag.SKIP_CACHE_STORE) || cmd.hasFlag(Flag.SKIP_CACHE_LOAD)
|| cmd.hasFlag(Flag.IGNORE_RETURN_VALUES)) {
return false; //skip operation
}
// If this is a remote call, skip loading UNLESS we are the primary data owner of this key, and
// are using eviction or write skew checking.
if (!isRetrieval && !ctx.isOriginLocal() && !forceLoad(key, cmd.getFlags())) return false;
// first check if the container contains the key we need. Try and load this into the context.
CacheEntry e = ctx.lookupEntry(key);
if (e == null || e.isNull() || e.getValue() == null) {
InternalCacheEntry loaded = loader.load(key);
if (loaded != null) {
CacheEntry wrappedEntry;
if (cmd instanceof ApplyDeltaCommand) {
ctx.putLookedUpEntry(key, loaded);
wrappedEntry = entryFactory.wrapEntryForDelta(ctx, key, ((ApplyDeltaCommand)cmd).getDelta());
} else {
wrappedEntry = entryFactory.wrapEntryForPut(ctx, key, loaded, false, cmd);
}
recordLoadedEntry(ctx, key, wrappedEntry, loaded, cmd);
return true;
} else {
return false;
}
} else {
return true;
}
}
/**
* This method records a loaded entry, performing the following steps: <ol> <li>Increments counters for reporting via
* JMX</li> <li>updates the 'entry' reference (an entry in the current thread's InvocationContext) with the contents
* of 'loadedEntry' (freshly loaded from the CacheStore) so that the loaded details will be flushed to the
* DataContainer when the call returns (in the LockingInterceptor, when locks are released)</li> <li>Notifies
* listeners</li> </ol>
*
* @param ctx the current invocation's context
* @param key key to record
* @param entry the appropriately locked entry in the caller's context
* @param loadedEntry the internal entry loaded from the cache store.
*/
private void recordLoadedEntry(InvocationContext ctx, Object key,
CacheEntry entry, InternalCacheEntry loadedEntry, FlagAffectedCommand cmd) throws Exception {
boolean entryExists = loadedEntry != null;
if (log.isTraceEnabled()) {
log.trace("Entry exists in loader? " + entryExists);
}
if (getStatisticsEnabled()) {
if (entryExists) {
cacheLoads.incrementAndGet();
} else {
cacheMisses.incrementAndGet();
}
}
if (entryExists) {
final Object value = loadedEntry.getValue();
// FIXME: There's no point to trigger the entryLoaded/Activated event twice.
sendNotification(key, value, true, ctx, cmd);
entry.setValue(value);
Metadata metadata = extractMetadata(cmd);
Metadata loadedMetadata = loadedEntry.getMetadata();
if (metadata != null && loadedMetadata != null)
metadata = metadata.builder().read(loadedMetadata).build();
else if (metadata == null)
metadata = loadedMetadata;
entry.setMetadata(metadata);
// TODO shouldn't we also be setting last used and created timestamps?
entry.setValid(true);
entry.setLoaded(true); // mark the entry as loaded from the store
sendNotification(key, value, false, ctx, cmd);
}
}
protected void sendNotification(Object key, Object value, boolean pre,
InvocationContext ctx, FlagAffectedCommand cmd) {
notifier.notifyCacheEntryLoaded(key, value, pre, ctx, cmd);
}
private void loadIfNeededAndUpdateStats(InvocationContext ctx, Object key, boolean isRetrieval, FlagAffectedCommand cmd) throws Throwable {
boolean found = loadIfNeeded(ctx, key, isRetrieval, cmd);
if (!found && getStatisticsEnabled()) {
cacheMisses.incrementAndGet();
}
}
@ManagedAttribute(
description = "Number of entries loaded from cache store",
displayName = "Number of cache store loads",
measurementType = MeasurementType.TRENDSUP
)
public long getCacheLoaderLoads() {
return cacheLoads.get();
}
@ManagedAttribute(
description = "Number of entries that did not exist in cache store",
displayName = "Number of cache store load misses",
measurementType = MeasurementType.TRENDSUP
)
public long getCacheLoaderMisses() {
return cacheMisses.get();
}
@Override
@ManagedOperation(
description = "Resets statistics gathered by this component",
displayName = "Reset Statistics"
)
public void resetStatistics() {
cacheLoads.set(0);
cacheMisses.set(0);
}
@ManagedAttribute(
description = "Returns a collection of cache loader types which configured and enabled",
displayName = "Returns a collection of cache loader types which configured and enabled",
displayType = DisplayType.DETAIL)
/**
* This method returns a collection of cache loader types (fully qualified class names) that are configured and enabled.
*/
public Collection<String> getCacheLoaders() {
if (enabled && clm.isEnabled()) {
if (loader instanceof ChainingCacheStore) {
ChainingCacheStore chainingStore = (ChainingCacheStore) loader;
LinkedHashMap<CacheStore, CacheStoreConfiguration> stores = chainingStore.getStores();
Set<String> storeTypes = new HashSet<String>(stores.size());
for (CacheStore cs : stores.keySet()) storeTypes.add(undelegateCacheLoader(cs).getClass().getName());
return storeTypes;
} else {
return Collections.singleton(undelegateCacheLoader(loader).getClass().getName());
}
} else {
return InfinispanCollections.emptySet();
}
}
@ManagedOperation(
description = "Disable all cache loaders of a given type, where type is a fully qualified class name of the cache loader to disable",
displayName = "Disable all cache loaders of a given type"
)
/**
* Disables a cache loader of a given type, where type is the fully qualified class name of a {@link CacheLoader} implementation.
*
* If the given type cannot be found, this is a no-op. If more than one cache loader of the same type is configured,
* all cache loaders of the given type are disabled.
*
* @param loaderType fully qualified class name of the cache loader type to disable
*/
public void disableCacheLoader(@Parameter(name="loaderType", description="Fully qualified class name of a CacheLoader implementation") String loaderType) {
if (enabled) clm.disableCacheStore(loaderType);
}
public void disableInterceptor() {
enabled = false;
}
private Metadata extractMetadata(FlagAffectedCommand cmd) {
return cmd instanceof MetadataAwareCommand
? ((MetadataAwareCommand) cmd).getMetadata() : null;
}
}