org.springframework.data.gemfire.config.annotation

Class EntityDefinedRegionsConfiguration

java.lang.Object

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

org.springframework.data.gemfire.config.annotation.EntityDefinedRegionsConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportBeanDefinitionRegistrar, EnvironmentAware

Direct Known Subclasses:

IndexConfiguration

public class EntityDefinedRegionsConfiguration
extends AbstractAnnotationConfigSupport
implements ImportBeanDefinitionRegistrar

The EntityDefinedRegionsConfiguration class is Spring ImportBeanDefinitionRegistrar used in the EnableEntityDefinedRegions annotation to dynamically create GemFire/Geode Regions based on the application persistent entity classes.

Since:

1.9.0

Author:

John Blum

See Also:

ClassLoader, Annotation, Region, BeanDefinition, BeanDefinitionBuilder, BeanDefinitionRegistry, ImportBeanDefinitionRegistrar, FixedPartitionAttributesFactoryBean, LocalRegionFactoryBean, PartitionAttributesFactoryBean, PartitionedRegionFactoryBean, RegionAttributesFactoryBean, ReplicatedRegionFactoryBean, ClientRegionFactoryBean, AbstractAnnotationConfigSupport, CacheTypeAwareRegionFactoryBean, GemFireComponentClassTypeScanner, GemfireMappingContext, GemfirePersistentEntity, ClientRegion, LocalRegion, PartitionRegion, ReplicateRegion, Region

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata The EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata class encapsulates details for creating a Region from application persistent entities.

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

AbstractAnnotationConfigSupport.TypeResolver<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.geode.cache.client.ClientRegionShortcut	DEFAULT_CLIENT_REGION_SHORTCUT
protected static org.apache.geode.cache.RegionShortcut	DEFAULT_SERVER_REGION_SHORTCUT

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

CURRENT_THREAD_CONTEXT_CLASS_LOADER, INFRASTRUCTURE_ROLES, ORG_SPRINGFRAMEWORK_DATA_GEMFIRE_PACKAGE, ORG_SPRINGFRAMEWORK_PACKAGE, SPRING_DATA_GEMFIRE_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor and Description
EntityDefinedRegionsConfiguration()

Method Summary

Modifier and Type	Method and Description
protected Class<? extends Annotation>	getAnnotationType() Returns the Annotation type that configures and creates Regions for application persistent entities.
protected GemfirePersistentEntity<?>	getPersistentEntity(Class<?> persistentEntityType) Returns the associated persistent entity for the given application domain object type.
protected GemFireComponentClassTypeScanner	newGemFireComponentClassTypeScanner(AnnotationMetadata importingClassMetadata, AnnotationAttributes enableEntityDefinedRegionsAttributes)
protected GemfirePersistentEntity<?>	postProcess(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry, GemfirePersistentEntity<?> persistentEntity) Performs addition post processing on the GemfirePersistentEntity to offer additional feature support (e.g. dynamic Index creation).
void	registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) Registers Region bean definitions in the Spring context for all application domain object that have been identified as persistent entities.
protected void	registerRegionBeanDefinition(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata, BeanDefinitionRegistry registry) Registers an individual bean definition in the Spring container for the Region determined from the application domain object, persistent entity.
protected Set<String>	resolveBasePackages(AnnotationMetadata importingClassMetaData, AnnotationAttributes enableEntityDefinedRegionAttributes)
protected org.apache.geode.cache.client.ClientRegionShortcut	resolveClientRegionShortcut(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata, Annotation regionAnnotation, AnnotationAttributes regionAnnotationAttributes)
protected Iterable<TypeFilter>	resolveExcludes(AnnotationAttributes enableEntityDefinedRegionsAttributes)
protected Iterable<TypeFilter>	resolveIncludes(AnnotationAttributes enableEntityDefinedRegionsAttributes)
protected GemfireMappingContext	resolveMappingContext() Resolves the mapping context by returning the configured mapping context if present, or attempts to lookup the mapping context from the configured BeanFactory.
protected Iterable<TypeFilter>	resolveRegionAnnotatedPersistentEntityTypeFilters()
protected List<RegionConfigurer>	resolveRegionConfigurers()
protected org.apache.geode.cache.RegionShortcut	resolveServerRegionShortcut(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata, Annotation regionAnnotation, AnnotationAttributes regionAnnotationAttributes)
protected BeanDefinitionBuilder	setClientRegionAttributes(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata, AnnotationAttributes regionAnnotationAttributes, BeanDefinitionBuilder regionFactoryBeanBuilder)
protected BeanDefinitionBuilder	setFixedPartitionRegionAttributes(AnnotationAttributes regionAnnotationAttributes, BeanDefinitionBuilder partitionAttributesFactoryBeanBuilder)
protected BeanDefinitionBuilder	setPartitionRegionAttributes(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata, AnnotationAttributes regionAnnotationAttributes, BeanDefinitionBuilder regionFactoryBeanBuilder, BeanDefinitionBuilder regionAttributesFactoryBeanBuilder)
protected BeanDefinitionBuilder	setRegionAttributes(BeanDefinitionBuilder regionFactoryBeanBuilder, EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata)
protected BeanDefinitionBuilder	setReplicateRegionAttributes(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata, AnnotationAttributes regionAnnotationAttributes, BeanDefinitionBuilder regionFactoryBeanBuilder)

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, getLogger, hasValue, hasValue, hasValue, httpServiceProperty, isAnnotationPresent, isAnnotationPresent, isNotInfrastructureBean, isNotInfrastructureBean, isNotInfrastructureClass, isNotInfrastructureRole, isUserLevelMethod, locatorProperty, logDebug, logDebug, logError, logError, loggingProperty, logInfo, logInfo, logWarning, logWarning, managementProperty, managerProperty, memcachedServiceProperty, namedCacheServerProperty, namedDiskStoreProperty, namedGatewaySenderProperty, namedPoolProperty, newEvaluationContext, newLogger, pdxProperty, poolProperty, propertyName, redisServiceProperty, register, register, requireProperty, resolveAnnotation, resolveBeanClass, resolveBeanClass, resolveBeanClass, resolveBeanClassLoader, 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

Methods inherited from interface org.springframework.context.annotation.ImportBeanDefinitionRegistrar

registerBeanDefinitions

Field Detail

DEFAULT_CLIENT_REGION_SHORTCUT

protected static final org.apache.geode.cache.client.ClientRegionShortcut DEFAULT_CLIENT_REGION_SHORTCUT

DEFAULT_SERVER_REGION_SHORTCUT

protected static final org.apache.geode.cache.RegionShortcut DEFAULT_SERVER_REGION_SHORTCUT

Constructor Detail

EntityDefinedRegionsConfiguration

public EntityDefinedRegionsConfiguration()

Method Detail

getAnnotationType

protected Class<? extends Annotation> getAnnotationType()

Returns the Annotation type that configures and creates Regions for application persistent entities.

Specified by:

getAnnotationType in class AbstractAnnotationConfigSupport

Returns:

the Annotation type that configures and creates Regions for application persistent entities.

See Also:

EnableEntityDefinedRegions, Annotation, Class

registerBeanDefinitions

public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
                                    BeanDefinitionRegistry registry)

Registers Region bean definitions in the Spring context for all application domain object that have been identified as persistent entities.

Specified by:

registerBeanDefinitions in interface ImportBeanDefinitionRegistrar

Parameters:

importingClassMetadata - Class with the EnableEntityDefinedRegions annotation.

registry - BeanDefinitionRegistry used to register the Region bean definitions in the Spring context.

See Also:

BeanDefinitionRegistry, AnnotationMetadata

newGemFireComponentClassTypeScanner

protected GemFireComponentClassTypeScanner newGemFireComponentClassTypeScanner(AnnotationMetadata importingClassMetadata,
                                                                               AnnotationAttributes enableEntityDefinedRegionsAttributes)

resolveBasePackages

protected Set<String> resolveBasePackages(AnnotationMetadata importingClassMetaData,
                                          AnnotationAttributes enableEntityDefinedRegionAttributes)

resolveExcludes

protected Iterable<TypeFilter> resolveExcludes(AnnotationAttributes enableEntityDefinedRegionsAttributes)

resolveIncludes

protected Iterable<TypeFilter> resolveIncludes(AnnotationAttributes enableEntityDefinedRegionsAttributes)

resolveRegionAnnotatedPersistentEntityTypeFilters

protected Iterable<TypeFilter> resolveRegionAnnotatedPersistentEntityTypeFilters()

getPersistentEntity

protected GemfirePersistentEntity<?> getPersistentEntity(Class<?> persistentEntityType)

Returns the associated persistent entity for the given application domain object type.

Parameters:

persistentEntityType - type of the application domain object used to lookup the persistent entity from the mapping context.

Returns:

the persistent entity for the given application domain object type.

See Also:

GemfirePersistentEntity, Class

resolveMappingContext

@NonNull
protected GemfireMappingContext resolveMappingContext()

Resolves the mapping context by returning the configured mapping context if present, or attempts to lookup the mapping context from the configured BeanFactory. If the lookup is unsuccessful, then this method will return a new mapping context.

Returns:

the resolved mapping context.

See Also:

GemfireMappingContext

registerRegionBeanDefinition

protected void registerRegionBeanDefinition(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata,
                                            BeanDefinitionRegistry registry)

Registers an individual bean definition in the Spring container for the Region determined from the application domain object, persistent entity.

Parameters:

regionMetadata - EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata used to configure the Region bean definition.

registry - BeanDefinitionRegistry used to register the Region bean definition in the Spring context.

See Also:

BeanDefinitionRegistry, GemfirePersistentEntity

resolveRegionConfigurers

protected List<RegionConfigurer> resolveRegionConfigurers()

setRegionAttributes

protected BeanDefinitionBuilder setRegionAttributes(BeanDefinitionBuilder regionFactoryBeanBuilder,
                                                    EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata)

resolveClientRegionShortcut

protected org.apache.geode.cache.client.ClientRegionShortcut resolveClientRegionShortcut(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata,
                                                                                         Annotation regionAnnotation,
                                                                                         AnnotationAttributes regionAnnotationAttributes)

resolveServerRegionShortcut

protected org.apache.geode.cache.RegionShortcut resolveServerRegionShortcut(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata,
                                                                            Annotation regionAnnotation,
                                                                            AnnotationAttributes regionAnnotationAttributes)

setClientRegionAttributes

protected BeanDefinitionBuilder setClientRegionAttributes(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata,
                                                          AnnotationAttributes regionAnnotationAttributes,
                                                          BeanDefinitionBuilder regionFactoryBeanBuilder)

setPartitionRegionAttributes

protected BeanDefinitionBuilder setPartitionRegionAttributes(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata,
                                                             AnnotationAttributes regionAnnotationAttributes,
                                                             BeanDefinitionBuilder regionFactoryBeanBuilder,
                                                             BeanDefinitionBuilder regionAttributesFactoryBeanBuilder)

setFixedPartitionRegionAttributes

protected BeanDefinitionBuilder setFixedPartitionRegionAttributes(AnnotationAttributes regionAnnotationAttributes,
                                                                  BeanDefinitionBuilder partitionAttributesFactoryBeanBuilder)

setReplicateRegionAttributes

protected BeanDefinitionBuilder setReplicateRegionAttributes(EntityDefinedRegionsConfiguration.RegionBeanDefinitionMetadata regionMetadata,
                                                             AnnotationAttributes regionAnnotationAttributes,
                                                             BeanDefinitionBuilder regionFactoryBeanBuilder)

postProcess

protected GemfirePersistentEntity<?> postProcess(AnnotationMetadata importingClassMetadata,
                                                 BeanDefinitionRegistry registry,
                                                 GemfirePersistentEntity<?> persistentEntity)

Performs addition post processing on the GemfirePersistentEntity to offer additional feature support (e.g. dynamic Index creation).

Parameters:

importingClassMetadata - AnnotationMetadata for the importing application class.

registry - BeanDefinitionRegistry used to register Spring bean definitions.

persistentEntity - GemfirePersistentEntity to process.

Returns:

the given GemfirePersistentEntity.

See Also:

BeanDefinitionRegistry, AnnotationMetadata, GemfirePersistentEntity