org.springframework.data.gemfire

Class CacheFactoryBean

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<org.apache.geode.cache.GemFireCache>

org.springframework.data.gemfire.AbstractBasicCacheFactoryBean

org.springframework.data.gemfire.AbstractConfigurableCacheFactoryBean

org.springframework.data.gemfire.AbstractResolvableCacheFactoryBean

org.springframework.data.gemfire.CacheFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, FactoryBean<org.apache.geode.cache.GemFireCache>, InitializingBean, Phased, PersistenceExceptionTranslator

Direct Known Subclasses:

ClientCacheFactoryBean

public class CacheFactoryBean
extends AbstractResolvableCacheFactoryBean

Spring FactoryBean used to construct, configure and initialize a peer Cache instance. Allows either the retrieval of an existing, open Cache or the creation of a new Cache.

Author:

Costin Leau, David Turanski, John Blum, Patrick Johnson

See Also:

Properties, Cache, CacheFactory, GemFireCache, PdxSerializer, SecurityManager, FactoryBean, AbstractResolvableCacheFactoryBean, PeerCacheConfigurer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CacheFactoryBean.CacheFactoryToPdxConfigurerAdapter
static class	CacheFactoryBean.JndiDataSource

Nested classes/interfaces inherited from class org.springframework.data.gemfire.AbstractBasicCacheFactoryBean

AbstractBasicCacheFactoryBean.CacheFactoryInitializer<T>, AbstractBasicCacheFactoryBean.PdxConfigurer<T>

Field Summary

Fields inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

DEFAULT_SINGLETON

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

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
CacheFactoryBean()

Method Summary

Modifier and Type	Method and Description
protected void	applyCacheConfigurers() Applies the composite PeerCacheConfigurers to this CacheFactoryBean before the peer cache is created.
protected void	applyPeerCacheConfigurers(Iterable<PeerCacheConfigurer> peerCacheConfigurers) Applies the Iterable of PeerCacheConfigurers to this CacheFactoryBean before the peer cache is created.
protected void	applyPeerCacheConfigurers(PeerCacheConfigurer... peerCacheConfigurers) Applies the array of PeerCacheConfigurers to this CacheFactoryBean before the peer cache is created.
protected Object	configureFactory(Object factory) Configures the CacheFactory used to create the Cache.
protected org.apache.geode.cache.CacheFactory	configurePdx(org.apache.geode.cache.CacheFactory cacheFactory) Configures the Cache to use PDX serialization.
protected org.apache.geode.cache.CacheFactory	configureSecurity(org.apache.geode.cache.CacheFactory cacheFactory) Configures the Cache with security.
protected <T extends org.apache.geode.cache.GemFireCache> T	createCache(Object factory) Creates a new Cache instance using the provided factory.
protected Object	createFactory(Properties gemfireProperties) Constructs a new instance of CacheFactory initialized with the given Apache Geode Properties used to construct, configure and initialize a new peer Cache instance.
protected <T extends org.apache.geode.cache.GemFireCache> T	doFetchCache() Called by AbstractBasicCacheFactoryBean.fetchCache() if the GemFireCache reference returned by AbstractBasicCacheFactoryBean.getCache() is null.
protected Class<? extends org.apache.geode.cache.GemFireCache>	doGetObjectType() By default, returns GemFireCache Class.
PeerCacheConfigurer	getCompositePeerCacheConfigurer() Returns a reference to the Composite PeerCacheConfigurer used to apply additional configuration to this CacheFactoryBean during Spring container initialization.
Boolean	getEnableAutoReconnect() Gets the value for the auto-reconnect setting.
org.apache.geode.cache.util.GatewayConflictResolver	getGatewayConflictResolver()
List<CacheFactoryBean.JndiDataSource>	getJndiDataSources()
Integer	getLockLease()
Integer	getLockTimeout()
Integer	getMessageSyncInterval()
Integer	getSearchTimeout()
org.apache.geode.security.SecurityManager	getSecurityManager() Returns the SecurityManager used to secure this cache.
Boolean	getUseClusterConfiguration() Return the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.
protected <T extends org.apache.geode.cache.GemFireCache> T	postProcess(T cache) Post process the GemFireCache by loading any cache.xml file, applying custom settings specified in SDG XML configuration meta-data, and registering appropriate Transaction Listeners, Writer and JNDI settings along with JVM Heap configuration.
void	setEnableAutoReconnect(Boolean enableAutoReconnect) Controls whether auto-reconnect functionality introduced in GemFire 8 is enabled or not.
void	setGatewayConflictResolver(org.apache.geode.cache.util.GatewayConflictResolver gatewayConflictResolver) Requires GemFire 7.0 or higher
void	setJndiDataSources(List<CacheFactoryBean.JndiDataSource> jndiDataSources)
void	setLockLease(Integer lockLease) Sets the number of seconds for implicit and explicit object lock leases to timeout.
void	setLockTimeout(Integer lockTimeout) Sets the number of seconds in which the implicit object lock request will timeout.
void	setMessageSyncInterval(Integer messageSyncInterval) Set for client subscription queue synchronization when this member acts as a server to clients and server redundancy is used.
void	setPeerCacheConfigurers(List<PeerCacheConfigurer> peerCacheConfigurers) Null-safe operation to set an Iterable of PeerCacheConfigurers to apply additional configuration to this CacheFactoryBean when using Annotation-based configuration.
void	setPeerCacheConfigurers(PeerCacheConfigurer... peerCacheConfigurers) Null-safe operation to set an array of PeerCacheConfigurers used to apply additional configuration to this CacheFactoryBean when using Annotation-based configuration.
void	setSearchTimeout(Integer searchTimeout) Set the number of seconds a netSearch operation can wait for data before timing out.
void	setSecurityManager(org.apache.geode.security.SecurityManager securityManager) Configures the SecurityManager used to secure this cache.
void	setUseClusterConfiguration(Boolean useSharedConfiguration) Sets the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.

Methods inherited from class org.springframework.data.gemfire.AbstractResolvableCacheFactoryBean

doGetObject, init, initializeFactory, postProcess, resolveCache

Methods inherited from class org.springframework.data.gemfire.AbstractConfigurableCacheFactoryBean

afterPropertiesSet, destroy, getBeanFactoryLocator, getCacheXml, getOptionalBeanFactoryLocator, getOptionalCacheXml, getProperties, isCacheXmlPresent, isCacheXmlResolvableAsAFile, isUseBeanFactoryLocator, loadCacheXml, resolveProperties, setAndGetProperties, setBeanFactoryLocator, setCacheXml, setProperties, setUseBeanFactoryLocator

Methods inherited from class org.springframework.data.gemfire.AbstractBasicCacheFactoryBean

close, configureHeapPercentages, configureOffHeapPercentages, configurePdx, fetchCache, getCache, getCacheFactoryInitializer, getCopyOnRead, getCriticalHeapPercentage, getCriticalOffHeapPercentage, getEvictionHeapPercentage, getEvictionOffHeapPercentage, getObject, getObjectType, getOptionalCache, getPdxDiskStoreName, getPdxIgnoreUnreadFields, getPdxPersistent, getPdxReadSerialized, getPdxSerializer, getPhase, getTransactionListeners, getTransactionWriter, isClose, isCopyOnRead, isNotClosed, registerTransactionListeners, registerTransactionWriter, setCache, setCacheFactoryInitializer, setClose, setCopyOnRead, setCriticalHeapPercentage, setCriticalOffHeapPercentage, setEvictionHeapPercentage, setEvictionOffHeapPercentage, setPdxDiskStoreName, setPdxIgnoreUnreadFields, setPdxPersistent, setPdxReadSerialized, setPdxSerializer, setPhase, setTransactionListeners, setTransactionWriter, translateExceptionIfPossible

Methods inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

getBeanClassLoader, getBeanFactory, getBeanName, getLogger, getOptionalLogger, isDebugLoggingEnabled, isErrorLoggingEnabled, isInfoLoggingEnabled, isSingleton, isWarnLoggingEnabled, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarning, logWarning, newLogger, setBeanClassLoader, setBeanFactory, setBeanName

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheFactoryBean

public CacheFactoryBean()

Method Detail

applyCacheConfigurers

protected void applyCacheConfigurers()

Applies the composite PeerCacheConfigurers to this CacheFactoryBean before the peer cache is created.

Specified by:

applyCacheConfigurers in class AbstractBasicCacheFactoryBean

See Also:

getCompositePeerCacheConfigurer(), applyPeerCacheConfigurers(PeerCacheConfigurer...)

applyPeerCacheConfigurers

protected void applyPeerCacheConfigurers(PeerCacheConfigurer... peerCacheConfigurers)

Applies the array of PeerCacheConfigurers to this CacheFactoryBean before the peer cache is created.

Parameters:

peerCacheConfigurers - array of PeerCacheConfigurers applied to this CacheFactoryBean.

See Also:

PeerCacheConfigurer, applyPeerCacheConfigurers(Iterable)

applyPeerCacheConfigurers

protected void applyPeerCacheConfigurers(Iterable<PeerCacheConfigurer> peerCacheConfigurers)

Applies the Iterable of PeerCacheConfigurers to this CacheFactoryBean before the peer cache is created.

Parameters:

peerCacheConfigurers - Iterable of PeerCacheConfigurers applied to this CacheFactoryBean.

See Also:

PeerCacheConfigurer, Iterable

doFetchCache

protected <T extends org.apache.geode.cache.GemFireCache> T doFetchCache()

Description copied from class: AbstractBasicCacheFactoryBean

Called by AbstractBasicCacheFactoryBean.fetchCache() if the GemFireCache reference returned by AbstractBasicCacheFactoryBean.getCache() is null. This method is typically implemented by calling CacheFactory.getAnyInstance() or ClientCacheFactory.getAnyInstance() depending on the GemFireCache type declared and used in the Spring application.

Specified by:

doFetchCache in class AbstractBasicCacheFactoryBean

Type Parameters:

T - parameterized Class type extending GemFireCache.

Returns:

a (existing) reference to a GemFireCache instance.

See Also:

AbstractBasicCacheFactoryBean.fetchCache()

doGetObjectType

protected Class<? extends org.apache.geode.cache.GemFireCache> doGetObjectType()

Description copied from class: AbstractBasicCacheFactoryBean

By default, returns GemFireCache Class.

Overrides:

doGetObjectType in class AbstractBasicCacheFactoryBean

Returns:

GemFireCache Class by default.

See Also:

GemFireCache, AbstractBasicCacheFactoryBean.getObjectType(), Class

createFactory

@NonNull
protected Object createFactory(@NonNull
                                        Properties gemfireProperties)

Constructs a new instance of CacheFactory initialized with the given Apache Geode Properties used to construct, configure and initialize a new peer Cache instance.

Specified by:

createFactory in class AbstractResolvableCacheFactoryBean

Parameters:

gemfireProperties - Properties used by the CacheFactory to configure the peer Cache.

Returns:

a new instance of CacheFactory initialized with the given Apache Geode Properties.

See Also:

CacheFactory, Properties

configureFactory

@NonNull
protected Object configureFactory(@NonNull
                                           Object factory)

Configures the CacheFactory used to create the Cache.

Overrides:

configureFactory in class AbstractResolvableCacheFactoryBean

Parameters:

factory - CacheFactory used to create the Cache.

Returns:

the configured CacheFactory.

See Also:

configurePdx(CacheFactory), configureSecurity(CacheFactory), CacheFactory

configurePdx

@NonNull
protected org.apache.geode.cache.CacheFactory configurePdx(@NonNull
                                                                    org.apache.geode.cache.CacheFactory cacheFactory)

Configures the Cache to use PDX serialization.

Parameters:

cacheFactory - CacheFactory to configure with PDX.

Returns:

the given CacheFactory.

See Also:

CacheFactoryBean.CacheFactoryToPdxConfigurerAdapter, CacheFactory, AbstractBasicCacheFactoryBean.configurePdx(PdxConfigurer)

configureSecurity

@NonNull
protected org.apache.geode.cache.CacheFactory configureSecurity(@NonNull
                                                                         org.apache.geode.cache.CacheFactory cacheFactory)

Configures the Cache with security.

Parameters:

cacheFactory - CacheFactory used to configure the peer Cache instance with security.

Returns:

the given CacheFactory.

See Also:

CacheFactory

createCache

@NonNull
protected <T extends org.apache.geode.cache.GemFireCache> T createCache(@NonNull
                                                                                 Object factory)

Creates a new Cache instance using the provided factory.

Specified by:

createCache in class AbstractResolvableCacheFactoryBean

Type Parameters:

T - sub-type of GemFireCache.

Parameters:

factory - instance of CacheFactory.

Returns:

a new instance of Cache created by the provided factory.

See Also:

CacheFactory.create(), GemFireCache

postProcess

@NonNull
protected <T extends org.apache.geode.cache.GemFireCache> T postProcess(@NonNull
                                                                                 T cache)

Post process the GemFireCache by loading any cache.xml file, applying custom settings specified in SDG XML configuration meta-data, and registering appropriate Transaction Listeners, Writer and JNDI settings along with JVM Heap configuration.

Overrides:

postProcess in class AbstractResolvableCacheFactoryBean

Type Parameters:

T - parameterized Class type extending GemFireCache.

Parameters:

cache - GemFireCache to post process.

Returns:

the given GemFireCache.

See Also:

AbstractConfigurableCacheFactoryBean.loadCacheXml(GemFireCache), GemFireCache.loadCacheXml(java.io.InputStream), AbstractBasicCacheFactoryBean.configureHeapPercentages(org.apache.geode.cache.GemFireCache), AbstractBasicCacheFactoryBean.configureOffHeapPercentages(GemFireCache), registerJndiDataSources(GemFireCache), AbstractBasicCacheFactoryBean.registerTransactionListeners(org.apache.geode.cache.GemFireCache), AbstractBasicCacheFactoryBean.registerTransactionWriter(org.apache.geode.cache.GemFireCache)

getCompositePeerCacheConfigurer

@NonNull
public PeerCacheConfigurer getCompositePeerCacheConfigurer()

Returns a reference to the Composite PeerCacheConfigurer used to apply additional configuration to this CacheFactoryBean during Spring container initialization.

Returns:

the Composite PeerCacheConfigurer.

See Also:

PeerCacheConfigurer

setEnableAutoReconnect

public void setEnableAutoReconnect(@Nullable
                                   Boolean enableAutoReconnect)

Controls whether auto-reconnect functionality introduced in GemFire 8 is enabled or not.

Parameters:

enableAutoReconnect - a boolean value to enable/disable auto-reconnect functionality.

Since:

GemFire 8.0

getEnableAutoReconnect

@Nullable
public Boolean getEnableAutoReconnect()

Gets the value for the auto-reconnect setting.

Returns:

a boolean value indicating whether auto-reconnect was specified (non-null) and whether it was enabled or not.

setGatewayConflictResolver

public void setGatewayConflictResolver(@Nullable
                                       org.apache.geode.cache.util.GatewayConflictResolver gatewayConflictResolver)

Requires GemFire 7.0 or higher

Parameters:

gatewayConflictResolver - defined as Object in the signature for backward compatibility with Gemfire 6 compatibility. This must be an instance of GatewayConflictResolver

getGatewayConflictResolver

@Nullable
public org.apache.geode.cache.util.GatewayConflictResolver getGatewayConflictResolver()

Returns:

the gatewayConflictResolver

setJndiDataSources

public void setJndiDataSources(List<CacheFactoryBean.JndiDataSource> jndiDataSources)

Parameters:

jndiDataSources - the list of configured JndiDataSources to use with this Cache.

getJndiDataSources

public List<CacheFactoryBean.JndiDataSource> getJndiDataSources()

Returns:

the list of configured JndiDataSources.

setLockLease

public void setLockLease(@Nullable
                         Integer lockLease)

Sets the number of seconds for implicit and explicit object lock leases to timeout.

Parameters:

lockLease - an integer value indicating the object lock lease timeout.

getLockLease

@Nullable
public Integer getLockLease()

Returns:

the lockLease

setLockTimeout

public void setLockTimeout(@Nullable
                           Integer lockTimeout)

Sets the number of seconds in which the implicit object lock request will timeout.

Parameters:

lockTimeout - an integer value specifying the object lock request timeout.

getLockTimeout

@Nullable
public Integer getLockTimeout()

Returns:

the lockTimeout

setMessageSyncInterval

public void setMessageSyncInterval(@Nullable
                                   Integer messageSyncInterval)

Set for client subscription queue synchronization when this member acts as a server to clients and server redundancy is used. Sets the frequency (in seconds) at which the primary server sends messages to its secondary servers to remove queued events that have already been processed by the clients.

Parameters:

messageSyncInterval - an integer value specifying the number of seconds in which the primary server sends messages to secondary servers.

getMessageSyncInterval

@Nullable
public Integer getMessageSyncInterval()

Returns:

the messageSyncInterval

setPeerCacheConfigurers

public void setPeerCacheConfigurers(PeerCacheConfigurer... peerCacheConfigurers)

Null-safe operation to set an array of PeerCacheConfigurers used to apply additional configuration to this CacheFactoryBean when using Annotation-based configuration.

Parameters:

peerCacheConfigurers - array of PeerCacheConfigurers used to apply additional configuration to this CacheFactoryBean.

See Also:

PeerCacheConfigurer, setPeerCacheConfigurers(List)

setPeerCacheConfigurers

public void setPeerCacheConfigurers(List<PeerCacheConfigurer> peerCacheConfigurers)

Null-safe operation to set an Iterable of PeerCacheConfigurers to apply additional configuration to this CacheFactoryBean when using Annotation-based configuration.

Parameters:

peerCacheConfigurers - Iterable of PeerCacheConfigurers used to apply additional configuration to this CacheFactoryBean.

See Also:

PeerCacheConfigurer

setSearchTimeout

public void setSearchTimeout(@Nullable
                             Integer searchTimeout)

Set the number of seconds a netSearch operation can wait for data before timing out.

Parameters:

searchTimeout - an integer value indicating the netSearch timeout value.

getSearchTimeout

@Nullable
public Integer getSearchTimeout()

Returns:

the searchTimeout

setSecurityManager

public void setSecurityManager(@Nullable
                               org.apache.geode.security.SecurityManager securityManager)

Configures the SecurityManager used to secure this cache.

Parameters:

securityManager - SecurityManager used to secure this cache.

See Also:

SecurityManager

getSecurityManager

@Nullable
public org.apache.geode.security.SecurityManager getSecurityManager()

Returns the SecurityManager used to secure this cache.

Returns:

the SecurityManager used to secure this cache.

See Also:

SecurityManager

setUseClusterConfiguration

public void setUseClusterConfiguration(@Nullable
                                       Boolean useSharedConfiguration)

Sets the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.

Parameters:

useSharedConfiguration - boolean value to set the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.

getUseClusterConfiguration

@Nullable
public Boolean getUseClusterConfiguration()

Return the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.

Returns:

the current boolean value for the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.