Package org.springframework.data.gemfire

Class AbstractConfigurableCacheFactoryBean

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<GemFireCache>

org.springframework.data.gemfire.AbstractBasicCacheFactoryBean

org.springframework.data.gemfire.AbstractConfigurableCacheFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, FactoryBean<GemFireCache>, InitializingBean, Phased, PersistenceExceptionTranslator

Direct Known Subclasses:

AbstractResolvableCacheFactoryBean

public abstract class AbstractConfigurableCacheFactoryBean
extends AbstractBasicCacheFactoryBean

Abstract base class encapsulating functionality for (externally) configuring an Apache Geode ClientCache or peer Cache as a bean in the Spring context.

Since:

2.5.0

Author:

John Blum

See Also:

• File
• InputStream
• Properties
• Cache
• GemFireCache
• ClientCache
• BeanFactory
• Resource
• AbstractBasicCacheFactoryBean
• GemfireBeanFactoryLocator

Nested Class Summary

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	Description
AbstractConfigurableCacheFactoryBean()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Initializes the GemfireBeanFactoryLocator if isUseBeanFactoryLocator() returns true and an existing GemfireBeanFactoryLocator is not already present.
void	destroy()	Destroys and releases resources used by the GemfireBeanFactoryLocator, if present.
GemfireBeanFactoryLocator	getBeanFactoryLocator()	Returns a reference to the configured GemfireBeanFactoryLocator used to resolve Spring bean references in Apache Geode native configuration metadata (e.g.
Resource	getCacheXml()	Returns a reference to an (optional) Apache Geode native cache.xml Resource.
Optional<GemfireBeanFactoryLocator>	getOptionalBeanFactoryLocator()	Returns an Optional reference to the configured GemfireBeanFactoryLocator used to resolve Spring bean references in Apache Geode native configuration metadata (e.g.
Optional<Resource>	getOptionalCacheXml()	Returns an Optional reference to an Apache Geode native cache.xml Resource.
Properties	getProperties()	Returns a reference to the Apache Geode Properties used to configure the cache.
protected boolean	isCacheXmlPresent()	Determines whether a cache.xml Resource exists (i.e. is present).
protected boolean	isCacheXmlResolvableAsAFile()	Determines whether the optionally configured cache.xml is resolvable as a File in the file system.
boolean	isUseBeanFactoryLocator()	Determines whether the GemfireBeanFactoryLocator has been enabled.
protected <T extends GemFireCache> T	loadCacheXml(T cache)	Loads the configured cache.xml to initialize the GemFireCache.
protected Properties	resolveProperties()	Resolves the Apache Geode Properties used to configure the GemFireCache.
Properties	setAndGetProperties(Properties properties)	Sets and then returns a reference to Apache Geode Properties used to configure the cache.
protected void	setBeanFactoryLocator(GemfireBeanFactoryLocator beanFactoryLocator)	Gets a reference to the configured GemfireBeanFactoryLocator used to resolve Spring bean references in Apache Geode native configuration metadata (e.g.
void	setCacheXml(Resource cacheXml)	Sets a reference to an (optional) Apache Geode native cache.xml Resource.
void	setProperties(Properties properties)	Sets the Apache Geode Properties used to configure the cache.
void	setUseBeanFactoryLocator(boolean use)	Sets a boolean value used to determine whether to enable the GemfireBeanFactoryLocator.

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

applyCacheConfigurers, close, configureHeapPercentages, configureOffHeapPercentages, configurePdx, doFetchCache, doGetObject, doGetObjectType, fetchCache, getCache, getCacheFactoryInitializer, getCopyOnRead, getCriticalHeapPercentage, getCriticalOffHeapPercentage, getEvictionHeapPercentage, getEvictionOffHeapPercentage, getObject, getObjectType, getOptionalCache, getPdxDiskStoreName, getPdxIgnoreUnreadFields, getPdxPersistent, getPdxReadSerialized, getPdxSerializer, getPhase, getTransactionListeners, getTransactionWriter, initializeFactory, 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 Details

AbstractConfigurableCacheFactoryBean

public AbstractConfigurableCacheFactoryBean()

Method Details

setBeanFactoryLocator

protected void setBeanFactoryLocator(@Nullable
 GemfireBeanFactoryLocator beanFactoryLocator)

Gets a reference to the configured GemfireBeanFactoryLocator used to resolve Spring bean references in Apache Geode native configuration metadata (e.g. cache.xml).

Parameters:

beanFactoryLocator - reference to the configured GemfireBeanFactoryLocator.

See Also:

• GemfireBeanFactoryLocator

getBeanFactoryLocator

@Nullable
public GemfireBeanFactoryLocator getBeanFactoryLocator()

Returns a reference to the configured GemfireBeanFactoryLocator used to resolve Spring bean references in Apache Geode native configuration metadata (e.g. cache.xml).

Returns:

a reference to the configured GemfireBeanFactoryLocator.

See Also:

• GemfireBeanFactoryLocator

getOptionalBeanFactoryLocator

public Optional<GemfireBeanFactoryLocator> getOptionalBeanFactoryLocator()

Returns an Optional reference to the configured GemfireBeanFactoryLocator used to resolve Spring bean references in Apache Geode native configuration metadata (e.g. cache.xml).

Returns:

an Optional reference to the configured GemfireBeanFactoryLocator.

See Also:

• GemfireBeanFactoryLocator
• getBeanFactoryLocator()
• Optional

setCacheXml

public void setCacheXml(@Nullable
 Resource cacheXml)

Sets a reference to an (optional) Apache Geode native cache.xml Resource.

Parameters:

cacheXml - reference to an (optional) Apache Geode native cache.xml Resource.

See Also:

• Resource

getCacheXml

@Nullable
public Resource getCacheXml()

Returns a reference to an (optional) Apache Geode native cache.xml Resource.

Returns:

a reference to an (optional) Apache Geode native cache.xml Resource.

See Also:

• Resource

getOptionalCacheXml

public Optional<Resource> getOptionalCacheXml()

Returns an Optional reference to an Apache Geode native cache.xml Resource.

Returns:

an Optional reference to an Apache Geode native cache.xml Resource.

See Also:

• Resource
• Optional
• getCacheXml()

isCacheXmlPresent

protected boolean isCacheXmlPresent()

Determines whether a cache.xml Resource exists (i.e. is present).

Returns:

boolean value indicating whether a cache.xml exists.

See Also:

• Resource.exists()
• getCacheXml()

isCacheXmlResolvableAsAFile

protected boolean isCacheXmlResolvableAsAFile()

Determines whether the optionally configured cache.xml is resolvable as a File in the file system.

Returns:

a boolean value indicating whether the optionally configured cache.xml is resolvable as a File in the file system.

See Also:

• Resource.isFile()
• getCacheXml()
• File

setAndGetProperties

@Nullable
public Properties setAndGetProperties(@Nullable
 Properties properties)

Sets and then returns a reference to Apache Geode Properties used to configure the cache.

Parameters:

properties - reference to Apache Geode Properties used to configure the cache.

Returns:

a reference to Apache Geode Properties used to configure the cache.

See Also:

• setProperties(Properties)
• getProperties()
• Properties

setProperties

public void setProperties(@Nullable
 Properties properties)

Sets the Apache Geode Properties used to configure the cache.

Parameters:

properties - reference to Apache Geode Properties used to configure the cache.

See Also:

• Properties

getProperties

@Nullable
public Properties getProperties()

Returns a reference to the Apache Geode Properties used to configure the cache.

Returns:

a reference to Apache Geode Properties.

See Also:

• Properties

setUseBeanFactoryLocator

public void setUseBeanFactoryLocator(boolean use)

Sets a boolean value used to determine whether to enable the GemfireBeanFactoryLocator.

Parameters:

use - boolean value used to determine 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

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Initializes the GemfireBeanFactoryLocator if isUseBeanFactoryLocator() returns true and an existing GemfireBeanFactoryLocator is not already present.

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractBasicCacheFactoryBean

Throws:

Exception - if initialization fails.

See Also:

• GemfireBeanFactoryLocator.newBeanFactoryLocator(BeanFactory, String)
• getOptionalBeanFactoryLocator()
• isUseBeanFactoryLocator()
• AbstractFactoryBeanSupport.getBeanFactory()
• AbstractFactoryBeanSupport.getBeanName()

destroy

public void destroy()

Destroys and releases resources used by the GemfireBeanFactoryLocator, if present.

Specified by:

destroy in interface DisposableBean

Overrides:

destroy in class AbstractBasicCacheFactoryBean

See Also:

• GemfireBeanFactoryLocator.destroy()
• getOptionalBeanFactoryLocator()

loadCacheXml

@NonNull
protected <T extends GemFireCache> T loadCacheXml(@NonNull
 T cache)

Loads the configured cache.xml to initialize the GemFireCache.

Type Parameters:

T - parameterized Class type extending GemFireCache.

Parameters:

cache - GemFireCache instance to initialize with cache.xml; must not be null.

Returns:

the given GemFireCache.

Throws:

RuntimeException - if the configured cache.xml file could not be loaded into the GemFireCache.

See Also:

• GemFireCache.loadCacheXml(InputStream)
• GemFireCache
• getOptionalCacheXml()

resolveProperties

@NonNull
protected Properties resolveProperties()

Resolves the Apache Geode Properties used to configure the GemFireCache.

Returns:

the resolved Apache Geode Properties used to configure the GemFireCache.

See Also:

• setAndGetProperties(Properties)
• getProperties()
• Properties