ehcache-core 2.10.9.2 · net.sf.ehcache.transaction.local.LocalTransactionStore

Modifier and Type	Field and Description
private final Ehcache	cache
private final String	cacheName Hides net.sf.ehcache.store.AbstractStore.cacheName.
private final ElementValueComparator	comparator
private static final Logger	LOG
private final SoftLockManager	softLockManager
private final TransactionController	transactionController
private final TransactionIDFactory	transactionIdFactory

Access	Constructor and Description
public	LocalTransactionStore(TransactionController the TransactionController transactionController, TransactionIDFactory transactionIdFactory, SoftLockManager the SoftLockManager softLockManager, Ehcache the cache cache, Store the underlying store store, ElementValueComparator the element value comparator comparator) Create a new LocalTransactionStore instance

Method Summary

Modifier and Type	Method and Description
private void	assertNotTimedOut()
private boolean	cleanupExpiredSoftLock(Element oldElement, SoftLockID softLockId)
pack-priv void	commit(List<SoftLock> the soft locks to commit softLocks, TransactionID the transaction ID to commit transactionId) Commit work of the specified soft locks
public boolean	containsKey(Object The Element key key) Implements net.sf.ehcache.store.Store.containsKey. A check to see if a key is in the Store.
private Element	createElement(Object key, SoftLockID softLockId)
public void	dispose() Overrides net.sf.ehcache.transaction.AbstractTransactionStore.dispose. Implements net.sf.ehcache.store.Store.dispose. Prepares for shutdown.
public Element	get(Object key) Implements net.sf.ehcache.store.Store.get. Gets an item from the cache.
pack-priv Ehcache	Returns: the cache using this store getCache() Get the cache using this store
private LocalTransactionContext	getCurrentTransactionContext()
public List<E>	getKeys() Implements net.sf.ehcache.store.Store.getKeys. Gets an Array of the keys for all elements in the disk store.
public Element	getQuiet(Object key) Implements net.sf.ehcache.store.Store.getQuiet. Gets an `Element` from the Store, without updating statistics
public int	getSize() Implements net.sf.ehcache.store.Store.getSize. Returns the current local store size
public int	getTerracottaClusteredSize() Implements net.sf.ehcache.store.Store.getTerracottaClusteredSize. Returns the current Terracotta clustered store size
public boolean	put(Element element) Implements net.sf.ehcache.store.Store.put. Puts an item into the store.
public Element	putIfAbsent(Element element to be added element) Implements net.sf.ehcache.store.Store.putIfAbsent. Put an element in the store if no element is currently mapped to the elements key.
public boolean	putWithWriter(final Element element, final CacheWriterManager writerManager) Implements net.sf.ehcache.store.Store.putWithWriter. Puts an item into the store and the cache writer manager in an atomic operation
public Set<TransactionID>	Returns: a set of transaction IDs that were recovered recover() Recover and resolve all known soft locks
public Element	remove(Object key) Implements net.sf.ehcache.store.Store.remove. Removes an item from the cache.
public void	removeAll() Implements net.sf.ehcache.store.Store.removeAll. Remove all of the elements from the store.
public Element	removeElement(Element Element to be removed element, ElementValueComparator ElementValueComparator to use to compare elements comparator) Implements net.sf.ehcache.store.Store.removeElement. 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.
public Element	removeWithWriter(final Object key, final CacheWriterManager writerManager) Implements net.sf.ehcache.store.Store.removeWithWriter. Removes an item from the store and the cache writer manager in an atomic operation.
public boolean	replace(Element Element to be test against old, Element Element to be cached element, ElementValueComparator ElementValueComparator to use to compare elements comparator) Implements net.sf.ehcache.store.Store.replace. Replace the cached element only if the value of the current Element is equal to the value of the supplied old Element.
public Element	replace(Element Element to be cached element) Implements net.sf.ehcache.store.Store.replace. Replace the cached element only if an Element is currently cached for this key
pack-priv void	rollback(List<SoftLock> the soft locks to rollback softLocks, TransactionID the transaction ID to rollback transactionId) Rollback work of the specified soft locks
private long	timeBeforeTimeout()

cache	back to summary
private final Ehcache cache

cacheName	back to summary
private final String cacheName Hides net.sf.ehcache.store.AbstractStore.cacheName.

comparator	back to summary
private final ElementValueComparator comparator

LOG	back to summary
private static final Logger LOG

softLockManager	back to summary
private final SoftLockManager softLockManager

transactionController	back to summary
private final TransactionController transactionController

transactionIdFactory	back to summary
private final TransactionIDFactory transactionIdFactory

LocalTransactionStore	back to summary
public LocalTransactionStore(TransactionController transactionController, TransactionIDFactory transactionIdFactory, SoftLockManager softLockManager, Ehcache cache, Store store, ElementValueComparator comparator) Create a new LocalTransactionStore instance Parameters transactionController:TransactionController the TransactionController softLockManager:SoftLockManager the SoftLockManager cache:Ehcache the cache store:Store the underlying store comparator:ElementValueComparator the element value comparator

Method Detail

assertNotTimedOut	back to summary
private void assertNotTimedOut()

cleanupExpiredSoftLock	back to summary
private boolean cleanupExpiredSoftLock(Element oldElement, SoftLockID softLockId)

commit	back to summary
pack-priv void commit(List<SoftLock> softLocks, TransactionID transactionId) Commit work of the specified soft locks Parameters softLocks:List<SoftLock> the soft locks to commit transactionId:TransactionID the transaction ID to commit

commit

back to summary

pack-priv void commit(List<SoftLock> softLocks, TransactionID transactionId)

Commit work of the specified soft locks

Parameters

softLocks:List<SoftLock>: the soft locks to commit
transactionId:TransactionID: the transaction ID to commit

containsKey	back to summary
public boolean containsKey(Object key) Implements net.sf.ehcache.store.Store.containsKey. Doc from net.sf.ehcache.store.Store.containsKey. A check to see if a key is in the Store. Parameters key:Object The Element key Returns:boolean true if found. No check is made to see if the Element is expired. 1.2

containsKey

back to summary

public boolean containsKey(Object key)

Implements net.sf.ehcache.store.Store.containsKey.

Doc from net.sf.ehcache.store.Store.containsKey.

A check to see if a key is in the Store.

Parameters

key:Object: The Element key

Returns:boolean

true if found. No check is made to see if the Element is expired. 1.2

createElement	back to summary
private Element createElement(Object key, SoftLockID softLockId)

dispose	back to summary
public void dispose() Overrides net.sf.ehcache.transaction.AbstractTransactionStore.dispose. Implements net.sf.ehcache.store.Store.dispose. Doc from net.sf.ehcache.transaction.AbstractTransactionStore.dispose. Prepares for shutdown. Annotations @Override

dispose

back to summary

public void dispose()

Overrides net.sf.ehcache.transaction.AbstractTransactionStore.dispose.

Implements net.sf.ehcache.store.Store.dispose.

Doc from net.sf.ehcache.transaction.AbstractTransactionStore.dispose.

Prepares for shutdown.

Annotations

@Override

get	back to summary
public Element get(Object key) Implements net.sf.ehcache.store.Store.get. Doc from net.sf.ehcache.store.Store.get. Gets an item from the cache.

get

back to summary

public Element get(Object key)

Implements net.sf.ehcache.store.Store.get.

Doc from net.sf.ehcache.store.Store.get.

Gets an item from the cache.

getCache	back to summary
pack-priv Ehcache getCache() Get the cache using this store Returns:Ehcache the cache using this store

getCache

back to summary

pack-priv Ehcache getCache()

Get the cache using this store

Returns:Ehcache: the cache using this store

getCurrentTransactionContext	back to summary
private LocalTransactionContext getCurrentTransactionContext()

getKeys back to summary

getKeys	back to summary
public List<E> getKeys() Implements net.sf.ehcache.store.Store.getKeys. Doc from net.sf.ehcache.store.Store.getKeys. Gets an Array of the keys for all elements in the disk store. Returns:List<E> An List of `java.io.Serializable` keys

public List<E> getKeys()

Implements net.sf.ehcache.store.Store.getKeys.

Doc from net.sf.ehcache.store.Store.getKeys.

Gets an Array of the keys for all elements in the disk store.

Returns:List<E>: An List of java.io.Serializable keys

getQuiet back to summary

getQuiet	back to summary
public Element getQuiet(Object key) Implements net.sf.ehcache.store.Store.getQuiet. Doc from net.sf.ehcache.store.Store.getQuiet. Gets an `Element` from the Store, without updating statistics Returns:Element The element

public Element getQuiet(Object key)

Implements net.sf.ehcache.store.Store.getQuiet.

Doc from net.sf.ehcache.store.Store.getQuiet.

Gets an Element from the Store, without updating statistics

Returns:Element: The element

getSize	back to summary
public int getSize() Implements net.sf.ehcache.store.Store.getSize. Doc from net.sf.ehcache.store.Store.getSize. Returns the current local store size Returns:int the count of the Elements in the Store on the local machine

getSize

back to summary

public int getSize()

Implements net.sf.ehcache.store.Store.getSize.

Doc from net.sf.ehcache.store.Store.getSize.

Returns the current local store size

Returns:int: the count of the Elements in the Store on the local machine

getTerracottaClusteredSize	back to summary
public int getTerracottaClusteredSize() Implements net.sf.ehcache.store.Store.getTerracottaClusteredSize. Doc from net.sf.ehcache.store.Store.getTerracottaClusteredSize. Returns the current Terracotta clustered store size Returns:int the count of the Elements in the Store across the cluster

getTerracottaClusteredSize

back to summary

public int getTerracottaClusteredSize()

Implements net.sf.ehcache.store.Store.getTerracottaClusteredSize.

Doc from net.sf.ehcache.store.Store.getTerracottaClusteredSize.

Returns the current Terracotta clustered store size

Returns:int: the count of the Elements in the Store across the cluster

put	back to summary
public boolean put(Element element) throws CacheException Implements net.sf.ehcache.store.Store.put. Doc from net.sf.ehcache.store.Store.put. Puts an item into the store. Returns:boolean true if this is a new put for the key or element is null. Returns false if it was an update.

put

back to summary

public boolean put(Element element) throws CacheException

Implements net.sf.ehcache.store.Store.put.

Doc from net.sf.ehcache.store.Store.put.

Puts an item into the store.

Returns:boolean: true if this is a new put for the key or element is null. Returns false if it was an update.

putIfAbsent	back to summary
public Element putIfAbsent(Element element) throws NullPointerException Implements net.sf.ehcache.store.Store.putIfAbsent. Doc from net.sf.ehcache.store.Store.putIfAbsent. Put an element in the store if no element is currently mapped to the elements key. Parameters element:Element element to be added Returns:Element the element previously cached for this key, or null if none. Exceptions NullPointerException: if the element is null, or has a null key

putIfAbsent

back to summary

public Element putIfAbsent(Element element) throws NullPointerException

Implements net.sf.ehcache.store.Store.putIfAbsent.

Doc from net.sf.ehcache.store.Store.putIfAbsent.

Put an element in the store if no element is currently mapped to the elements key.

Parameters

element:Element: element to be added

Returns:Element

the element previously cached for this key, or null if none.

Exceptions

NullPointerException:: if the element is null, or has a null key

putWithWriter	back to summary
public boolean putWithWriter(final Element element, final CacheWriterManager writerManager) throws CacheException Implements net.sf.ehcache.store.Store.putWithWriter. Doc from net.sf.ehcache.store.Store.putWithWriter. Puts an item into the store and the cache writer manager in an atomic operation Returns:boolean true if this is a new put for the key or element is null. Returns false if it was an update.

putWithWriter

back to summary

public boolean putWithWriter(final Element element, final CacheWriterManager writerManager) throws CacheException

Implements net.sf.ehcache.store.Store.putWithWriter.

Doc from net.sf.ehcache.store.Store.putWithWriter.

Puts an item into the store and the cache writer manager in an atomic operation

Returns:boolean: true if this is a new put for the key or element is null. Returns false if it was an update.

recover	back to summary
public Set<TransactionID> recover() Recover and resolve all known soft locks Returns:Set<TransactionID> a set of transaction IDs that were recovered

recover

back to summary

public Set<TransactionID> recover()

Recover and resolve all known soft locks

Returns:Set<TransactionID>: a set of transaction IDs that were recovered

remove	back to summary
public Element remove(Object key) Implements net.sf.ehcache.store.Store.remove. Doc from net.sf.ehcache.store.Store.remove. Removes an item from the cache.

remove

back to summary

public Element remove(Object key)

Implements net.sf.ehcache.store.Store.remove.

Doc from net.sf.ehcache.store.Store.remove.

Removes an item from the cache.

removeAll back to summary

removeAll	back to summary
public void removeAll() throws CacheException Implements net.sf.ehcache.store.Store.removeAll. Doc from net.sf.ehcache.store.Store.removeAll. Remove all of the elements from the store. If there are registered `CacheEventListener`s they are notified of the expiry or removal of the `Element` as each is removed.

public void removeAll() throws CacheException

Implements net.sf.ehcache.store.Store.removeAll.

Doc from net.sf.ehcache.store.Store.removeAll.

Remove all of the elements from the store.

If there are registered CacheEventListeners they are notified of the expiry or removal of the Element as each is removed.

removeElement	back to summary
public Element removeElement(Element element, ElementValueComparator comparator) throws NullPointerException Implements net.sf.ehcache.store.Store.removeElement. Doc from net.sf.ehcache.store.Store.removeElement. 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. This is a CAS operation. It is consistent even against a distributed cache that is not coherent. If the old value is stale when this operation is attempted the remove does not take place. Parameters element:Element Element to be removed comparator:ElementValueComparator ElementValueComparator to use to compare elements Returns:Element the Element removed or null if no Element was removed Exceptions NullPointerException: if the element is null, or has a null key

removeElement

back to summary

public Element removeElement(Element element, ElementValueComparator comparator) throws NullPointerException

Implements net.sf.ehcache.store.Store.removeElement.

Doc from net.sf.ehcache.store.Store.removeElement.

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. This is a CAS operation. It is consistent even against a distributed cache that is not coherent. If the old value is stale when this operation is attempted the remove does not take place.

Parameters

element:Element: Element to be removed
comparator:ElementValueComparator: ElementValueComparator to use to compare elements

Returns:Element

the Element removed or null if no Element was removed

Exceptions

NullPointerException:: if the element is null, or has a null key

removeWithWriter	back to summary
public Element removeWithWriter(final Object key, final CacheWriterManager writerManager) throws CacheException Implements net.sf.ehcache.store.Store.removeWithWriter. Doc from net.sf.ehcache.store.Store.removeWithWriter. Removes an item from the store and the cache writer manager in an atomic operation.

removeWithWriter

back to summary

public Element removeWithWriter(final Object key, final CacheWriterManager writerManager) throws CacheException

Implements net.sf.ehcache.store.Store.removeWithWriter.

Doc from net.sf.ehcache.store.Store.removeWithWriter.

Removes an item from the store and the cache writer manager in an atomic operation.

replace	back to summary
public boolean replace(Element old, Element element, ElementValueComparator comparator) throws NullPointerException, IllegalArgumentException Implements net.sf.ehcache.store.Store.replace. Doc from net.sf.ehcache.store.Store.replace. Replace the cached element only if the value of the current Element is equal to the value of the supplied old Element. Parameters old:Element Element to be test against element:Element Element to be cached comparator:ElementValueComparator ElementValueComparator to use to compare elements Returns:boolean true is the Element was replaced Exceptions NullPointerException: if the either Element is null or has a null key IllegalArgumentException: if the two Element keys are non-null but not equal

replace

back to summary

public boolean replace(Element old, Element element, ElementValueComparator comparator) throws NullPointerException, IllegalArgumentException

Implements net.sf.ehcache.store.Store.replace.

Doc from net.sf.ehcache.store.Store.replace.

Replace the cached element only if the value of the current Element is equal to the value of the supplied old Element.

Parameters

old:Element: Element to be test against
element:Element: Element to be cached
comparator:ElementValueComparator: ElementValueComparator to use to compare elements

Returns:boolean

true is the Element was replaced

Exceptions

NullPointerException:: if the either Element is null or has a null key
IllegalArgumentException:: if the two Element keys are non-null but not equal

replace	back to summary
public Element replace(Element element) throws NullPointerException Implements net.sf.ehcache.store.Store.replace. Doc from net.sf.ehcache.store.Store.replace. Replace the cached element only if an Element is currently cached for this key Parameters element:Element Element to be cached Returns:Element the Element previously cached for this key, or null if no Element was cached Exceptions NullPointerException: if the Element is null or has a null key

replace

back to summary

public Element replace(Element element) throws NullPointerException

Implements net.sf.ehcache.store.Store.replace.

Doc from net.sf.ehcache.store.Store.replace.

Replace the cached element only if an Element is currently cached for this key

Parameters

element:Element: Element to be cached

Returns:Element

the Element previously cached for this key, or null if no Element was cached

Exceptions

NullPointerException:: if the Element is null or has a null key

rollback	back to summary
pack-priv void rollback(List<SoftLock> softLocks, TransactionID transactionId) Rollback work of the specified soft locks Parameters softLocks:List<SoftLock> the soft locks to rollback transactionId:TransactionID the transaction ID to rollback

rollback

back to summary

pack-priv void rollback(List<SoftLock> softLocks, TransactionID transactionId)

Rollback work of the specified soft locks

Parameters

softLocks:List<SoftLock>: the soft locks to rollback
transactionId:TransactionID: the transaction ID to rollback

timeBeforeTimeout	back to summary
private long timeBeforeTimeout()

public Class LocalTransactionStore

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail