Package org.infinispan.interceptors.impl

Class CacheLoaderInterceptor<K,V>

java.lang.Object

org.infinispan.interceptors.BaseAsyncInterceptor

org.infinispan.interceptors.DDAsyncInterceptor

org.infinispan.interceptors.impl.JmxStatsCommandInterceptor

org.infinispan.interceptors.impl.CacheLoaderInterceptor<K,V>

All Implemented Interfaces:

Visitor, AsyncInterceptor, JmxStatisticsExposer, EntryLoader<K,V>

Direct Known Subclasses:

ClusteredCacheLoaderInterceptor, PassivationCacheLoaderInterceptor

@MBean(objectName="CacheLoader",
       description="Component that handles loading entries from a CacheStore into memory.")
public class CacheLoaderInterceptor<K,V>
extends JmxStatsCommandInterceptor
implements EntryLoader<K,V>

Since:

9.0

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	activation
protected AtomicLong	cacheLoads
protected AtomicLong	cacheMisses
protected EntryFactory	entryFactory
protected ExecutorService	nonBlockingExecutor
protected CacheNotifier	notifier
protected PersistenceManager	persistenceManager

Fields inherited from class org.infinispan.interceptors.BaseAsyncInterceptor

cacheConfiguration

Constructor Summary

Constructors

Constructor	Description
CacheLoaderInterceptor()

Method Summary

Modifier and Type	Method	Description
protected boolean	canLoad(Object key)
void	disableStore(String storeType)	Disables a store of a given type.
long	getCacheLoaderLoads()
long	getCacheLoaderMisses()
Collection<String>	getStores()	This method returns a collection of cache loader types (fully qualified class names) that are configured and enabled.
protected boolean	hasSkipLoadFlag(FlagAffectedCommand cmd)
protected boolean	isConditional(WriteCommand cmd)
CompletionStage<InternalCacheEntry<K,V>>	loadAndStoreInDataContainer(InvocationContext ctx, Object key, int segment, FlagAffectedCommand cmd)	Load and store the entry if present in the data container, returning the entry in the CompletionStage
protected CompletionStage<Void>	loadIfNeeded(InvocationContext ctx, Object key, FlagAffectedCommand cmd)	Loads from the cache loader the entry for the given key.
protected CompletionStage<Void>	loadInContext(InvocationContext ctx, Object key, FlagAffectedCommand cmd)	Attemps to load the given entry for a key from the persistence store.
void	resetStatistics()	Resets statistics gathered.
protected CompletionStage<Void>	sendNotification(Object key, Object value, boolean pre, InvocationContext ctx, FlagAffectedCommand cmd)
protected boolean	skipLoadForWriteCommand(WriteCommand cmd, Object key, InvocationContext ctx)
void	start()
Object	visitComputeCommand(InvocationContext ctx, ComputeCommand command)
Object	visitComputeIfAbsentCommand(InvocationContext ctx, ComputeIfAbsentCommand command)
Object	visitEntrySetCommand(InvocationContext ctx, EntrySetCommand command)
Object	visitGetAllCommand(InvocationContext ctx, GetAllCommand command)
Object	visitGetCacheEntryCommand(InvocationContext ctx, GetCacheEntryCommand command)
Object	visitGetKeysInGroupCommand(InvocationContext ctx, GetKeysInGroupCommand command)
Object	visitGetKeyValueCommand(InvocationContext ctx, GetKeyValueCommand command)
Object	visitKeySetCommand(InvocationContext ctx, KeySetCommand command)
Object	visitPutKeyValueCommand(InvocationContext ctx, PutKeyValueCommand command)
Object	visitReadOnlyKeyCommand(InvocationContext ctx, ReadOnlyKeyCommand command)
Object	visitReadOnlyManyCommand(InvocationContext ctx, ReadOnlyManyCommand command)
Object	visitReadWriteKeyCommand(InvocationContext ctx, ReadWriteKeyCommand command)
Object	visitReadWriteKeyValueCommand(InvocationContext ctx, ReadWriteKeyValueCommand command)
Object	visitReadWriteManyCommand(InvocationContext ctx, ReadWriteManyCommand command)
Object	visitReadWriteManyEntriesCommand(InvocationContext ctx, ReadWriteManyEntriesCommand command)
Object	visitRemoveCommand(InvocationContext ctx, RemoveCommand command)
Object	visitReplaceCommand(InvocationContext ctx, ReplaceCommand command)
Object	visitSizeCommand(InvocationContext ctx, SizeCommand command)

Methods inherited from class org.infinispan.interceptors.impl.JmxStatsCommandInterceptor

getStatisticsEnabled, onStart, setStatisticsEnabled

Methods inherited from class org.infinispan.interceptors.DDAsyncInterceptor

handleDefault, visitClearCommand, visitCommand, visitCommitCommand, visitEvictCommand, visitInvalidateCommand, visitInvalidateL1Command, visitLockControlCommand, visitPrepareCommand, visitPutMapCommand, visitRollbackCommand, visitUnknownCommand, visitWriteOnlyKeyCommand, visitWriteOnlyKeyValueCommand, visitWriteOnlyManyCommand, visitWriteOnlyManyEntriesCommand

Methods inherited from class org.infinispan.interceptors.BaseAsyncInterceptor

asyncInvokeNext, asyncInvokeNext, asyncInvokeNext, asyncValue, delayedNull, delayedValue, delayedValue, invokeNext, invokeNextAndExceptionally, invokeNextAndFinally, invokeNextAndHandle, invokeNextThenAccept, invokeNextThenApply, isSuccessfullyDone, makeStage, setNextInterceptor, valueOrException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.infinispan.persistence.util.EntryLoader

loadAndStoreInDataContainer

Methods inherited from interface org.infinispan.commands.Visitor

visitRemoveExpiredCommand

Field Detail

cacheLoads

protected final AtomicLong cacheLoads

cacheMisses

protected final AtomicLong cacheMisses

persistenceManager

protected PersistenceManager persistenceManager

notifier

protected CacheNotifier notifier

entryFactory

protected EntryFactory entryFactory

nonBlockingExecutor

protected ExecutorService nonBlockingExecutor

activation

protected boolean activation

Constructor Detail

CacheLoaderInterceptor

public CacheLoaderInterceptor()

Method Detail

start

public void start()

visitPutKeyValueCommand

public Object visitPutKeyValueCommand(InvocationContext ctx,
                                      PutKeyValueCommand command)

Specified by:

visitPutKeyValueCommand in interface Visitor

Overrides:

visitPutKeyValueCommand in class DDAsyncInterceptor

visitGetKeyValueCommand

public Object visitGetKeyValueCommand(InvocationContext ctx,
                                      GetKeyValueCommand command)

Specified by:

visitGetKeyValueCommand in interface Visitor

Overrides:

visitGetKeyValueCommand in class DDAsyncInterceptor

visitGetCacheEntryCommand

public Object visitGetCacheEntryCommand(InvocationContext ctx,
                                        GetCacheEntryCommand command)

Specified by:

visitGetCacheEntryCommand in interface Visitor

Overrides:

visitGetCacheEntryCommand in class DDAsyncInterceptor

visitGetAllCommand

public Object visitGetAllCommand(InvocationContext ctx,
                                 GetAllCommand command)

Specified by:

visitGetAllCommand in interface Visitor

Overrides:

visitGetAllCommand in class DDAsyncInterceptor

visitRemoveCommand

public Object visitRemoveCommand(InvocationContext ctx,
                                 RemoveCommand command)

Specified by:

visitRemoveCommand in interface Visitor

Overrides:

visitRemoveCommand in class DDAsyncInterceptor

visitReplaceCommand

public Object visitReplaceCommand(InvocationContext ctx,
                                  ReplaceCommand command)

Specified by:

visitReplaceCommand in interface Visitor

Overrides:

visitReplaceCommand in class DDAsyncInterceptor

visitComputeCommand

public Object visitComputeCommand(InvocationContext ctx,
                                  ComputeCommand command)

Specified by:

visitComputeCommand in interface Visitor

Overrides:

visitComputeCommand in class DDAsyncInterceptor

visitComputeIfAbsentCommand

public Object visitComputeIfAbsentCommand(InvocationContext ctx,
                                          ComputeIfAbsentCommand command)

Specified by:

visitComputeIfAbsentCommand in interface Visitor

Overrides:

visitComputeIfAbsentCommand in class DDAsyncInterceptor

visitGetKeysInGroupCommand

public Object visitGetKeysInGroupCommand(InvocationContext ctx,
                                         GetKeysInGroupCommand command)

Specified by:

visitGetKeysInGroupCommand in interface Visitor

Overrides:

visitGetKeysInGroupCommand in class DDAsyncInterceptor

visitEntrySetCommand

public Object visitEntrySetCommand(InvocationContext ctx,
                                   EntrySetCommand command)
                            throws Throwable

Specified by:

visitEntrySetCommand in interface Visitor

Overrides:

visitEntrySetCommand in class DDAsyncInterceptor

Throws:

Throwable

visitKeySetCommand

public Object visitKeySetCommand(InvocationContext ctx,
                                 KeySetCommand command)
                          throws Throwable

Specified by:

visitKeySetCommand in interface Visitor

Overrides:

visitKeySetCommand in class DDAsyncInterceptor

Throws:

Throwable

visitReadOnlyKeyCommand

public Object visitReadOnlyKeyCommand(InvocationContext ctx,
                                      ReadOnlyKeyCommand command)

Specified by:

visitReadOnlyKeyCommand in interface Visitor

Overrides:

visitReadOnlyKeyCommand in class DDAsyncInterceptor

visitReadOnlyManyCommand

public Object visitReadOnlyManyCommand(InvocationContext ctx,
                                       ReadOnlyManyCommand command)

Specified by:

visitReadOnlyManyCommand in interface Visitor

Overrides:

visitReadOnlyManyCommand in class DDAsyncInterceptor

visitReadWriteKeyCommand

public Object visitReadWriteKeyCommand(InvocationContext ctx,
                                       ReadWriteKeyCommand command)
                                throws Throwable

Specified by:

visitReadWriteKeyCommand in interface Visitor

Overrides:

visitReadWriteKeyCommand in class DDAsyncInterceptor

Throws:

Throwable

visitReadWriteKeyValueCommand

public Object visitReadWriteKeyValueCommand(InvocationContext ctx,
                                            ReadWriteKeyValueCommand command)

Specified by:

visitReadWriteKeyValueCommand in interface Visitor

Overrides:

visitReadWriteKeyValueCommand in class DDAsyncInterceptor

visitReadWriteManyCommand

public Object visitReadWriteManyCommand(InvocationContext ctx,
                                        ReadWriteManyCommand command)

Specified by:

visitReadWriteManyCommand in interface Visitor

Overrides:

visitReadWriteManyCommand in class DDAsyncInterceptor

visitReadWriteManyEntriesCommand

public Object visitReadWriteManyEntriesCommand(InvocationContext ctx,
                                               ReadWriteManyEntriesCommand command)
                                        throws Throwable

Specified by:

visitReadWriteManyEntriesCommand in interface Visitor

Overrides:

visitReadWriteManyEntriesCommand in class DDAsyncInterceptor

Throws:

Throwable

visitSizeCommand

public Object visitSizeCommand(InvocationContext ctx,
                               SizeCommand command)

Specified by:

visitSizeCommand in interface Visitor

Overrides:

visitSizeCommand in class DDAsyncInterceptor

isConditional

protected final boolean isConditional(WriteCommand cmd)

hasSkipLoadFlag

protected final boolean hasSkipLoadFlag(FlagAffectedCommand cmd)

canLoad

protected boolean canLoad(Object key)

loadIfNeeded

protected final CompletionStage<Void> loadIfNeeded(InvocationContext ctx,
                                                   Object key,
                                                   FlagAffectedCommand cmd)

Loads from the cache loader the entry for the given key. A found value is loaded into the current context. The method returns whether the value was found or not, or even if the cache loader was checked.

Parameters:

ctx - The current invocation's context

key - The key for the entry to look up

cmd - The command that was called that now wants to query the cache loader

Returns:

null or a CompletionStage that when complete all listeners will be notified

Throws:

Throwable

loadInContext

protected CompletionStage<Void> loadInContext(InvocationContext ctx,
                                              Object key,
                                              FlagAffectedCommand cmd)

Attemps to load the given entry for a key from the persistence store. This method optimizes concurrent loads of the same key so only the first is actually loaded. The additional loads will in turn complete when the first completes, which provides minimal hits to the backing store(s).

Parameters:

ctx - context for this invocation

key - key to find the entry for

cmd - the command that initiated this load

Returns:

a stage that when complete will have the entry loaded into the provided context

loadAndStoreInDataContainer

public CompletionStage<InternalCacheEntry<K,V>> loadAndStoreInDataContainer(InvocationContext ctx,
                                                                                  Object key,
                                                                                  int segment,
                                                                                  FlagAffectedCommand cmd)

Description copied from interface: EntryLoader

Load and store the entry if present in the data container, returning the entry in the CompletionStage

Specified by:

loadAndStoreInDataContainer in interface EntryLoader<K,V>

Parameters:

ctx - context that generated this request

key - key to load from the store

segment - segment of the key to load

cmd - the command that generated this load request

Returns:

stage that when complete contains the loaded entry. If the entry is non null the entry is also written into the underlying data container

skipLoadForWriteCommand

protected boolean skipLoadForWriteCommand(WriteCommand cmd,
                                          Object key,
                                          InvocationContext ctx)

sendNotification

protected CompletionStage<Void> sendNotification(Object key,
                                                 Object value,
                                                 boolean pre,
                                                 InvocationContext ctx,
                                                 FlagAffectedCommand cmd)

getCacheLoaderLoads

@ManagedAttribute(description="Number of entries loaded from cache store",
                  displayName="Number of cache store loads",
                  measurementType=TRENDSUP)
public long getCacheLoaderLoads()

getCacheLoaderMisses

@ManagedAttribute(description="Number of entries that did not exist in cache store",
                  displayName="Number of cache store load misses",
                  measurementType=TRENDSUP)
public long getCacheLoaderMisses()

resetStatistics

public void resetStatistics()

Description copied from class: JmxStatsCommandInterceptor

Resets statistics gathered. Is a no-op, and should be overridden if it is to be meaningful.

Specified by:

resetStatistics in interface JmxStatisticsExposer

Overrides:

resetStatistics in class JmxStatsCommandInterceptor

getStores

@ManagedAttribute(description="Returns a collection of cache loader types which are configured and enabled",
                  displayName="Returns a collection of cache loader types which are configured and enabled")
public Collection<String> getStores()

This method returns a collection of cache loader types (fully qualified class names) that are configured and enabled.

disableStore

@ManagedOperation(description="Disable all stores of a given type, where type is a fully qualified class name of the cache loader to disable",
                  displayName="Disable all stores of a given type")
public void disableStore(@Parameter(name="storeType",description="Fully qualified class name of a store implementation")
                         String storeType)

Disables a store of a given type. If the given type cannot be found, this is a no-op. If more than one store of the same type is configured, all stores of the given type are disabled.

Parameters:

storeType - fully qualified class name of the cache loader type to disable