info.magnolia.module.cache.blocking

Class AbstractBlockingCache

java.lang.Object

info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper

info.magnolia.module.cache.blocking.AbstractBlockingCache

All Implemented Interfaces:

BlockingCache, Cache

Direct Known Subclasses:

EhCache3Wrapper, MemcachedWrapper

public abstract class AbstractBlockingCache
extends AbstractListeningCacheWrapper
implements BlockingCache

Abstract implementation of BlockingCache.

Constructor Summary

Constructors

Constructor and Description
AbstractBlockingCache(String name, CacheModule cacheModule, Integer blockingTimeout)

Method Summary

Modifier and Type	Method and Description
Object	get(Object key)
int	getBlockingTimeout() If the timeout is reached an exception is thrown to unlock the blocked thread (in milliseconds).
String	getName()
boolean	hasElement(Object key)
void	put(Object key, Object value)
void	put(Object key, Object value, int timeToLiveInSeconds)
protected abstract void	putQuiet(Object key, Object value, int timeToLiveInSeconds)
void	unlock(Object key) Will unlock the key.

Methods inherited from class info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper

clear, getQuiet, getSize, remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface info.magnolia.module.cache.Cache

clear, getKeys, getQuiet, getSize, remove

Constructor Detail

AbstractBlockingCache

public AbstractBlockingCache(String name,
                             CacheModule cacheModule,
                             Integer blockingTimeout)

Method Detail

get

public final Object get(Object key)

Specified by:

get in interface Cache

Overrides:

get in class AbstractListeningCacheWrapper

hasElement

public final boolean hasElement(Object key)

Specified by:

hasElement in interface Cache

put

public final void put(Object key,
                      Object value)

Specified by:

put in interface Cache

Overrides:

put in class AbstractListeningCacheWrapper

put

public final void put(Object key,
                      Object value,
                      int timeToLiveInSeconds)

Specified by:

put in interface Cache

Overrides:

put in class AbstractListeningCacheWrapper

putQuiet

protected abstract void putQuiet(Object key,
                                 Object value,
                                 int timeToLiveInSeconds)

unlock

public final void unlock(Object key)

Description copied from interface: BlockingCache

Will unlock the key.

Specified by:

unlock in interface BlockingCache

getBlockingTimeout

public int getBlockingTimeout()

Description copied from interface: BlockingCache

If the timeout is reached an exception is thrown to unlock the blocked thread (in milliseconds). This guarantees that not all threads are waiting on a non-available resource.

Specified by:

getBlockingTimeout in interface BlockingCache

getName

public String getName()

Specified by:

getName in interface Cache

Specified by:

getName in class AbstractListeningCacheWrapper