org.springframework.data.gemfire.config.annotation

Class AbstractCacheConfiguration

java.lang.Object

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

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportAware

Direct Known Subclasses:

ClientCacheConfiguration, PeerCacheConfiguration

@Configuration
public abstract class AbstractCacheConfiguration
extends Object
implements BeanClassLoaderAware, BeanFactoryAware, 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 GemFire peer caches and client caches.

Since:

1.9.0

Author:

John Blum

See Also:

BeanClassLoaderAware, BeanFactory, BeanFactoryAware, Bean, Configuration, ImportAware, Resource, AnnotationMetadata, CacheFactoryBean

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 ClassLoader	beanClassLoader() Returns a reference to the ClassLoader use by the Spring BeanFactory to load classes for bean definitions.
protected BeanFactory	beanFactory() Returns a reference to the Spring BeanFactory in the current application context.
protected Resource	cacheXml()
protected boolean	close()
protected void	configureCache(AnnotationMetadata importMetadata) Configures the GemFire cache settings.
protected void	configureInfrastructure(AnnotationMetadata importMetadata) Configures Spring container infrastructure components used by Spring Data GemFire to enable GemFire to function properly inside a Spring context.
protected void	configureOther(AnnotationMetadata importMetadata) Callback method to configure other, specific GemFire cache configuration settings.
protected void	configurePdx(AnnotationMetadata importMetadata) Configures GemFire's PDX Serialization components.
protected <T extends CacheFactoryBean> T	constructCacheFactoryBean() Constructs a new, initialized instance of the CacheFactoryBean based on the Spring application's GemFire cache type (i.e. client or peer) preference specified via annotation.
protected boolean	copyOnRead()
protected Float	criticalHeapPercentage()
protected CacheFactoryBean.DynamicRegionSupport	dynamicRegionSupport()
protected Float	evictionHeapPercentage()
protected com.gemstone.gemfire.cache.util.GatewayConflictResolver	gatewayConflictResolver()
protected Properties	gemfireProperties() Returns a Properties object containing GemFire System properties used to configure the GemFire cache.
protected abstract Class	getAnnotationType() Returns the GemFire cache application Annotation type pertaining to this configuration.
protected String	getAnnotationTypeName() Returns the fully-qualified class name of the GemFire cache application Annotation type.
protected String	getAnnotationTypeSimpleName() Returns the simple class name of the GemFire cache application Annotation type.
protected static boolean	hasValue(Number value) Determines whether the given Number has value.
protected static boolean	hasValue(Object value) Determines whether the given Object has value.
protected static boolean	hasValue(String value) Determines whether the given String has value.
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 the CacheFactoryBean based on the Spring application's GemFire cache type (i.e. client or peer) preference specified via annotation.
protected <T extends com.gemstone.gemfire.pdx.PdxSerializer> T	newPdxSerializer()
protected String	pdxDiskStoreName()
protected Boolean	pdxIgnoreUnreadFields()
protected Boolean	pdxPersistent()
protected Boolean	pdxReadSerialized()
protected com.gemstone.gemfire.pdx.PdxSerializer	pdxSerializer()
protected AbstractBeanDefinition	register(AbstractBeanDefinition beanDefinition) Registers the given BeanDefinition with the BeanDefinitionRegistry using a generated bean name.
protected void	registerCustomEditorBeanFactoryPostProcessor(AnnotationMetadata importMetadata)
protected void	registerDefinedIndexesApplicationListener(AnnotationMetadata importMetadata)
protected void	registerDiskStoreDirectoryBeanPostProcessor(AnnotationMetadata importMetadata)
protected void	registerPdxDiskStoreAwareBeanFactoryPostProcessor(AnnotationMetadata importMetadata)
protected com.gemstone.gemfire.pdx.PdxSerializer	resolvePdxSerializer(String pdxSerializerBeanName)
void	setBeanClassLoader(ClassLoader beanClassLoader)
void	setBeanFactory(BeanFactory beanFactory)
protected <T extends CacheFactoryBean> T	setCommonCacheConfiguration(T gemfireCache) Configures common GemFire cache configuration settings.
void	setImportMetadata(AnnotationMetadata importMetadata)
protected String	startLocator()
String	toString()
protected List<com.gemstone.gemfire.cache.TransactionListener>	transactionListeners()
protected com.gemstone.gemfire.cache.TransactionWriter	transactionWriter()
protected boolean	useBeanFactoryLocator()

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

hasValue

protected static boolean hasValue(Object value)

Determines whether the given Object has value. The Object is valuable if it is not null.

Parameters:

value - Object to evaluate.

Returns:

a boolean value indicating whether the given Object has value.

hasValue

protected static boolean hasValue(Number value)

Determines whether the given Number has value. The Number is valuable if it is not null and is not equal to 0.0d.

Parameters:

value - Number to evaluate.

Returns:

a boolean value indicating whether the given Number has value.

hasValue

protected static boolean hasValue(String value)

Determines whether the given String has value. The String is valuable if it is not null or empty.

Parameters:

value - String to evaluate.

Returns:

a boolean value indicating whether the given String is valuable.

gemfireProperties

@Bean
protected Properties gemfireProperties()

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

Returns:

a Properties object containing GemFire System properties used to configure the GemFire cache.

See Also:

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

setBeanClassLoader

public void setBeanClassLoader(ClassLoader beanClassLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

beanClassLoader

protected ClassLoader beanClassLoader()

Returns a reference to the ClassLoader use by the Spring BeanFactory to load classes for bean definitions.

Returns:

the ClassLoader used by the Spring BeanFactory to load classes for bean definitions.

See Also:

setBeanClassLoader(ClassLoader)

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

beanFactory

protected BeanFactory beanFactory()

Returns a reference to the Spring BeanFactory in the current application context.

Returns:

a reference to the Spring BeanFactory.

Throws:

IllegalStateException - if the Spring BeanFactory was not properly initialized.

See Also:

BeanFactory

setImportMetadata

public void setImportMetadata(AnnotationMetadata importMetadata)

Specified by:

setImportMetadata in interface ImportAware

configureInfrastructure

protected void configureInfrastructure(AnnotationMetadata importMetadata)

Configures Spring container infrastructure components used by Spring Data GemFire to enable GemFire to function properly inside a Spring context.

Parameters:

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

See Also:

AnnotationMetadata

configureCache

protected void configureCache(AnnotationMetadata importMetadata)

Configures the GemFire cache settings.

Parameters:

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

See Also:

AnnotationMetadata

configurePdx

protected void configurePdx(AnnotationMetadata importMetadata)

Configures GemFire's PDX Serialization components.

Parameters:

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

See Also:

AnnotationMetadata, GemFire PDX Serialization

configureOther

protected void configureOther(AnnotationMetadata importMetadata)

Callback method to configure other, specific GemFire cache configuration settings.

Parameters:

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

See Also:

AnnotationMetadata

resolvePdxSerializer

protected com.gemstone.gemfire.pdx.PdxSerializer resolvePdxSerializer(String pdxSerializerBeanName)

newPdxSerializer

protected <T extends com.gemstone.gemfire.pdx.PdxSerializer> T newPdxSerializer()

registerCustomEditorBeanFactoryPostProcessor

protected void registerCustomEditorBeanFactoryPostProcessor(AnnotationMetadata importMetadata)

registerDefinedIndexesApplicationListener

protected void registerDefinedIndexesApplicationListener(AnnotationMetadata importMetadata)

registerDiskStoreDirectoryBeanPostProcessor

protected void registerDiskStoreDirectoryBeanPostProcessor(AnnotationMetadata importMetadata)

registerPdxDiskStoreAwareBeanFactoryPostProcessor

protected void registerPdxDiskStoreAwareBeanFactoryPostProcessor(AnnotationMetadata importMetadata)

register

protected AbstractBeanDefinition register(AbstractBeanDefinition beanDefinition)

Registers the given BeanDefinition with the BeanDefinitionRegistry using a generated bean name.

Parameters:

beanDefinition - AbstractBeanDefinition to register.

Returns:

the given BeanDefinition.

See Also:

AbstractBeanDefinition, BeanDefinitionRegistry, #registerWithGeneratedName(AbstractBeanDefinition, BeanDefinitionRegistry), beanFactory()

getAnnotationType

protected abstract Class getAnnotationType()

Returns the GemFire cache application Annotation type pertaining to this configuration.

Returns:

the GemFire 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 GemFire cache application Annotation type.

Returns:

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

See Also:

Class.getName(), getAnnotationType()

getAnnotationTypeSimpleName

protected String getAnnotationTypeSimpleName()

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

Returns:

the simple class name of the GemFire 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)

constructCacheFactoryBean

protected <T extends CacheFactoryBean> T constructCacheFactoryBean()

Constructs a new, initialized instance of the CacheFactoryBean based on the Spring application's GemFire cache type (i.e. client or peer) preference specified via annotation.

Type Parameters:

T - Class type of the CacheFactoryBean.

Returns:

a new instance of an appropriate CacheFactoryBean given the Spring application's GemFire cache type preference (i.e client or peer) specified with the corresponding annotation (e.g. ClientCacheApplication or PeerCacheApplication);

See Also:

ClientCacheFactoryBean, CacheFactoryBean, setCommonCacheConfiguration(CacheFactoryBean), newCacheFactoryBean()

newCacheFactoryBean

protected abstract <T extends CacheFactoryBean> T newCacheFactoryBean()

Constructs a new, uninitialized instance of the CacheFactoryBean based on the Spring application's GemFire cache type (i.e. client or peer) preference specified via annotation.

Type Parameters:

T - Class type of the CacheFactoryBean.

Returns:

a new instance of an appropriate CacheFactoryBean given the Spring application's GemFire cache type preference (i.e client or peer) specified with the corresponding annotation (e.g. ClientCacheApplication or PeerCacheApplication).

See Also:

ClientCacheFactoryBean, CacheFactoryBean

setCommonCacheConfiguration

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

Configures common GemFire cache configuration settings.

Type Parameters:

T - Class type of the CacheFactoryBean.

Parameters:

gemfireCache - CacheFactoryBean instance to configure.

Returns:

the given CacheFactoryBean after common configuration settings have been applied.

See Also:

ClientCacheFactoryBean, CacheFactoryBean

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 com.gemstone.gemfire.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 com.gemstone.gemfire.pdx.PdxSerializer pdxSerializer()

startLocator

protected String startLocator()

transactionListeners

protected List<com.gemstone.gemfire.cache.TransactionListener> transactionListeners()

transactionWriter

protected com.gemstone.gemfire.cache.TransactionWriter transactionWriter()

useBeanFactoryLocator

protected boolean useBeanFactoryLocator()

add

public void add(Properties gemfireProperties)

toString

public String toString()

Overrides:

toString in class Object