org.infinispan.spring.provider

Class SpringEmbeddedCacheManagerFactoryBean

java.lang.Object

org.infinispan.spring.AbstractEmbeddedCacheManagerFactory

org.infinispan.spring.provider.SpringEmbeddedCacheManagerFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<SpringEmbeddedCacheManager>, org.springframework.beans.factory.InitializingBean

public class SpringEmbeddedCacheManagerFactoryBean
extends AbstractEmbeddedCacheManagerFactory
implements org.springframework.beans.factory.FactoryBean<SpringEmbeddedCacheManager>, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

A FactoryBean for creating an SpringEmbeddedCacheManager instance. The location of the Infinispan configuration file used to provide the default configuration for the EmbeddedCacheManager instance created by this FactoryBean is configurable.

If no configuration file location is set the SpringEmbeddedCacheManager instance created by this FactoryBean will use Infinispan's default settings. See Infinispan's documentation for what those default settings are.

A user may further customize the SpringEmbeddedCacheManager's configuration using explicit setters on this FactoryBean. The properties thus defined will be applied either to the configuration loaded from Infinispan's configuration file in case one has been specified, or to a configuration initialized with Infinispan's default settings. Either way, the net effect is that explicitly set configuration properties take precedence over both those loaded from a configuration file as well as INFNISPAN's default settings.

In addition to creating an SpringEmbeddedCacheManager this FactoryBean does also control that SpringEmbeddedCacheManager's lifecycle by shutting it down when the enclosing Spring application context is closed. It is therefore advisable to always use this FactoryBean when creating an SpringEmbeddedCacheManager.

Author:

Olaf Bergner

See Also:

AbstractEmbeddedCacheManagerFactory.setConfigurationFileLocation(org.springframework.core.io.Resource), destroy(), SpringEmbeddedCacheManager, EmbeddedCacheManager, Configuration

Field Summary

Fields inherited from class org.infinispan.spring.AbstractEmbeddedCacheManagerFactory

logger

Constructor Summary

Constructors

Constructor and Description
SpringEmbeddedCacheManagerFactoryBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy() Shuts down the SpringEmbeddedCacheManager instance created by this FactoryBean.
SpringEmbeddedCacheManager	getObject()
Class<? extends SpringEmbeddedCacheManager>	getObjectType()
boolean	isSingleton() Always returns true.

Methods inherited from class org.infinispan.spring.AbstractEmbeddedCacheManagerFactory

addCustomCacheConfiguration, addCustomGlobalConfiguration, createBackingEmbeddedCacheManager, createCacheManager, createCacheManager, setConfigurationFileLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringEmbeddedCacheManagerFactoryBean

public SpringEmbeddedCacheManagerFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

See Also:

InitializingBean.afterPropertiesSet()

getObject

public SpringEmbeddedCacheManager getObject()
                                     throws Exception

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<SpringEmbeddedCacheManager>

Throws:

Exception

See Also:

FactoryBean.getObject()

getObjectType

public Class<? extends SpringEmbeddedCacheManager> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<SpringEmbeddedCacheManager>

See Also:

FactoryBean.getObjectType()

isSingleton

public boolean isSingleton()

Always returns true.

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<SpringEmbeddedCacheManager>

Returns:

Always true

See Also:

FactoryBean.isSingleton()

destroy

public void destroy()
             throws Exception

Shuts down the SpringEmbeddedCacheManager instance created by this FactoryBean.

Specified by:

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

Throws:

Exception

See Also:

DisposableBean.destroy(), SpringEmbeddedCacheManager.stop()