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

Class CacheTypeAwareRegionFactoryBean<K,V>

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<Region<K,V>>

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

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

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, FactoryBean<Region<K,V>>, InitializingBean, Lifecycle, Phased, SmartLifecycle, EvictingRegionFactoryBean, ExpiringRegionFactoryBean<K,V>

public class CacheTypeAwareRegionFactoryBean<K,V>
extends ResolvableRegionFactoryBean<K,V>
implements EvictingRegionFactoryBean, ExpiringRegionFactoryBean<K,V>, SmartLifecycle

The CacheTypeAwareRegionFactoryBean 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:

• Cache
• CustomExpiry
• DataPolicy
• EvictionAttributes
• ExpirationAttributes
• GemFireCache
• Region
• RegionAttributes
• RegionShortcut
• Scope
• ClientCache
• ClientRegionShortcut
• Compressor
• GenericRegionFactoryBean
• LocalRegionFactoryBean
• PartitionedRegionFactoryBean
• PeerRegionFactoryBean
• ResolvableRegionFactoryBean
• ReplicatedRegionFactoryBean
• ClientRegionFactoryBean
• RegionConfigurer
• EvictingRegionFactoryBean
• ExpiringRegionFactoryBean

Field Summary

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

CREATING_REGION_LOG_MESSAGE, REGION_FOUND_LOG_MESSAGE, REGION_NOT_FOUND_ERROR_MESSAGE

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

DEFAULT_SINGLETON

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
CacheTypeAwareRegionFactoryBean()

Method Summary

Modifier and Type	Method	Description
protected void	configureEviction(EvictingRegionFactoryBean regionFactoryBean)
protected void	configureExpiration(ExpiringRegionFactoryBean<K,V> regionFactoryBean)
Region<K,V>	createRegion(GemFireCache gemfireCache, String regionName)	Creates a new Region with the given name.
protected RegionAttributes<K,V>	getAttributes()
protected ClientRegionShortcut	getClientRegionShortcut()
protected Boolean	getClose()
protected Compressor	getCompressor()	Returns the configured Compressor used to compress the this Region's data.
protected CustomExpiry<K,V>	getCustomEntryIdleTimeout()
protected CustomExpiry<K,V>	getCustomEntryTimeToLive()
protected DataPolicy	getDataPolicy()
protected String	getDiskStoreName()
protected ExpirationAttributes	getEntryIdleTimeout()
protected ExpirationAttributes	getEntryTimeToLive()
protected EvictionAttributes	getEvictionAttributes()
protected Interest<K>[]	getInterests()
protected Class<K>	getKeyConstraint()
protected Boolean	getOffHeap()	Return the configuration setting for whether the Region's data will be managed in Off-Heap Memory.
int	getPhase()
protected Optional<String>	getPoolName()
protected ExpirationAttributes	getRegionIdleTimeout()
protected ExpirationAttributes	getRegionTimeToLive()
protected Scope	getScope()
protected RegionShortcut	getServerRegionShortcut()
protected Optional<SmartLifecycle>	getSmartLifecycleComponent()
Boolean	getStatisticsEnabled()
protected Class<V>	getValueConstraint()
boolean	isAutoStartup()
protected boolean	isClose()
boolean	isRunning()
protected Region<K,V>	newClientRegion(GemFireCache gemfireCache, String regionName)	Constructs, configures and initialize\s a new client Region using the ClientRegionFactoryBean.
protected <K, V> ClientRegionFactoryBean<K,V>	newClientRegionFactoryBean()	Constructs a new instance of the ClientRegionFactoryBean.
protected PeerRegionFactoryBean<K,V>	newPeerRegionFactoryBean()	Constructs a sub-type of the PeerRegionFactoryBean class based on the getServerRegionShortcut() and getDataPolicy().
protected Region<K,V>	newServerRegion(GemFireCache gemfireCache, String regionName)	Constructs, configures and initializes a new server Region using a sub-class of PeerRegionFactoryBean.
protected String	resolvePoolName()
void	setAttributes(RegionAttributes<K,V> regionAttributes)
void	setClientRegionShortcut(ClientRegionShortcut clientRegionShortcut)
void	setClose(Boolean close)
void	setCompressor(Compressor compressor)	Configures the Compressor used to compress the this Region's data.
void	setCustomEntryIdleTimeout(CustomExpiry<K,V> customEntryIdleTimeout)
void	setCustomEntryTimeToLive(CustomExpiry<K,V> customEntryTimeToLive)
void	setDataPolicy(DataPolicy dataPolicy)
void	setDiskStoreName(String diskStoreName)
void	setEntryIdleTimeout(ExpirationAttributes entryIdleTimeout)
void	setEntryTimeToLive(ExpirationAttributes entryTimeToLive)
void	setEvictionAttributes(EvictionAttributes evictionAttributes)
void	setInterests(Interest<K>[] interests)
void	setKeyConstraint(Class<K> keyConstraint)
void	setOffHeap(Boolean offHeap)	Configure the Region to manage data in Off-Heap Memory.
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 ResolvableRegionFactoryBean 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 ResolvableRegionFactoryBean when using Annotation-based configuration.
void	setRegionIdleTimeout(ExpirationAttributes regionIdleTimeout)
void	setRegionTimeToLive(ExpirationAttributes regionTimeToLive)
void	setScope(Scope scope)
void	setServerRegionShortcut(RegionShortcut shortcut)
void	setStatisticsEnabled(Boolean statisticsEnabled)
void	setValueConstraint(Class<V> valueConstraint)
void	start()
void	stop()
void	stop(Runnable callback)

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

afterPropertiesSet, getCache, getLookupEnabled, getObject, getObjectType, getParent, getRegion, isLookupEnabled, loadSnapshot, postProcess, resolveRegionName, setCache, setLookupEnabled, setName, setParent, setRegion, setRegionName, setSnapshot

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

getBeanClassLoader, getBeanFactory, getBeanName, getLog, getOptionalLog, isDebugLoggingEnabled, isErrorLoggingEnabled, isInfoLoggingEnabled, isSingleton, isWarnLoggingEnabled, 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 Details

CacheTypeAwareRegionFactoryBean

public CacheTypeAwareRegionFactoryBean()

Method Details

createRegion

public Region<K,V> createRegion(GemFireCache gemfireCache,
 String regionName)
                         throws Exception

Description copied from class: ResolvableRegionFactoryBean

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

newClientRegion

protected Region<K,V> newClientRegion(GemFireCache gemfireCache,
 String regionName)
                               throws Exception

Constructs, configures and initialize\s 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
• newClientRegionFactoryBean()

newClientRegionFactoryBean

protected <K,
V> ClientRegionFactoryBean<K,V> newClientRegionFactoryBean()

Constructs a new instance of the ClientRegionFactoryBean.

Type Parameters:

K - type of the created Region's key.

V - type of the created Region's value.

Returns:

a new instance of the ClientRegionFactoryBean.

See Also:

• ClientRegionFactoryBean

newServerRegion

protected Region<K,V> newServerRegion(GemFireCache gemfireCache,
 String regionName)
                               throws Exception

Constructs, configures and initializes a new server Region using a sub-class of PeerRegionFactoryBean.

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
• newPeerRegionFactoryBean()

newPeerRegionFactoryBean

protected PeerRegionFactoryBean<K,V> newPeerRegionFactoryBean()

Constructs a sub-type of the PeerRegionFactoryBean class based on the getServerRegionShortcut() and getDataPolicy().

Returns:

a new instance of the PeerRegionFactoryBean.

See Also:

• LocalRegionFactoryBean
• PartitionedRegionFactoryBean
• ReplicatedRegionFactoryBean
• PeerRegionFactoryBean

configureEviction

protected void configureEviction(EvictingRegionFactoryBean regionFactoryBean)

configureExpiration

protected void configureExpiration(ExpiringRegionFactoryBean<K,V> regionFactoryBean)

setAttributes

public void setAttributes(RegionAttributes<K,V> regionAttributes)

getAttributes

protected RegionAttributes<K,V> getAttributes()

setClientRegionShortcut

public void setClientRegionShortcut(ClientRegionShortcut clientRegionShortcut)

getClientRegionShortcut

protected ClientRegionShortcut getClientRegionShortcut()

setClose

public void setClose(Boolean close)

getClose

protected Boolean getClose()

isClose

protected boolean isClose()

setCompressor

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

getCompressor

protected Compressor getCompressor()

Returns the configured Compressor used to compress the this Region's data.

Returns:

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

See Also:

• Compressor

setCustomEntryIdleTimeout

public void setCustomEntryIdleTimeout(CustomExpiry<K,V> customEntryIdleTimeout)

Specified by:

setCustomEntryIdleTimeout in interface ExpiringRegionFactoryBean<K,V>

getCustomEntryIdleTimeout

protected CustomExpiry<K,V> getCustomEntryIdleTimeout()

setCustomEntryTimeToLive

public void setCustomEntryTimeToLive(CustomExpiry<K,V> customEntryTimeToLive)

Specified by:

setCustomEntryTimeToLive in interface ExpiringRegionFactoryBean<K,V>

getCustomEntryTimeToLive

protected CustomExpiry<K,V> getCustomEntryTimeToLive()

setDataPolicy

public void setDataPolicy(DataPolicy dataPolicy)

getDataPolicy

protected DataPolicy getDataPolicy()

setDiskStoreName

public void setDiskStoreName(String diskStoreName)

getDiskStoreName

protected String getDiskStoreName()

setEvictionAttributes

public void setEvictionAttributes(EvictionAttributes evictionAttributes)

Specified by:

setEvictionAttributes in interface EvictingRegionFactoryBean

getEvictionAttributes

protected EvictionAttributes getEvictionAttributes()

setEntryIdleTimeout

public void setEntryIdleTimeout(ExpirationAttributes entryIdleTimeout)

Specified by:

setEntryIdleTimeout in interface ExpiringRegionFactoryBean<K,V>

getEntryIdleTimeout

protected ExpirationAttributes getEntryIdleTimeout()

setEntryTimeToLive

public void setEntryTimeToLive(ExpirationAttributes entryTimeToLive)

Specified by:

setEntryTimeToLive in interface ExpiringRegionFactoryBean<K,V>

getEntryTimeToLive

protected ExpirationAttributes getEntryTimeToLive()

setInterests

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

getInterests

protected Interest<K>[] getInterests()

setKeyConstraint

public void setKeyConstraint(Class<K> keyConstraint)

getKeyConstraint

protected Class<K> getKeyConstraint()

setOffHeap

public void setOffHeap(Boolean offHeap)

Configure the Region to manage data in Off-Heap Memory.

Parameters:

offHeap - boolean value indicating whether the Region's data will be managed in Off-Heap Memory.

getOffHeap

protected Boolean getOffHeap()

Return the configuration setting for whether the Region's data will be managed in Off-Heap Memory.

Returns:

a boolean value indicating whether the Region's data will be managed in Off-Heap Memory.

setPoolName

public void setPoolName(String poolName)

getPoolName

protected Optional<String> getPoolName()

resolvePoolName

protected String resolvePoolName()

setRegionConfigurers

public void setRegionConfigurers(RegionConfigurer... regionConfigurers)

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

Parameters:

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

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

Parameters:

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

See Also:

• RegionConfigurer

setRegionIdleTimeout

public void setRegionIdleTimeout(ExpirationAttributes regionIdleTimeout)

Specified by:

setRegionIdleTimeout in interface ExpiringRegionFactoryBean<K,V>

getRegionIdleTimeout

protected ExpirationAttributes getRegionIdleTimeout()

setRegionTimeToLive

public void setRegionTimeToLive(ExpirationAttributes regionTimeToLive)

Specified by:

setRegionTimeToLive in interface ExpiringRegionFactoryBean<K,V>

getRegionTimeToLive

protected ExpirationAttributes getRegionTimeToLive()

setScope

public void setScope(Scope scope)

getScope

protected Scope getScope()

setServerRegionShortcut

public void setServerRegionShortcut(RegionShortcut shortcut)

getServerRegionShortcut

protected RegionShortcut getServerRegionShortcut()

getSmartLifecycleComponent

protected Optional<SmartLifecycle> getSmartLifecycleComponent()

setStatisticsEnabled

public void setStatisticsEnabled(Boolean statisticsEnabled)

getStatisticsEnabled

public Boolean getStatisticsEnabled()

setValueConstraint

public void setValueConstraint(Class<V> valueConstraint)

getValueConstraint

protected Class<V> getValueConstraint()

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle