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

Class GemFireCacheTypeAwareRegionFactoryBean<K,V>

java.lang.Object

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

org.springframework.data.gemfire.config.annotation.support.GemFireCacheTypeAwareRegionFactoryBean<K,V>

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>, InitializingBean

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

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:

BeanFactory, BeanFactoryAware, FactoryBean, RegionLookupFactoryBean, GemFireCache, Region

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
GemFireCacheTypeAwareRegionFactoryBean()

Method Summary

Modifier and Type	Method and Description
protected BeanFactory	getBeanFactory()
protected com.gemstone.gemfire.cache.client.ClientRegionShortcut	getClientRegionShortcut()
protected Boolean	getClose()
protected com.gemstone.gemfire.cache.DataPolicy	getDataPolicy()
protected Class<K>	getKeyConstraint()
protected String	getPoolName()
protected com.gemstone.gemfire.cache.RegionAttributes<K,V>	getRegionAttributes()
protected com.gemstone.gemfire.cache.RegionShortcut	getServerRegionShortcut()
protected Class<V>	getValueConstraint()
protected boolean	isClose()
com.gemstone.gemfire.cache.Region<K,V>	lookupRegion(com.gemstone.gemfire.cache.GemFireCache gemfireCache, String regionName) Method to perform a lookup when the named Region does not exist.
protected com.gemstone.gemfire.cache.Region<K,V>	newClientRegion(com.gemstone.gemfire.cache.GemFireCache gemfireCache, String regionName) Constructs a new client Region using the ClientRegionFactoryBean.
protected com.gemstone.gemfire.cache.Region<K,V>	newServerRegion(com.gemstone.gemfire.cache.GemFireCache gemfireCache, String regionName) Constructs a new server Region using the GenericRegionFactoryBean.
void	setAttributes(com.gemstone.gemfire.cache.RegionAttributes<K,V> regionAttributes)
void	setBeanFactory(BeanFactory beanFactory)
void	setClientRegionShortcut(com.gemstone.gemfire.cache.client.ClientRegionShortcut clientRegionShortcut)
void	setClose(Boolean close)
void	setDataPolicy(com.gemstone.gemfire.cache.DataPolicy dataPolicy)
void	setKeyConstraint(Class<K> keyConstraint)
void	setPoolName(String poolName)
void	setServerRegionShortcut(com.gemstone.gemfire.cache.RegionShortcut shortcut)
void	setValueConstraint(Class<V> valueConstraint)

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

afterPropertiesSet, getLookupEnabled, getObject, getObjectType, getParent, getRegion, isSingleton, lookupFallback, resolveRegionName, setBeanName, setCache, setLookupEnabled, setName, setParent, setRegionName

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

lookupRegion

public com.gemstone.gemfire.cache.Region<K,V> lookupRegion(com.gemstone.gemfire.cache.GemFireCache gemfireCache,
                                                           String regionName)
                                                    throws Exception

Description copied from class: RegionLookupFactoryBean

Method to perform a lookup when the named Region does not exist. By default, this implementation throws an exception.

Overrides:

lookupRegion in class RegionLookupFactoryBean<K,V>

Parameters:

gemfireCache - reference to the GemFire cache.

regionName - name of the GemFire Region.

Returns:

the Region in the GemFire cache with the given name.

Throws:

BeanInitializationException - if the lookup operation fails.

Exception

See Also:

Region

newClientRegion

protected com.gemstone.gemfire.cache.Region<K,V> newClientRegion(com.gemstone.gemfire.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 com.gemstone.gemfire.cache.Region<K,V> newServerRegion(com.gemstone.gemfire.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(com.gemstone.gemfire.cache.RegionAttributes<K,V> regionAttributes)

getRegionAttributes

protected com.gemstone.gemfire.cache.RegionAttributes<K,V> getRegionAttributes()

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

getBeanFactory

protected BeanFactory getBeanFactory()

setClientRegionShortcut

public void setClientRegionShortcut(com.gemstone.gemfire.cache.client.ClientRegionShortcut clientRegionShortcut)

getClientRegionShortcut

protected com.gemstone.gemfire.cache.client.ClientRegionShortcut getClientRegionShortcut()

setClose

public void setClose(Boolean close)

getClose

protected Boolean getClose()

isClose

protected boolean isClose()

setDataPolicy

public void setDataPolicy(com.gemstone.gemfire.cache.DataPolicy dataPolicy)

getDataPolicy

protected com.gemstone.gemfire.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()

setServerRegionShortcut

public void setServerRegionShortcut(com.gemstone.gemfire.cache.RegionShortcut shortcut)

getServerRegionShortcut

protected com.gemstone.gemfire.cache.RegionShortcut getServerRegionShortcut()

setValueConstraint

public void setValueConstraint(Class<V> valueConstraint)

getValueConstraint

protected Class<V> getValueConstraint()