org.xwiki.cache.oscache.internal
Class OSCacheCache<T>

java.lang.Object
  org.xwiki.cache.util.AbstractCache<T>
      org.xwiki.cache.oscache.internal.OSCacheCache<T>

Type Parameters:

T - the class of the data stored in the cache.

All Implemented Interfaces:

com.opensymphony.oscache.base.events.CacheEntryEventListener, com.opensymphony.oscache.base.events.CacheEventListener, java.util.EventListener, Cache<T>

public class OSCacheCache<T>
extends AbstractCache<T>
implements com.opensymphony.oscache.base.events.CacheEntryEventListener

Implements Cache based on OSCache.

Version:

$Id$

Field Summary

Fields inherited from class org.xwiki.cache.util.AbstractCache

cacheEntryListeners, configuration

Constructor Summary

OSCacheCache()

Method Summary

java.lang.String	apiKey(java.lang.String cacheKey) Get the API cache key from the real cache key.
void	cacheEntryAdded(com.opensymphony.oscache.base.events.CacheEntryEvent event)
void	cacheEntryFlushed(com.opensymphony.oscache.base.events.CacheEntryEvent event)
void	cacheEntryRemoved(com.opensymphony.oscache.base.events.CacheEntryEvent event)
void	cacheEntryUpdated(com.opensymphony.oscache.base.events.CacheEntryEvent event)
void	cacheFlushed(com.opensymphony.oscache.base.events.CachewideEvent event)
void	cacheGroupFlushed(com.opensymphony.oscache.base.events.CacheGroupEvent event)
void	cachePatternFlushed(com.opensymphony.oscache.base.events.CachePatternEvent event)
void	dispose()
T	get(java.lang.String key)
void	initialize(OSCacheCacheConfiguration oscacheConfiguration) Create and initialize the cache.
void	remove(java.lang.String key)
void	removeAll()
void	set(java.lang.String key, T obj)

Methods inherited from class org.xwiki.cache.util.AbstractCache

addCacheEntryListener, disposeCacheValue, removeCacheEntryListener, sendEntryAddedEvent, sendEntryModifiedEvent, sendEntryRemovedEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

OSCacheCache

public OSCacheCache()

Method Detail

initialize

public void initialize(OSCacheCacheConfiguration oscacheConfiguration)

Create and initialize the cache.

Parameters:

oscacheConfiguration - the configuration to use to create the cache.

apiKey

public java.lang.String apiKey(java.lang.String cacheKey)

Get the API cache key from the real cache key.

Parameters:

cacheKey - the real cache.

Returns:

the API cache key.

remove

public void remove(java.lang.String key)

Specified by:

remove in interface Cache<T>

See Also:

Cache.remove(java.lang.String)

set

public void set(java.lang.String key,
                T obj)

Specified by:

set in interface Cache<T>

See Also:

Cache.set(java.lang.String, java.lang.Object)

get

public T get(java.lang.String key)

Specified by:

get in interface Cache<T>

See Also:

Cache.get(java.lang.String)

removeAll

public void removeAll()

Specified by:

removeAll in interface Cache<T>

See Also:

Cache.removeAll()

dispose

public void dispose()

Specified by:

dispose in interface Cache<T>

Overrides:

dispose in class AbstractCache<T>

See Also:

AbstractCache.dispose()

cacheEntryAdded

public void cacheEntryAdded(com.opensymphony.oscache.base.events.CacheEntryEvent event)

Specified by:

cacheEntryAdded in interface com.opensymphony.oscache.base.events.CacheEntryEventListener

See Also:

CacheEntryEventListener.cacheEntryAdded(com.opensymphony.oscache.base.events.CacheEntryEvent)

cacheEntryFlushed

public void cacheEntryFlushed(com.opensymphony.oscache.base.events.CacheEntryEvent event)

Specified by:

cacheEntryFlushed in interface com.opensymphony.oscache.base.events.CacheEntryEventListener

See Also:

CacheEntryEventListener.cacheEntryFlushed(com.opensymphony.oscache.base.events.CacheEntryEvent)

cacheEntryRemoved

public void cacheEntryRemoved(com.opensymphony.oscache.base.events.CacheEntryEvent event)

Specified by:

cacheEntryRemoved in interface com.opensymphony.oscache.base.events.CacheEntryEventListener

See Also:

CacheEntryEventListener.cacheEntryRemoved(com.opensymphony.oscache.base.events.CacheEntryEvent)

cacheEntryUpdated

public void cacheEntryUpdated(com.opensymphony.oscache.base.events.CacheEntryEvent event)

Specified by:

cacheEntryUpdated in interface com.opensymphony.oscache.base.events.CacheEntryEventListener

See Also:

CacheEntryEventListener.cacheEntryUpdated(com.opensymphony.oscache.base.events.CacheEntryEvent)

cacheGroupFlushed

public void cacheGroupFlushed(com.opensymphony.oscache.base.events.CacheGroupEvent event)

Specified by:

cacheGroupFlushed in interface com.opensymphony.oscache.base.events.CacheEntryEventListener

See Also:

CacheEntryEventListener.cacheGroupFlushed(com.opensymphony.oscache.base.events.CacheGroupEvent)

cachePatternFlushed

public void cachePatternFlushed(com.opensymphony.oscache.base.events.CachePatternEvent event)

Specified by:

cachePatternFlushed in interface com.opensymphony.oscache.base.events.CacheEntryEventListener

See Also:

CacheEntryEventListener.cachePatternFlushed(com.opensymphony.oscache.base.events.CachePatternEvent)

cacheFlushed

public void cacheFlushed(com.opensymphony.oscache.base.events.CachewideEvent event)

Specified by:

cacheFlushed in interface com.opensymphony.oscache.base.events.CacheEntryEventListener

See Also:

CacheEntryEventListener.cacheFlushed(com.opensymphony.oscache.base.events.CachewideEvent)