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, InitializingBean, ImportAware

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, PdxSerializer, BeanFactory, BeanDefinition, BeanDefinitionBuilder, BeanDefinitionRegistry, Bean, Configuration, ImportAware, ConversionService, Resource, AnnotationMetadata, CacheFactoryBean, ClientCacheFactoryBean, AbstractAnnotationConfigSupport, CustomEditorBeanFactoryPostProcessor, DefinedIndexesApplicationListener, DiskStoreDirectoryBeanPostProcessor, PdxDiskStoreAwareBeanFactoryPostProcessor, GemfireMappingContext, MappingPdxSerializer

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractCacheConfiguration()

Method Summary

Modifier and Type	Method and Description
void	add(Properties gemfireProperties)
protected Resource	cacheXml()
protected boolean	close()
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	configurePdx(AnnotationMetadata importMetadata) Configures Pivotal GemFire/Apache Geode cache PDX Serialization.
protected void	configureTheRest(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 boolean	copyOnRead()
protected Float	criticalHeapPercentage()
protected CacheFactoryBean.DynamicRegionSupport	dynamicRegionSupport()
protected Float	evictionHeapPercentage()
protected org.apache.geode.cache.util.GatewayConflictResolver	gatewayConflictResolver()
protected Properties	gemfireProperties() Returns a Properties object containing Pivotal GemFire/Apache Geode properties used to configure the Pivotal GemFire/Apache Geode cache.
protected abstract Class	getAnnotationType() Returns the cache application Annotation type pertaining to this configuration.
protected String	getAnnotationTypeName() Returns the fully-qualified class name of the cache application Annotation type.
protected String	getAnnotationTypeSimpleName() Returns the simple class name of the cache application Annotation type.
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	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 List<CacheFactoryBean.JndiDataSource>	jndiDataSources()
protected String	locators()
protected String	logLevel()
protected GemfireMappingContext	mappingContext()
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.
protected <T extends org.apache.geode.pdx.PdxSerializer> T	newPdxSerializer() Constructs a new instance of PdxSerializer.
protected <T extends org.apache.geode.pdx.PdxSerializer> T	newPdxSerializer(BeanFactory beanFactory) Constructs a new instance of MappingPdxSerializer.
protected String	pdxDiskStoreName()
protected Boolean	pdxIgnoreUnreadFields()
protected Boolean	pdxPersistent()
protected Boolean	pdxReadSerialized()
protected org.apache.geode.pdx.PdxSerializer	pdxSerializer()
protected org.apache.geode.pdx.PdxSerializer	resolvePdxSerializer(String pdxSerializerBeanName) Resolves the PdxSerializer used to configure the cache for PDX De/Serialization.
void	setImportMetadata(AnnotationMetadata importMetadata)
protected String	startLocator()
String	toString()
protected List<org.apache.geode.cache.TransactionListener>	transactionListeners()
protected org.apache.geode.cache.TransactionWriter	transactionWriter()
protected boolean	useBeanFactoryLocator()

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

afterPropertiesSet, beanClassLoader, beanFactory, evaluationContext, hasValue, hasValue, hasValue, newEvaluationContext, register, register, setBeanClassLoader, setBeanFactory

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

AbstractCacheConfiguration

public AbstractCacheConfiguration()

Method Detail

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 accoridingly 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:

GemFire Properties, Properties, locators(), logLevel(), mcastPort(), name()

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

configurePdx

protected void configurePdx(AnnotationMetadata importMetadata)

Configures Pivotal GemFire/Apache Geode cache PDX Serialization.

Parameters:

importMetadata - AnnotationMetadata containing PDX meta-data used to configure the cache with PDX de/serialization capabilities.

See Also:

AnnotationMetadata, GemFire PDX Serialization

resolvePdxSerializer

protected org.apache.geode.pdx.PdxSerializer resolvePdxSerializer(String pdxSerializerBeanName)

Resolves the PdxSerializer used to configure the cache for PDX De/Serialization.

Parameters:

pdxSerializerBeanName - String containing the name of a Spring bean implementing the PdxSerializer interface.

Returns:

the resolved PdxSerializer from configuration.

See Also:

PdxSerializer, newPdxSerializer(BeanFactory), AbstractAnnotationConfigSupport.beanFactory()

newPdxSerializer

protected <T extends org.apache.geode.pdx.PdxSerializer> T newPdxSerializer()

Constructs a new instance of PdxSerializer.

Type Parameters:

T - Class type of the PdxSerializer.

Returns:

a new instance of PdxSerializer.

See Also:

PdxSerializer, newPdxSerializer(BeanFactory)

newPdxSerializer

protected <T extends org.apache.geode.pdx.PdxSerializer> T newPdxSerializer(BeanFactory beanFactory)

Constructs a new instance of MappingPdxSerializer.

Type Parameters:

T - Class type of the PdxSerializer; this method returns a MappingPdxSerializer.

Parameters:

beanFactory - BeanFactory used to get an instance of ConversionService used by the MappingPdxSerializer.

Returns:

a new instance of MappingPdxSerializer.

See Also:

MappingPdxSerializer, BeanFactory, PdxSerializer

configureTheRest

protected void configureTheRest(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

getAnnotationType

protected abstract Class getAnnotationType()

Returns the cache application Annotation type pertaining to this configuration.

Specified by:

getAnnotationType in class AbstractAnnotationConfigSupport

Returns:

the cache application Annotation type used by this application.

See Also:

CacheServerApplication, ClientCacheApplication, PeerCacheApplication

getAnnotationTypeName

protected String getAnnotationTypeName()

Returns the fully-qualified class name of the cache application Annotation type.

Overrides:

getAnnotationTypeName in class AbstractAnnotationConfigSupport

Returns:

the fully-qualified class name of the cache application Annotation type.

See Also:

Class.getName(), getAnnotationType()

getAnnotationTypeSimpleName

protected String getAnnotationTypeSimpleName()

Returns the simple class name of the cache application Annotation type.

Overrides:

getAnnotationTypeSimpleName in class AbstractAnnotationConfigSupport

Returns:

the simple class name of the cache application Annotation type.

See Also:

Class.getSimpleName(), getAnnotationType()

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, getAnnotationTypeName(), 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)

cacheXml

protected Resource cacheXml()

close

protected boolean close()

copyOnRead

protected boolean copyOnRead()

criticalHeapPercentage

protected Float criticalHeapPercentage()

dynamicRegionSupport

protected CacheFactoryBean.DynamicRegionSupport dynamicRegionSupport()

evictionHeapPercentage

protected Float evictionHeapPercentage()

gatewayConflictResolver

protected org.apache.geode.cache.util.GatewayConflictResolver gatewayConflictResolver()

jndiDataSources

protected List<CacheFactoryBean.JndiDataSource> jndiDataSources()

locators

protected String locators()

logLevel

protected String logLevel()

mappingContext

protected GemfireMappingContext mappingContext()

mcastPort

protected Integer mcastPort()

name

protected String name()

pdxDiskStoreName

protected String pdxDiskStoreName()

pdxIgnoreUnreadFields

protected Boolean pdxIgnoreUnreadFields()

pdxPersistent

protected Boolean pdxPersistent()

pdxReadSerialized

protected Boolean pdxReadSerialized()

pdxSerializer

protected org.apache.geode.pdx.PdxSerializer pdxSerializer()

startLocator

protected String startLocator()

transactionListeners

protected List<org.apache.geode.cache.TransactionListener> transactionListeners()

transactionWriter

protected org.apache.geode.cache.TransactionWriter transactionWriter()

useBeanFactoryLocator

protected boolean useBeanFactoryLocator()

add

public void add(Properties gemfireProperties)

toString

public String toString()

Overrides:

toString in class Object