|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Store
This is the interface for all stores. A store is a physical counterpart to a cache, which is a logical concept.
Field Summary | |
---|---|
static String |
CLUSTER_COHERENT
clusterCoherent property |
static String |
NODE_COHERENT
nodeCoherent property |
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. |
|
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. |
|
Results |
executeQuery(StoreQuery query)
Execute the given query on this store |
|
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. |
|
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 |
|
Set<Attribute> |
getSearchAttributes()
|
|
int |
getSize()
Returns the current local store size |
|
Status |
getStatus()
Returns the cache status. |
|
int |
getTerracottaClusteredSize()
Returns the current Terracotta clustered store size |
|
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 |
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. |
|
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 |
waitUntilClusterCoherent()
This method waits until the cache is in coherent mode in all the connected nodes. |
Field Detail |
---|
static final String CLUSTER_COHERENT
static final String NODE_COHERENT
Method Detail |
---|
void addStoreListener(StoreListener listener)
listener
- void removeStoreListener(StoreListener listener)
listener
- boolean put(Element element) throws CacheException
CacheException
void putAll(Collection<Element> elements) throws CacheException
elements
- Collection of elements to be put in the store
CacheException
boolean putWithWriter(Element element, CacheWriterManager writerManager) throws CacheException
CacheException
Element get(Object key)
Element getQuiet(Object key)
Element
from the Store, without updating statistics
List getKeys()
Serializable
keysElement remove(Object key)
void removeAll(Collection<?> keys)
Element removeWithWriter(Object key, CacheWriterManager writerManager) throws CacheException
CacheException
void removeAll() throws CacheException
CacheEventListener
s they are notified of the expiry or removal
of the Element
as each is removed.
CacheException
Element putIfAbsent(Element element) throws NullPointerException
element
- element to be added
NullPointerException
- if the element is null, or has a null keyElement removeElement(Element element, ElementValueComparator comparator) throws NullPointerException
element
- Element to be removedcomparator
- ElementValueComparator to use to compare elements
NullPointerException
- if the element is null, or has a null keyboolean replace(Element old, Element element, ElementValueComparator comparator) throws NullPointerException, IllegalArgumentException
old
- 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 equalElement replace(Element element) throws NullPointerException
element
- Element to be cached
NullPointerException
- if the Element is null or has a null keyvoid dispose()
int getSize()
int getInMemorySize()
int getOffHeapSize()
int getOnDiskSize()
int getTerracottaClusteredSize()
long getInMemorySizeInBytes()
long getOffHeapSizeInBytes()
long getOnDiskSizeInBytes()
boolean hasAbortedSizeOf()
Status getStatus()
boolean containsKey(Object key)
key
- The Element key
boolean containsKeyOnDisk(Object key)
key
- The Element key
boolean containsKeyOffHeap(Object key)
key
- The Element key
boolean containsKeyInMemory(Object key)
key
- The Element key
void expireElements()
void flush() throws IOException
IOException
- if any IO error occursboolean bufferFull()
Policy getInMemoryEvictionPolicy()
setInMemoryEvictionPolicy(Policy)
void setInMemoryEvictionPolicy(Policy policy)
policy
- the new policyObject getInternalContext()
boolean isCacheCoherent()
isClusterCoherent()
(introduced since 2.0)
Use isNodeCoherent()
to find out if the cache is coherent in the current node in the cluster
true
if the store is coherent; or false
if the
store potentially splits the cache storage with another store or
isn't internally coherentboolean isClusterCoherent() throws TerracottaNotRunningException
TerracottaNotRunningException
boolean isNodeCoherent() throws TerracottaNotRunningException
TerracottaNotRunningException
void setNodeCoherent(boolean coherent) throws UnsupportedOperationException, TerracottaNotRunningException
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
coherent
- true transitions to coherent mode, false to incoherent mode
UnsupportedOperationException
- if this store does not support cache coherence, like RMI replication
TerracottaNotRunningException
void waitUntilClusterCoherent() throws UnsupportedOperationException, TerracottaNotRunningException, InterruptedException
UnsupportedOperationException
- if this store does not support cache coherence, like RMI replication
InterruptedException
TerracottaNotRunningException
Object getMBean()
void setAttributeExtractors(Map<String,AttributeExtractor> extractors)
extractors
- Results executeQuery(StoreQuery query) throws SearchException
query
- query to execute
SearchException
Set<Attribute> getSearchAttributes()
<T> Attribute<T> getSearchAttribute(String attributeName)
T
- type of the attributeattributeName
- the name of the attribute to retrieve
Map<Object,Element> getAllQuiet(Collection<?> keys)
keys
- a collection of keys to look for
Map<Object,Element> getAll(Collection<?> keys)
keys
- a collection of keys to look for
void recalculateSize(Object key)
key
- the key
|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |