org.springframework.cache.ehcache
Class EhCacheManagerFactoryBean

java.lang.Object
  org.springframework.cache.ehcache.EhCacheManagerFactoryBean

All Implemented Interfaces:

DisposableBean, FactoryBean, InitializingBean

public class EhCacheManagerFactoryBean

extends java.lang.Object

implements FactoryBean, InitializingBean, DisposableBean

FactoryBean that exposes a EHCache CacheManager singleton, configured from a specified config location.

If no config location is specified, a CacheManager will be configured from "ehcache.xml" in the root of the class path (i.e., defautl EHCache initialization will apply).

Setting up a separate EhCacheManagerFactoryBean is also advisable when using EhCacheFactoryBean, as it cares for proper shutdown of the CacheManager. EhCacheManagerFactoryBean is also necessary for loading EHCache configuration from a non-default config location.

Since:

1.1.1

Author:

Dmitriy Kopylenko, Juergen Hoeller

See Also:

EhCacheFactoryBean, CacheManager

Field Summary

protected org.apache.commons.logging.Log

logger

Constructor Summary

EhCacheManagerFactoryBean()

Method Summary

void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
void	destroy() Invoked by a BeanFactory on destruction of a singleton.
java.lang.Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
java.lang.Class	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?
void	setConfigLocation(Resource configLocation) Set the location of the EHCache config file.

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

EhCacheManagerFactoryBean

public EhCacheManagerFactoryBean()

Method Detail

setConfigLocation

public void setConfigLocation(Resource configLocation)

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 (default EHCache initialization).

afterPropertiesSet

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

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

java.io.IOException

net.sf.ehcache.CacheException

getObject

public java.lang.Object getObject()

Description copied from interface: FactoryBean

Return an instance (possibly shared or independent) of the object managed by this factory. As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should never be null)

getObjectType

public java.lang.Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, e.g. on autowiring.

For a singleton, this can simply return getObject().getClass(), or even null, as autowiring will always check the actual objects for singletons. For prototypes, returning a meaningful type here is highly advisable, as autowiring will simply ignore them else.

Specified by:

getObjectType in interface FactoryBean

Returns:

the type of object that this FactoryBean creates, or null

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class, boolean, boolean)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? That is, will getObject() always return the same object?

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton

destroy

public void destroy()

Description copied from interface: DisposableBean

Invoked by a BeanFactory on destruction of a singleton.

Specified by:

destroy in interface DisposableBean