FactoryBean that exposes an EhCache CacheManager
instance (independent or shared), 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 (that is, default EhCache initialization
- as defined in the EhCache docs - will apply).
Setting up a separate EhCacheManagerFactoryBean is also advisable when using
EhCacheFactoryBean, as it provides a (by default) independent CacheManager instance
and cares for proper shutdown of the CacheManager. EhCacheManagerFactoryBean is
also necessary for loading EhCache configuration from a non-default config location.
Note: As of Spring 5.0, Spring's EhCache support requires EhCache 2.10 or higher.
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.
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.
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.
If this FactoryBean is not fully initialized yet at the time of
the call (for example because it is involved in a circular reference),
throw a corresponding FactoryBeanNotInitializedException.
As of Spring 2.0, FactoryBeans are allowed to return null
objects. The factory will consider this as normal value to be used; it
will not throw a FactoryBeanNotInitializedException in this case anymore.
FactoryBean implementations are encouraged to throw
FactoryBeanNotInitializedException themselves now, as appropriate.
Return the type of object that this FactoryBean creates,
or null if not known in advance.
This allows one to check for specific types of beans without
instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object,
this method should try to avoid singleton creation as far as possible;
it should rather estimate the type in advance.
For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has
been fully initialized. It must not rely on state created during
initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null here. Therefore it is highly recommended to implement
this method properly, using the current state of the FactoryBean.
Is the object managed by this factory a singleton? That is,
will FactoryBean.getObject() always return the same object
(a reference that can be cached)?
NOTE: If a FactoryBean indicates to hold a singleton object,
the object returned from getObject() might get cached
by the owning BeanFactory. Hence, do not return true
unless the FactoryBean always exposes the same reference.
The singleton status of the FactoryBean itself will generally
be provided by the owning BeanFactory; usually, it has to be
defined as singleton there.
NOTE: This method returning false does not
necessarily indicate that returned objects are independent instances.
An implementation of the extended SmartFactoryBean interface
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype() method. Plain FactoryBean
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton() implementation returns false.
The default implementation returns true, since a
FactoryBean typically manages a singleton instance.