CacheFactoryBean (Spring Data for Pivotal GemFire 2.2.13.RELEASE API)

java.lang.Object
- org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<org.apache.geode.cache.GemFireCache>
- - 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 AbstractFactoryBeanSupport<org.apache.geode.cache.GemFireCache>
implements DisposableBean, InitializingBean, PersistenceExceptionTranslator, Phased
```
Spring FactoryBean used to construct, configure and initialize a Pivotal GemFire/Apache Geode Cache peer cache). Allows either retrieval of an existing, open {@link Cache} or creation of a new {@link Cache}. This class implements the {@link PersistenceExceptionTranslator} interface and is auto-detected by Spring's {@link org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor} for AOP-based translation of native persistent data store exceptions to Spring's {@link DataAccessException} hierarchy. Therefore, the presence of this class automatically enables a {@link org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor} to translate Pivotal GemFire/Apache Geode exceptions appropriately.

Author:

Costin Leau, David Turanski, John Blum

See Also:

Properties, Cache, CacheFactory, GemFireCache, DynamicRegionFactory, RegionService, DistributedMember, DistributedSystem, org.apache.geode.cache.pdx.PdxSerializer, BeanFactory, DisposableBean, FactoryBean, InitializingBean, Phased, Resource, PersistenceExceptionTranslator, PeerCacheConfigurer, AbstractFactoryBeanSupport, GemfireBeanFactoryLocator

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CacheFactoryBean.CacheFactoryInitializer<T>` Callback interface for initializing either a `CacheFactory` or a `ClientCacheFactory` instance, which is used to create an instance of `GemFireCache`.
`static class`	`CacheFactoryBean.DynamicRegionSupport`
`static class`	`CacheFactoryBean.JndiDataSource`

Field Summary

Fields
Modifier and Type Field and Description

protected GemfireBeanFactoryLocator beanFactoryLocator
- Fields inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport
  DEFAULT_SINGLETON
- Fields inherited from interface org.springframework.beans.factory.FactoryBean
  OBJECT_TYPE_ATTRIBUTE

Fields
Modifier and Type	Field and Description
`protected GemfireBeanFactoryLocator`	`beanFactoryLocator`

Constructor Summary

Constructors
Constructor and Description

CacheFactoryBean()

Constructors
Constructor and Description
`CacheFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()` Initializes this `CacheFactoryBean` after properties have been set by the Spring container.
`protected void`	`applyCacheConfigurers()` Applies the composite `PeerCacheConfigurers` to this `CacheFactoryBean` before creating the `peer Cache`.
`protected void`	`applyPeerCacheConfigurers(Iterable<PeerCacheConfigurer> peerCacheConfigurers)` Applies the given `Iterable` of `PeerCacheConfigurers` to this `CacheFactoryBean`.
`protected void`	`applyPeerCacheConfigurers(PeerCacheConfigurer... peerCacheConfigurers)` Applies the given array of `PeerCacheConfigurers` to this `CacheFactoryBean`.
`protected void`	`close(org.apache.geode.cache.GemFireCache cache)` Null-safe internal method used to close the `GemFireCache` and calling `RegionService.close()` iff the cache `is not already closed`.
`protected Object`	`configureFactory(Object factory)` Configures the `CacheFactory` used to create the `Cache`.
`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 Pivotal GemFire/Apache Geode `Properties` used to construct, configure and initialize an instance of a `Cache`.
`void`	`destroy()` Destroys the `Cache` bean on Spring container shutdown.
`protected <T extends org.apache.geode.cache.GemFireCache> T`	`fetchCache()` Fetches an existing `Cache` instance from the `CacheFactory`.
`GemfireBeanFactoryLocator`	`getBeanFactoryLocator()` Returns a reference to the configured `GemfireBeanFactoryLocator` used to resolve Spring bean references in native Pivotal GemFire/Apache Geode native config (e.g.
`protected <T extends org.apache.geode.cache.GemFireCache> T`	`getCache()` Returns a direct reference to the constructed, configured an initialized `Cache` created by this `CacheFactoryBean`.
`CacheFactoryBean.CacheFactoryInitializer`	`getCacheFactoryInitializer()` Return the `CacheFactoryBean.CacheFactoryInitializer` that will be called to initialize the cache factory used to create the cache constructed by this `CacheFactoryBean`.
`Resource`	`getCacheXml()` Returns a reference to the Pivotal GemFire/Apache Geode native cache.xml as a Spring `Resource`.
`PeerCacheConfigurer`	`getCompositePeerCacheConfigurer()` Returns a reference to the Composite `PeerCacheConfigurer` used to apply additional configuration to this `CacheFactoryBean` on Spring container initialization.
`Boolean`	`getCopyOnRead()`
`Float`	`getCriticalHeapPercentage()`
`Float`	`getCriticalOffHeapPercentage()`
`CacheFactoryBean.DynamicRegionSupport`	`getDynamicRegionSupport()`
`Boolean`	`getEnableAutoReconnect()` Gets the value for the auto-reconnect setting.
`Float`	`getEvictionHeapPercentage()`
`Float`	`getEvictionOffHeapPercentage()`
`org.apache.geode.cache.util.GatewayConflictResolver`	`getGatewayConflictResolver()`
`List<CacheFactoryBean.JndiDataSource>`	`getJndiDataSources()`
`Integer`	`getLockLease()`
`Integer`	`getLockTimeout()`
`Integer`	`getMessageSyncInterval()`
`org.apache.geode.cache.GemFireCache`	`getObject()` Returns an object reference to the `Cache` created by this `CacheFactoryBean`.
`Class<? extends org.apache.geode.cache.GemFireCache>`	`getObjectType()` Returns the `Class` type of the `GemFireCache` produced by this `CacheFactoryBean`.
`String`	`getPdxDiskStoreName()`
`Boolean`	`getPdxIgnoreUnreadFields()`
`Boolean`	`getPdxPersistent()`
`Boolean`	`getPdxReadSerialized()`
`org.apache.geode.pdx.PdxSerializer`	`getPdxSerializer()`
`int`	`getPhase()` Returns the configured phase of the `Cache` bean in the lifecycle managed by the Spring container.
`Properties`	`getProperties()` Returns a reference to Pivotal GemFire/Apache Geode `Properties` used to configure the cache.
`Integer`	`getSearchTimeout()`
`org.apache.geode.security.SecurityManager`	`getSecurityManager()` Returns the `SecurityManager` used to secure this cache.
`List<org.apache.geode.cache.TransactionListener>`	`getTransactionListeners()`
`org.apache.geode.cache.TransactionWriter`	`getTransactionWriter()`
`Boolean`	`getUseClusterConfiguration()` Return the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.
`protected Object`	`initializeFactory(Object factory)` Initializes the given `CacheFactory` with the configured `CacheFactoryBean.CacheFactoryInitializer`.
`boolean`	`isClose()` Returns a boolean value indicating whether the cache will be closed on shutdown of the Spring container.
`boolean`	`isUseBeanFactoryLocator()` Determines whether the `GemfireBeanFactoryLocator` has been enabled.
`protected Object`	`postProcess(Object factory)` Post processes the `CacheFactory` used to create the `Cache`.
`protected <T extends org.apache.geode.cache.GemFireCache> T`	`postProcess(T cache)` Post processes the `GemFireCache` by loading any cache.xml, applying custom settings specified in SDG XML configuration meta-data, and registering appropriate Transaction Listeners, Writer and JNDI settings.
`protected <T extends org.apache.geode.cache.GemFireCache> T`	`resolveCache()` Resolves the `Cache` by first attempting to lookup an existing `Cache` instance in the JVM.
`protected Properties`	`resolveProperties()` Resolves the Pivotal GemFire/Apache Geode `Properties` used to configure the `Cache`.
`protected Properties`	`setAndGetProperties(Properties properties)` Sets and then returns a reference to Pivotal GemFire/Apache Geode `Properties` used to configure the cache.
`protected void`	`setCache(org.apache.geode.cache.GemFireCache cache)` Sets a reference to the constructed, configured an initialized `Cache` created by this `CacheFactoryBean`.
`void`	`setCacheFactoryInitializer(CacheFactoryBean.CacheFactoryInitializer cacheFactoryInitializer)` Set the `CacheFactoryBean.CacheFactoryInitializer` that will be called to initialize the cache factory used to create the cache constructed by this `CacheFactoryBean`.
`void`	`setCacheXml(Resource cacheXml)` Sets a reference to the Pivotal GemFire/Apache Geode native cache.xml `Resource`.
`void`	`setClose(boolean close)` Sets a value to indicate whether the cache will be closed on shutdown of the Spring container.
`void`	`setCopyOnRead(Boolean copyOnRead)` Set the copyOnRead attribute of the Cache.
`void`	`setCriticalHeapPercentage(Float criticalHeapPercentage)` Set the Cache's critical heap percentage attribute.
`void`	`setCriticalOffHeapPercentage(Float criticalOffHeapPercentage)` Set the cache's critical off-heap percentage property.
`void`	`setDynamicRegionSupport(CacheFactoryBean.DynamicRegionSupport dynamicRegionSupport)` Sets an instance of the DynamicRegionSupport to support Dynamic Regions in this Pivotal GemFire Cache.
`void`	`setEnableAutoReconnect(Boolean enableAutoReconnect)` Controls whether auto-reconnect functionality introduced in Pivotal GemFire 8 is enabled or not.
`void`	`setEvictionHeapPercentage(Float evictionHeapPercentage)` Set the Cache's eviction heap percentage attribute.
`void`	`setEvictionOffHeapPercentage(Float evictionOffHeapPercentage)` Set the cache's eviction off-heap percentage property.
`void`	`setGatewayConflictResolver(org.apache.geode.cache.util.GatewayConflictResolver gatewayConflictResolver)` Requires Pivotal 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`	`setPdxDiskStoreName(String pdxDiskStoreName)` Set the disk store that is used for PDX meta data.
`void`	`setPdxIgnoreUnreadFields(Boolean pdxIgnoreUnreadFields)` Controls whether pdx ignores fields that were unread during deserialization.
`void`	`setPdxPersistent(Boolean pdxPersistent)` Controls whether type metadata for PDX objects is persisted to disk.
`void`	`setPdxReadSerialized(Boolean pdxReadSerialized)` Sets the object preference to PdxInstance.
`void`	`setPdxSerializer(org.apache.geode.pdx.PdxSerializer serializer)` Sets the `PdxSerializable` for this cache.
`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.
`protected void`	`setPhase(int phase)` Set the phase for the `Cache` bean in the lifecycle managed by the Spring container.
`void`	`setProperties(Properties properties)` Returns a reference to Pivotal GemFire/Apache Geode `Properties` used to configure the cache.
`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`	`setTransactionListeners(List<org.apache.geode.cache.TransactionListener> transactionListeners)` Sets the list of TransactionListeners used to configure the Cache to receive transaction events after the transaction is processed (committed, rolled back).
`void`	`setTransactionWriter(org.apache.geode.cache.TransactionWriter transactionWriter)` Sets the TransactionWriter used to configure the Cache for handling transaction events, such as to veto the transaction or update an external DB before the commit.
`void`	`setUseBeanFactoryLocator(boolean use)` Sets whether to enable the `GemfireBeanFactoryLocator`.
`void`	`setUseClusterConfiguration(Boolean useSharedConfiguration)` Sets the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.
`DataAccessException`	`translateExceptionIfPossible(RuntimeException exception)` Translates the given Pivotal GemFire/Apache Geode `RuntimeException` thrown to a corresponding exception from Spring's generic `DataAccessException` hierarchy, if possible.

Methods inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport
getBeanClassLoader, getBeanFactory, getBeanName, getLog, isSingleton, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarning, logWarning, newLog, setBeanClassLoader, setBeanFactory, setBeanName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - beanFactoryLocator
```
protected GemfireBeanFactoryLocator beanFactoryLocator
```
- Constructor Detail
  - CacheFactoryBean
```
public CacheFactoryBean()
```
- Method Detail
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Initializes this CacheFactoryBean after properties have been set by the Spring container.
    
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
    
    Throws:
    
    Exception - if initialization fails.
    
    See Also:
    
    InitializingBean.afterPropertiesSet(), applyCacheConfigurers(), initBeanFactoryLocator()
  - applyCacheConfigurers
```
protected void applyCacheConfigurers()
```
    Applies the composite PeerCacheConfigurers to this CacheFactoryBean before creating the peer Cache.
    
    See Also:
    
    getCompositePeerCacheConfigurer(), applyPeerCacheConfigurers(PeerCacheConfigurer...)
  - applyPeerCacheConfigurers
```
protected void applyPeerCacheConfigurers(PeerCacheConfigurer... peerCacheConfigurers)
```
    Applies the given array of PeerCacheConfigurers to this CacheFactoryBean.
    
    Parameters:
    
    peerCacheConfigurers - array of PeerCacheConfigurers applied to this CacheFactoryBean.
    
    See Also:
    
    PeerCacheConfigurer, applyPeerCacheConfigurers(Iterable)
  - applyPeerCacheConfigurers
```
protected void applyPeerCacheConfigurers(Iterable<PeerCacheConfigurer> peerCacheConfigurers)
```
    Applies the given Iterable of PeerCacheConfigurers to this CacheFactoryBean.
    
    Parameters:
    
    peerCacheConfigurers - Iterable of PeerCacheConfigurers applied to this CacheFactoryBean.
    
    See Also:
    
    PeerCacheConfigurer, Iterable, applyPeerCacheConfigurers(PeerCacheConfigurer...)
  - resolveCache
```
protected <T extends org.apache.geode.cache.GemFireCache> T resolveCache()
```
    Resolves the Cache by first attempting to lookup an existing Cache instance in the JVM. If an existing Cache could not be found, then this method proceeds in attempting to create a new Cache instance.
    
    Type Parameters:
    
    T - parameterized Class type extension of GemFireCache.
    
    Returns:
    
    the resolved Cache instance.
    
    See Also:
    
    Cache, fetchCache(), resolveProperties(), createFactory(java.util.Properties), configureFactory(Object), createCache(Object)
  - fetchCache
```
protected <T extends org.apache.geode.cache.GemFireCache> T fetchCache()
```
    Fetches an existing Cache instance from the CacheFactory.
    
    Type Parameters:
    
    T - parameterized Class type extension of GemFireCache.
    
    Returns:
    
    an existing Cache instance if available.
    
    Throws:
    
    org.apache.geode.cache.CacheClosedException - if an existing Cache instance does not exist.
    
    See Also:
    
    CacheFactory.getAnyInstance(), GemFireCache, getCache()
  - resolveProperties
```
protected Properties resolveProperties()
```
    Resolves the Pivotal GemFire/Apache Geode Properties used to configure the Cache.
    
    Returns:
    
    the resolved Pivotal GemFire/Apache Geode Properties used to configure the Cache.
    
    See Also:
    
    setAndGetProperties(Properties), getProperties()
  - createFactory
```
protected Object createFactory(Properties gemfireProperties)
```
    Constructs a new instance of CacheFactory initialized with the given Pivotal GemFire/Apache Geode Properties used to construct, configure and initialize an instance of a Cache.
    
    Parameters:
    
    gemfireProperties - Properties used by the CacheFactory to configure the Cache.
    
    Returns:
    
    a new instance of CacheFactory initialized with the given Pivotal GemFire/Apache Geode Properties.
    
    See Also:
    
    CacheFactory, Properties
  - initializeFactory
```
@Nullable
protected Object initializeFactory(Object factory)
```
    Initializes the given CacheFactory with the configured CacheFactoryBean.CacheFactoryInitializer.
    
    Parameters:
    
    factory - CacheFactory to initialize; may be null.
    
    Returns:
    
    the initialized CacheFactory.
    
    See Also:
    
    CacheFactoryBean.CacheFactoryInitializer.initialize(Object), CacheFactory, getCacheFactoryInitializer()
  - configureFactory
```
protected Object configureFactory(Object factory)
```
    Configures the CacheFactory used to create the Cache. Sets PDX options specified by the user.
    
    Parameters:
    
    factory - CacheFactory used to create the Cache.
    
    Returns:
    
    the configured CacheFactory.
    
    See Also:
    
    CacheFactory, configurePdx(CacheFactory)
  - postProcess
```
protected Object postProcess(Object factory)
```
    Post processes the CacheFactory used to create the Cache.
    
    Parameters:
    
    factory - CacheFactory used to create the Cache.
    
    Returns:
    
    the post processed CacheFactory.
    
    See Also:
    
    CacheFactory
  - createCache
```
protected <T extends org.apache.geode.cache.GemFireCache> T createCache(Object factory)
```
    Creates a new Cache instance using the provided factory.
    
    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
```
protected <T extends org.apache.geode.cache.GemFireCache> T postProcess(T cache)
```
    Post processes the GemFireCache by loading any cache.xml, applying custom settings specified in SDG XML configuration meta-data, and registering appropriate Transaction Listeners, Writer and JNDI settings.
    
    Type Parameters:
    
    T - Parameterized Class type extension of GemFireCache.
    
    Parameters:
    
    cache - GemFireCache instance to post process.
    
    Returns:
    
    the given GemFireCache.
    
    See Also:
    
    GemFireCache.loadCacheXml(java.io.InputStream), getCacheXml(), configureHeapPercentages(org.apache.geode.cache.GemFireCache), #registerJndiDataSources(), registerTransactionListeners(org.apache.geode.cache.GemFireCache), registerTransactionWriter(org.apache.geode.cache.GemFireCache)
  - close
```
protected void close(org.apache.geode.cache.GemFireCache cache)
```
    Null-safe internal method used to close the GemFireCache and calling RegionService.close() iff the cache is not already closed.
    
    Parameters:
    
    cache - GemFireCache to close.
    
    See Also:
    
    RegionService.isClosed(), RegionService.close()
  - destroy
```
public void destroy()
             throws Exception
```
    Destroys the Cache bean on Spring container shutdown.
    
    Specified by:
    
    destroy in interface DisposableBean
    
    Throws:
    
    Exception - if an error occurs while closing the cache.
    
    See Also:
    
    DisposableBean.destroy(), destroyBeanFactoryLocator(), close(GemFireCache), isClose()
  - translateExceptionIfPossible
```
public DataAccessException translateExceptionIfPossible(RuntimeException exception)
```
    Translates the given Pivotal GemFire/Apache Geode RuntimeException thrown to a corresponding exception from Spring's generic DataAccessException hierarchy, if possible.
    
    Specified by:
    
    translateExceptionIfPossible in interface PersistenceExceptionTranslator
    
    Parameters:
    
    exception - RuntimeException to translate.
    
    Returns:
    
    the translated Spring DataAccessException or null if the Pivotal GemFire/Apache Geode RuntimeException could not be converted.
    
    See Also:
    
    PersistenceExceptionTranslator.translateExceptionIfPossible(RuntimeException), DataAccessException
  - getBeanFactoryLocator
```
public GemfireBeanFactoryLocator getBeanFactoryLocator()
```
    Returns a reference to the configured GemfireBeanFactoryLocator used to resolve Spring bean references in native Pivotal GemFire/Apache Geode native config (e.g. cache.xml).
    
    Returns:
    
    a reference to the configured GemfireBeanFactoryLocator.
    
    See Also:
    
    GemfireBeanFactoryLocator
  - setCache
```
protected void setCache(org.apache.geode.cache.GemFireCache cache)
```
    Sets a reference to the constructed, configured an initialized Cache created by this CacheFactoryBean.
    
    Parameters:
    
    cache - Cache created by this CacheFactoryBean.
    
    See Also:
    
    Cache
  - getCache
```
protected <T extends org.apache.geode.cache.GemFireCache> T getCache()
```
    Returns a direct reference to the constructed, configured an initialized Cache created by this CacheFactoryBean.
    
    Returns:
    
    a direct reference to the Cache created by this CacheFactoryBean.
    
    See Also:
    
    Cache
  - setCacheXml
```
public void setCacheXml(Resource cacheXml)
```
    Sets a reference to the Pivotal GemFire/Apache Geode native cache.xml Resource.
    
    Parameters:
    
    cacheXml - reference to the Pivotal GemFire/Apache Geode native cache.xml Resource.
    
    See Also:
    
    Resource
  - getCacheXml
```
public Resource getCacheXml()
```
    Returns a reference to the Pivotal GemFire/Apache Geode native cache.xml as a Spring Resource.
    
    Returns:
    
    a reference to the Pivotal GemFire/Apache Geode native cache.xml as a Spring Resource.
    
    See Also:
    
    Resource
  - getObject
```
public org.apache.geode.cache.GemFireCache getObject()
                                              throws Exception
```
    Returns an object reference to the Cache created by this CacheFactoryBean.
    
    Specified by:
    
    getObject in interface FactoryBean<org.apache.geode.cache.GemFireCache>
    
    Returns:
    
    an object reference to the Cache created by this CacheFactoryBean.
    
    Throws:
    
    Exception
    
    See Also:
    
    FactoryBean.getObject(), Cache, getCache()
  - getObjectType
```
public Class<? extends org.apache.geode.cache.GemFireCache> getObjectType()
```
    Returns the Class type of the GemFireCache produced by this CacheFactoryBean.
    
    Specified by:
    
    getObjectType in interface FactoryBean<org.apache.geode.cache.GemFireCache>
    
    Returns:
    
    the Class type of the GemFireCache produced by this CacheFactoryBean.
    
    See Also:
    
    FactoryBean.getObjectType()
  - setCacheFactoryInitializer
```
public void setCacheFactoryInitializer(CacheFactoryBean.CacheFactoryInitializer cacheFactoryInitializer)
```
    Set the CacheFactoryBean.CacheFactoryInitializer that will be called to initialize the cache factory used to create the cache constructed by this CacheFactoryBean.
    
    Parameters:
    
    cacheFactoryInitializer - CacheFactoryBean.CacheFactoryInitializer configured to initialize the cache factory.
    
    See Also:
    
    CacheFactoryBean.CacheFactoryInitializer
  - getCacheFactoryInitializer
```
public CacheFactoryBean.CacheFactoryInitializer getCacheFactoryInitializer()
```
    Return the CacheFactoryBean.CacheFactoryInitializer that will be called to initialize the cache factory used to create the cache constructed by this CacheFactoryBean.
    
    Returns:
    
    the CacheFactoryBean.CacheFactoryInitializer configured to initialize the cache factory.
    
    See Also:
    
    CacheFactoryBean.CacheFactoryInitializer
  - setAndGetProperties
```
protected Properties setAndGetProperties(Properties properties)
```
    Sets and then returns a reference to Pivotal GemFire/Apache Geode Properties used to configure the cache.
    
    Parameters:
    
    properties - reference to Pivotal GemFire/Apache Geode Properties used to configure the cache.
    
    Returns:
    
    a reference to Pivotal GemFire/Apache Geode Properties used to configure the cache.
    
    See Also:
    
    Properties, setProperties(Properties), getProperties()
  - setProperties
```
public void setProperties(Properties properties)
```
    Returns a reference to Pivotal GemFire/Apache Geode Properties used to configure the cache.
    
    Parameters:
    
    properties - reference to Pivotal GemFire/Apache Geode Properties used to configure the cache.
    
    See Also:
    
    Properties
  - getProperties
```
public Properties getProperties()
```
    Returns a reference to Pivotal GemFire/Apache Geode Properties used to configure the cache.
    
    Returns:
    
    a reference to Pivotal GemFire/Apache Geode Properties.
    
    See Also:
    
    Properties
  - setClose
```
public void setClose(boolean close)
```
    Sets a value to indicate whether the cache will be closed on shutdown of the Spring container.
    
    Parameters:
    
    close - boolean value indicating whether the cache will be closed on shutdown of the Spring container.
  - isClose
```
public boolean isClose()
```
    Returns a boolean value indicating whether the cache will be closed on shutdown of the Spring container.
    
    Returns:
    
    a boolean value indicating whether the cache will be closed on shutdown of the Spring container.
  - getCompositePeerCacheConfigurer
```
public PeerCacheConfigurer getCompositePeerCacheConfigurer()
```
    Returns a reference to the Composite PeerCacheConfigurer used to apply additional configuration to this CacheFactoryBean on Spring container initialization.
    
    Returns:
    
    the Composite PeerCacheConfigurer.
    
    See Also:
    
    PeerCacheConfigurer
  - setCopyOnRead
```
public void setCopyOnRead(Boolean copyOnRead)
```
    Set the copyOnRead attribute of the Cache.
    
    Parameters:
    
    copyOnRead - a boolean value indicating whether the object stored in the Cache is copied on gets.
  - getCopyOnRead
```
public Boolean getCopyOnRead()
```
    Returns:
    
    the copyOnRead
  - setCriticalHeapPercentage
```
public void setCriticalHeapPercentage(Float criticalHeapPercentage)
```
    Set the Cache's critical heap percentage attribute.
    
    Parameters:
    
    criticalHeapPercentage - floating point value indicating the critical heap percentage.
  - getCriticalHeapPercentage
```
public Float getCriticalHeapPercentage()
```
    Returns:
    
    the criticalHeapPercentage
  - setCriticalOffHeapPercentage
```
public void setCriticalOffHeapPercentage(Float criticalOffHeapPercentage)
```
    Set the cache's critical off-heap percentage property.
    
    Parameters:
    
    criticalOffHeapPercentage - floating point value indicating the critical off-heap percentage.
  - getCriticalOffHeapPercentage
```
public Float getCriticalOffHeapPercentage()
```
    Returns:
    
    the criticalOffHeapPercentage
  - setDynamicRegionSupport
```
public void setDynamicRegionSupport(CacheFactoryBean.DynamicRegionSupport dynamicRegionSupport)
```
    Sets an instance of the DynamicRegionSupport to support Dynamic Regions in this Pivotal GemFire Cache.
    
    Parameters:
    
    dynamicRegionSupport - the DynamicRegionSupport class to setup Dynamic Regions in this Cache.
  - getDynamicRegionSupport
```
public CacheFactoryBean.DynamicRegionSupport getDynamicRegionSupport()
```
    Returns:
    
    the dynamicRegionSupport
  - setEnableAutoReconnect
```
public void setEnableAutoReconnect(Boolean enableAutoReconnect)
```
    Controls whether auto-reconnect functionality introduced in Pivotal GemFire 8 is enabled or not.
    
    Parameters:
    
    enableAutoReconnect - a boolean value to enable/disable auto-reconnect functionality.
    
    Since:
    
    Pivotal GemFire 8.0
  - getEnableAutoReconnect
```
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.
  - setEvictionHeapPercentage
```
public void setEvictionHeapPercentage(Float evictionHeapPercentage)
```
    Set the Cache's eviction heap percentage attribute.
    
    Parameters:
    
    evictionHeapPercentage - float-point value indicating the Cache's heap use percentage to trigger eviction.
  - getEvictionHeapPercentage
```
public Float getEvictionHeapPercentage()
```
    Returns:
    
    the evictionHeapPercentage
  - setEvictionOffHeapPercentage
```
public void setEvictionOffHeapPercentage(Float evictionOffHeapPercentage)
```
    Set the cache's eviction off-heap percentage property.
    
    Parameters:
    
    evictionOffHeapPercentage - float-point value indicating the percentage of off-heap use triggering eviction.
  - getEvictionOffHeapPercentage
```
public Float getEvictionOffHeapPercentage()
```
    Returns:
    
    the evictionOffHeapPercentage
  - setGatewayConflictResolver
```
public void setGatewayConflictResolver(org.apache.geode.cache.util.GatewayConflictResolver gatewayConflictResolver)
```
    Requires Pivotal 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
```
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(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
```
public Integer getLockLease()
```
    Returns:
    
    the lockLease
  - setLockTimeout
```
public void setLockTimeout(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
```
public Integer getLockTimeout()
```
    Returns:
    
    the lockTimeout
  - setMessageSyncInterval
```
public void setMessageSyncInterval(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
```
public Integer getMessageSyncInterval()
```
    Returns:
    
    the messageSyncInterval
  - setPhase
```
protected void setPhase(int phase)
```
    Set the phase for the Cache bean in the lifecycle managed by the Spring container.
    
    Parameters:
    
    phase - int value indicating the phase of this Cache bean in the lifecycle managed by the Spring container.
    
    See Also:
    
    Phased.getPhase()
  - getPhase
```
public int getPhase()
```
    Returns the configured phase of the Cache bean in the lifecycle managed by the Spring container.
    
    Specified by:
    
    getPhase in interface Phased
    
    Returns:
    
    an int value indicating the phase of this Cache bean in the lifecycle managed by the Spring container.
    
    See Also:
    
    Phased.getPhase()
  - setPdxDiskStoreName
```
public void setPdxDiskStoreName(String pdxDiskStoreName)
```
    Set the disk store that is used for PDX meta data. Applicable on GemFire 6.6 or higher.
    
    Parameters:
    
    pdxDiskStoreName - the pdxDiskStoreName to set
  - getPdxDiskStoreName
```
public String getPdxDiskStoreName()
```
    Returns:
    
    the pdxDiskStoreName
  - setPdxIgnoreUnreadFields
```
public void setPdxIgnoreUnreadFields(Boolean pdxIgnoreUnreadFields)
```
    Controls whether pdx ignores fields that were unread during deserialization. Applicable on Pivotal GemFire 6.6 or higher.
    
    Parameters:
    
    pdxIgnoreUnreadFields - the pdxIgnoreUnreadFields to set
  - getPdxIgnoreUnreadFields
```
public Boolean getPdxIgnoreUnreadFields()
```
    Returns:
    
    the pdxIgnoreUnreadFields
  - setPdxPersistent
```
public void setPdxPersistent(Boolean pdxPersistent)
```
    Controls whether type metadata for PDX objects is persisted to disk. Applicable on Pivotal GemFire 6.6 or higher.
    
    Parameters:
    
    pdxPersistent - a boolean value indicating that PDX type meta-data should be persisted to disk.
  - getPdxPersistent
```
public Boolean getPdxPersistent()
```
    Returns:
    
    the pdxPersistent
  - setPdxReadSerialized
```
public void setPdxReadSerialized(Boolean pdxReadSerialized)
```
    Sets the object preference to PdxInstance. Applicable on Pivotal GemFire 6.6 or higher.
    
    Parameters:
    
    pdxReadSerialized - a boolean value indicating the PDX instance should be returned from Region.get(key) when available.
  - getPdxReadSerialized
```
public Boolean getPdxReadSerialized()
```
    Returns:
    
    the pdxReadSerialized
  - setPdxSerializer
```
public void setPdxSerializer(org.apache.geode.pdx.PdxSerializer serializer)
```
    Sets the PdxSerializable for this cache. Applicable on GemFire 6.6 or higher. The argument is of type object for compatibility with Pivotal GemFire 6.5.
    
    Parameters:
    
    serializer - pdx serializer configured for this cache.
  - getPdxSerializer
```
public org.apache.geode.pdx.PdxSerializer getPdxSerializer()
```
    Returns:
    
    the pdxSerializer
  - 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(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
```
public Integer getSearchTimeout()
```
    Returns:
    
    the searchTimeout
  - setSecurityManager
```
public void setSecurityManager(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
```
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
  - setTransactionListeners
```
public void setTransactionListeners(List<org.apache.geode.cache.TransactionListener> transactionListeners)
```
    Sets the list of TransactionListeners used to configure the Cache to receive transaction events after the transaction is processed (committed, rolled back).
    
    Parameters:
    
    transactionListeners - the list of Pivotal GemFire TransactionListeners listening for transaction events.
    
    See Also:
    
    TransactionListener
  - getTransactionListeners
```
public List<org.apache.geode.cache.TransactionListener> getTransactionListeners()
```
    Returns:
    
    the transactionListeners
  - setTransactionWriter
```
public void setTransactionWriter(org.apache.geode.cache.TransactionWriter transactionWriter)
```
    Sets the TransactionWriter used to configure the Cache for handling transaction events, such as to veto the transaction or update an external DB before the commit.
    
    Parameters:
    
    transactionWriter - the Pivotal GemFire TransactionWriter callback receiving transaction events.
    
    See Also:
    
    TransactionWriter
  - getTransactionWriter
```
public org.apache.geode.cache.TransactionWriter getTransactionWriter()
```
    Returns:
    
    the transactionWriter
  - setUseBeanFactoryLocator
```
public void setUseBeanFactoryLocator(boolean use)
```
    Sets whether to enable the GemfireBeanFactoryLocator.
    
    Parameters:
    
    use - boolean value indicating whether to enable the GemfireBeanFactoryLocator.
    
    See Also:
    
    GemfireBeanFactoryLocator
  - isUseBeanFactoryLocator
```
public boolean isUseBeanFactoryLocator()
```
    Determines whether the GemfireBeanFactoryLocator has been enabled.
    
    Returns:
    
    a boolean value indicating whether the GemfireBeanFactoryLocator has been enabled.
    
    See Also:
    
    GemfireBeanFactoryLocator
  - setUseClusterConfiguration
```
public void setUseClusterConfiguration(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
```
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.

Class CacheFactoryBean

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

beanFactoryLocator

Constructor Detail

CacheFactoryBean

Method Detail

afterPropertiesSet

applyCacheConfigurers

applyPeerCacheConfigurers

applyPeerCacheConfigurers

resolveCache

fetchCache

resolveProperties

createFactory

initializeFactory

configureFactory

postProcess

createCache

postProcess

close

destroy

translateExceptionIfPossible

getBeanFactoryLocator

setCache

getCache

setCacheXml

getCacheXml

getObject

getObjectType

setCacheFactoryInitializer

getCacheFactoryInitializer

setAndGetProperties

setProperties

getProperties

setClose

isClose

getCompositePeerCacheConfigurer

setCopyOnRead

getCopyOnRead

setCriticalHeapPercentage

getCriticalHeapPercentage

setCriticalOffHeapPercentage

getCriticalOffHeapPercentage

setDynamicRegionSupport

getDynamicRegionSupport

setEnableAutoReconnect

getEnableAutoReconnect

setEvictionHeapPercentage

getEvictionHeapPercentage

setEvictionOffHeapPercentage

getEvictionOffHeapPercentage

setGatewayConflictResolver

getGatewayConflictResolver

setJndiDataSources

getJndiDataSources

setLockLease

getLockLease

setLockTimeout

getLockTimeout

setMessageSyncInterval

getMessageSyncInterval

setPhase

getPhase

setPdxDiskStoreName

getPdxDiskStoreName

setPdxIgnoreUnreadFields

getPdxIgnoreUnreadFields

setPdxPersistent

getPdxPersistent

setPdxReadSerialized

getPdxReadSerialized

setPdxSerializer