org.springframework.data.gemfire.client

Class ClientRegionFactoryBean<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.client.ClientRegionFactoryBean<K,V>

All Implemented Interfaces:

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

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

Spring FactoryBean used to construct, configure and initialize a client Region.

Author:

Costin Leau, David Turanski, John Blum

See Also:

DataPolicy, EvictionAttributes, GemFireCache, Region, RegionAttributes, ClientCache, ClientRegionFactory, ClientRegionShortcut, Pool, DisposableBean, FactoryBean, DataPolicyConverter, RegionLookupFactoryBean, RegionConfigurer

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_POOL_NAME
static String	GEMFIRE_POOL_NAME

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

DEFAULT_SINGLETON

Constructor Summary

Constructors

Constructor and Description
ClientRegionFactoryBean()

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 ClientRegionFactoryBean.
protected void	applyRegionConfigurers(String regionName, RegionConfigurer... regionConfigurers) Null-safe operation to apply the given array of RegionConfigurers to this ClientRegionFactoryBean.
protected org.apache.geode.cache.client.ClientRegionFactory<K,V>	configure(org.apache.geode.cache.client.ClientRegionFactory<K,V> clientRegionFactory) Configures the given ClientRegionFactoryBean from the configuration settings of this ClientRegionFactoryBean.
protected org.apache.geode.cache.client.ClientRegionFactory<K,V>	createClientRegionFactory(org.apache.geode.cache.client.ClientCache clientCache, org.apache.geode.cache.client.ClientRegionShortcut shortcut) Constructs a new instance of ClientRegionFactory using the given ClientCache and ClientRegionShortcut.
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.
void	destroy() Closes and destroys the Region.
protected RegionConfigurer	getCompositeRegionConfigurer() Returns a reference to the Composite RegionConfigurer used to apply additional configuration to this ClientRegionFactoryBean on Spring container initialization.
Optional<String>	getPoolName() Returns the name of the configured Pool to use with this client Region.
protected boolean	isNotPersistent()
protected boolean	isPersistent()
protected boolean	isPersistentUnspecified()
protected org.apache.geode.cache.client.ClientRegionFactory<K,V>	postProcess(org.apache.geode.cache.client.ClientRegionFactory<K,V> clientRegionFactory) Post-process the given ClientRegionFactory setup by this ClientRegionFactoryBean.
protected org.apache.geode.cache.Region<K,V>	postProcess(org.apache.geode.cache.Region<K,V> region) Post-process the Region created by this ClientRegionFactoryBean.
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 CacheLoader used to load data local to the client's Region on cache misses.
void	setCacheWriter(org.apache.geode.cache.CacheWriter<K,V> cacheWriter) Sets the CacheWriter used to perform a synchronous write-behind when data is put into the client's Region.
void	setClose(boolean close) Indicates whether the region referred by this factory bean will be closed on shutdown (default true).
void	setCompressor(org.apache.geode.compression.Compressor compressor) Configures the Compressor used to compress the this Region's data.
void	setDataPolicy(org.apache.geode.cache.DataPolicy dataPolicy) Sets the Data Policy.
void	setDataPolicyName(String dataPolicyName) Deprecated. use setDataPolicy(:DataPolicy) instead.
void	setDestroy(boolean destroy) Indicates whether the region referred by this factory bean will be destroyed on shutdown (default false).
void	setDiskStoreName(String diskStoreName) Sets the name of disk store to use for overflow and persistence
void	setEvictionAttributes(org.apache.geode.cache.EvictionAttributes evictionAttributes)
void	setInterests(Interest<K>[] interests) Set the interests for this client region.
void	setKeyConstraint(Class<K> keyConstraint)
void	setPersistent(boolean persistent)
void	setPool(org.apache.geode.cache.client.Pool pool) Sets the Pool used by this client Region.
void	setPoolName(String poolName) Sets the name of the Pool used by this client Region.
void	setRegionConfigurers(List<RegionConfigurer> regionConfigurers) Null-safe operation to set an Iterable of RegionConfigurers used to apply additional configuration to this ClientRegionFactoryBean 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 ClientRegionFactoryBean when using Annotation-based configuration.
void	setShortcut(org.apache.geode.cache.client.ClientRegionShortcut shortcut) Initializes the client Region using the given ClientRegionShortcut.
void	setValueConstraint(Class<V> valueConstraint) Sets a type constraint on this Region's values.

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

afterPropertiesSet, getCache, getLookupEnabled, getObject, getObjectType, getParent, getRegion, loadSnapshot, 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, logError, logError, logInfo, logInfo, logWarning, logWarning, newLog, setBeanClassLoader, setBeanFactory, setBeanName

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POOL_NAME

public static final String DEFAULT_POOL_NAME

See Also:

Constant Field Values

GEMFIRE_POOL_NAME

public static final String GEMFIRE_POOL_NAME

See Also:

Constant Field Values

Constructor Detail

ClientRegionFactoryBean

public ClientRegionFactoryBean()

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 ClientRegionFactoryBean.

Parameters:

regionName - String containing the name of the Region.

regionConfigurers - array of RegionConfigurers applied to this ClientRegionFactoryBean.

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 ClientRegionFactoryBean.

Parameters:

regionName - String containing the name of the Region.

regionConfigurers - Iterable of RegionConfigurers applied to this ClientRegionFactoryBean.

See Also:

RegionConfigurer

createClientRegionFactory

protected org.apache.geode.cache.client.ClientRegionFactory<K,V> createClientRegionFactory(org.apache.geode.cache.client.ClientCache clientCache,
                                                                                           org.apache.geode.cache.client.ClientRegionShortcut shortcut)

Constructs a new instance of ClientRegionFactory using the given ClientCache and ClientRegionShortcut.

Parameters:

clientCache - reference to the ClientCache.

shortcut - ClientRegionShortcut used to specify the client Region DataPolicy.

Returns:

a new instance of ClientRegionFactory.

See Also:

ClientCache.createClientRegionFactory(ClientRegionShortcut), ClientRegionShortcut, ClientRegionFactory

configure

protected org.apache.geode.cache.client.ClientRegionFactory<K,V> configure(org.apache.geode.cache.client.ClientRegionFactory<K,V> clientRegionFactory)

Configures the given ClientRegionFactoryBean from the configuration settings of this ClientRegionFactoryBean.

Parameters:

clientRegionFactory - ClientRegionFactory to configure.

Returns:

the given ClientRegionFactory.

See Also:

ClientRegionFactory

postProcess

protected org.apache.geode.cache.client.ClientRegionFactory<K,V> postProcess(org.apache.geode.cache.client.ClientRegionFactory<K,V> clientRegionFactory)

Post-process the given ClientRegionFactory setup by this ClientRegionFactoryBean.

Parameters:

clientRegionFactory - ClientRegionFactory to process.

Returns:

the given ClientRegionFactory.

See Also:

ClientRegionFactory

postProcess

protected org.apache.geode.cache.Region<K,V> postProcess(org.apache.geode.cache.Region<K,V> region)

Post-process the Region created by this ClientRegionFactoryBean.

Overrides:

postProcess in class RegionLookupFactoryBean<K,V>

Parameters:

region - Region to process.

See Also:

Region

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

getCompositeRegionConfigurer

protected RegionConfigurer getCompositeRegionConfigurer()

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

Returns:

the Composite RegionConfigurer.

See Also:

RegionConfigurer

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. Note that using this method allows for advanced customization of the region - while it provides a lot of flexibility, note that it's quite easy to create misconfigured regions (especially in a client/server scenario).

Parameters:

attributes - the attributes to set on a newly created region

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 CacheLoader used to load data local to the client's Region on cache misses.

Parameters:

cacheLoader - a GemFire CacheLoader used to load data into the client Region.

See Also:

CacheLoader

setCacheWriter

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

Sets the CacheWriter used to perform a synchronous write-behind when data is put into the client's Region.

Parameters:

cacheWriter - the GemFire CacheWriter used to perform synchronous write-behinds on put ops.

See Also:

CacheWriter

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)

setCompressor

public void setCompressor(org.apache.geode.compression.Compressor compressor)

Configures the Compressor used to compress the this Region's data.

Parameters:

compressor - Compressor used to compress the this Region's data.

See Also:

Compressor

setDataPolicy

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

Sets the Data Policy. Used only when a new Region is created.

Parameters:

dataPolicy - the client Region's Data Policy.

See Also:

DataPolicy

setDataPolicyName

@Deprecated
public void setDataPolicyName(String dataPolicyName)

Deprecated. use setDataPolicy(:DataPolicy) instead.

An alternate way to set the Data Policy, using the String name of the enumerated value.

Parameters:

dataPolicyName - the enumerated value String name of the Data Policy.

See Also:

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

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)

setDiskStoreName

public void setDiskStoreName(String diskStoreName)

Sets the name of disk store to use for overflow and persistence

Parameters:

diskStoreName - a String specifying the 'name' of the client Region Disk Store.

setEvictionAttributes

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

setInterests

public void setInterests(Interest<K>[] interests)

Set the interests for this client region. Both key and regex interest are supported.

Parameters:

interests - the interests to set

setKeyConstraint

public void setKeyConstraint(Class<K> keyConstraint)

isPersistentUnspecified

protected boolean isPersistentUnspecified()

isPersistent

protected boolean isPersistent()

isNotPersistent

protected boolean isNotPersistent()

setPersistent

public void setPersistent(boolean persistent)

setPool

public void setPool(org.apache.geode.cache.client.Pool pool)

Sets the Pool used by this client Region.

Parameters:

pool - client Pool to be used by this client Region.

See Also:

Pool, setPoolName(String)

setPoolName

public void setPoolName(String poolName)

Sets the name of the Pool used by this client Region.

Parameters:

poolName - String containing the name of the client Pool used by this client Region.

See Also:

getPoolName(), setPool(Pool)

getPoolName

public Optional<String> getPoolName()

Returns the name of the configured Pool to use with this client Region.

Returns:

the Optional name of the configured Pool to use with this client Region.

See Also:

setPoolName(String)

setRegionConfigurers

public void setRegionConfigurers(RegionConfigurer... regionConfigurers)

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

Parameters:

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

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 ClientRegionFactoryBean when using Annotation-based configuration.

Parameters:

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

See Also:

RegionConfigurer

setShortcut

public void setShortcut(org.apache.geode.cache.client.ClientRegionShortcut shortcut)

Initializes the client Region using the given ClientRegionShortcut.

Parameters:

shortcut - ClientRegionShortcut used to initialize this client Region.

See Also:

ClientRegionShortcut

setValueConstraint

public void setValueConstraint(Class<V> valueConstraint)

Sets a type constraint on this Region's values.

Parameters:

valueConstraint - type of this client Region's values.

See Also:

Class