Package org.springframework.data.gemfire.config.annotation

Class AbstractCacheConfiguration

java.lang.Object

org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

org.springframework.data.gemfire.config.annotation.AbstractCacheConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportAware, EnvironmentAware

Direct Known Subclasses:

ClientCacheConfiguration, PeerCacheConfiguration

@Configuration
public abstract class AbstractCacheConfiguration
extends AbstractAnnotationConfigSupport
implements ImportAware

AbstractCacheConfiguration is an abstract base class for configuring either a Pivotal GemFire/Apache Geode client or peer-based cache instance using Spring's Java-based, Annotation Configuration support. This class encapsulates configuration settings common to both Pivotal GemFire/Apache Geode peer caches and client caches.

Since:

1.9.0

Author:

John Blum

See Also:

• Annotation
• Properties
• Cache
• GemFireCache
• ClientCache
• CacheServer
• BeanFactory
• BeanDefinition
• BeanDefinitionBuilder
• BeanDefinitionRegistry
• Bean
• Configuration
• ImportAware
• AnnotationAttributes
• Resource
• AnnotationMetadata
• CacheFactoryBean
• ClientCacheFactoryBean
• AbstractAnnotationConfigSupport
• CustomEditorBeanFactoryPostProcessor
• DefinedIndexesApplicationListener
• DiskStoreDirectoryBeanPostProcessor
• PropertiesBuilder

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

AbstractAnnotationConfigSupport.TypeResolver<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final boolean	DEFAULT_CLOSE
protected static final boolean	DEFAULT_COPY_ON_READ
protected static final String	DEFAULT_LOCATORS
protected static final String	DEFAULT_LOG_LEVEL
protected static final int	DEFAULT_MCAST_PORT
protected static final String	DEFAULT_NAME
protected static final boolean	DEFAULT_USE_BEAN_FACTORY_LOCATOR

Fields inherited from class org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

INFRASTRUCTURE_ROLES, ORG_SPRINGFRAMEWORK_DATA_GEMFIRE_PACKAGE, ORG_SPRINGFRAMEWORK_PACKAGE, SPRING_DATA_GEMFIRE_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor	Description
AbstractCacheConfiguration()

Method Summary

Modifier and Type	Method	Description
void	add(Properties gemfireProperties)
protected void	configureCache(AnnotationMetadata importMetadata)	Configures Pivotal GemFire/Apache Geode cache specific settings.
protected <T extends CacheFactoryBean> T	configureCacheFactoryBean(T gemfireCache)	Configures the CacheFactoryBean with common cache configuration settings.
protected void	configureInfrastructure(AnnotationMetadata importMetadata)	Configures Spring container infrastructure components and beans used by Spring Data GemFire to enable Pivotal GemFire or Apache Geode to function properly inside a Spring context.
protected void	configureOptional(AnnotationMetadata importMetadata)	Callback method allowing developers to configure other cache or application specific configuration settings.
protected <T extends CacheFactoryBean> T	constructCacheFactoryBean()	Constructs a new, initialized instance of CacheFactoryBean based on the Spring application's cache type preference (i.e. client or peer), which is expressed via the appropriate annotation.
protected Properties	gemfireProperties()	Returns a Properties object containing Pivotal GemFire/Apache Geode properties used to configure the Pivotal GemFire/Apache Geode cache.
protected Resource	getCacheXml()
protected boolean	getCopyOnRead()
protected Float	getCriticalHeapPercentage()
protected Float	getCriticalOffHeapPercentage()
protected Float	getEvictionHeapPercentage()
protected Float	getEvictionOffHeapPercentage()
protected GatewayConflictResolver	getGatewayConflictResolver()
protected List<CacheFactoryBean.JndiDataSource>	getJndiDataSources()
protected List<TransactionListener>	getTransactionListeners()
protected TransactionWriter	getTransactionWriter()
protected boolean	isCacheServerApplication(AnnotationMetadata importMetadata)	Determines whether this is a GemFire CacheServer application, which is indicated by the presence of the CacheServerApplication annotation on a Spring application @Configuration class.
protected boolean	isCacheServerOrPeerCacheApplication(AnnotationMetadata importMetadata)	Determines whether this is a GemFire CacheServer or peer cache application, which is indicated by the presence of either the CacheServerApplication annotation or the PeerCacheApplication annotation on a Spring application @Configuration class.
protected boolean	isClientCacheApplication(AnnotationMetadata importMetadata)	Determines whether this is a GemFire ClientCache application, which is indicated by the presence of the ClientCacheApplication annotation on a Spring application @Configuration class.
protected boolean	isClientPeerOrServerCacheApplication(AnnotationMetadata importMetadata)	Determine whether this Spring application is a CacheServer, ClientCache or a Cache application.
protected boolean	isClose()
protected boolean	isPeerCacheApplication(AnnotationMetadata importMetadata)	Determines whether this is a GemFire peer Cache application, which is indicated by the presence of the PeerCacheApplication annotation on a Spring application @Configuration class.
protected boolean	isTypedCacheApplication(Class<? extends Annotation> annotationType, AnnotationMetadata importMetadata)	Determines whether this Spring application is annotated with the given GemFire cache type annotation.
protected String	locators()
protected String	logLevel()
protected Integer	mcastPort()
protected String	name()
protected abstract <T extends CacheFactoryBean> T	newCacheFactoryBean()	Constructs a new, uninitialized instance of CacheFactoryBean based on the Spring application's cache type preference (i.e. client or peer), which is expressed via the appropriate annotation.
void	setImportMetadata(AnnotationMetadata importMetadata)
protected String	startLocator()
String	toString()
protected boolean	useBeanFactoryLocator()

Methods inherited from class org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

arrayOfPropertyNamesFor, arrayOfPropertyNamesFor, asArrayProperty, cacheClientProperty, cacheCompressionProperty, cacheOffHeapProperty, cachePeerProperty, cacheProperty, cacheServerProperty, clusterProperty, diskStoreProperty, entitiesProperty, gatewayReceiverProperty, gatewaySenderProperty, getAnnotationAttributes, getAnnotationAttributes, getAnnotationAttributes, getAnnotationType, getAnnotationTypeName, getAnnotationTypeSimpleName, getBeanClassLoader, getBeanFactory, getEnvironment, getEvaluationContext, getLog, hasValue, hasValue, hasValue, httpServiceProperty, isAnnotationPresent, isAnnotationPresent, isNotInfrastructureBean, isNotInfrastructureBean, isNotInfrastructureClass, isNotInfrastructureClass, isNotInfrastructureRole, isUserLevelMethod, locatorProperty, logDebug, logDebug, logError, logError, loggingProperty, logInfo, logInfo, logWarning, logWarning, managementProperty, managerProperty, memcachedServiceProperty, namedCacheServerProperty, namedDiskStoreProperty, namedGatewaySenderProperty, namedPoolProperty, newEvaluationContext, newLog, pdxProperty, poolProperty, propertyName, redisServiceProperty, register, register, requireProperty, resolveAnnotation, resolveBeanClass, resolveBeanClass, resolveBeanClass, resolveBeanClassLoader, resolveBeanClassLoader, resolveBeanClassName, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, safeResolveType, securityProperty, serviceProperty, setBeanClassLoader, setBeanFactory, setEnvironment, sslProperty, statsProperty

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CLOSE

protected static final boolean DEFAULT_CLOSE

See Also:

• Constant Field Values

DEFAULT_COPY_ON_READ

protected static final boolean DEFAULT_COPY_ON_READ

See Also:

• Constant Field Values

DEFAULT_USE_BEAN_FACTORY_LOCATOR

protected static final boolean DEFAULT_USE_BEAN_FACTORY_LOCATOR

See Also:

• Constant Field Values

DEFAULT_MCAST_PORT

protected static final int DEFAULT_MCAST_PORT

See Also:

• Constant Field Values

DEFAULT_LOCATORS

protected static final String DEFAULT_LOCATORS

See Also:

• Constant Field Values

DEFAULT_LOG_LEVEL

protected static final String DEFAULT_LOG_LEVEL

See Also:

• Constant Field Values

DEFAULT_NAME

protected static final String DEFAULT_NAME

See Also:

• Constant Field Values

Constructor Details

AbstractCacheConfiguration

public AbstractCacheConfiguration()

Method Details

gemfireProperties

@Bean
protected Properties gemfireProperties()

Returns a Properties object containing Pivotal GemFire/Apache Geode properties used to configure the Pivotal GemFire/Apache Geode cache. The name of the Pivotal GemFire/Apache Geode member/node in the cluster is set to a default, pre-defined and descriptive value depending on the type of configuration meta-data applied. mcast-port is set to 0 and locators is set to an empty String, which is necessary for cache client-based applications. These values can be changed and set accordingly for peer cache and cache server applications. Finally, the log-level property defaults to config.

Returns:

a Properties object containing Pivotal GemFire/Apache Geode properties used to configure the Pivotal GemFire/Apache Geode cache instance.

See Also:

• Geode Properties
• Properties
• locators()
• logLevel()
• mcastPort()
• name()
• startLocator()

setImportMetadata

public void setImportMetadata(AnnotationMetadata importMetadata)

Specified by:

setImportMetadata in interface ImportAware

configureInfrastructure

protected void configureInfrastructure(AnnotationMetadata importMetadata)

Configures Spring container infrastructure components and beans used by Spring Data GemFire to enable Pivotal GemFire or Apache Geode to function properly inside a Spring context.

Parameters:

importMetadata - AnnotationMetadata containing annotation meta-data for the Spring Data GemFire cache application class.

See Also:

• AnnotationMetadata

configureCache

protected void configureCache(AnnotationMetadata importMetadata)

Configures Pivotal GemFire/Apache Geode cache specific settings.

Parameters:

importMetadata - AnnotationMetadata containing the cache meta-data used to configure the cache.

See Also:

• AnnotationMetadata

configureOptional

protected void configureOptional(AnnotationMetadata importMetadata)

Callback method allowing developers to configure other cache or application specific configuration settings.

Parameters:

importMetadata - AnnotationMetadata containing meta-data used to configure the cache or application.

See Also:

• AnnotationMetadata

constructCacheFactoryBean

protected <T extends CacheFactoryBean> T constructCacheFactoryBean()

Constructs a new, initialized instance of CacheFactoryBean based on the Spring application's cache type preference (i.e. client or peer), which is expressed via the appropriate annotation. Use the ClientCacheApplication Annotation to construct a cache client application. Use the PeerCacheApplication Annotation to construct a peer cache application.

Type Parameters:

T - Class specific sub-type of the CacheFactoryBean.

Returns:

a new instance of the appropriate CacheFactoryBean given the Spring application's cache type preference (i.e client or peer), (e.g. ClientCacheApplication or PeerCacheApplication).

See Also:

• ClientCacheFactoryBean
• CacheFactoryBean
• configureCacheFactoryBean(CacheFactoryBean)
• newCacheFactoryBean()

newCacheFactoryBean

protected abstract <T extends CacheFactoryBean> T newCacheFactoryBean()

Constructs a new, uninitialized instance of CacheFactoryBean based on the Spring application's cache type preference (i.e. client or peer), which is expressed via the appropriate annotation. Use the ClientCacheApplication Annotation to construct a cache client application. Use the PeerCacheApplication Annotation to construct a peer cache application.

Type Parameters:

T - Class specific sub-type of the CacheFactoryBean.

Returns:

a new instance of the appropriate CacheFactoryBean given the Spring application's cache type preference (i.e client or peer), (e.g. ClientCacheApplication or PeerCacheApplication).

See Also:

• ClientCacheFactoryBean
• CacheFactoryBean

configureCacheFactoryBean

protected <T extends CacheFactoryBean> T configureCacheFactoryBean(T gemfireCache)

Configures the CacheFactoryBean with common cache configuration settings.

Type Parameters:

T - Class specific sub-type of the CacheFactoryBean.

Parameters:

gemfireCache - CacheFactoryBean to configure.

Returns:

the given CacheFactoryBean with common cache configuration settings applied.

See Also:

• ClientCacheFactoryBean
• CacheFactoryBean

isCacheServerApplication

protected boolean isCacheServerApplication(AnnotationMetadata importMetadata)

Determines whether this is a GemFire CacheServer application, which is indicated by the presence of the CacheServerApplication annotation on a Spring application @Configuration class.

Parameters:

importMetadata - AnnotationMetadata containing application configuration meta-data from the annotations used to configure the Spring application.

Returns:

a boolean value indicating whether this is a GemFire cache server application.

See Also:

• CacheServerApplication
• isTypedCacheApplication(Class, AnnotationMetadata)

isClientCacheApplication

protected boolean isClientCacheApplication(AnnotationMetadata importMetadata)

Determines whether this is a GemFire ClientCache application, which is indicated by the presence of the ClientCacheApplication annotation on a Spring application @Configuration class.

Parameters:

importMetadata - AnnotationMetadata containing application configuration meta-data from the annotations used to configure the Spring application.

Returns:

a boolean value indicating whether this is a GemFire cache client application.

See Also:

• ClientCacheApplication
• isTypedCacheApplication(Class, AnnotationMetadata)

isPeerCacheApplication

protected boolean isPeerCacheApplication(AnnotationMetadata importMetadata)

Determines whether this is a GemFire peer Cache application, which is indicated by the presence of the PeerCacheApplication annotation on a Spring application @Configuration class.

Parameters:

importMetadata - AnnotationMetadata containing application configuration meta-data from the annotations used to configure the Spring application.

Returns:

a boolean value indicating whether this is a GemFire peer cache application.

See Also:

• PeerCacheApplication
• isTypedCacheApplication(Class, AnnotationMetadata)

isTypedCacheApplication

protected boolean isTypedCacheApplication(Class<? extends Annotation> annotationType,
 AnnotationMetadata importMetadata)

Determines whether this Spring application is annotated with the given GemFire cache type annotation.

Parameters:

annotationType - Annotation cache type.

importMetadata - AnnotationMetadata containing application configuration meta-data from the annotations used to configure the Spring application.

Returns:

a boolean value indicating if this Spring application is annotated with the given GemFire cache type annotation.

See Also:

• AnnotationMetadata
• Annotation
• AbstractAnnotationConfigSupport.getAnnotationTypeName()
• AbstractAnnotationConfigSupport.getAnnotationType()

isCacheServerOrPeerCacheApplication

protected boolean isCacheServerOrPeerCacheApplication(AnnotationMetadata importMetadata)

Determines whether this is a GemFire CacheServer or peer cache application, which is indicated by the presence of either the CacheServerApplication annotation or the PeerCacheApplication annotation on a Spring application @Configuration class.

Parameters:

importMetadata - AnnotationMetadata containing application configuration meta-data from the annotations used to configure the Spring application.

Returns:

a boolean value indicating whether this is a GemFire cache server or peer cache application.

See Also:

• AnnotationMetadata
• CacheServerApplication
• PeerCacheApplication
• isCacheServerApplication(AnnotationMetadata)
• isPeerCacheApplication(AnnotationMetadata)

isClientPeerOrServerCacheApplication

protected boolean isClientPeerOrServerCacheApplication(AnnotationMetadata importMetadata)

Determine whether this Spring application is a CacheServer, ClientCache or a Cache application.

Parameters:

importMetadata - AnnotationMetadata containing application configuration meta-data from the class type-level annotations used to configure the Spring application.

Returns:

a boolean value indicating whether this is a GemFire cache server, client cache or peer cache Spring application.

See Also:

• isCacheServerApplication(AnnotationMetadata)
• isClientCacheApplication(AnnotationMetadata)
• isPeerCacheApplication(AnnotationMetadata)

getCacheXml

protected Resource getCacheXml()

isClose

protected boolean isClose()

getCopyOnRead

protected boolean getCopyOnRead()

getCriticalHeapPercentage

protected Float getCriticalHeapPercentage()

getCriticalOffHeapPercentage

protected Float getCriticalOffHeapPercentage()

getEvictionHeapPercentage

protected Float getEvictionHeapPercentage()

getEvictionOffHeapPercentage

protected Float getEvictionOffHeapPercentage()

getGatewayConflictResolver

protected GatewayConflictResolver getGatewayConflictResolver()

getJndiDataSources

protected List<CacheFactoryBean.JndiDataSource> getJndiDataSources()

locators

protected String locators()

logLevel

protected String logLevel()

mcastPort

protected Integer mcastPort()

name

protected String name()

startLocator

protected String startLocator()

getTransactionListeners

protected List<TransactionListener> getTransactionListeners()

getTransactionWriter

protected TransactionWriter getTransactionWriter()

useBeanFactoryLocator

protected boolean useBeanFactoryLocator()

add

public void add(Properties gemfireProperties)

toString

public String toString()

Overrides:

toString in class Object