com.airlenet.play.cache.infinispan.support.embedded

类 InfinispanNamedEmbeddedCacheFactoryBean<K,V>

java.lang.Object

com.airlenet.play.cache.infinispan.support.embedded.InfinispanNamedEmbeddedCacheFactoryBean<K,V>

所有已实现的接口:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<org.infinispan.Cache<K,V>>, org.springframework.beans.factory.InitializingBean

public class InfinispanNamedEmbeddedCacheFactoryBean<K,V>
extends Object
implements org.springframework.beans.factory.FactoryBean<org.infinispan.Cache<K,V>>, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

A FactoryBean for creating a native named Infinispan org.infinispan.Cache, delegating to a configurable org.infinispan.manager.EmbeddedCacheManager. If no cache name is explicitly set, this FactoryBean's beanName will be used instead.

Beyond merely creating named Cache instances, this FactoryBean offers great flexibility in configuring those Caches. It has setters for all non-global configuration settings, i.e. all settings that are specific to a single Cache. The configuration settings thus defined override those settings obtained from the EmbeddedCacheManager.

There are different configuration modes that control with what Configuration to start before further customizing it as described above:

• NONE: Configuration starts with a new Configuration instance. Note that this mode may only be used if no named configuration having the same name as the Cache to be created already exists. It is therefore illegal to use this mode to create a Cache named, say, "cacheName" if the configuration file used to configure the EmbeddedCacheManager contains a configuration section named "cacheName".
• DEFAULT: Configuration starts with the EmbeddedCacheManager's default Configuration instance, i.e. the configuration settings defined in its configuration file's default section. Note that this mode may only be used if no named configuration having the same name as the Cache to be created already exists. It is therefore illegal to use this mode to create a Cache named, say, "cacheName" if the configuration file used to configure the EmbeddedCacheManager contains a configuration section named "cacheName".
• CUSTOM: This is where a user will provide a custom-built ConfigurationBuilder object which will be used to configure a Cache instance. If a setCacheName(String) has already been called, then that name will be used.
• NAMED: Configuration starts with the EmbeddedCacheManager's Configuration instance having the same name as the Cache to be created. For a Cache named, say, "cacheName" this is the configuration section named "cacheName" as defined in the EmbeddedCacheManager's configuration file. Note that this mode is only useful if such a named configuration section does indeed exist. Otherwise, it is equivalent to using DEFAULT.

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

作者:

Olaf Bergner, Marius Bogoevici

构造器概要

构造器

构造器和说明
InfinispanNamedEmbeddedCacheFactoryBean()

方法概要

限定符和类型	方法和说明
void	addCustomConfiguration(org.infinispan.configuration.cache.ConfigurationBuilder builder) API to introduce a customised ConfigurationBuilder that will override the default configurations which are already available on this class.
void	afterPropertiesSet()
void	destroy() Shuts down the org.infinispan.Cache created by this FactoryBean.
org.infinispan.Cache<K,V>	getObject()
Class<? extends org.infinispan.Cache>	getObjectType()
boolean	isSingleton() Always returns true.
void	setBeanName(String name)
void	setCacheName(String cacheName) Sets the name of the org.infinispan.Cache to be created.
void	setConfigurationTemplateMode(String configurationTemplateMode)
void	setInfinispanEmbeddedCacheManager(org.infinispan.manager.EmbeddedCacheManager infinispanEmbeddedCacheManager) Sets the org.infinispan.manager.EmbeddedCacheManager to be used for creating our Cache instance.

从类继承的方法 java.lang.Object

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

构造器详细资料

InfinispanNamedEmbeddedCacheFactoryBean

public InfinispanNamedEmbeddedCacheFactoryBean()

方法详细资料

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

指定者:

afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean

抛出:

Exception

另请参阅:

InitializingBean.afterPropertiesSet()

getObject

public org.infinispan.Cache<K,V> getObject()
                                    throws Exception

指定者:

getObject 在接口中 org.springframework.beans.factory.FactoryBean<org.infinispan.Cache<K,V>>

抛出:

Exception

另请参阅:

FactoryBean.getObject()

getObjectType

public Class<? extends org.infinispan.Cache> getObjectType()

指定者:

getObjectType 在接口中 org.springframework.beans.factory.FactoryBean<org.infinispan.Cache<K,V>>

另请参阅:

FactoryBean.getObjectType()

isSingleton

public boolean isSingleton()

Always returns true.

指定者:

isSingleton 在接口中 org.springframework.beans.factory.FactoryBean<org.infinispan.Cache<K,V>>

返回:

Always true

另请参阅:

FactoryBean.isSingleton()

setBeanName

public void setBeanName(String name)

指定者:

setBeanName 在接口中 org.springframework.beans.factory.BeanNameAware

另请参阅:

BeanNameAware.setBeanName(java.lang.String)

destroy

public void destroy()
             throws Exception

Shuts down the org.infinispan.Cache created by this FactoryBean.

指定者:

destroy 在接口中 org.springframework.beans.factory.DisposableBean

抛出:

Exception

另请参阅:

DisposableBean.destroy(), Lifecycle.stop()

setCacheName

public void setCacheName(String cacheName)

Sets the name of the org.infinispan.Cache to be created. If no explicit cacheName is set, this FactoryBean will use its beanName as the cacheName.

参数:

cacheName - The name of the org.infinispan.Cache to be created

setInfinispanEmbeddedCacheManager

public void setInfinispanEmbeddedCacheManager(org.infinispan.manager.EmbeddedCacheManager infinispanEmbeddedCacheManager)

Sets the org.infinispan.manager.EmbeddedCacheManager to be used for creating our Cache instance. Note that this is a mandatory property.

参数:

infinispanEmbeddedCacheManager - The org.infinispan.manager.EmbeddedCacheManager to be used for creating our Cache instance

setConfigurationTemplateMode

public void setConfigurationTemplateMode(String configurationTemplateMode)
                                  throws IllegalArgumentException

参数:

configurationTemplateMode -

抛出:

IllegalArgumentException

addCustomConfiguration

public void addCustomConfiguration(org.infinispan.configuration.cache.ConfigurationBuilder builder)

API to introduce a customised ConfigurationBuilder that will override the default configurations which are already available on this class. This can only be used if setConfigurationTemplateMode(String) has been set to CUSTOM.

参数:

builder -