org.jahia.services.cache.ehcache

Class EhCacheImpl

java.lang.Object

org.jahia.services.cache.ehcache.EhCacheImpl

All Implemented Interfaces:

CacheImplementation, CacheStatistics

public class EhCacheImpl
extends Object
implements CacheImplementation, CacheStatistics

Ehcache based caching implementation.

Author:

Serge Huber

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EhCacheImpl(String name, net.sf.ehcache.CacheManager ehCacheManager, EhCacheProvider provider)

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(Object key) Deprecated.
void	flushAll(boolean propagate)
void	flushGroup(String groupName)
protected void	flushKeys(Set keysToFlush)
Object	get(Object key)
double	getCacheEfficiency() Retrieves the percentage of cache hit that could successfully be served.
Set	getGroupKeys(String groupName)
long	getGroupsKeysTotal() Get the total number of keys in all the groups of this cache.
long	getGroupsSize() Get the number of groups for this cache.
Collection<Object>	getKeys()
String	getName()
long	getSuccessHits() Retrieves the number of cache hits that could successfully be served.
long	getTotalHits() Retrieves the total number of cache hits.
boolean	isEmpty()
void	put(Object key, String[] groups, Object value) Puts an entry in the cache, using optional groups
void	remove(Object key)
void	setName(String name)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCacheImpl

protected EhCacheImpl(String name,
                      net.sf.ehcache.CacheManager ehCacheManager,
                      EhCacheProvider provider)

Method Detail

containsKey

@Deprecated
public boolean containsKey(Object key)

Deprecated.

Specified by:

containsKey in interface CacheImplementation

get

public Object get(Object key)

Specified by:

get in interface CacheImplementation

put

public void put(Object key,
                String[] groups,
                Object value)

Description copied from interface: CacheImplementation

Puts an entry in the cache, using optional groups

Specified by:

put in interface CacheImplementation

groups - the groups this entry should be part of, or null if it's part of no group.

size

public int size()

Specified by:

size in interface CacheImplementation

getGroupsSize

public long getGroupsSize()

Description copied from interface: CacheImplementation

Get the number of groups for this cache. This is an approximate value as it is not synchronized.

Specified by:

getGroupsSize in interface CacheImplementation

Returns:

a long representing the number of elements in the cache groups LRUMap.

getGroupsKeysTotal

public long getGroupsKeysTotal()

Description copied from interface: CacheImplementation

Get the total number of keys in all the groups of this cache. This is an approximate value as it is not cached.

Specified by:

getGroupsKeysTotal in interface CacheImplementation

Returns:

a long representing the number of keys in all the groups.

flushAll

public void flushAll(boolean propagate)

Specified by:

flushAll in interface CacheImplementation

remove

public void remove(Object key)

Specified by:

remove in interface CacheImplementation

getName

public String getName()

Specified by:

getName in interface CacheImplementation

setName

public void setName(String name)

Specified by:

setName in interface CacheImplementation

flushGroup

public void flushGroup(String groupName)

Specified by:

flushGroup in interface CacheImplementation

getGroupKeys

public Set getGroupKeys(String groupName)

Specified by:

getGroupKeys in interface CacheImplementation

flushKeys

protected void flushKeys(Set keysToFlush)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface CacheImplementation

getKeys

public Collection<Object> getKeys()

Specified by:

getKeys in interface CacheImplementation

getCacheEfficiency

public double getCacheEfficiency()

Description copied from interface: CacheStatistics

Retrieves the percentage of cache hit that could successfully be served. This efficiency is useful for tuning the maximum cache size. Cache size should be changed increased for low efficiency percentages.

Specified by:

getCacheEfficiency in interface CacheStatistics

Returns:

the percentage of cache hit that could successfully be served

getSuccessHits

public long getSuccessHits()

Description copied from interface: CacheStatistics

Retrieves the number of cache hits that could successfully be served.

Specified by:

getSuccessHits in interface CacheStatistics

Returns:

the number of cache hits that could successfully be served

getTotalHits

public long getTotalHits()

Description copied from interface: CacheStatistics

Retrieves the total number of cache hits.

Specified by:

getTotalHits in interface CacheStatistics

Returns:

the number of cache hits