AbstractCacheConfiguration (Spring Data Gemfire 1.9.0.M1 API)

java.lang.Object
- org.springframework.data.gemfire.config.annotation.AbstractCacheConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportAware

Direct Known Subclasses:

ClientCacheConfiguration, PeerCacheConfiguration
```
public abstract class AbstractCacheConfiguration
extends Object
implements BeanFactoryAware, BeanClassLoaderAware, 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 Configuration support. This class contain configuration settings common to both GemFire peer caches and client caches.

Since:

1.9.0

Author:

John Blum

See Also:

BeanClassLoaderAware, BeanFactory, BeanFactoryAware, Bean, ImportAware

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_LOG_LEVEL`
`protected static String`	`DEFAULT_NAME`
`protected static boolean`	`DEFAULT_USE_BEAN_FACTORY_LOCATOR`

Constructor Summary

Constructors
Constructor and Description

AbstractCacheConfiguration()

Constructors
Constructor and Description
`AbstractCacheConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected ClassLoader`	`beanClassLoader()` Gets a reference to the `ClassLoader` use by the Spring `BeanFactory` to load classes for bean definitions.
`protected BeanFactory`	`beanFactory()` Gets 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`	`configureOther(AnnotationMetadata importMetadata)` Callback method to configure other, specific GemFire cache configuration settings.
`protected void`	`configurePdx(AnnotationMetadata importMetadata)` Configures GemFire's PDX Serialization feature.
`protected <T extends CacheFactoryBean> T`	`constructCacheFactoryBean()` Constructs a new, initialized instance of the `CacheFactoryBean` based on the application GemFire cache type (i.e. client or peer).
`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 give `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`	`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 List<CacheFactoryBean.JndiDataSource>`	`jndiDataSources()`
`protected String`	`locators()`
`protected String`	`logLevel()`
`protected String`	`name()`
`protected abstract <T extends CacheFactoryBean> T`	`newCacheFactoryBean()` Constructs a new, uninitialized instance of the `CacheFactoryBean` based on the application GemFire cache type (i.e. client or peer).
`protected static <T> List<T>`	`nullSafeList(List<T> list)` Returns the given `List` if not null or an empty `List`.
`protected static <T> Set<T>`	`nullSafeSet(Set<T> set)` Returns the given `Set` if not null or an empty `Set`.
`protected static <T> T`	`nullSafeValue(T value, T defaultValue)` Returns the given `value` if not null or the `defaultValue`.
`protected String`	`pdxDiskStoreName()`
`protected Boolean`	`pdxIgnoreUnreadFields()`
`protected Boolean`	`pdxPersistent()`
`protected Boolean`	`pdxReadSerialized()`
`protected com.gemstone.gemfire.pdx.PdxSerializer`	`pdxSerializer()`
`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)`
`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_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
  - nullSafeList
```
protected static <T> List<T> nullSafeList(List<T> list)
```
    Returns the given List if not null or an empty List.
    
    Type Parameters:
    
    T - Class type of the elements in the List.
    
    Parameters:
    
    list - List on which to perform the null check.
    
    Returns:
    
    the given List if not null or an empty List.
    
    See Also:
    
    Collections.emptyList(), List
  - nullSafeSet
```
protected static <T> Set<T> nullSafeSet(Set<T> set)
```
    Returns the given Set if not null or an empty Set.
    
    Type Parameters:
    
    T - Class type of the elements in the Set.
    
    Parameters:
    
    set - Set on which to perform the null check.
    
    Returns:
    
    the given Set if not null or an empty Set.
    
    See Also:
    
    Collections.emptySet(), Set
  - nullSafeValue
```
protected static <T> T nullSafeValue(T value,
                                     T defaultValue)
```
    Returns the given value if not null or the defaultValue.
    
    Type Parameters:
    
    T - Class type of the given value and defaultValue.
    
    Parameters:
    
    value - value on which to perform the null check.
    
    defaultValue - value to return by default if the value is null.
    
    Returns:
    
    the given value if not null or the defaultValue.
  - hasValue
```
protected static boolean hasValue(Object value)
```
    Determines whether the give 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 is set to a pre-dined, descriptive default value depending on the type configuraiton applied. Both 'mcast-port' and 'locators' are to set 0 and empty String respectively, which is necessary for cache client-based 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()
```
    Gets 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()
```
    Gets 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
  - 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 feature.
    
    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 the cache meta-data used to configure the GemFire cache.
    
    See Also:
    
    AnnotationMetadata
  - 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, getAnnotationTypeName(), getAnnotationType()
  - 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, getAnnotationTypeName(), getAnnotationType()
  - 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, getAnnotationTypeName(), getAnnotationType()
  - 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 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 application GemFire cache type (i.e. client or peer).
    
    Type Parameters:
    
    T - Class type of the CacheFactoryBean.
    
    Returns:
    
    a new instance of the CacheFactoryBean for the particular application GemFire cache type (i.e client or peer).
    
    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 application GemFire cache type (i.e. client or peer).
    
    Type Parameters:
    
    T - Class type of the CacheFactoryBean.
    
    Returns:
    
    a new instance of the CacheFactoryBean for the particular application GemFire cache type (i.e client or peer).
    
    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 - specific 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()
```
  - 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()
```
  - transactionListeners
```
protected List<com.gemstone.gemfire.cache.TransactionListener> transactionListeners()
```
  - transactionWriter
```
protected com.gemstone.gemfire.cache.TransactionWriter transactionWriter()
```
  - useBeanFactoryLocator
```
protected boolean useBeanFactoryLocator()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractCacheConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CLOSE

DEFAULT_COPY_ON_READ

DEFAULT_USE_BEAN_FACTORY_LOCATOR

DEFAULT_LOG_LEVEL

DEFAULT_NAME

Constructor Detail

AbstractCacheConfiguration

Method Detail

nullSafeList

nullSafeSet

nullSafeValue

hasValue

hasValue

hasValue

gemfireProperties

setBeanClassLoader

beanClassLoader

setBeanFactory

beanFactory

setImportMetadata

configureCache

configurePdx

configureOther

getAnnotationType

getAnnotationTypeName

getAnnotationTypeSimpleName

isCacheServerApplication

isClientCacheApplication

isPeerCacheApplication

isClientPeerOrServerCacheApplication

constructCacheFactoryBean

newCacheFactoryBean

setCommonCacheConfiguration

cacheXml

close

copyOnRead

criticalHeapPercentage

dynamicRegionSupport

evictionHeapPercentage

gatewayConflictResolver

jndiDataSources

locators

logLevel

name

pdxDiskStoreName

pdxIgnoreUnreadFields

pdxPersistent

pdxReadSerialized

pdxSerializer

transactionListeners

transactionWriter

useBeanFactoryLocator

toString