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

Class CachingDefinedRegionsConfiguration

java.lang.Object

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

org.springframework.data.gemfire.config.annotation.CachingDefinedRegionsConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportAware, EnvironmentAware

@Configuration
public class CachingDefinedRegionsConfiguration
extends AbstractAnnotationConfigSupport
implements ImportAware

The CachingDefinedRegionsConfiguration class is a Spring @Configuration class that applies configuration to a Spring (Data GemFire/Geode) application to create GemFire/Geode cache Regions based on the use of Spring's Cache Abstraction to enable caching for application service classes and methods.

Since:

2.0.0

Author:

John Blum

See Also:

• Annotation
• AnnotatedElement
• GemFireCache
• Region
• RegionShortcut
• ClientRegionShortcut
• Pool
• AnnotatedBeanDefinition
• BeanDefinition
• BeanPostProcessor
• ConfigurableBeanFactory
• AbstractBeanDefinition
• BeanDefinitionBuilder
• BeanDefinitionRegistry
• BeanDefinitionRegistryPostProcessor
• CacheConfig
• CacheEvict
• CachePut
• Cacheable
• Caching
• Bean
• Configuration
• ImportAware
• AnnotatedElementUtils
• AnnotationUtils
• EnableCachingDefinedRegions
• AbstractAnnotationConfigSupport
• BeanDefinitionRegistryPostProcessorSupport
• CacheTypeAwareRegionFactoryBean

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CachingDefinedRegionsConfiguration.AbstractCacheNameResolver	CachingDefinedRegionsConfiguration.AbstractCacheNameResolver is an abstract base class encapsulating reusable functionality common to all CachingDefinedRegionsConfiguration.CacheNameResolver implementations.
static interface	CachingDefinedRegionsConfiguration.CacheNameResolver	CachingDefinedRegionsConfiguration.CacheNameResolver is a FunctionalInterface declaring a contract for all implementations used to resolve all cache names declared and used by a Spring application.
protected static class	CachingDefinedRegionsConfiguration.SpringCacheAnnotationsCacheNameResolver

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

AbstractAnnotationConfigSupport.TypeResolver<T>

Field Summary

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

Method Summary

Modifier and Type	Method	Description
BeanPostProcessor	cachingAnnotationsRegionBeanRegistrar(ConfigurableBeanFactory beanFactory)
Lifecycle	cachingDefinedRegionsCompositeLifecycleBean()
protected Class<? extends Annotation>	getAnnotationType()	Returns the Annotation type that configures and creates Regions for application service Methods that are annotated with Spring's Cache Abstraction Annotations.
protected CachingDefinedRegionsConfiguration.CacheNameResolver	getCacheNameResolver()	Returns the configured CachingDefinedRegionsConfiguration.CacheNameResolver to resolve all the declared cache name on Spring application beans/components declared and registered in the Spring container (context).
protected Optional<ClientRegionShortcut>	getClientRegionShortcut()	Returns the configured ClientRegionShortcut specifying the data management policy to use when creating a client Region.
protected Optional<String>	getPoolName()	Returns the name of the dedicated Pool used by all caching-defined client Regions to send and receive data between the client and server.
protected Optional<RegionShortcut>	getServerRegionShortcut()	Returns the configured RegionShortcut specifying the data management policy to use when creating a server (peer) Region.
protected ClientRegionShortcut	resolveClientRegionShortcut()	Resolves the ClientRegionShortcut specifying the data management policy to use when creating a client Region; defaults to ClientRegionShortcut.PROXY.
protected String	resolvePoolName()	Resolves the name of the dedicated Pool used by all caching-defined client Regions to send and receive data between the client and server; defaults to DEFAULT.
protected RegionShortcut	resolveServerRegionShortcut()	Resolves the RegionShortcut specifying the data management policy to use when creating a server (peer) Region; defaults to RegionShortcut.PARTITION.
void	setClientRegionShortcut(ClientRegionShortcut clientRegionShortcut)	Configures the ClientRegionShortcut specifying the data management policy to use when creating a client Region.
void	setImportMetadata(AnnotationMetadata importMetadata)
void	setPoolName(String poolName)	Configures the name of the dedicated Pool used by all caching-defined client Regions to send and receive data between the client and server.
void	setServerRegionShortcut(RegionShortcut serverRegionShortcut)	Configures the RegionShortcut specifying the data management policy to use when creating a server (peer) Region.

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, 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, toString, wait, wait, wait

Constructor Details

CachingDefinedRegionsConfiguration

public CachingDefinedRegionsConfiguration()

Method Details

getAnnotationType

protected Class<? extends Annotation> getAnnotationType()

Returns the Annotation type that configures and creates Regions for application service Methods that are annotated with Spring's Cache Abstraction Annotations.

Specified by:

getAnnotationType in class AbstractAnnotationConfigSupport

Returns:

the Annotation type that configures and creates Regions for application service Methods that are annotated with Spring's Cache Abstraction Annotations.

See Also:

• EnableCachingDefinedRegions
• Annotation
• Class

getCacheNameResolver

protected CachingDefinedRegionsConfiguration.CacheNameResolver getCacheNameResolver()

Returns the configured CachingDefinedRegionsConfiguration.CacheNameResolver to resolve all the declared cache name on Spring application beans/components declared and registered in the Spring container (context).

Returns:

the configured CachingDefinedRegionsConfiguration.CacheNameResolver to resolve all teh caches used by the Spring application.

See Also:

• CachingDefinedRegionsConfiguration.CacheNameResolver

setClientRegionShortcut

public void setClientRegionShortcut(ClientRegionShortcut clientRegionShortcut)

Configures the ClientRegionShortcut specifying the data management policy to use when creating a client Region.

Parameters:

clientRegionShortcut - ClientRegionShortcut specifying the data management policy to use when creating a client Region.

See Also:

• ClientRegionShortcut

getClientRegionShortcut

protected Optional<ClientRegionShortcut> getClientRegionShortcut()

Returns the configured ClientRegionShortcut specifying the data management policy to use when creating a client Region.

Returns:

an Optional ClientRegionShortcut specifying the data management policy to use when creating a client Region.

See Also:

• ClientRegionShortcut
• setClientRegionShortcut(ClientRegionShortcut)
• Optional

resolveClientRegionShortcut

protected ClientRegionShortcut resolveClientRegionShortcut()

Resolves the ClientRegionShortcut specifying the data management policy to use when creating a client Region; defaults to ClientRegionShortcut.PROXY.

Returns:

the resolved ClientRegionShortcut specifying the data management policy to use when creating a client Region; defaults to ClientRegionShortcut.PROXY.

See Also:

• ClientRegionShortcut
• getClientRegionShortcut()

setPoolName

public void setPoolName(String poolName)

Configures the name of the dedicated Pool used by all caching-defined client Regions to send and receive data between the client and server.

Parameters:

poolName - String containing the name of the dedicated Pool for all caching-defined client Regions.

getPoolName

protected Optional<String> getPoolName()

Returns the name of the dedicated Pool used by all caching-defined client Regions to send and receive data between the client and server.

Returns:

an Optional name of the dedicated Pool used by all caching-defined client Regions.

See Also:

• setPoolName(String)
• Optional

resolvePoolName

protected String resolvePoolName()

Resolves the name of the dedicated Pool used by all caching-defined client Regions to send and receive data between the client and server; defaults to DEFAULT.

Returns:

the name of the dedicated Pool used by all caching-defined client Regions; defaults to DEFAULT.

See Also:

• getPoolName()

setServerRegionShortcut

public void setServerRegionShortcut(RegionShortcut serverRegionShortcut)

Configures the RegionShortcut specifying the data management policy to use when creating a server (peer) Region.

Parameters:

serverRegionShortcut - RegionShortcut specifying the data management policy to use when creating a server (peer) Region.

See Also:

• RegionShortcut

getServerRegionShortcut

protected Optional<RegionShortcut> getServerRegionShortcut()

Returns the configured RegionShortcut specifying the data management policy to use when creating a server (peer) Region.

Returns:

an Optional RegionShortcut specifying the data management policy to use when creating a server (peer) Region.

See Also:

• setServerRegionShortcut(RegionShortcut)
• RegionShortcut
• Optional

resolveServerRegionShortcut

protected RegionShortcut resolveServerRegionShortcut()

Resolves the RegionShortcut specifying the data management policy to use when creating a server (peer) Region; defaults to RegionShortcut.PARTITION.

Returns:

the resolved RegionShortcut specifying the data management policy to use when creating a server (peer) Region; defaults to RegionShortcut.PARTITION.

See Also:

• RegionShortcut
• getServerRegionShortcut()

setImportMetadata

public void setImportMetadata(AnnotationMetadata importMetadata)

Specified by:

setImportMetadata in interface ImportAware

cachingAnnotationsRegionBeanRegistrar

@Bean
public BeanPostProcessor cachingAnnotationsRegionBeanRegistrar(ConfigurableBeanFactory beanFactory)

cachingDefinedRegionsCompositeLifecycleBean

@Bean
public Lifecycle cachingDefinedRegionsCompositeLifecycleBean()