com.foreach.across.modules.ehcache.config

Class AcrossEhCacheManagerFactoryBean

java.lang.Object

com.foreach.across.modules.ehcache.config.AcrossEhCacheManagerFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<net.sf.ehcache.CacheManager>, org.springframework.beans.factory.InitializingBean

public class AcrossEhCacheManagerFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<net.sf.ehcache.CacheManager>, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
AcrossEhCacheManagerFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
net.sf.ehcache.CacheManager	getObject()
Class<? extends net.sf.ehcache.CacheManager>	getObjectType()
boolean	isSingleton()
void	setAcceptExisting(boolean acceptExisting) Set whether an existing EhCache CacheManager of the same name will be accepted for this EhCacheManagerFactoryBean setup.
void	setCacheManagerName(String cacheManagerName) Set the name of the EhCache CacheManager (if a specific name is desired).
void	setConfigLocation(org.springframework.core.io.Resource resource) Set the location of the EhCache config file.
void	setConfiguration(net.sf.ehcache.config.Configuration configuration)
void	setShared(boolean shared) Set whether the EhCache CacheManager should be shared (as a singleton at the ClassLoader level) or independent (typically local within the application).

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

AcrossEhCacheManagerFactoryBean

public AcrossEhCacheManagerFactoryBean()

Method Detail

setConfigLocation

public void setConfigLocation(org.springframework.core.io.Resource resource)

Set the location of the EhCache config file. A typical value is "/WEB-INF/ehcache.xml".

Default is "ehcache.xml" in the root of the class path, or if not found, "ehcache-failsafe.xml" in the EhCache jar (default EhCache initialization).

See Also:

CacheManager.create(java.io.InputStream), CacheManager.CacheManager(java.io.InputStream)

setConfiguration

public void setConfiguration(net.sf.ehcache.config.Configuration configuration)

setCacheManagerName

public void setCacheManagerName(String cacheManagerName)

Set the name of the EhCache CacheManager (if a specific name is desired).

See Also:

net.sf.ehcache.CacheManager#setName(String)

setAcceptExisting

public void setAcceptExisting(boolean acceptExisting)

Set whether an existing EhCache CacheManager of the same name will be accepted for this EhCacheManagerFactoryBean setup. Default is "false".

Typically used in combination with "cacheManagerName" but will simply work with the default CacheManager name if none specified. All references to the same CacheManager name (or the same default) in the same ClassLoader space will share the specified CacheManager then.

NOTE: This feature requires EhCache 2.5 or higher. In contrast to the "shared" flag, it supports controlled shutdown of the CacheManager by the EhCacheManagerFactoryBean that actually created it.

See Also:

setCacheManagerName(java.lang.String), setShared(boolean), CacheManager.getCacheManager(String), CacheManager.CacheManager()

setShared

public void setShared(boolean shared)

Set whether the EhCache CacheManager should be shared (as a singleton at the ClassLoader level) or independent (typically local within the application). Default is "false", creating an independent local instance.

NOTE: This feature allows for sharing this EhCacheManagerFactoryBean's CacheManager with any code calling CacheManager.create() in the same ClassLoader space, with no need to agree on a specific CacheManager name. However, it only supports a single EhCacheManagerFactoryBean involved which will control the lifecycle of the underlying CacheManager (in particular, its shutdown).

This flag overrides "acceptExisting" if both are set, since it indicates the 'stronger' mode of sharing.

See Also:

setCacheManagerName(java.lang.String), setAcceptExisting(boolean), CacheManager.create(), CacheManager.CacheManager()

afterPropertiesSet

public void afterPropertiesSet()
                        throws IOException,
                               net.sf.ehcache.CacheException

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

IOException

net.sf.ehcache.CacheException

getObject

public net.sf.ehcache.CacheManager getObject()

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<net.sf.ehcache.CacheManager>

getObjectType

public Class<? extends net.sf.ehcache.CacheManager> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<net.sf.ehcache.CacheManager>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<net.sf.ehcache.CacheManager>

destroy

public void destroy()

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean