org.springframework.extensions.surf.persister

Class AbstractCachedObjectPersister

java.lang.Object

org.springframework.extensions.surf.persister.AbstractObjectPersister

org.springframework.extensions.surf.persister.AbstractCachedObjectPersister

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, ModelObjectPersister, CachedPersister

Direct Known Subclasses:

ReadOnlyStoreObjectPersister

public abstract class AbstractCachedObjectPersister
extends AbstractObjectPersister
implements CachedPersister

Extends the abstract implementation by offering the basics of a caching layer.

Author:

muzquiano, kevinr

Field Summary

Fields

Modifier and Type	Field and Description
protected long	cacheDelay
protected int	cacheMaxSize
protected Map<String,ContentCache<ModelObject>>	caches
protected static String	GLOBAL_STORE_ID_SUFFIX
protected boolean	useCache

Fields inherited from class org.springframework.extensions.surf.persister.AbstractObjectPersister

MODELOBJECT_CLASSES

Constructor Summary

Constructors

Constructor and Description
AbstractCachedObjectPersister() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cachePut(ModelPersistenceContext context, ModelObject obj) Places an object into this persister's cache.
protected void	cacheRemove(ModelPersistenceContext context, ModelObject obj) Removes an object from the cache
protected abstract ContentCache<ModelObject>	createCache() Creates a new cache.
protected abstract ContentCache<ModelObject>	getCache(ModelPersistenceContext context, String bucket) Gets the cache for a particular model persistence context
void	invalidateCache() Invalidates the cache
void	setCache(boolean useCache) Enables or disables the caching mechanics
void	setCacheCheckDelay(int cacheCheckDelay) Sets the number of seconds to wait between cache checks, -1 for never.
void	setCacheMaxSize(int cacheMaxSize) Sets the maximum size of the underlying cache, -1 for no max size.

Methods inherited from class org.springframework.extensions.surf.persister.AbstractObjectPersister

disable, getId, getPersisterService, getServiceRegistry, getWebFrameworkConfiguration, hasObject, init, isEnabled, removeObject, reset, setBeanName, setPersisterService, setServiceRegistry, setWebFrameworkConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.extensions.surf.ModelObjectPersister

getAllObjects, getAllObjectsByFilter, getObject, getTimestamp, hasObject, hasReadOnlyStore, newObject, removeObject, saveObject, saveObjects

Field Detail

GLOBAL_STORE_ID_SUFFIX

protected static final String GLOBAL_STORE_ID_SUFFIX

See Also:

Constant Field Values

caches

protected final Map<String,ContentCache<ModelObject>> caches

useCache

protected boolean useCache

cacheDelay

protected long cacheDelay

cacheMaxSize

protected int cacheMaxSize

Constructor Detail

AbstractCachedObjectPersister

public AbstractCachedObjectPersister()

Constructor

Method Detail

getCache

protected abstract ContentCache<ModelObject> getCache(ModelPersistenceContext context,
                                 String bucket)

Gets the cache for a particular model persistence context

Parameters:

context - ModelPersistenceContext

bucket - Cache bucket to pick

Returns:

the cache

createCache

protected abstract ContentCache<ModelObject> createCache()

Creates a new cache.

Returns:

the cache

cachePut

protected void cachePut(ModelPersistenceContext context,
            ModelObject obj)

Places an object into this persister's cache.

Parameters:

context - the context

obj - the obj

cacheRemove

protected void cacheRemove(ModelPersistenceContext context,
               ModelObject obj)

Removes an object from the cache

Parameters:

context - the context

obj - ModelObject

setCache

public void setCache(boolean useCache)

Description copied from interface: CachedPersister

Enables or disables the caching mechanics

Specified by:

setCache in interface CachedPersister

Parameters:

useCache - boolean

See Also:

CachedPersister.setCache(boolean)

setCacheCheckDelay

public void setCacheCheckDelay(int cacheCheckDelay)

Description copied from interface: CachedPersister

Sets the number of seconds to wait between cache checks, -1 for never.

Specified by:

setCacheCheckDelay in interface CachedPersister

Parameters:

cacheCheckDelay - int

See Also:

CachedPersister.setCacheCheckDelay(int)

setCacheMaxSize

public void setCacheMaxSize(int cacheMaxSize)

Description copied from interface: CachedPersister

Sets the maximum size of the underlying cache, -1 for no max size.

Specified by:

setCacheMaxSize in interface CachedPersister

Parameters:

cacheMaxSize - int

See Also:

CachedPersister.setCacheMaxSize(int)

invalidateCache

public void invalidateCache()

Description copied from interface: CachedPersister

Invalidates the cache

Specified by:

invalidateCache in interface CachedPersister

See Also:

CachedPersister.invalidateCache()