org.springframework.data.gemfire

Class RegionLookupFactoryBean<K,V>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ClientRegionFactoryBean, GemFireCacheTypeAwareRegionFactoryBean, LookupRegionFactoryBean, RegionFactoryBean

public abstract class RegionLookupFactoryBean<K,V>
extends Object
implements FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>, InitializingBean, BeanNameAware

Simple FactoryBean for retrieving generic GemFire Regions. If lookups are not enabled or the Region does not exist, an exception is thrown. For declaring and configuring new Regions, see RegionFactoryBean.

Author:

Costin Leau, John Blum

See Also:

BeanNameAware, FactoryBean, InitializingBean, Region

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RegionLookupFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
Boolean	getLookupEnabled()
com.gemstone.gemfire.cache.Region<K,V>	getObject()
Class<?>	getObjectType()
protected com.gemstone.gemfire.cache.Region<?,?>	getParent() Returns a reference to the parent Region indicating this FactoryBean represents a GemFire cache Sub-Region.
protected com.gemstone.gemfire.cache.Region<K,V>	getRegion() Returns a reference to the GemFire Region resolved by this Spring FactoryBean during the lookup operation; maybe a new Region.
boolean	isSingleton()
protected com.gemstone.gemfire.cache.Region<K,V>	lookupFallback(com.gemstone.gemfire.cache.GemFireCache cache, String regionName) Deprecated. call lookupRegion(GemFireCache, String) instead.
protected com.gemstone.gemfire.cache.Region<K,V>	lookupRegion(com.gemstone.gemfire.cache.GemFireCache cache, String regionName) Method to perform a lookup when the named Region does not exist.
String	resolveRegionName() Resolves the name of the GemFire Region.
void	setBeanName(String name) Sets the name of the Region based on the bean 'id' attribute.
void	setCache(com.gemstone.gemfire.cache.GemFireCache cache) Sets a reference to the GemFireCache used to create the Region.
void	setLookupEnabled(Boolean lookupEnabled)
void	setName(String name) Sets the name of the cache Region based on the bean 'name' attribute.
void	setParent(com.gemstone.gemfire.cache.Region<?,?> parent) Sets a reference to the parent Region to indicated this FactoryBean represents a GemFire cache Sub-Region.
void	setRegionName(String regionName) Sets the name of the cache Region.

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

RegionLookupFactoryBean

public RegionLookupFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

lookupFallback

@Deprecated
protected com.gemstone.gemfire.cache.Region<K,V> lookupFallback(com.gemstone.gemfire.cache.GemFireCache cache,
                                                                            String regionName)
                                                                     throws Exception

Deprecated. call lookupRegion(GemFireCache, String) instead.

Throws:

Exception

lookupRegion

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

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

Parameters:

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

getObject

public com.gemstone.gemfire.cache.Region<K,V> getObject()
                                                 throws Exception

Specified by:

getObject in interface FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>

Throws:

Exception

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>

resolveRegionName

public String resolveRegionName()

Resolves the name of the GemFire Region.

Returns:

a String indicating the name of the GemFire Region.

See Also:

Region.getName()

setBeanName

public void setBeanName(String name)

Sets the name of the Region based on the bean 'id' attribute. If no Region is found with the given name, a new one will be created.

Specified by:

setBeanName in interface BeanNameAware

Parameters:

name - name of this Region bean in the Spring ApplicationContext.

See Also:

BeanNameAware.setBeanName(String)

setCache

public void setCache(com.gemstone.gemfire.cache.GemFireCache cache)

Sets a reference to the GemFireCache used to create the Region.

Parameters:

cache - reference to the GemFireCache.

See Also:

CacheFactoryBean, GemFireCache

setLookupEnabled

public void setLookupEnabled(Boolean lookupEnabled)

getLookupEnabled

public Boolean getLookupEnabled()

setName

public void setName(String name)

Sets the name of the cache Region based on the bean 'name' attribute. If no Region is found with the given name, a new one will be created. If no name is given, the value of the 'beanName' property will be used.

Parameters:

name - Region name.

See Also:

setBeanName(String)

setParent

public void setParent(com.gemstone.gemfire.cache.Region<?,?> parent)

Sets a reference to the parent Region to indicated this FactoryBean represents a GemFire cache Sub-Region.

Parameters:

parent - reference to the parent Region.

See Also:

Region

getParent

protected com.gemstone.gemfire.cache.Region<?,?> getParent()

Returns a reference to the parent Region indicating this FactoryBean represents a GemFire cache Sub-Region.

Returns:

a reference to the parent Region or null if this Region is not a Sub-Region.

See Also:

Region

getRegion

protected com.gemstone.gemfire.cache.Region<K,V> getRegion()

Returns a reference to the GemFire Region resolved by this Spring FactoryBean during the lookup operation; maybe a new Region.

Returns:

a reference to the GemFire Region resolved during lookup.

See Also:

Region

setRegionName

public void setRegionName(String regionName)

Sets the name of the cache Region. If no Region is found with the given name, a new one will be created. If no name is given, the value of the 'name' property will be used.

Parameters:

regionName - name of the Region.

See Also:

setName(String)