de.hybris.platform.regioncache.region.impl

Class EHCacheRegion

java.lang.Object

de.hybris.platform.regioncache.region.impl.EHCacheRegion

All Implemented Interfaces:

CacheRegion

Direct Known Subclasses:

CacheAccessImpl

public class EHCacheRegion
extends java.lang.Object
implements CacheRegion

Cache region implementation using EHCache.

Field Summary

Fields

Modifier and Type	Field and Description
protected Cache	cacheMap
protected CacheLifecycleCallback	lifecycleCallback
protected CacheManager	manager
protected CacheStatistics	stats

Constructor Summary

Constructors

Constructor and Description
EHCacheRegion(java.lang.String name, int maxEntries)
EHCacheRegion(java.lang.String name, int maxEntries, java.lang.String evictionPolicy)
EHCacheRegion(java.lang.String name, int maxEntries, java.lang.String evictionPolicy, boolean exclusiveComputation, boolean statsEnabled)
EHCacheRegion(java.lang.String name, int maxEntries, java.lang.String evictionPolicy, boolean exclusiveComputation, boolean statsEnabled, java.lang.Long ttlSeconds) Constructor that adds possibility to configure TTL seconds for cache elements.

Method Summary

Modifier and Type	Method and Description
void	clearCache() Removes all elements from cache.
boolean	containsKey(CacheKey key) Checks if key is in the cache map.
protected CacheConfiguration	createCacheConfiguration()
protected CacheEventListener	createCacheEventListener()
protected CacheStatistics	createCacheStatistics()
void	destroy() Method unregisters cache
java.lang.Object	get(CacheKey key) Gets value from the cache.
java.util.Collection<CacheKey>	getAllKeys() Returns all keys currently stored in this region.
long	getCacheMaxEntries() Gets number of cache entries above which invalidation occurs.
CacheStatistics	getCacheRegionStatistics() Gets statistics for current region.
java.lang.String[]	getHandledTypes() Gets types which can be stored in the region.
long	getMaxReachedSize() Returns number of elements currently in the cache
java.lang.String	getName() Gets region name.
java.lang.Object	getWithLoader(CacheKey key, CacheValueLoader loader) Gets value from cache.
void	init()
java.lang.Object	invalidate(CacheKey key, boolean fireEventsEvenIfNotRemoved) Invalidates (removes) value from cache map.
boolean	isStatsEnabled()
void	registerLifecycleCallback(CacheLifecycleCallback callback) This callback shall be called when eviction occurs.
java.lang.Object	remove(CacheKey key, boolean fireEvents) Removes value stored on the key specified.
void	setHandledTypes(java.lang.String[] handledTypes)
void	setStatsEnabled(boolean enabled)
java.lang.String	toString()
CacheRegion	unwrap()

Methods inherited from class java.lang.Object

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

Field Detail

lifecycleCallback

protected CacheLifecycleCallback lifecycleCallback

manager

protected CacheManager manager

cacheMap

protected Cache cacheMap

stats

protected final CacheStatistics stats

Constructor Detail

EHCacheRegion

public EHCacheRegion(java.lang.String name,
                     int maxEntries)

EHCacheRegion

public EHCacheRegion(java.lang.String name,
                     int maxEntries,
                     java.lang.String evictionPolicy)

EHCacheRegion

public EHCacheRegion(java.lang.String name,
                     int maxEntries,
                     java.lang.String evictionPolicy,
                     boolean exclusiveComputation,
                     boolean statsEnabled)

EHCacheRegion

public EHCacheRegion(java.lang.String name,
                     int maxEntries,
                     java.lang.String evictionPolicy,
                     boolean exclusiveComputation,
                     boolean statsEnabled,
                     java.lang.Long ttlSeconds)

Constructor that adds possibility to configure TTL seconds for cache elements.

Parameters:

ttlSeconds - time to live seconds for cache elements (see EHCache docs for information about how this affects cache operations)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createCacheStatistics

protected CacheStatistics createCacheStatistics()

createCacheConfiguration

protected CacheConfiguration createCacheConfiguration()

init

@PostConstruct
public void init()

destroy

@PreDestroy
public void destroy()

Method unregisters cache

createCacheEventListener

protected CacheEventListener createCacheEventListener()

get

public java.lang.Object get(CacheKey key)

Description copied from interface: CacheRegion

Gets value from the cache. If value is absent returns null. Must be thread safe.

Specified by:

get in interface CacheRegion

getMaxReachedSize

public long getMaxReachedSize()

Description copied from interface: CacheRegion

Returns number of elements currently in the cache

Specified by:

getMaxReachedSize in interface CacheRegion

getWithLoader

public java.lang.Object getWithLoader(CacheKey key,
                                      CacheValueLoader loader)
                               throws CacheValueLoadException

Description copied from interface: CacheRegion

Gets value from cache. Invokes loader if necessary. Must be thread safe.

Specified by:

getWithLoader in interface CacheRegion

Throws:

CacheValueLoadException

getName

public java.lang.String getName()

Description copied from interface: CacheRegion

Gets region name. Needed to resolve proper cache region.

Specified by:

getName in interface CacheRegion

getHandledTypes

public java.lang.String[] getHandledTypes()

Description copied from interface: CacheRegion

Gets types which can be stored in the region. Needed to resolve proper cache region.
Special type names are defined in RegionType.

Specified by:

getHandledTypes in interface CacheRegion

getCacheRegionStatistics

public CacheStatistics getCacheRegionStatistics()

Description copied from interface: CacheRegion

Gets statistics for current region.

Specified by:

getCacheRegionStatistics in interface CacheRegion

getCacheMaxEntries

public long getCacheMaxEntries()

Description copied from interface: CacheRegion

Gets number of cache entries above which invalidation occurs.

Specified by:

getCacheMaxEntries in interface CacheRegion

registerLifecycleCallback

public void registerLifecycleCallback(CacheLifecycleCallback callback)

Description copied from interface: CacheRegion

This callback shall be called when eviction occurs.

Specified by:

registerLifecycleCallback in interface CacheRegion

clearCache

public void clearCache()

Description copied from interface: CacheRegion

Removes all elements from cache.

Specified by:

clearCache in interface CacheRegion

invalidate

public java.lang.Object invalidate(CacheKey key,
                                   boolean fireEventsEvenIfNotRemoved)

Description copied from interface: CacheRegion

Invalidates (removes) value from cache map. Must be thread safe.

Specified by:

invalidate in interface CacheRegion

Returns:

an object invalidated from cache.

getAllKeys

public java.util.Collection<CacheKey> getAllKeys()

Description copied from interface: CacheRegion

Returns all keys currently stored in this region.

Specified by:

getAllKeys in interface CacheRegion

remove

public java.lang.Object remove(CacheKey key,
                               boolean fireEvents)

Description copied from interface: CacheRegion

Removes value stored on the key specified. This method does not update statistics. Returns value removed or null.

Specified by:

remove in interface CacheRegion

setHandledTypes

public void setHandledTypes(java.lang.String[] handledTypes)

Parameters:

handledTypes - the handledTypes to set

containsKey

public boolean containsKey(CacheKey key)

Description copied from interface: CacheRegion

Checks if key is in the cache map.

Specified by:

containsKey in interface CacheRegion

setStatsEnabled

public void setStatsEnabled(boolean enabled)

Specified by:

setStatsEnabled in interface CacheRegion

isStatsEnabled

public boolean isStatsEnabled()

Specified by:

isStatsEnabled in interface CacheRegion

unwrap

public CacheRegion unwrap()