|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.ehcache.constructs.classloader.ClassLoaderAwareCache
public class ClassLoaderAwareCache
A cache decorator that adjusts the Thread context classloader (TCCL) for every cache operation. The TCCL is reset to its original value when the method is complete
Field Summary | |
---|---|
protected Ehcache |
cache
Used by InternalClassLoaderAwareCache |
protected ClassLoader |
classLoader
Used by InternalClassLoaderAwareCache |
Constructor Summary | |
---|---|
ClassLoaderAwareCache(Ehcache cache,
ClassLoader classLoader)
Constructor |
Method Summary | |
---|---|
void |
acquireReadLockOnKey(Object arg0)
Acquires the proper read lock for a given cache key |
void |
acquireWriteLockOnKey(Object arg0)
Acquires the proper write lock for a given cache key |
void |
addPropertyChangeListener(PropertyChangeListener arg0)
Add a PropertyChangeListener. |
void |
bootstrap()
Bootstrap command. |
long |
calculateInMemorySize()
Deprecated. |
long |
calculateOffHeapSize()
Deprecated. |
long |
calculateOnDiskSize()
Deprecated. |
Object |
clone()
Clones a cache. |
Query |
createQuery()
Create a new query builder for this cache |
void |
disableDynamicFeatures()
Disables dynamic configuration and disable/enable for this cache. |
void |
dispose()
Flushes all cache items from memory to auxilliary caches and close the auxilliary caches. |
void |
evictExpiredElements()
Causes all elements stored in the Cache to be synchronously checked for expiry, and if expired, evicted. |
void |
flush()
Flushes all cache items from memory to the disk store, and from the DiskStore to disk. |
Element |
get(Object arg0)
Gets an element from the cache. |
Element |
get(Serializable arg0)
Gets an element from the cache. |
Map |
getAll(Collection arg0)
Gets all the elements from the cache for the keys provided. |
Map |
getAllWithLoader(Collection arg0,
Object arg1)
The getAll method will return, from the cache, a Map of the objects associated with the Collection of keys in argument "keys". |
BootstrapCacheLoader |
getBootstrapCacheLoader()
Accessor for the BootstrapCacheLoader associated with this cache. |
CacheConfiguration |
getCacheConfiguration()
Gets the cache configuration this cache was created with. |
RegisteredEventListeners |
getCacheEventNotificationService()
Use this to access the service in order to register and unregister listeners |
CacheExceptionHandler |
getCacheExceptionHandler()
Sets an ExceptionHandler on the Cache. |
CacheManager |
getCacheManager()
Gets the CacheManager managing this cache. |
int |
getDiskStoreSize()
Deprecated. |
String |
getGuid()
The GUID for this cache instance can be used to determine whether two cache instance references are pointing to the same cache. |
Object |
getInternalContext()
This should not be used return some internal context (generally will be null) |
List |
getKeys()
Returns a list of all elements in the cache, whether or not they are expired. |
List |
getKeysNoDuplicateCheck()
Returns a list of all elements in the cache, whether or not they are expired. |
List |
getKeysWithExpiryCheck()
Returns a list of all elements in the cache. |
long |
getMemoryStoreSize()
Deprecated. |
String |
getName()
Gets the cache name. |
long |
getOffHeapStoreSize()
Deprecated. |
Element |
getQuiet(Object arg0)
Gets an element from the cache, without updating Element statistics. |
Element |
getQuiet(Serializable arg0)
Gets an element from the cache, without updating Element statistics. |
List |
getRegisteredCacheExtensions()
|
List |
getRegisteredCacheLoaders()
|
CacheWriter |
getRegisteredCacheWriter()
Retrieves the CacheWriter that was registered for this cache. |
Attribute |
getSearchAttribute(String arg0)
Retrieve the given named search attribute |
Set<Attribute> |
getSearchAttributes()
|
int |
getSize()
Gets the size of the cache. |
StatisticsGateway |
getStatistics()
Gets an immutable Statistics object representing the Cache statistics at the time. |
Status |
getStatus()
Gets the status attribute of the Cache. |
Element |
getWithLoader(Object arg0,
CacheLoader arg1,
Object arg2)
This method will return, from the cache, the object associated with the argument "key". |
CacheWriterManager |
getWriterManager()
Obtain the writer manager that's used by this cache instance. |
boolean |
hasAbortedSizeOf()
Check if the cache may contain elements which the SizeOf engine could not fully size. |
void |
initialise()
Newly created caches do not have a MemoryStore or
a DiskStore . |
boolean |
isClusterBulkLoadEnabled()
Returns true if at least one node in the cluster is in bulk-load mode. |
boolean |
isClusterCoherent()
Returns true if the cache is in coherent mode cluster-wide. |
boolean |
isDisabled()
Whether this cache is disabled. |
boolean |
isElementInMemory(Object arg0)
Whether an Element is stored in the cache in Memory, indicating a very low cost of retrieval. |
boolean |
isElementInMemory(Serializable arg0)
Whether an Element is stored in the cache in Memory, indicating a very low cost of retrieval. |
boolean |
isElementOnDisk(Object arg0)
Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval. |
boolean |
isElementOnDisk(Serializable arg0)
Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval. |
boolean |
isExpired(Element arg0)
Checks whether this cache element has expired. |
boolean |
isKeyInCache(Object arg0)
An inexpensive check to see if the key exists in the cache. |
boolean |
isNodeBulkLoadEnabled()
Returns true if the current node is in bulk-load mode. |
boolean |
isNodeCoherent()
Returns true if the cache is in coherent mode for the current node. |
boolean |
isReadLockedByCurrentThread(Object arg0)
Returns true if a read lock for the key is held by the current thread |
boolean |
isSearchable()
Is this cache searchable? |
boolean |
isValueInCache(Object arg0)
An extremely expensive check to see if the value exists in the cache. |
boolean |
isWriteLockedByCurrentThread(Object arg0)
Returns true if a write lock for the key is held by the current thread |
void |
load(Object arg0)
The load method provides a means to "pre load" the cache. |
void |
loadAll(Collection arg0,
Object arg1)
The loadAll method provides a means to "pre load" objects into the cache. |
static void |
main(String[] args)
Generator for the method bodies |
void |
put(Element arg0)
Put an element in the cache. |
void |
put(Element arg0,
boolean arg1)
Put an element in the cache. |
void |
putAll(Collection arg0)
Puts a collection of elements in to the cache. |
Element |
putIfAbsent(Element arg0)
Put an element in the cache if no element is currently mapped to the elements key. |
Element |
putIfAbsent(Element arg0,
boolean arg1)
Put an element in the cache if no element is currently mapped to the elements key. |
void |
putQuiet(Element arg0)
Put an element in the cache, without updating statistics, or updating listeners. |
void |
putWithWriter(Element arg0)
Put an element in the cache writing through a CacheWriter. |
void |
registerCacheExtension(CacheExtension arg0)
Register a CacheExtension with the cache. |
void |
registerCacheLoader(CacheLoader arg0)
Register a CacheLoader with the cache. |
void |
registerCacheWriter(CacheWriter arg0)
Register the CacheWriter for this cache. |
void |
registerDynamicAttributesExtractor(DynamicAttributesExtractor extractor)
Allows user to register a dynamic attribute extractor with a searchable cache that is dynamically indexable, as indicated by its configuration. |
void |
releaseReadLockOnKey(Object arg0)
Release a held read lock for the passed in key |
void |
releaseWriteLockOnKey(Object arg0)
Release a held write lock for the passed in key |
boolean |
remove(Object arg0)
Removes an Element from the Cache. |
boolean |
remove(Object arg0,
boolean arg1)
Removes an Element from the Cache. |
boolean |
remove(Serializable arg0)
Removes an Element from the Cache. |
boolean |
remove(Serializable arg0,
boolean arg1)
Removes an Element from the Cache. |
void |
removeAll()
Removes all cached items. |
void |
removeAll(boolean arg0)
Removes all cached items. |
void |
removeAll(Collection arg0)
Removes given set of Element from the Cache. |
void |
removeAll(Collection arg0,
boolean arg1)
Removes all cached items. |
boolean |
removeElement(Element arg0)
Remove the Element mapped to the key for the supplied element if the value of the supplied Element compares equal to the value of the cached Element. |
void |
removePropertyChangeListener(PropertyChangeListener arg0)
Remove a PropertyChangeListener. |
boolean |
removeQuiet(Object arg0)
Removes an Element from the Cache, without notifying listeners. |
boolean |
removeQuiet(Serializable arg0)
Removes an Element from the Cache, without notifying listeners. |
boolean |
removeWithWriter(Object arg0)
Removes an Element from the Cache and any stores it might be in. |
Element |
replace(Element arg0)
Replace the cached element only if an Element is currently cached for this key |
boolean |
replace(Element arg0,
Element arg1)
Replace the cached element only if the current Element is equal to the supplied old Element. |
void |
setBootstrapCacheLoader(BootstrapCacheLoader arg0)
Sets the bootstrap cache loader. |
void |
setCacheExceptionHandler(CacheExceptionHandler arg0)
Sets an ExceptionHandler on the Cache. |
void |
setCacheManager(CacheManager arg0)
Sets the CacheManager |
void |
setDisabled(boolean arg0)
Disables or enables this cache. |
void |
setName(String arg0)
Sets the cache name which will name. |
void |
setNodeBulkLoadEnabled(boolean arg0)
Enable/disable bulk-load mode in this node for this cache. |
void |
setNodeCoherent(boolean arg0)
Sets the cache in coherent or incoherent mode depending on the parameter on this node. |
void |
setTransactionManagerLookup(TransactionManagerLookup arg0)
This class is used to access the transaction manager used during XA. |
String |
toString()
Returns a String representation of Cache . |
boolean |
tryReadLockOnKey(Object arg0,
long arg1)
Try to get a read lock on a given key. |
boolean |
tryWriteLockOnKey(Object arg0,
long arg1)
Try to get a write lock on a given key. |
void |
unregisterCacheExtension(CacheExtension arg0)
Unregister a CacheExtension with the cache. |
void |
unregisterCacheLoader(CacheLoader arg0)
Unregister a CacheLoader with the cache. |
void |
unregisterCacheWriter()
Unregister the CacheWriter from the cache. |
void |
waitUntilClusterBulkLoadComplete()
This method waits until all the connected nodes have disabled bulk-load. |
void |
waitUntilClusterCoherent()
This method waits until the cache is in coherent mode in all the connected nodes. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final ClassLoader classLoader
protected final Ehcache cache
Constructor Detail |
---|
public ClassLoaderAwareCache(Ehcache cache, ClassLoader classLoader)
cache
- wrapped cacheclassLoader
- loader to set Thread context loader to for duration of cache opeartionMethod Detail |
---|
public static void main(String[] args)
args
- public void putQuiet(Element arg0) throws IllegalArgumentException, IllegalStateException, CacheException
Ehcache.getQuiet(java.io.Serializable)
putQuiet
in interface Ehcache
arg0
- An object. If Serializable it can fully participate in replication and the DiskStore.
IllegalArgumentException
- if the element is null
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
public void putWithWriter(Element arg0) throws IllegalArgumentException, IllegalStateException, CacheException
putWithWriter
in interface Ehcache
arg0
- An object. If Serializable it can fully participate in replication and the DiskStore.
IllegalArgumentException
- if the element is null
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
- if no CacheWriter was registeredpublic Map getAll(Collection arg0) throws IllegalStateException, CacheException, NullPointerException
Ehcache.getQuiet(Object)
to peek into the Element to see its last access time with get
getAll
in interface Ehcache
arg0
- a collection of keys for which value is to be fetched
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
NullPointerException
- if any key is null in the collection
CacheException
Ehcache.isExpired(net.sf.ehcache.Element)
public Element getQuiet(Serializable arg0) throws IllegalStateException, CacheException
getQuiet
in interface Ehcache
arg0
- a serializable value
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
Ehcache.isExpired(net.sf.ehcache.Element)
public Element getQuiet(Object arg0) throws IllegalStateException, CacheException
getQuiet
in interface Ehcache
arg0
- a serializable value
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
Ehcache.isExpired(net.sf.ehcache.Element)
public List getKeysWithExpiryCheck() throws IllegalStateException, CacheException
getKeysWithExpiryCheck
in interface Ehcache
Object
keys
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
public List getKeysNoDuplicateCheck() throws IllegalStateException
getKeysNoDuplicateCheck
in interface Ehcache
Object
keys
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public boolean removeQuiet(Serializable arg0) throws IllegalStateException
Element
from the Cache, without notifying listeners. This also removes it from any
stores it may be in.
removeQuiet
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public boolean removeQuiet(Object arg0) throws IllegalStateException
Element
from the Cache, without notifying listeners. This also removes it from any
stores it may be in.
removeQuiet
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public boolean removeWithWriter(Object arg0) throws IllegalStateException, CacheException
Element
from the Cache and any stores it might be in. This also removes through
to a CacheWriter. If no CacheWriter has been registered for the cache, then this method throws an exception.
Also notifies the CacheEventListener after the element was removed, but only if an Element
with the key actually existed.
removeWithWriter
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
- if no CacheWriter was registered@Deprecated public long calculateInMemorySize() throws IllegalStateException, CacheException
calculateInMemorySize
in interface Ehcache
IllegalStateException
CacheException
@Deprecated public long calculateOffHeapSize() throws IllegalStateException, CacheException
calculateOffHeapSize
in interface Ehcache
IllegalStateException
CacheException
@Deprecated public long calculateOnDiskSize() throws IllegalStateException, CacheException
calculateOnDiskSize
in interface Ehcache
IllegalStateException
CacheException
public boolean hasAbortedSizeOf()
hasAbortedSizeOf
in interface Ehcache
@Deprecated public long getMemoryStoreSize() throws IllegalStateException
getMemoryStoreSize
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
@Deprecated public long getOffHeapStoreSize() throws IllegalStateException
getOffHeapStoreSize
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
@Deprecated public int getDiskStoreSize() throws IllegalStateException
getDiskStoreSize
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public boolean isExpired(Element arg0) throws IllegalStateException, NullPointerException
isExpired
in interface Ehcache
arg0
- the element to check
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
NullPointerException
- if the element is nullpublic RegisteredEventListeners getCacheEventNotificationService()
getCacheEventNotificationService
in interface Ehcache
public boolean isElementInMemory(Object arg0)
Since no assertions are made about the state of the Element it is possible that the Element is expired, but this method still returns true.
isElementInMemory
in interface Ehcache
public boolean isElementInMemory(Serializable arg0)
Since no assertions are made about the state of the Element it is possible that the Element is expired, but this method still returns true.
isElementInMemory
in interface Ehcache
public boolean isElementOnDisk(Object arg0)
Since no assertions are made about the state of the Element it is possible that the Element is expired, but this method still returns true.
isElementOnDisk
in interface Ehcache
public boolean isElementOnDisk(Serializable arg0)
Since no assertions are made about the state of the Element it is possible that the Element is expired, but this method still returns true.
isElementOnDisk
in interface Ehcache
public String getGuid()
getGuid
in interface Ehcache
public CacheManager getCacheManager()
getCacheManager
in interface Ehcache
public void evictExpiredElements()
For large caches - or caches with high-latency storage this method can take a very long time to complete. You should seriously consider relying on some form of capacity eviction to control cache capacity over calling this method. As this method can take a long time the cache may not be fully purged of expired elements on return, since more elements may have expired during the call.
evictExpiredElements
in interface Ehcache
public boolean isKeyInCache(Object arg0)
Since no assertions are made about the state of the Element it is possible that the Element is expired, but this method still returns true.
isKeyInCache
in interface Ehcache
arg0
- the key to check for
public boolean isValueInCache(Object arg0)
isValueInCache
in interface Ehcache
arg0
- to check for
public StatisticsGateway getStatistics() throws IllegalStateException
Statistics#STATISTICS_ACCURACY_BEST_EFFORT
.
The size is the number of Element
s in the MemoryStore
plus
the number of Element
s in the DiskStore
.
This number is the actual number of elements, including expired elements that have
not been removed. Any duplicates between stores are accounted for.
Expired elements are removed from the the memory store when
getting an expired element, or when attempting to spool an expired element to
disk.
Expired elements are removed from the disk store when getting an expired element,
or when the expiry thread runs, which is once every five minutes.
Statistics#STATISTICS_ACCURACY_GUARANTEED
.
This method accounts for elements which might be expired or duplicated between stores. It take approximately
200ms per 1000 elements to execute.
Statistics#STATISTICS_ACCURACY_NONE
.
The number given may contain expired elements. In addition if the DiskStore is used it may contain some double
counting of elements. It takes 6ms for 1000 elements to execute. Time to execute is O(log n). 50,000 elements take
36ms.
getStatistics
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public void setCacheManager(CacheManager arg0)
setCacheManager
in interface Ehcache
arg0
- the CacheManager for this cache to use.public BootstrapCacheLoader getBootstrapCacheLoader()
getBootstrapCacheLoader
in interface Ehcache
public void setBootstrapCacheLoader(BootstrapCacheLoader arg0) throws CacheException
setBootstrapCacheLoader
in interface Ehcache
arg0
- the loader to be used
CacheException
- if this method is called after the cache is initializedpublic void initialise()
MemoryStore
or
a DiskStore
.
This method creates those and makes the cache ready to accept elements
This method is not intended to be called explicitly, but rather is called implicitly
by the cache's CacheManager
instance during the cache
initialization. Invoking this method directly will likely lead to breaking.
initialise
in interface Ehcache
public void bootstrap()
CacheManager
instance during the cache
initialization. Invoking this method directly will likely lead to breaking.
bootstrap
in interface Ehcache
public CacheConfiguration getCacheConfiguration()
getCacheConfiguration
in interface Ehcache
public void registerCacheExtension(CacheExtension arg0)
CacheExtension
with the cache. It will then be tied into the cache lifecycle.
If the CacheExtension is not initialised, initialise it.
registerCacheExtension
in interface Ehcache
public void unregisterCacheExtension(CacheExtension arg0)
CacheExtension
with the cache. It will then be detached from the cache lifecycle.
unregisterCacheExtension
in interface Ehcache
public List getRegisteredCacheExtensions()
getRegisteredCacheExtensions
in interface Ehcache
public void setCacheExceptionHandler(CacheExceptionHandler arg0)
setCacheExceptionHandler
in interface Ehcache
public CacheExceptionHandler getCacheExceptionHandler()
getCacheExceptionHandler
in interface Ehcache
public void registerCacheLoader(CacheLoader arg0)
CacheLoader
with the cache. It will then be tied into the cache lifecycle.
The CacheLoader instance will be initialized when the cache itself is being initialized.
Should the cache already be initialized, CacheLoader.init()
will not be invoked.
If the loader requires initialization, the user will have to call it manually before registering it with a Cache instance
that's already alive
registerCacheLoader
in interface Ehcache
arg0
- A Cache Loader to registerpublic void unregisterCacheLoader(CacheLoader arg0)
CacheLoader
with the cache. It will then be detached from the cache lifecycle.
unregisterCacheLoader
in interface Ehcache
arg0
- A Cache Loader to unregisterpublic List getRegisteredCacheLoaders()
getRegisteredCacheLoaders
in interface Ehcache
public void registerCacheWriter(CacheWriter arg0)
CacheWriter
for this cache. It will then be tied into the cache lifecycle.
If the CacheWriter
is not initialised, initialise it.
registerCacheWriter
in interface Ehcache
arg0
- A CacheWriter to registerpublic void registerDynamicAttributesExtractor(DynamicAttributesExtractor extractor)
registerDynamicAttributesExtractor
in interface Ehcache
public void unregisterCacheWriter()
CacheWriter
from the cache. It will then be detached from the cache lifecycle.
If not CacheWriter
was registered beforehand this operation has no effect.
unregisterCacheWriter
in interface Ehcache
public CacheWriter getRegisteredCacheWriter()
CacheWriter
that was registered for this cache.
getRegisteredCacheWriter
in interface Ehcache
CacheWriter
; or null
if none was registered beforepublic Element getWithLoader(Object arg0, CacheLoader arg1, Object arg2) throws CacheException
getWithLoader
in interface Ehcache
arg0
- key whose associated value is to be returned.arg1
- the override loader to use. If null, the cache's default loader will be usedarg2
- an argument to pass to the CacheLoader.
CacheException
public Map getAllWithLoader(Collection arg0, Object arg1) throws CacheException
SelfPopulatingCache
getAllWithLoader
in interface Ehcache
arg0
- a collection of keys to be returned/loadedarg1
- an argument to pass to the CacheLoader.
CacheException
public boolean isDisabled()
Ehcache.setDisabled(boolean)
method.
isDisabled
in interface Ehcache
public void setDisabled(boolean arg0)
setDisabled
in interface Ehcache
arg0
- true if you wish to disable, false to enableEhcache.isDisabled()
public Object getInternalContext()
getInternalContext
in interface Ehcache
public void disableDynamicFeatures()
This is a one time operation. Once an Ehcache instance has had its dynamic operations disabled they cannot be re-enabled.
disableDynamicFeatures
in interface Ehcache
public CacheWriterManager getWriterManager()
getWriterManager
in interface Ehcache
public boolean isClusterCoherent() throws TerracottaNotRunningException
isClusterCoherent
in interface Ehcache
TerracottaNotRunningException
public boolean isNodeCoherent() throws TerracottaNotRunningException
isNodeCoherent
in interface Ehcache
TerracottaNotRunningException
public void setNodeCoherent(boolean arg0) 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
When using Terracotta clustered caches with nonstop enabled, the timeout used by this method is
NonstopConfiguration.getBulkOpsTimeoutMultiplyFactor()
times the timeout value in the config.
setNodeCoherent
in interface Ehcache
arg0
- true transitions to coherent mode, false to incoherent mode
UnsupportedOperationException
- if this cache does not support coherence, like RMI replication
TerracottaNotRunningException
public void waitUntilClusterCoherent() throws UnsupportedOperationException, TerracottaNotRunningException
waitUntilClusterCoherent
in interface Ehcache
UnsupportedOperationException
- if this cache does not support coherence, like RMI replication
TerracottaNotRunningException
public void setTransactionManagerLookup(TransactionManagerLookup arg0)
setTransactionManagerLookup
in interface Ehcache
public Attribute getSearchAttribute(String arg0) throws CacheException
getSearchAttribute
in interface Ehcache
arg0
- the name of the attribute to retrieve
CacheException
- if no such attribute is defined for the given namepublic Set<Attribute> getSearchAttributes() throws CacheException
getSearchAttributes
in interface Ehcache
CacheException
public Query createQuery()
createQuery
in interface Ehcache
public boolean isSearchable()
isSearchable
in interface Ehcache
public void acquireReadLockOnKey(Object arg0)
acquireReadLockOnKey
in interface Ehcache
arg0
- - The key that retrieves a value that you want to protect via lockingpublic void acquireWriteLockOnKey(Object arg0)
acquireWriteLockOnKey
in interface Ehcache
arg0
- - The key that retrieves a value that you want to protect via lockingpublic boolean tryReadLockOnKey(Object arg0, long arg1) throws InterruptedException
tryReadLockOnKey
in interface Ehcache
arg0
- - The key that retrieves a value that you want to protect via lockingarg1
- - millis until giveup on getting the lock
InterruptedException
public boolean tryWriteLockOnKey(Object arg0, long arg1) throws InterruptedException
tryWriteLockOnKey
in interface Ehcache
arg0
- - The key that retrieves a value that you want to protect via lockingarg1
- - millis until giveup on getting the lock
InterruptedException
public void releaseReadLockOnKey(Object arg0)
releaseReadLockOnKey
in interface Ehcache
arg0
- - The key that retrieves a value that you want to protect via lockingpublic void releaseWriteLockOnKey(Object arg0)
releaseWriteLockOnKey
in interface Ehcache
arg0
- - The key that retrieves a value that you want to protect via lockingpublic boolean isReadLockedByCurrentThread(Object arg0) throws UnsupportedOperationException
isReadLockedByCurrentThread
in interface Ehcache
UnsupportedOperationException
- if querying the read lock state is not supportedpublic boolean isWriteLockedByCurrentThread(Object arg0) throws UnsupportedOperationException
isWriteLockedByCurrentThread
in interface Ehcache
UnsupportedOperationException
- if querying the write lock state is not supportedpublic boolean isClusterBulkLoadEnabled() throws UnsupportedOperationException, TerracottaNotRunningException
Ehcache.isNodeBulkLoadEnabled()
returns true, this method will always return true.
Applies to caches clustered with Terracotta only.
isClusterBulkLoadEnabled
in interface Ehcache
UnsupportedOperationException
- if the cache is not clustered with Terracotta
TerracottaNotRunningException
public boolean isNodeBulkLoadEnabled() throws UnsupportedOperationException, TerracottaNotRunningException
Ehcache.isClusterBulkLoadEnabled()
method will always return true.
Applies to caches clustered with Terracotta only.
isNodeBulkLoadEnabled
in interface Ehcache
UnsupportedOperationException
- if the cache is not clustered with Terracotta
TerracottaNotRunningException
public void setNodeBulkLoadEnabled(boolean arg0) throws UnsupportedOperationException, TerracottaNotRunningException
setBulkLoadEnabled(true)
when the cache is already in bulk-load mode or
calling setBulkLoadEnabled(false)
when already NOT in bulk-load mode will be a no-op.
Applies to caches clustered with Terracotta only.
When using Terracotta clustered caches with nonstop enabled, the timeout used by this method is
NonstopConfiguration.getBulkOpsTimeoutMultiplyFactor()
times the timeout value in the nonstop config.
setNodeBulkLoadEnabled
in interface Ehcache
arg0
- true enables bulk-load, false disables it if not already disabled
UnsupportedOperationException
- if the cache is not clustered with Terracotta
TerracottaNotRunningException
public void waitUntilClusterBulkLoadComplete() throws UnsupportedOperationException, TerracottaNotRunningException
waitUntilClusterBulkLoadComplete
in interface Ehcache
UnsupportedOperationException
- if the cache is not clustered with Terracotta
TerracottaNotRunningException
public void loadAll(Collection arg0, Object arg1) throws CacheException
SelfPopulatingCache
loadAll
in interface Ehcache
CacheException
public String toString()
String
representation of Cache
.
toString
in interface Ehcache
toString
in class Object
public Element get(Object arg0) throws IllegalStateException, CacheException
Ehcache.getQuiet(Object)
to peek into the Element to see its last access time with get
get
in interface Ehcache
arg0
- an Object value
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
Ehcache.isExpired(net.sf.ehcache.Element)
public Element get(Serializable arg0) throws IllegalStateException, CacheException
Ehcache.getQuiet(Object)
to peak into the Element to see its last access time with get
get
in interface Ehcache
arg0
- a serializable value
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
Ehcache.isExpired(net.sf.ehcache.Element)
public void put(Element arg0) throws IllegalArgumentException, IllegalStateException, CacheException
put
in interface Ehcache
arg0
- An object. If Serializable it can fully participate in replication and the DiskStore.
IllegalArgumentException
- if the element is null
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
public void put(Element arg0, boolean arg1) throws IllegalArgumentException, IllegalStateException, CacheException
put
in interface Ehcache
arg0
- An object. If Serializable it can fully participate in replication and the DiskStore.arg1
- whether the put is coming from a doNotNotifyCacheReplicators cache peer, in which case this put should not initiate a
further notification to doNotNotifyCacheReplicators cache peers
IllegalArgumentException
- if the element is null
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
public Object clone() throws CloneNotSupportedException
MemoryStore
or DiskStore
has been created.
A new, empty, RegisteredEventListeners is created on clone.
clone
in interface Ehcache
clone
in class Object
Cache
CloneNotSupportedException
public String getName()
getName
in interface Ehcache
public Element replace(Element arg0) throws NullPointerException
replace
in interface Ehcache
arg0
- Element to be cached
NullPointerException
- if the Element is null or has a null keypublic boolean replace(Element arg0, Element arg1) throws NullPointerException, IllegalArgumentException
replace
in interface Ehcache
arg0
- Element to be test againstarg1
- Element to be cached
NullPointerException
- if the either Element is null or has a null key
IllegalArgumentException
- if the two Element keys are non-null but not equalpublic void putAll(Collection arg0) throws IllegalArgumentException, IllegalStateException, CacheException
This method will throw a NullPointerException
if a null element or null key is encountered
in the collection, and a partial completion may result (as only some of the elements may have been put).
For each element that is put the registered CacheEventListener
s are notified of a newly put item
(notifyElementPut(...)
)
regardless of whether the individual put is a new put or an update.
putAll
in interface Ehcache
arg0
- the collection of elements to be put in the cache.
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
IllegalArgumentException
public boolean remove(Serializable arg0, boolean arg1) throws IllegalStateException
Element
from the Cache. This also removes it from any
stores it may be in.
Also notifies the CacheEventListener after the element was removed, but only if an Element
with the key actually existed.
remove
in interface Ehcache
arg1
- whether the put is coming from a doNotNotifyCacheReplicators cache peer, in which case this put should not initiate a
further notification to doNotNotifyCacheReplicators cache peers
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public boolean remove(Object arg0) throws IllegalStateException
Element
from the Cache. This also removes it from any
stores it may be in.
Also notifies the CacheEventListener after the element was removed, but only if an Element
with the key actually existed.
remove
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public boolean remove(Serializable arg0) throws IllegalStateException
Element
from the Cache. This also removes it from any
stores it may be in.
Also notifies the CacheEventListener after the element was removed.
remove
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public boolean remove(Object arg0, boolean arg1) throws IllegalStateException
Element
from the Cache. This also removes it from any
stores it may be in.
Also notifies the CacheEventListener after the element was removed, but only if an Element
with the key actually existed.
remove
in interface Ehcache
arg1
- whether the put is coming from a doNotNotifyCacheReplicators cache peer, in which case this put should not initiate a
further notification to doNotNotifyCacheReplicators cache peers
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public void load(Object arg0) throws CacheException
SelfPopulatingCache
load
in interface Ehcache
arg0
- key whose associated value to be loaded using the associated cacheloader if this cache doesn't contain it.
CacheException
public void setName(String arg0)
setName
in interface Ehcache
arg0
- the name of the cache. Should not be null.public void flush() throws IllegalStateException, CacheException
flush
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
public int getSize() throws IllegalStateException, CacheException
Element
s in the MemoryStore
plus
the number of Element
s in the DiskStore
.
This number is the actual number of elements, including expired elements that have
not been removed.
Expired elements are removed from the the memory store when
getting an expired element, or when attempting to spool an expired element to
disk.
Expired elements are removed from the disk store when getting an expired element,
or when the expiry thread runs, which is once every five minutes.
To get an exact size, which would exclude expired elements, use Ehcache.getKeysWithExpiryCheck()
.size(),
although see that method for the approximate time that would take.
To get a very fast result, use Ehcache.getKeysNoDuplicateCheck()
.size(). If the disk store
is being used, there will be some duplicates.
Note:getSize() is a very expensive operation in off-heap, disk and Terracotta implementations.
getSize
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
public boolean removeElement(Element arg0) throws NullPointerException
This is equivalent to
if (elementValueComparator.equals(cache.get(element.getObjectKey()), element)) { return cache.remove(element.getObjectKey()); } else return false;except that the action is performed atomically.
removeElement
in interface Ehcache
arg0
- Element to be removed
true
if the value was removed
NullPointerException
- if the element is null, or has a null keyCacheConfiguration.addElementValueComparator(net.sf.ehcache.config.ElementValueComparatorConfiguration)
public void removeAll(boolean arg0) throws IllegalStateException, CacheException
NonstopConfiguration.getBulkOpsTimeoutMultiplyFactor()
times the timeout value in the nonstop config.
removeAll
in interface Ehcache
arg0
- whether the put is coming from a doNotNotifyCacheReplicators cache peer,
in which case this put should not initiate a further notification to doNotNotifyCacheReplicators cache peers
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
public void removeAll() throws IllegalStateException, CacheException
NonstopConfiguration.getBulkOpsTimeoutMultiplyFactor()
times the timeout value in the nonstop config.
removeAll
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
public void removeAll(Collection arg0, boolean arg1) throws IllegalStateException, NullPointerException
NonstopConfiguration.getBulkOpsTimeoutMultiplyFactor()
times the timeout value in the nonstop config.
removeAll
in interface Ehcache
arg1
- whether the put is coming from a doNotNotifyCacheReplicators cache peer,
in which case this put should not initiate a further notification to doNotNotifyCacheReplicators cache peers
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
NullPointerException
public void removeAll(Collection arg0) throws IllegalStateException, NullPointerException
Element
from the Cache. This also removes them from any
stores it may be in. Throws a NullPointerException if any key in the collection is null
Also notifies the CacheEventListener after the elements were removed.
Notification is sent for every key irrespective of whether the key was present in the cache or not
This operation is partially completed if any element or any key is null
removeAll
in interface Ehcache
arg0
- a collection of keys to operate on
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
NullPointerException
- if any key is null in the collectionpublic Element putIfAbsent(Element arg0) throws NullPointerException
putIfAbsent
in interface Ehcache
arg0
- element to be added
NullPointerException
- if the element is null, or has a null keypublic Element putIfAbsent(Element arg0, boolean arg1) throws NullPointerException
putIfAbsent
in interface Ehcache
arg0
- element to be addedarg1
- whether the put is coming from a doNotNotifyCacheReplicators cache peer, in which case this put should not initiate a
further notification to doNotNotifyCacheReplicators cache peers
NullPointerException
- if the element is null, or has a null keypublic void addPropertyChangeListener(PropertyChangeListener arg0)
addPropertyChangeListener
in interface Ehcache
public void removePropertyChangeListener(PropertyChangeListener arg0)
removePropertyChangeListener
in interface Ehcache
public void dispose() throws IllegalStateException
dispose
in interface Ehcache
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public List getKeys() throws IllegalStateException, CacheException
getKeys
in interface Ehcache
Object
keys
IllegalStateException
- if the cache is not Status.STATUS_ALIVE
CacheException
public Status getStatus()
getStatus
in interface Ehcache
|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |