|
ehcache | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.ehcache.constructs.nonstop.store.ExecutorServiceStore
public class ExecutorServiceStore
This implementation executes all operations using a NonstopExecutorService. On Timeout, uses the
NonstopTimeoutBehaviorStoreResolver to
resolve the timeout behavior store and execute it.
| Field Summary | |
|---|---|
protected NonstopConfiguration |
nonstopConfiguration
The NonstopConfiguration of the cache using this store |
| Fields inherited from interface net.sf.ehcache.store.Store |
|---|
CLUSTER_COHERENT, NODE_COHERENT |
| Constructor Summary | |
|---|---|
ExecutorServiceStore(NonstopActiveDelegateHolder nonstopActiveDelegateHolder,
NonstopConfiguration nonstopConfiguration,
NonstopTimeoutBehaviorStoreResolver timeoutBehaviorResolver,
CacheCluster cacheCluster,
ExplicitLockingContextThreadLocal explicitLockingContextThreadLocal)
Constructor accepting the NonstopActiveDelegateHolder, NonstopConfiguration and
NonstopTimeoutBehaviorStoreResolver |
|
| Method Summary | ||
|---|---|---|
void |
addStoreListener(StoreListener listener)
Add a listener to the store. |
|
boolean |
bufferFull()
Some store types, such as the disk stores can fill their write buffers if puts come in too fast. |
|
void |
clusterRejoined()
Called when rejoin has happened for this store |
|
boolean |
containsKey(Object key)
A check to see if a key is in the Store. |
|
boolean |
containsKeyInMemory(Object key)
A check to see if a key is in the Store and is currently held in memory. |
|
boolean |
containsKeyOffHeap(Object key)
A check to see if a key is in the Store and is currently held off-heap. |
|
boolean |
containsKeyOnDisk(Object key)
A check to see if a key is in the Store and is currently held on disk. |
|
void |
dispose()
Prepares for shutdown. |
|
|
executeClusterOperation(ClusterOperation<V> operation)
Execute the ClusterOperation within this NonstopStore context. |
|
protected
|
executeClusterOperationNoTimeout(ClusterOperation<V> operation)
Executes the ClusterOperation parameter, but without any timeout. |
|
Results |
executeQuery(StoreQuery query)
Execute the given query on this store |
|
protected
|
executeWithExecutor(Callable<V> callable)
Execute call within NonStop executor |
|
protected
|
executeWithExecutor(Callable<V> callable,
long timeoutMillis)
Execute call within NonStop executor |
|
void |
expireElements()
Expire all elements. |
|
void |
flush()
Flush elements to persistent store. |
|
Element |
get(Object key)
Gets an item from the cache. |
|
Map<Object,Element> |
getAll(Collection<?> keys)
Retries the elements associated with a set of keys and update the statistics Keys which are not present in the cache will have null values associated with them in the returned map |
|
Map<Object,Element> |
getAllQuiet(Collection<?> keys)
Retries the elements associated with a set of keys without updating the statistics Keys which are not present in the cache will have null values associated with them in the returned map |
|
Policy |
getInMemoryEvictionPolicy()
. |
|
int |
getInMemorySize()
Returns the current local in-memory store size |
|
long |
getInMemorySizeInBytes()
Gets the size of the in-memory portion of the store, in bytes. |
|
Object |
getInternalContext()
This should not be used, and will generally return null |
|
List |
getKeys()
Gets an Array of the keys for all elements in the disk store. |
|
Set |
getLocalKeys()
Returns set of keys from the cache which are present in the node locally. |
|
Object |
getMBean()
Optional implementation specific MBean exposed by the store. |
|
int |
getOffHeapSize()
Returns the current local off-heap store size |
|
long |
getOffHeapSizeInBytes()
Gets the size of the off-heap portion of the store, in bytes. |
|
int |
getOnDiskSize()
Returns the current local on-disk store size |
|
long |
getOnDiskSizeInBytes()
Gets the size of the on-disk portion of the store, in bytes. |
|
Element |
getQuiet(Object key)
Gets an Element from the Store, without updating statistics |
|
|
getSearchAttribute(String attributeName)
Retrieve the given named search attribute |
|
int |
getSize()
Returns the current local store size |
|
Status |
getStatus()
Returns the cache status. |
|
int |
getTerracottaClusteredSize()
Returns the current Terracotta clustered store size |
|
CacheConfiguration.TransactionalMode |
getTransactionalMode()
Get the transactional mode of this store. |
|
boolean |
hasAbortedSizeOf()
Checks if the cache may contain elements for which the SizeOf engine gave up and only partially calculated the size. |
|
boolean |
isCacheCoherent()
Indicates whether this store provides a coherent view of all the elements in a cache. |
|
boolean |
isClusterCoherent()
Returns true if the cache is in coherent mode cluster-wide. |
|
boolean |
isNodeCoherent()
Returns true if the cache is in coherent mode for the current node. |
|
boolean |
isPinned(Object key)
Check if the key is pinned |
|
boolean |
put(Element element)
Puts an item into the store. |
|
void |
putAll(Collection<Element> elements)
Puts a collection of elements into the store. |
|
Element |
putIfAbsent(Element element)
Put an element in the store if no element is currently mapped to the elements key. |
|
boolean |
putWithWriter(Element element,
CacheWriterManager writerManager)
Puts an item into the store and the cache writer manager in an atomic operation |
|
void |
recalculateSize(Object key)
Recalculate size of the element mapped to the key |
|
Element |
remove(Object key)
Removes an item from the cache. |
|
void |
removeAll()
Remove all of the elements from the store. |
|
void |
removeAll(Collection<?> keys)
Removes a collection of elements from the cache. |
|
Element |
removeElement(Element element,
ElementValueComparator comparator)
Remove the Element mapped to the key for the supplied element if the value of the supplied Element is equal to the value of the cached Element. |
|
void |
removeStoreListener(StoreListener listener)
Remove listener from store. |
|
Element |
removeWithWriter(Object key,
CacheWriterManager writerManager)
Removes an item from the store and the cache writer manager in an atomic operation. |
|
Element |
replace(Element element)
Replace the cached element only if an Element is currently cached for this key |
|
boolean |
replace(Element old,
Element element,
ElementValueComparator comparator)
Replace the cached element only if the value of the current Element is equal to the value of the supplied old Element. |
|
protected NonstopStore |
resolveTimeoutBehaviorStore()
Get the timeout behavior resolver NonstopStore |
|
void |
setAttributeExtractors(Map<String,AttributeExtractor> extractors)
Inform this store of the configured attribute extractors. |
|
void |
setInMemoryEvictionPolicy(Policy policy)
Sets the eviction policy strategy. |
|
void |
setNodeCoherent(boolean coherent)
Sets the cache in coherent or incoherent mode for the current node depending on the parameter. |
|
void |
setPinned(Object key,
boolean pinned)
Mark the key as pinned or not |
|
protected TerracottaStore |
underlyingTerracottaStore()
Get the underlying Terracotta store |
|
Element |
unlockedGet(Object key)
Gets the value associated with the key without acquiring any locks. |
|
Element |
unlockedGetQuiet(Object key)
Same as TerracottaStore.unlockedGet(Object) but does not update statistics |
|
void |
unpinAll()
unpin all pinned keys |
|
Element |
unsafeGet(Object key)
Returns the local value associated with the key. |
|
Element |
unsafeGetQuiet(Object key)
Same as TerracottaStore.unsafeGet(Object) but does not update last usage statistics |
|
void |
waitUntilClusterCoherent()
This method waits until the cache is in coherent mode in all the connected nodes. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected final NonstopConfiguration nonstopConfiguration
| Constructor Detail |
|---|
public ExecutorServiceStore(NonstopActiveDelegateHolder nonstopActiveDelegateHolder,
NonstopConfiguration nonstopConfiguration,
NonstopTimeoutBehaviorStoreResolver timeoutBehaviorResolver,
CacheCluster cacheCluster,
ExplicitLockingContextThreadLocal explicitLockingContextThreadLocal)
NonstopActiveDelegateHolder, NonstopConfiguration and
NonstopTimeoutBehaviorStoreResolver
explicitLockingContextThreadLocal - | Method Detail |
|---|
protected <V> V executeWithExecutor(Callable<V> callable)
throws CacheException,
TimeoutException
V - callable -
CacheException
TimeoutException
protected <V> V executeWithExecutor(Callable<V> callable,
long timeoutMillis)
throws CacheException,
TimeoutException
V - callable - timeoutMillis -
CacheException
TimeoutExceptionprotected TerracottaStore underlyingTerracottaStore()
protected NonstopStore resolveTimeoutBehaviorStore()
public void dispose()
dispose in interface Store
public void setNodeCoherent(boolean coherent)
throws UnsupportedOperationException
setNodeCoherent(true) when the cache is already in coherent mode or
calling setNodeCoherent(false) when already in incoherent mode will be a no-op.
It applies to coherent clustering mechanisms only e.g. Terracotta.
The timeout used by this method is NonstopConfiguration.getBulkOpsTimeoutMultiplyFactor() times the timeout value in the
config.
setNodeCoherent in interface Storecoherent - true transitions to coherent mode, false to incoherent mode
UnsupportedOperationException - if this store does not support cache coherence, like RMI replicationpublic void setAttributeExtractors(Map<String,AttributeExtractor> extractors)
setAttributeExtractors in interface Storepublic void addStoreListener(StoreListener listener)
addStoreListener in interface Storepublic void removeStoreListener(StoreListener listener)
removeStoreListener in interface Storepublic void unpinAll()
unpinAll in interface Storepublic boolean isPinned(Object key)
isPinned in interface Storekey - the key to be checked
true if the element is pinned
public void setPinned(Object key,
boolean pinned)
setPinned in interface Storekey - the key to be pinned or notpinned - true if the key should be pinned, false otherwise
public boolean put(Element element)
throws CacheException
put in interface StoreCacheException
public void putAll(Collection<Element> elements)
throws CacheException
putAll in interface Storeelements - Collection of elements to be put in the store
CacheException
public boolean putWithWriter(Element element,
CacheWriterManager writerManager)
throws CacheException
putWithWriter in interface StoreCacheExceptionpublic Element get(Object key)
get in interface Storepublic Element getQuiet(Object key)
Element from the Store, without updating statistics.
getQuiet in interface Storepublic Map<Object,Element> getAllQuiet(Collection<?> keys)
getAllQuiet in interface Storekeys - a collection of keys to look for
public Map<Object,Element> getAll(Collection<?> keys)
getAll in interface Storekeys - a collection of keys to look for
public List getKeys()
getKeys in interface StoreSerializable keyspublic Element remove(Object key)
remove in interface Storepublic void removeAll(Collection<?> keys)
removeAll in interface Store
public Element removeWithWriter(Object key,
CacheWriterManager writerManager)
throws CacheException
removeWithWriter in interface StoreCacheException
public void removeAll()
throws CacheException
CacheEventListeners they are notified of the expiry or removal
of the Element as each is removed..
The timeout used by this method is NonstopConfiguration.getBulkOpsTimeoutMultiplyFactor() times the timeout value in the
config.
removeAll in interface StoreCacheException
public Element putIfAbsent(Element element)
throws NullPointerException
putIfAbsent in interface Storeelement - element to be added
NullPointerException - if the element is null, or has a null key
public Element removeElement(Element element,
ElementValueComparator comparator)
throws NullPointerException
removeElement in interface Storeelement - Element to be removedcomparator - ElementValueComparator to use to compare elements
NullPointerException - if the element is null, or has a null key
public boolean replace(Element old,
Element element,
ElementValueComparator comparator)
throws NullPointerException,
IllegalArgumentException
replace in interface Storeold - Element to be test againstelement - Element to be cachedcomparator - ElementValueComparator to use to compare elements
NullPointerException - if the either Element is null or has a null key
IllegalArgumentException - if the two Element keys are non-null but not equal
public Element replace(Element element)
throws NullPointerException
replace in interface Storeelement - Element to be cached
NullPointerException - if the Element is null or has a null keypublic int getSize()
getSize in interface Storepublic int getInMemorySize()
getInMemorySize in interface Storepublic int getOffHeapSize()
getOffHeapSize in interface Storepublic int getOnDiskSize()
getOnDiskSize in interface Storepublic int getTerracottaClusteredSize()
getTerracottaClusteredSize in interface Storepublic long getInMemorySizeInBytes()
getInMemorySizeInBytes in interface Storepublic long getOffHeapSizeInBytes()
getOffHeapSizeInBytes in interface Storepublic long getOnDiskSizeInBytes()
getOnDiskSizeInBytes in interface Storepublic boolean hasAbortedSizeOf()
hasAbortedSizeOf in interface Storepublic Status getStatus()
getStatus in interface Storepublic boolean containsKey(Object key)
containsKey in interface Storekey - The Element key
public boolean containsKeyOnDisk(Object key)
containsKeyOnDisk in interface Storekey - The Element key
public boolean containsKeyOffHeap(Object key)
containsKeyOffHeap in interface Storekey - The Element key
public boolean containsKeyInMemory(Object key)
containsKeyInMemory in interface Storekey - The Element key
public void expireElements()
expireElements in interface Store
public void flush()
throws IOException
flush in interface StoreIOException - if any IO error occurspublic boolean bufferFull()
bufferFull in interface Storepublic Policy getInMemoryEvictionPolicy()
getInMemoryEvictionPolicy in interface StoreStore.setInMemoryEvictionPolicy(Policy)public void setInMemoryEvictionPolicy(Policy policy)
setInMemoryEvictionPolicy in interface Storepolicy - the new policypublic Object getInternalContext()
getInternalContext in interface Storepublic boolean isCacheCoherent()
Store.isClusterCoherent() (introduced since 2.0)
Use Store.isNodeCoherent() to find out if the cache is coherent in the current node in the cluster.
isCacheCoherent in interface Storetrue if the store is coherent; or false if the
store potentially splits the cache storage with another store or
isn't internally coherentpublic boolean isClusterCoherent()
isClusterCoherent in interface Storepublic boolean isNodeCoherent()
isNodeCoherent in interface Store
public void waitUntilClusterCoherent()
throws UnsupportedOperationException,
InterruptedException
waitUntilClusterCoherent in interface StoreInterruptedException
UnsupportedOperationException - if this store does not support cache coherence, like RMI replicationpublic Object getMBean()
getMBean in interface Storepublic Results executeQuery(StoreQuery query)
executeQuery in interface Storequery - query to execute
public <T> Attribute<T> getSearchAttribute(String attributeName)
getSearchAttribute in interface StoreT - type of the attributeattributeName - the name of the attribute to retrieve
public Set getLocalKeys()
getLocalKeys in interface TerracottaStorepublic CacheConfiguration.TransactionalMode getTransactionalMode()
getTransactionalMode in interface TerracottaStoreCacheConfiguration.TransactionalModepublic Element unlockedGet(Object key)
unlockedGet in interface TerracottaStorepublic Element unlockedGetQuiet(Object key)
TerracottaStore.unlockedGet(Object) but does not update statistics
unlockedGetQuiet in interface TerracottaStorepublic Element unsafeGet(Object key)
unsafeGet in interface TerracottaStorekey - the key
public Element unsafeGetQuiet(Object key)
TerracottaStore.unsafeGet(Object) but does not update last usage statistics
unsafeGetQuiet in interface TerracottaStorekey - the key
public <V> V executeClusterOperation(ClusterOperation<V> operation)
ClusterOperation within this NonstopStore context.
executeClusterOperation in interface NonstopStoreV - Return type depending on the ClusterOperation
ClusterOperation
protected <V> V executeClusterOperationNoTimeout(ClusterOperation<V> operation)
throws InterruptedException,
TimeoutException
ClusterOperation parameter, but without any timeout. This call will block until the ClusterOperation
completes. The
ClusterOperation.performClusterOperationTimedOut(net.sf.ehcache.config.TimeoutBehaviorConfiguration.TimeoutBehaviorType) will
never be invoked for this
InterruptedException - if the executing thread is interrupted before the ClusterOperation can complete
TimeoutExceptionpublic void clusterRejoined()
clusterRejoined in interface RejoinAwareNonstopStorepublic void recalculateSize(Object key)
recalculateSize in interface Storekey - the key
|
ehcache | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||