Package org.springframework.data.gemfire

Class AbstractResolvableCacheFactoryBean

java.lang.Object

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

org.springframework.data.gemfire.AbstractBasicCacheFactoryBean

org.springframework.data.gemfire.AbstractConfigurableCacheFactoryBean

org.springframework.data.gemfire.AbstractResolvableCacheFactoryBean

All Implemented Interfaces:

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

Direct Known Subclasses:

CacheFactoryBean

public abstract class AbstractResolvableCacheFactoryBean
extends AbstractConfigurableCacheFactoryBean

Abstract base class encapsulating logic to resolve or create a GemFireCache instance.

Since:

2.5.0

Author:

John Blum

See Also:

• Optional
• Properties
• GemFireCache
• DistributedMember
• DistributedSystem
• AbstractConfigurableCacheFactoryBean

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
AbstractResolvableCacheFactoryBean()

Method Summary

Modifier and Type	Method	Description
protected Object	configureFactory(Object factory)	Configures the cache factory used to create the GemFireCache.
protected abstract <T extends GemFireCache> T	createCache(Object factory)	Creates a new GemFireCache instance using the provided factory.
protected abstract Object	createFactory(Properties gemfireProperties)	Constructs a new cache factory initialized with the given Apache Geode Properties used to construct, configure and initialize a new GemFireCache.
protected GemFireCache	doGetObject()	Called if AbstractBasicCacheFactoryBean.getCache() returns a null GemFireCache reference from AbstractBasicCacheFactoryBean.getObject().
protected GemFireCache	init()	Initializes a GemFireCache.
protected Object	initializeFactory(Object factory)	Initializes the given CacheFactory or ClientCacheFactory with the configured AbstractBasicCacheFactoryBean.CacheFactoryInitializer.
protected Object	postProcess(Object factory)	Post process the cache factory used to create the GemFireCache.
protected <T extends GemFireCache> T	postProcess(T cache)	Post process the GemFireCache by loading any cache.xml file, applying custom settings specified in SDG XML configuration metadata, and registering appropriate Transaction Listeners, Writer and JVM Heap configuration.
protected <T extends GemFireCache> T	resolveCache()	Resolves a GemFireCache by attempting to lookup an existing GemFireCache instance in the JVM, first.

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

applyCacheConfigurers, close, configureHeapPercentages, configureOffHeapPercentages, configurePdx, doFetchCache, doGetObjectType, 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, getLog, getOptionalLog, isDebugLoggingEnabled, isErrorLoggingEnabled, isInfoLoggingEnabled, isSingleton, isWarnLoggingEnabled, 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

Constructor Details

AbstractResolvableCacheFactoryBean

public AbstractResolvableCacheFactoryBean()

Method Details

doGetObject

protected GemFireCache doGetObject()

Description copied from class: AbstractBasicCacheFactoryBean

Called if AbstractBasicCacheFactoryBean.getCache() returns a null GemFireCache reference from AbstractBasicCacheFactoryBean.getObject().

Specified by:

doGetObject in class AbstractBasicCacheFactoryBean

Returns:

a new constructed, configured and initialized GemFireCache instance.

See Also:

• GemFireCache
• AbstractBasicCacheFactoryBean.getObject()

init

protected GemFireCache init()

Initializes a GemFireCache.

Returns:

a reference to the initialized GemFireCache.

See Also:

• GemFireCache
• AbstractBasicCacheFactoryBean.setCache(GemFireCache)
• resolveCache()
• AbstractBasicCacheFactoryBean.getCache()

resolveCache

protected <T extends GemFireCache> T resolveCache()

Resolves a GemFireCache by attempting to lookup an existing GemFireCache instance in the JVM, first. If an existing GemFireCache could not be found, then this method proceeds in attempting to create a new GemFireCache instance.

Type Parameters:

T - parameterized Class type extending GemFireCache.

Returns:

the resolved GemFireCache.

See Also:

• ClientCache
• GemFireCache
• Cache
• AbstractBasicCacheFactoryBean.fetchCache()
• AbstractConfigurableCacheFactoryBean.resolveProperties()
• createFactory(java.util.Properties)
• initializeFactory(Object)
• configureFactory(Object)
• postProcess(Object)
• createCache(Object)
• postProcess(GemFireCache)

createFactory

@NonNull
protected abstract Object createFactory(@NonNull
 Properties gemfireProperties)

Constructs a new cache factory initialized with the given Apache Geode Properties used to construct, configure and initialize a new GemFireCache.

Parameters:

gemfireProperties - Properties used by the cache factory to configure the GemFireCache; must not be null

Returns:

a new cache factory initialized with the given Apache Geode Properties.

See Also:

• ClientCacheFactory
• CacheFactory
• Properties
• AbstractConfigurableCacheFactoryBean.resolveProperties()

configureFactory

@NonNull
protected Object configureFactory(@NonNull
 Object factory)

Configures the cache factory used to create the GemFireCache.

Parameters:

factory - cache factory to configure; must not be null.

Returns:

the given cache factory.

See Also:

• createFactory(Properties)

initializeFactory

protected Object initializeFactory(Object factory)

Description copied from class: AbstractBasicCacheFactoryBean

Initializes the given CacheFactory or ClientCacheFactory with the configured AbstractBasicCacheFactoryBean.CacheFactoryInitializer.

Overrides:

initializeFactory in class AbstractBasicCacheFactoryBean

Parameters:

factory - CacheFactory or ClientCacheFactory to initialize.

Returns:

the initialized CacheFactory or ClientCacheFactory.

See Also:

• AbstractBasicCacheFactoryBean.CacheFactoryInitializer.initialize(Object)
• ClientCacheFactory
• CacheFactory
• AbstractBasicCacheFactoryBean.getCacheFactoryInitializer()

postProcess

@NonNull
protected Object postProcess(@NonNull
 Object factory)

Post process the cache factory used to create the GemFireCache.

Parameters:

factory - cache factory to post process; must not be null.

Returns:

the post processed cache factory.

See Also:

• ClientCacheFactory
• CacheFactory
• createFactory(Properties)

createCache

@NonNull
protected abstract <T extends GemFireCache> T createCache(@NonNull
 Object factory)

Creates a new GemFireCache instance using the provided factory.

Type Parameters:

T - Subtype of GemFireCache.

Parameters:

factory - factory used to create the GemFireCache.

Returns:

a new instance of GemFireCache created by the provided factory.

See Also:

• ClientCacheFactory.create()
• CacheFactory.create()
• GemFireCache

postProcess

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

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

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)
• AbstractBasicCacheFactoryBean.registerTransactionListeners(org.apache.geode.cache.GemFireCache)
• AbstractBasicCacheFactoryBean.registerTransactionWriter(org.apache.geode.cache.GemFireCache)