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

java.lang.Object
  org.springframework.data.gemfire.RegionLookupFactoryBean<K,V>
      org.springframework.data.gemfire.RegionFactoryBean<K,V>

All Implemented Interfaces:

BeanNameAware, DisposableBean, FactoryBean<Region<K,V>>, InitializingBean

Direct Known Subclasses:

ClientRegionFactoryBean

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

FactoryBean for creating generic GemFire Regions. Will try to first locate the region (by name) and, in case none if found, proceed to creating one using the given settings.

Author:

Costin Leau

Field Summary

protected Log

log

Constructor Summary

RegionFactoryBean()

Method Summary

void	afterPropertiesSet()
void	destroy()
protected Region<K,V>	lookupFallback(Cache cache, String regionName) Fall back method in case the named region does not exist.
protected void	postProcess(AttributesFactory<K,V> attrFactory) Post-process the attribute factory object used for configuring the region of this factory bean during the initialization process.
protected void	postProcess(Region<K,V> region) Post-process the region object for this factory bean during the initialization process.
void	setAttributes(RegionAttributes<K,V> attributes) Sets the region attributes used for the region used by this factory.
void	setCacheListeners(CacheListener<K,V>[] cacheListeners) Sets the cache listeners used for the region used by this factory.
void	setCacheLoader(CacheLoader<K,V> cacheLoader) Sets the cache loader used for the region used by this factory.
void	setCacheWriter(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 by this factory bean, will be closed on shutdown (default true).
void	setDataPolicy(DataPolicy dataPolicy) Sets the data policy.
void	setDestroy(boolean destroy) Indicates whether the region referred by this factory bean, will be destroyed on shutdown (default false).
void	setScope(Scope scope) Sets the region scope.
void	setSnapshot(Resource snapshot) Sets the snapshots used for loading a newly created region.

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

getObject, getObjectType, isSingleton, setBeanName, setCache, setName

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final Log log

Constructor Detail

RegionFactoryBean

public RegionFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class RegionLookupFactoryBean<K,V>

Throws:

Exception

lookupFallback

protected Region<K,V> lookupFallback(Cache cache,
                                     String regionName)
                              throws Exception

Description copied from class: RegionLookupFactoryBean

Fall back method in case the named region does not exist. By default, this implementation throws an exception.

Overrides:

lookupFallback in class RegionLookupFactoryBean<K,V>

Parameters:

cache - GemFire cache

regionName - region name

Throws:

Exception

postProcess

protected void postProcess(AttributesFactory<K,V> attrFactory)

Post-process the attribute factory object used for configuring the region of this factory bean during the initialization process. The object is already initialized and configured by the factory bean before this method is invoked.

Parameters:

attrFactory - attribute factory

postProcess

protected void postProcess(Region<K,V> region)

Post-process the region object for this factory bean during the initialization process. The object is already initialized and configured by the factory bean before this method is invoked.

Parameters:

region -

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface DisposableBean

Throws:

Exception

setDestroy

public void setDestroy(boolean destroy)

Indicates whether the region referred by this factory bean, will be destroyed on shutdown (default false). Note: destroy and close are mutually exclusive. Enabling one will automatically disable the other.

Parameters:

destroy - whether or not to destroy the region

See Also:

setClose(boolean)

setClose

public void setClose(boolean close)

Indicates whether the region referred by this factory bean, will be closed on shutdown (default true). Note: destroy and close are mutually exclusive. Enabling one will automatically disable the other.

Parameters:

close - whether to close or not the region

See Also:

setDestroy(boolean)

setSnapshot

public void setSnapshot(Resource snapshot)

Sets the snapshots used for loading a newly created region. That is, the snapshot will be used only when a new region is created - if the region already exists, no loading will be performed.

Parameters:

snapshot - the snapshot to set

See Also:

RegionLookupFactoryBean.setName(String)

setCacheListeners

public void setCacheListeners(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(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(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

setDataPolicy

public void setDataPolicy(DataPolicy dataPolicy)

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

Parameters:

dataPolicy - the region data policy

setScope

public void setScope(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

setAttributes

public void setAttributes(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