|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.ehcache.store.AbstractStore net.sf.ehcache.store.disk.DiskStore
public final class DiskStore
Implements a persistent-to-disk store.
All new elements are automatically scheduled for writing to disk.
Field Summary |
---|
Fields inherited from class net.sf.ehcache.store.AbstractStore |
---|
attributeExtractors, searchManager |
Fields inherited from interface net.sf.ehcache.store.Store |
---|
CLUSTER_COHERENT, NODE_COHERENT |
Method Summary | |
---|---|
boolean |
bufferFull()
Some store types, such as the disk stores can fill their write buffers if puts come in too fast. |
void |
changeDiskCapacity(int newCapacity)
Change the disk capacity, in number of elements |
void |
clearFaultedBit()
Marks all entries has flushed (i.e. |
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. |
static DiskStore |
create(Cache cache)
Creates a persitent-to-disk store for the given cache, using the given disk path. |
static DiskStore |
create(Ehcache cache,
Pool onHeapPool,
Pool onDiskPool)
Creates a persitent-to-disk store for the given cache, using the given disk path. |
static Store |
createCacheStore(Ehcache cache,
Pool onHeapPool,
Pool onDiskPool)
Create a DiskBackedMemoryStore instance |
StripedReadWriteLock |
createStripedReadWriteLock()
Will create a StripedReadWriteLock always using the same spreading function |
void |
dispose()
Prepares for shutdown. |
boolean |
evict(Object key,
DiskStorageFactory.DiskSubstitute substitute)
Remove the matching mapping. |
Element |
evictElement(Object key,
DiskStorageFactory.DiskSubstitute substitute)
Remove the matching mapping. |
void |
expireElements()
Expire all elements. |
Element |
fault(Object key,
boolean updateStats)
Marks the entry as not evictable and returns it atomically |
boolean |
fault(Object key,
net.sf.ehcache.store.disk.DiskStorageFactory.Placeholder expect,
DiskStorageFactory.DiskMarker fault)
Atomically switch (CAS) the expect representation of this element for the
fault representation. |
void |
flush()
Flush elements to persistent store. |
boolean |
flush(Element element)
This marks the entry as evictable again and updates relevant access stats |
Element |
get(Object key)
Gets an item from the cache. |
File |
getDataFile()
Return a reference to the data file backing this store. |
File |
getIndexFile()
Return a reference to the index file for this store. |
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 |
List<DiskStorageFactory.DiskSubstitute> |
getRandomSample(ElementSubstituteFilter factory,
int sampleSize,
Object keyHint)
Select a random sample of elements generated by the supplied factory. |
int |
getSize()
Returns the current local store size |
Status |
getStatus()
Returns the cache status. |
int |
getTerracottaClusteredSize()
Returns the current Terracotta clustered store size |
boolean |
isFaulted(Object key)
Verifies if the mapping for a key is marked as faulted |
Set<Object> |
keySet()
Get a set view of the keys in this store |
boolean |
put(Element element)
Puts an item into the store. |
boolean |
putFaulted(Element element)
Stupid "implicit" contract in tests that dictates that entries put, will be in highest tier! |
Element |
putIfAbsent(Element element)
Put an element in the store if no element is currently mapped to the elements key. |
boolean |
putRawIfAbsent(Object key,
DiskStorageFactory.DiskMarker encoded)
Put the given encoded element directly into the store |
boolean |
putWithWriter(Element element,
CacheWriterManager writerManager)
Puts an item into the store and the cache writer manager in an atomic operation |
Element |
remove(Object key)
Removes an item from the cache. |
void |
removeAll()
Remove all of the elements from the store. |
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. |
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 |
setInMemoryEvictionPolicy(Policy policy)
Sets the eviction policy strategy. |
Object |
unretrievedGet(Object key)
Return the unretrieved (undecoded) value for this key |
Methods inherited from class net.sf.ehcache.store.AbstractStore |
---|
addStoreListener, executeQuery, getAll, getAllQuiet, getEventListenerList, getSearchAttribute, getSearchAttributes, hasAbortedSizeOf, isCacheCoherent, isClusterCoherent, isNodeCoherent, putAll, recalculateSize, removeAll, removeStoreListener, setAttributeExtractors, setNodeCoherent, waitUntilClusterCoherent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.ehcache.store.Store |
---|
addStoreListener, executeQuery, getAll, getAllQuiet, getSearchAttribute, getSearchAttributes, hasAbortedSizeOf, isCacheCoherent, isClusterCoherent, isNodeCoherent, putAll, recalculateSize, removeAll, removeStoreListener, setAttributeExtractors, setNodeCoherent, waitUntilClusterCoherent |
Method Detail |
---|
public static DiskStore create(Ehcache cache, Pool onHeapPool, Pool onDiskPool)
cache
- cache that fronts this storeonHeapPool
- pool to track heap usageonDiskPool
- pool to track disk usage
public static DiskStore create(Cache cache)
cache
- cache that fronts this store
public static Store createCacheStore(Ehcache cache, Pool onHeapPool, Pool onDiskPool)
cache
- the cacheonHeapPool
- the pool tracking on-heap usageonDiskPool
- the pool tracking on-disk usage
public StripedReadWriteLock createStripedReadWriteLock()
createStripedReadWriteLock
in interface StripedReadWriteLockProvider
public Element fault(Object key, boolean updateStats)
AuthoritativeTier
fault
in interface AuthoritativeTier
public boolean putFaulted(Element element)
AuthoritativeTier
putFaulted
in interface AuthoritativeTier
public boolean flush(Element element)
AuthoritativeTier
flush
in interface AuthoritativeTier
public boolean isFaulted(Object key)
key
- the key to check the mapping for
public void changeDiskCapacity(int newCapacity)
newCapacity
- the new max elements on diskpublic boolean bufferFull()
bufferFull
in interface Store
public boolean containsKeyInMemory(Object key)
containsKeyInMemory
in interface Store
key
- The Element key
public boolean containsKeyOffHeap(Object key)
containsKeyOffHeap
in interface Store
key
- The Element key
public boolean containsKeyOnDisk(Object key)
containsKeyOnDisk
in interface Store
key
- The Element key
public void expireElements()
expireElements
in interface Store
public void flush() throws IOException
flush
in interface Store
IOException
- if any IO error occurspublic Policy getInMemoryEvictionPolicy()
getInMemoryEvictionPolicy
in interface Store
Store.setInMemoryEvictionPolicy(Policy)
public int getInMemorySize()
getInMemorySize
in interface Store
public long getInMemorySizeInBytes()
getInMemorySizeInBytes
in interface Store
public int getOffHeapSize()
getOffHeapSize
in interface Store
public long getOffHeapSizeInBytes()
getOffHeapSizeInBytes
in interface Store
public int getOnDiskSize()
getOnDiskSize
in interface Store
public long getOnDiskSizeInBytes()
getOnDiskSizeInBytes
in interface Store
public int getTerracottaClusteredSize()
getTerracottaClusteredSize
in interface Store
public void setInMemoryEvictionPolicy(Policy policy)
setInMemoryEvictionPolicy
in interface Store
policy
- the new policypublic File getDataFile()
public File getIndexFile()
public Object getMBean()
getMBean
in interface Store
public boolean put(Element element)
put
in interface Store
public boolean putWithWriter(Element element, CacheWriterManager writerManager)
putWithWriter
in interface Store
public Element get(Object key)
get
in interface Store
public Element getQuiet(Object key)
Element
from the Store, without updating statistics
getQuiet
in interface Store
public Object unretrievedGet(Object key)
key
- key to lookup
public boolean putRawIfAbsent(Object key, DiskStorageFactory.DiskMarker encoded) throws IllegalArgumentException
key
- the key of the elementencoded
- the encoded element
IllegalArgumentException
- if the supplied key is already presentpublic List getKeys()
getKeys
in interface Store
Serializable
keyspublic Set<Object> keySet()
public Element remove(Object key)
remove
in interface Store
public Element removeWithWriter(Object key, CacheWriterManager writerManager)
removeWithWriter
in interface Store
public void removeAll()
CacheEventListener
s they are notified of the expiry or removal
of the Element
as each is removed.
removeAll
in interface Store
public void dispose()
dispose
in interface Store
public void clearFaultedBit()
public int getSize()
getSize
in interface Store
public Status getStatus()
getStatus
in interface Store
public boolean containsKey(Object key)
containsKey
in interface Store
key
- The Element key
public Object getInternalContext()
getInternalContext
in interface Store
public Element putIfAbsent(Element element) throws NullPointerException
putIfAbsent
in interface Store
element
- element to be added
NullPointerException
- if the element is null, or has a null keypublic Element removeElement(Element element, ElementValueComparator comparator) throws NullPointerException
removeElement
in interface Store
element
- Element to be removedcomparator
- ElementValueComparator to use to compare elements
NullPointerException
- if the element is null, or has a null keypublic boolean replace(Element old, Element element, ElementValueComparator comparator) throws NullPointerException, IllegalArgumentException
replace
in interface Store
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 equalpublic Element replace(Element element) throws NullPointerException
replace
in interface Store
element
- Element to be cached
NullPointerException
- if the Element is null or has a null keypublic boolean fault(Object key, net.sf.ehcache.store.disk.DiskStorageFactory.Placeholder expect, DiskStorageFactory.DiskMarker fault)
expect
representation of this element for the
fault
representation.
A successful switch will return true
, and free the replaced element/element-proxy.
A failed switch will return false
and free the element/element-proxy which was not
installed.
key
- key to which this element (proxy) is mappedexpect
- element (proxy) expectedfault
- element (proxy) to install
true
if fault
was installedpublic boolean evict(Object key, DiskStorageFactory.DiskSubstitute substitute)
key
- key to match againstsubstitute
- optional value to match against
true
on a successful removepublic Element evictElement(Object key, DiskStorageFactory.DiskSubstitute substitute)
key
- key to match againstsubstitute
- optional value to match against
public List<DiskStorageFactory.DiskSubstitute> getRandomSample(ElementSubstituteFilter factory, int sampleSize, Object keyHint)
factory
- generator of the given typesampleSize
- minimum number of elements to returnkeyHint
- a key on which we are currently working
|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |