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

Class GemFireCacheTypeAwareRegionFactoryBean<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.config.annotation.support.GemFireCacheTypeAwareRegionFactoryBean<K,V>

All Implemented Interfaces:

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

public class GemFireCacheTypeAwareRegionFactoryBean<K,V>
extends RegionLookupFactoryBean<K,V>

The GemFireCacheTypeAwareRegionFactoryBean class is a smart Spring FactoryBean that knows how to create a client or server Region depending on whether the GemFireCache is a ClientCache or a peer Cache.

Since:

1.9.0

Author:

John Blum

See Also:

GemFireCache, Region, FactoryBean, GenericRegionFactoryBean, RegionLookupFactoryBean, RegionFactoryBean, ClientRegionFactoryBean, RegionConfigurer

Field Summary

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

DEFAULT_SINGLETON

Constructor Summary

Constructors

Constructor and Description
GemFireCacheTypeAwareRegionFactoryBean()

Method Summary

Modifier and Type	Method and Description
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.client.ClientRegionShortcut	getClientRegionShortcut()
protected Boolean	getClose()
protected org.apache.geode.cache.DataPolicy	getDataPolicy()
protected Class<K>	getKeyConstraint()
protected String	getPoolName()
protected org.apache.geode.cache.RegionAttributes<K,V>	getRegionAttributes()
protected org.apache.geode.cache.RegionShortcut	getServerRegionShortcut()
protected Class<V>	getValueConstraint()
protected boolean	isClose()
protected org.apache.geode.cache.Region<K,V>	newClientRegion(org.apache.geode.cache.GemFireCache gemfireCache, String regionName) Constructs a new client Region using the ClientRegionFactoryBean.
protected org.apache.geode.cache.Region<K,V>	newServerRegion(org.apache.geode.cache.GemFireCache gemfireCache, String regionName) Constructs a new server Region using the GenericRegionFactoryBean.
void	setAttributes(org.apache.geode.cache.RegionAttributes<K,V> regionAttributes)
void	setClientRegionShortcut(org.apache.geode.cache.client.ClientRegionShortcut clientRegionShortcut)
void	setClose(Boolean close)
void	setDataPolicy(org.apache.geode.cache.DataPolicy dataPolicy)
void	setKeyConstraint(Class<K> keyConstraint)
void	setPoolName(String poolName)
void	setRegionConfigurers(List<RegionConfigurer> regionConfigurers) Null-safe operation used to set an Iterable of RegionConfigurers used to apply additional configuration to this RegionLookupFactoryBean when using Annotation-based configuration.
void	setRegionConfigurers(RegionConfigurer... regionConfigurers) Null-safe operation used to set an array of RegionConfigurers used to apply additional configuration to this RegionLookupFactoryBean when using Annotation-based configuration.
void	setServerRegionShortcut(org.apache.geode.cache.RegionShortcut shortcut)
void	setValueConstraint(Class<V> valueConstraint)

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

Constructor Detail

GemFireCacheTypeAwareRegionFactoryBean

public GemFireCacheTypeAwareRegionFactoryBean()

Method Detail

createRegion

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

Description copied from class: RegionLookupFactoryBean

Creates a new Region with the given name. This method gets called when a Region with the specified name does not already exist. By default, this method implementation throws a BeanInitializationException and it is expected that subclasses will override this method.

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:

org.springframework.beans.factory.BeanInitializationException - by default unless a subclass overrides this method.

Exception

See Also:

GemFireCache, Region

newClientRegion

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

Constructs a new client Region using the ClientRegionFactoryBean.

Parameters:

gemfireCache - reference to the GemFireCache used to create/initialize the factory used to create the client Region.

regionName - name given to the client Region.

Returns:

a new instance of a client Region with the given regionName.

Throws:

Exception - if the client Region could not be created.

See Also:

ClientRegionFactoryBean, GemFireCache, Region

newServerRegion

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

Constructs a new server Region using the GenericRegionFactoryBean.

Parameters:

gemfireCache - reference to the GemFireCache used to create/initialize the factory used to create the server Region.

regionName - name given to the server Region.

Returns:

a new instance of a server Region with the given regionName.

Throws:

Exception - if the server Region could not be created.

See Also:

GenericRegionFactoryBean, GemFireCache, Region

setAttributes

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

getRegionAttributes

protected org.apache.geode.cache.RegionAttributes<K,V> getRegionAttributes()

setClientRegionShortcut

public void setClientRegionShortcut(org.apache.geode.cache.client.ClientRegionShortcut clientRegionShortcut)

getClientRegionShortcut

protected org.apache.geode.cache.client.ClientRegionShortcut getClientRegionShortcut()

setClose

public void setClose(Boolean close)

getClose

protected Boolean getClose()

isClose

protected boolean isClose()

setDataPolicy

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

getDataPolicy

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

setKeyConstraint

public void setKeyConstraint(Class<K> keyConstraint)

getKeyConstraint

protected Class<K> getKeyConstraint()

setPoolName

public void setPoolName(String poolName)

getPoolName

protected String getPoolName()

setRegionConfigurers

public void setRegionConfigurers(RegionConfigurer... regionConfigurers)

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

Parameters:

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

See Also:

RegionConfigurer, setRegionConfigurers(List)

setRegionConfigurers

public void setRegionConfigurers(List<RegionConfigurer> regionConfigurers)

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

Parameters:

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

See Also:

RegionConfigurer

setServerRegionShortcut

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

getServerRegionShortcut

protected org.apache.geode.cache.RegionShortcut getServerRegionShortcut()

setValueConstraint

public void setValueConstraint(Class<V> valueConstraint)

getValueConstraint

protected Class<V> getValueConstraint()