org.springframework.data.gemfire

Class RegionFactoryBean<K,V>

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<org.apache.geode.cache.Region<K,V>>

org.springframework.data.gemfire.RegionLookupFactoryBean<K,V>

org.springframework.data.gemfire.RegionFactoryBean<K,V>

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, FactoryBean<org.apache.geode.cache.Region<K,V>>, InitializingBean, Lifecycle, Phased, SmartLifecycle

Direct Known Subclasses:

GenericRegionFactoryBean, LocalRegionFactoryBean, PartitionedRegionFactoryBean, ReplicatedRegionFactoryBean

public abstract class RegionFactoryBean<K,V>
extends RegionLookupFactoryBean<K,V>
implements DisposableBean, SmartLifecycle

<<<<<<< HEAD Abstract base class and Spring FactoryBean for constructing and initializing a GemFire Region. ======= Abstract Spring FactoryBean base class extended by other SDG FactoryBeans used to construct, configure and initialize peer Regions. This FactoryBean allows for very easy and flexible creation of peer Region. For client Regions, however, see the ClientRegionFactoryBean. >>>>>>> c22ebe6... DATAGEODE-12 - Introduce Spring Configurers to flexibly alter Spring Data GemFire configuration when using Annotation config.

Author:

Costin Leau, David Turanski, John Blum <<<<<<< HEAD

See Also:

DisposableBean, SmartLifecycle, =======, Cache, CacheListener, CacheLoader, CacheWriter, DataPolicy, EvictionAttributes, GemFireCache, PartitionAttributes, Region, RegionAttributes, RegionFactory, RegionShortcut, Scope, AsyncEventQueue, DisposableBean, SmartLifecycle, RegionLookupFactoryBean, ClientRegionFactoryBean, >>>>>>> c22ebe6... DATAGEODE-12 - Introduce Spring Configurers to flexibly alter Spring Data GemFire configuration when using Annotation config.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Fields inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

DEFAULT_SINGLETON

Constructor Summary

Constructors

Constructor and Description
RegionFactoryBean()

Method Summary

Modifier and Type	Method and Description
protected void	applyRegionConfigurers(String regionName, Iterable<RegionConfigurer> regionConfigurers) Null-safe operation to apply the given Iterable of RegionConfigurers to this RegionFactoryBean.
protected void	applyRegionConfigurers(String regionName, RegionConfigurer... regionConfigurers) Null-safe operation to apply the given array of RegionConfigurers to this RegionFactoryBean.
protected void	assertDataPolicyAndPersistentAttributesAreCompatible(org.apache.geode.cache.DataPolicy resolvedDataPolicy) Validates that the settings for Data Policy and the 'persistent' attribute in <gfe:*-region> elements are compatible.
protected org.apache.geode.cache.RegionFactory<K,V>	configure(org.apache.geode.cache.RegionFactory<K,V> regionFactory) Configures the RegionFactory based on the configuration settings of this RegionFactoryBean.
protected org.apache.geode.cache.Region<K,V>	createRegion(org.apache.geode.cache.GemFireCache gemfireCache, String regionName) Creates a new Region with the given name.
protected org.apache.geode.cache.RegionFactory<K,V>	createRegionFactory(org.apache.geode.cache.Cache cache) Creates an instance of RegionFactory with the given Cache which is then used to construct, configure and initialize the Region specified by this RegionFactoryBean.
void	destroy() Closes and destroys the Region.
org.apache.geode.cache.RegionAttributes<K,V>	getAttributes() Returns the attributes used to configure the Region created by this factory as set in the SDG XML namespace configuration meta-data, or as set with the setAttributes(:Attributes) method.
protected RegionConfigurer	getCompositeRegionConfigurer() Returns a reference to the Composite RegionConfigurer used to apply additional configuration to this RegionFactoryBean on Spring container initialization.
org.apache.geode.cache.DataPolicy	getDataPolicy() Gets the "resolved" Data Policy as determined by this RegionFactory when configuring the attributes of the Region to be created.
Boolean	getOffHeap() Returns a Boolean value indicating whether off-heap memory was enabled for this Region.
int	getPhase()
org.apache.geode.cache.Scope	getScope()
protected org.apache.geode.cache.RegionShortcut	getShortcut()
boolean	isAutoStartup()
protected boolean	isNotPersistent() Returns true when the user explicitly specified a value for the persistent attribute and it is false.
boolean	isOffHeap() Returns a boolean value indicating whether off-heap has been enabled for this Region.
protected boolean	isPersistent() Returns true when the user explicitly specified a value for the persistent attribute and it is true.
protected boolean	isPersistentUnspecified() Determines whether the user explicitly set the 'persistent' attribute or not.
boolean	isRunning()
protected <K,V> void	mergePartitionAttributes(org.apache.geode.cache.RegionFactory<K,V> regionFactory, org.apache.geode.cache.RegionAttributes<K,V> regionAttributes)
protected <K,V> org.apache.geode.cache.RegionFactory<K,V>	mergeRegionAttributes(org.apache.geode.cache.RegionFactory<K,V> regionFactory, org.apache.geode.cache.RegionAttributes<K,V> regionAttributes) Intelligently merges the given RegionAttributes with the configuration setting of the RegionFactory.
protected org.apache.geode.cache.RegionFactory<K,V>	postProcess(org.apache.geode.cache.RegionFactory<K,V> regionFactory) Post-process the RegionFactory used to create the Region specified by this RegionFactoryBean during initialization.
protected void	resolveDataPolicy(org.apache.geode.cache.RegionFactory<K,V> regionFactory, Boolean persistent, org.apache.geode.cache.DataPolicy dataPolicy) ======= >>>>>>> c22ebe6...
protected void	resolveDataPolicy(org.apache.geode.cache.RegionFactory<K,V> regionFactory, Boolean persistent, String dataPolicy) Validates the configured Data Policy and may override it, taking into account the 'persistent' attribute and constraints for the Region type.
void	setAsyncEventQueues(org.apache.geode.cache.asyncqueue.AsyncEventQueue[] asyncEventQueues) The list of AsyncEventQueues to use with this Region.
void	setAttributes(org.apache.geode.cache.RegionAttributes<K,V> attributes) Sets the region attributes used for the region used by this factory.
void	setCacheListeners(org.apache.geode.cache.CacheListener<K,V>[] cacheListeners) Sets the cache listeners used for the region used by this factory.
void	setCacheLoader(org.apache.geode.cache.CacheLoader<K,V> cacheLoader) Sets the cache loader used for the region used by this factory.
void	setCacheWriter(org.apache.geode.cache.CacheWriter<K,V> cacheWriter) Sets the cache writer used for the region used by this factory.
void	setClose(boolean close) Indicates whether the Region referred to by this factory bean will be closed on shutdown (default true).
void	setDataPolicy(org.apache.geode.cache.DataPolicy dataPolicy) Sets the DataPolicy of the Region.
void	setDataPolicy(String dataPolicyName) Deprecated. as of 1.4.0, use setDataPolicy(:DataPolicy) instead.
void	setDestroy(boolean destroy) Indicates whether the Region referred to by this factory bean will be destroyed on shutdown (default false).
void	setDiskStoreName(String diskStoreName) Sets the name of Disk Store used for either overflow or persistence, or both.
void	setEvictionAttributes(org.apache.geode.cache.EvictionAttributes evictionAttributes)
void	setGatewaySenders(org.apache.geode.cache.wan.GatewaySender[] gatewaySenders)
void	setKeyConstraint(Class<K> keyConstraint)
void	setOffHeap(Boolean offHeap) Sets whether to enable this Region to store it's data in off-heap memory.
void	setPersistent(Boolean persistent)
void	setRegionConfigurers(List<RegionConfigurer> regionConfigurers) Null-safe operation to set an Iterable of RegionConfigurers used to apply additional configuration to this RegionFactoryBean when using Annotation-based configuration.
void	setRegionConfigurers(RegionConfigurer... regionConfigurers) Null-safe operation to set an array of RegionConfigurers used to apply additional configuration to this RegionFactoryBean when using Annotation-based configuration.
void	setScope(org.apache.geode.cache.Scope scope) Sets the region scope.
void	setShortcut(org.apache.geode.cache.RegionShortcut shortcut) Configures the Region with a RegionShortcut.
void	setValueConstraint(Class<V> valueConstraint)
void	start()
void	stop()
void	stop(Runnable callback)

Methods inherited from class org.springframework.data.gemfire.RegionLookupFactoryBean

afterPropertiesSet, getCache, getLookupEnabled, getObject, getObjectType, getParent, getRegion, loadSnapshot, postProcess, resolveRegionName, setCache, setLookupEnabled, setName, setParent, setRegion, setRegionName, setSnapshot

Methods inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

getBeanClassLoader, getBeanFactory, getBeanName, getLog, isSingleton, logDebug, logDebug, logInfo, logInfo, newLog, setBeanClassLoader, setBeanFactory, setBeanName

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

RegionFactoryBean

public RegionFactoryBean()

Method Detail

createRegion

protected org.apache.geode.cache.Region<K,V> createRegion(org.apache.geode.cache.GemFireCache gemfireCache,
                                                          String regionName)
                                                   throws Exception

Creates a new Region with the given name.

Overrides:

createRegion in class RegionLookupFactoryBean<K,V>

Parameters:

gemfireCache - reference to the GemFireCache.

regionName - name of the new Region.

Returns:

a new Region with the given name.

Throws:

BeanInitializationException - by default unless a subclass overrides this method.

Exception

See Also:

GemFireCache, Region

applyRegionConfigurers

protected void applyRegionConfigurers(String regionName,
                                      RegionConfigurer... regionConfigurers)

Null-safe operation to apply the given array of RegionConfigurers to this RegionFactoryBean.

Parameters:

regionName - String containing the name of the Region.

regionConfigurers - array of RegionConfigurers applied to this RegionFactoryBean.

See Also:

RegionConfigurer, applyRegionConfigurers(String, Iterable)

applyRegionConfigurers

protected void applyRegionConfigurers(String regionName,
                                      Iterable<RegionConfigurer> regionConfigurers)

Null-safe operation to apply the given Iterable of RegionConfigurers to this RegionFactoryBean.

Parameters:

regionName - String containing the name of the Region.

regionConfigurers - Iterable of RegionConfigurers applied to this RegionFactoryBean.

See Also:

RegionConfigurer

createRegionFactory

protected org.apache.geode.cache.RegionFactory<K,V> createRegionFactory(org.apache.geode.cache.Cache cache)

Creates an instance of RegionFactory with the given Cache which is then used to construct, configure and initialize the Region specified by this RegionFactoryBean.

Parameters:

cache - reference to the Cache.

Returns:

a RegionFactory used to construct, configure and initialized the Region specified by this RegionFactoryBean.

See Also:

Cache.createRegionFactory(org.apache.geode.cache.RegionShortcut), Cache.createRegionFactory(org.apache.geode.cache.RegionAttributes), Cache.createRegionFactory(), RegionFactory

configure

protected org.apache.geode.cache.RegionFactory<K,V> configure(org.apache.geode.cache.RegionFactory<K,V> regionFactory)

Configures the RegionFactory based on the configuration settings of this RegionFactoryBean.

Parameters:

regionFactory - RegionFactory to configure

Returns:

the given RegionFactory.

See Also:

RegionFactory

postProcess

protected org.apache.geode.cache.RegionFactory<K,V> postProcess(org.apache.geode.cache.RegionFactory<K,V> regionFactory)

Post-process the RegionFactory used to create the Region specified by this RegionFactoryBean during initialization. The RegionFactory has been already constructed, configured and initialized by this RegionFactoryBean before this method gets invoked.

Parameters:

regionFactory - RegionFactory used to create the Region.

Returns:

the given RegionFactory.

See Also:

RegionFactory

getCompositeRegionConfigurer

protected RegionConfigurer getCompositeRegionConfigurer()

Returns a reference to the Composite RegionConfigurer used to apply additional configuration to this RegionFactoryBean on Spring container initialization.

Returns:

the Composite RegionConfigurer.

See Also:

RegionConfigurer

mergeRegionAttributes

protected <K,V> org.apache.geode.cache.RegionFactory<K,V> mergeRegionAttributes(org.apache.geode.cache.RegionFactory<K,V> regionFactory,
                                                                                org.apache.geode.cache.RegionAttributes<K,V> regionAttributes)

Intelligently merges the given RegionAttributes with the configuration setting of the RegionFactory. This method is used to merge the RegionAttributes and PartitionAttributes with the RegionFactory that is created when the user specified a RegionShortcut. This method gets called by the createRegionFactory method depending upon the value passed to the Cache.createRegionFactory() method (i.e. whether there was a RegionShortcut specified or not).

Type Parameters:

K - the Class type fo the Region key.

V - the Class type of the Region value.

Parameters:

regionFactory - the GemFire RegionFactory used to configure and create the Region that is the product of this RegionFactoryBean.

regionAttributes - the RegionAttributes containing the Region configuration settings to merge to the RegionFactory.

Returns:

the RegionFactory with the configuration settings of the RegionAttributes merged.

See Also:

isUserSpecifiedEvictionAttributes(org.apache.geode.cache.RegionAttributes), validateRegionAttributes(org.apache.geode.cache.RegionAttributes), RegionAttributes, RegionFactory

mergePartitionAttributes

protected <K,V> void mergePartitionAttributes(org.apache.geode.cache.RegionFactory<K,V> regionFactory,
                                              org.apache.geode.cache.RegionAttributes<K,V> regionAttributes)

Parameters:

regionFactory -

regionAttributes -

isPersistent

protected boolean isPersistent()

Returns true when the user explicitly specified a value for the persistent attribute and it is true. If the persistent attribute was not explicitly specified, then the persistence setting is implicitly undefined and will be determined by the Data Policy.

Returns:

true when the user specified an explicit value for the persistent attribute and it is true; false otherwise.

See Also:

isNotPersistent(), isPersistentUnspecified()

isPersistentUnspecified

protected boolean isPersistentUnspecified()

Determines whether the user explicitly set the 'persistent' attribute or not.

Returns:

a boolean value indicating whether the user explicitly set the 'persistent' attribute to true or false.

See Also:

isPersistent(), isNotPersistent()

isNotPersistent

protected boolean isNotPersistent()

Returns true when the user explicitly specified a value for the persistent attribute and it is false. If the persistent attribute was not explicitly specified, then the persistence setting is implicitly undefined and will be determined by the Data Policy.

Returns:

true when the user specified an explicit value for the persistent attribute and it is false; false otherwise.

See Also:

isPersistent(), isPersistentUnspecified()

assertDataPolicyAndPersistentAttributesAreCompatible

protected void assertDataPolicyAndPersistentAttributesAreCompatible(org.apache.geode.cache.DataPolicy resolvedDataPolicy)

Validates that the settings for Data Policy and the 'persistent' attribute in <gfe:*-region> elements are compatible.

Parameters:

resolvedDataPolicy - the GemFire Data Policy resolved form the Spring GemFire XML namespace configuration meta-data.

See Also:

isPersistent(), isNotPersistent(), DataPolicy

resolveDataPolicy

protected void resolveDataPolicy(org.apache.geode.cache.RegionFactory<K,V> regionFactory,
                                 Boolean persistent,
                                 org.apache.geode.cache.DataPolicy dataPolicy)

======= >>>>>>> c22ebe6... DATAGEODE-12 - Introduce Spring Configurers to flexibly alter Spring Data GemFire configuration when using Annotation config. Validates and sets the Data Policy on the RegionFactory used to create and configure the Region from this FactoryBean.

Parameters:

regionFactory - the RegionFactory used by this FactoryBean to create and configure the Region.

persistent - a boolean value indicating whether the Region should be persistent and persist it's data to disk.

dataPolicy - the configured Data Policy for the Region.

See Also:

resolveDataPolicy(org.apache.geode.cache.RegionFactory, Boolean, String), DataPolicy, RegionFactory

resolveDataPolicy

protected void resolveDataPolicy(org.apache.geode.cache.RegionFactory<K,V> regionFactory,
                                 Boolean persistent,
                                 String dataPolicy)

Validates the configured Data Policy and may override it, taking into account the 'persistent' attribute and constraints for the Region type.

Parameters:

regionFactory - the GemFire RegionFactory used to create the desired Region.

persistent - a boolean value indicating whether the Region should persist it's data to disk.

dataPolicy - requested Data Policy as set by the user in the Spring GemFire configuration meta-data.

See Also:

DataPolicy, RegionFactory

destroy

public void destroy()
             throws Exception

Closes and destroys the Region.

Specified by:

destroy in interface DisposableBean

Throws:

Exception - if destroy fails.

See Also:

DisposableBean

setAsyncEventQueues

public void setAsyncEventQueues(org.apache.geode.cache.asyncqueue.AsyncEventQueue[] asyncEventQueues)

The list of AsyncEventQueues to use with this Region.

Parameters:

asyncEventQueues - defined as Object for backwards compatibility with Gemfire 6.

setAttributes

public void setAttributes(org.apache.geode.cache.RegionAttributes<K,V> attributes)

Sets the region attributes used for the region used by this factory. Allows maximum control in specifying the region settings. Used only when a new region is created.

Parameters:

attributes - the attributes to set on a newly created region

getAttributes

public org.apache.geode.cache.RegionAttributes<K,V> getAttributes()

Returns the attributes used to configure the Region created by this factory as set in the SDG XML namespace configuration meta-data, or as set with the setAttributes(:Attributes) method.

Returns:

the RegionAttributes used to configure the Region created by this factory.

See Also:

RegionAttributes

setCacheListeners

public void setCacheListeners(org.apache.geode.cache.CacheListener<K,V>[] cacheListeners)

Sets the cache listeners used for the region used by this factory. Used only when a new region is created.Overrides the settings specified through setAttributes(RegionAttributes).

Parameters:

cacheListeners - the cacheListeners to set on a newly created region

setCacheLoader

public void setCacheLoader(org.apache.geode.cache.CacheLoader<K,V> cacheLoader)

Sets the cache loader used for the region used by this factory. Used only when a new region is created.Overrides the settings specified through setAttributes(RegionAttributes).

Parameters:

cacheLoader - the cacheLoader to set on a newly created region

setCacheWriter

public void setCacheWriter(org.apache.geode.cache.CacheWriter<K,V> cacheWriter)

Sets the cache writer used for the region used by this factory. Used only when a new region is created. Overrides the settings specified through setAttributes(RegionAttributes).

Parameters:

cacheWriter - the cacheWriter to set on a newly created region

setClose

public void setClose(boolean close)

Indicates whether the Region referred to by this factory bean will be closed on shutdown (default true).

Parameters:

close - a boolean value indicating whether this Region should be closed on member shutdown.

See Also:

setDestroy(boolean)

setDestroy

public void setDestroy(boolean destroy)

Indicates whether the Region referred to by this factory bean will be destroyed on shutdown (default false).

Parameters:

destroy - a boolean value indicating whether the Region is to be destroy on member shutdown.

See Also:

setDestroy(boolean)

setDataPolicy

public void setDataPolicy(org.apache.geode.cache.DataPolicy dataPolicy)

Sets the DataPolicy of the Region.

Parameters:

dataPolicy - the GemFire DataPolicy to use when configuring the Region.

Since:

1.4.0

setDataPolicy

@Deprecated
public void setDataPolicy(String dataPolicyName)

Deprecated. as of 1.4.0, use setDataPolicy(:DataPolicy) instead.

Sets the DataPolicy of the Region as a String.

Parameters:

dataPolicyName - the name of the DataPolicy (e.g. REPLICATE, PARTITION)

See Also:

setDataPolicy(org.apache.geode.cache.DataPolicy)

getDataPolicy

public org.apache.geode.cache.DataPolicy getDataPolicy()

Gets the "resolved" Data Policy as determined by this RegionFactory when configuring the attributes of the Region to be created.

Returns:

the "resolved" Data Policy to be used to create the Region.

See Also:

DataPolicy

setDiskStoreName

public void setDiskStoreName(String diskStoreName)

Sets the name of Disk Store used for either overflow or persistence, or both.

Parameters:

diskStoreName - the name of the Disk Store bean in context used for overflow/persistence.

setEvictionAttributes

public void setEvictionAttributes(org.apache.geode.cache.EvictionAttributes evictionAttributes)

setGatewaySenders

public void setGatewaySenders(org.apache.geode.cache.wan.GatewaySender[] gatewaySenders)

Parameters:

gatewaySenders - defined as Object for backward compatibility with Gemfire 6

setOffHeap

public void setOffHeap(Boolean offHeap)

Sets whether to enable this Region to store it's data in off-heap memory.

Parameters:

offHeap - Boolean value indicating whether to enable off-heap memory for this Region.

See Also:

RegionFactory.setOffHeap(boolean)

getOffHeap

public Boolean getOffHeap()

Returns a Boolean value indicating whether off-heap memory was enabled for this Region. Off-heap will be enabled if this method returns a non-null Boolean value that evaluates to true.

Returns:

a Boolean value indicating whether off-heap is enabled for this Region.

isOffHeap

public boolean isOffHeap()

Returns a boolean value indicating whether off-heap has been enabled for this Region.

Returns:

a boolean value indicating whether off-heap has been enabled for this Region.

See Also:

getOffHeap()

setKeyConstraint

public void setKeyConstraint(Class<K> keyConstraint)

setPersistent

public void setPersistent(Boolean persistent)

setRegionConfigurers

public void setRegionConfigurers(RegionConfigurer... regionConfigurers)

Null-safe operation to set an array of RegionConfigurers used to apply additional configuration to this RegionFactoryBean when using Annotation-based configuration.

Parameters:

regionConfigurers - array of RegionConfigurers used to apply additional configuration to this RegionFactoryBean.

See Also:

RegionConfigurer, setRegionConfigurers(List)

setRegionConfigurers

public void setRegionConfigurers(List<RegionConfigurer> regionConfigurers)

Null-safe operation to set an Iterable of RegionConfigurers used to apply additional configuration to this RegionFactoryBean when using Annotation-based configuration.

Parameters:

regionConfigurers - Iterable of RegionConfigurers used to apply additional configuration to this RegionFactoryBean.

See Also:

RegionConfigurer

getScope

public org.apache.geode.cache.Scope getScope()

setScope

public void setScope(org.apache.geode.cache.Scope scope)

Sets the region scope. Used only when a new region is created. Overrides the settings specified through setAttributes(RegionAttributes).

Parameters:

scope - the region scope

See Also:

Scope

setShortcut

public void setShortcut(org.apache.geode.cache.RegionShortcut shortcut)

Configures the Region with a RegionShortcut.

Parameters:

shortcut - the RegionShortcut used to configure pre-defined default for the Region created by this FactoryBean.

See Also:

RegionShortcut

getShortcut

protected final org.apache.geode.cache.RegionShortcut getShortcut()

setValueConstraint

public void setValueConstraint(Class<V> valueConstraint)

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle