|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.data.gemfire.RegionLookupFactoryBean<K,V>
org.springframework.data.gemfire.RegionFactoryBean<K,V>
public class RegionFactoryBean<K,V>
Base class for FactoryBeans used to create GemFire Regions. Will try
to first locate the region (by name) and, in case none if found, proceed to
creating one using the given settings.
Note that this factory bean allows for very flexible creation of GemFire
Region. For "client" regions however, see
ClientRegionFactoryBean which offers easier configuration and
defaults.
| Field Summary | |
|---|---|
protected org.apache.commons.logging.Log |
log
|
| Constructor Summary | |
|---|---|
RegionFactoryBean()
|
|
| Method Summary | ||
|---|---|---|
void |
afterPropertiesSet()
|
|
protected void |
assertDataPolicyAndPersistentAttributesAreCompatible(com.gemstone.gemfire.cache.DataPolicy resolvedDataPolicy)
Validates that the settings for Data Policy and the 'persistent' attribute in <gfe:*-region> elements are compatible. |
|
protected com.gemstone.gemfire.cache.RegionFactory<K,V> |
createRegionFactory(com.gemstone.gemfire.cache.Cache cache)
Creates an instance of RegionFactory using the given Cache instance used to configure and construct the Region created by this FactoryBean. |
|
void |
destroy()
|
|
com.gemstone.gemfire.cache.RegionAttributes |
getAttributes()
Returns the attributes used to configure the Region created by this factory as set in the SDG XML namespace configuration meta-data, or as set with the setAttributes(:Attributes) method. |
|
com.gemstone.gemfire.cache.DataPolicy |
getDataPolicy()
Gets the "resolved" Data Policy as determined by this RegionFactory when configuring the attributes of the Region to be created. |
|
int |
getPhase()
|
|
protected com.gemstone.gemfire.cache.RegionShortcut |
getShortcut()
|
|
boolean |
isAutoStartup()
|
|
protected boolean |
isNotPersistent()
Returns true when the user explicitly specified a value for the persistent attribute and it is false. |
|
protected boolean |
isPersistent()
Returns true when the user explicitly specified a value for the persistent attribute and it is true. |
|
protected boolean |
isPersistentUnspecified()
Determines whether the user explicitly set the 'persistent' attribute or not. |
|
boolean |
isRunning()
|
|
protected com.gemstone.gemfire.cache.Region<K,V> |
lookupFallback(com.gemstone.gemfire.cache.GemFireCache gemfireCache,
String regionName)
Fallback method in case the named Region does not exist. |
|
protected
|
mergePartitionAttributes(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory,
com.gemstone.gemfire.cache.RegionAttributes<K,V> regionAttributes)
|
|
protected
|
mergeRegionAttributes(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory,
com.gemstone.gemfire.cache.RegionAttributes<K,V> regionAttributes)
Intelligently merges the given RegionAttributes with the configuration setting of the RegionFactory. |
|
protected void |
postProcess(com.gemstone.gemfire.cache.Region<K,V> region)
Post-process the Region for this factory bean during the initialization process. |
|
protected void |
postProcess(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory)
Post-process the RegionFactory used to create the GemFire Region for this factory bean during the initialization process. |
|
protected void |
resolveDataPolicy(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory,
Boolean persistent,
com.gemstone.gemfire.cache.DataPolicy dataPolicy)
Validates and sets the Data Policy on the RegionFactory used to create and configure the Region from this FactoryBean. |
|
protected void |
resolveDataPolicy(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory,
Boolean persistent,
String dataPolicy)
Validates the configured Data Policy and may override it, taking into account the 'persistent' attribute and constraints for the Region type. |
|
void |
setAsyncEventQueues(Object[] asyncEventQueues)
The list of AsyncEventQueues to use with this Region. |
|
void |
setAttributes(com.gemstone.gemfire.cache.RegionAttributes<K,V> attributes)
Sets the region attributes used for the region used by this factory. |
|
void |
setCacheListeners(com.gemstone.gemfire.cache.CacheListener<K,V>[] cacheListeners)
Sets the cache listeners used for the region used by this factory. |
|
void |
setCacheLoader(com.gemstone.gemfire.cache.CacheLoader<K,V> cacheLoader)
Sets the cache loader used for the region used by this factory. |
|
void |
setCacheWriter(com.gemstone.gemfire.cache.CacheWriter<K,V> cacheWriter)
Sets the cache writer used for the region used by this factory. |
|
void |
setClose(boolean close)
Indicates whether the Region referred to by this factory bean will be closed on shutdown (default true). |
|
void |
setDataPolicy(com.gemstone.gemfire.cache.DataPolicy dataPolicy)
Sets the DataPolicy of the Region. |
|
void |
setDataPolicy(String dataPolicyName)
Deprecated. as of 1.4.0, use setDataPolicy(:DataPolicy) instead. |
|
void |
setDestroy(boolean destroy)
Indicates whether the Region referred to by this factory bean will be destroyed on shutdown (default false). |
|
void |
setDiskStoreName(String diskStoreName)
Sets the name of Disk Store used for either overflow or persistence, or both. |
|
void |
setEnableGateway(boolean enableGateway)
|
|
void |
setGatewaySenders(Object[] gatewaySenders)
|
|
void |
setHubId(String hubId)
|
|
void |
setPersistent(Boolean persistent)
|
|
void |
setScope(com.gemstone.gemfire.cache.Scope scope)
Sets the region scope. |
|
void |
setShortcut(com.gemstone.gemfire.cache.RegionShortcut shortcut)
Configures the Region with a RegionShortcut. |
|
void |
setSnapshot(Resource snapshot)
Sets the snapshots used for loading a newly created region. |
|
void |
start()
|
|
void |
stop()
|
|
void |
stop(Runnable callback)
|
|
| Methods inherited from class org.springframework.data.gemfire.RegionLookupFactoryBean |
|---|
getLookupEnabled, getObject, getObjectType, getParent, getRegion, isSingleton, setBeanName, setCache, setLookupEnabled, setName, setParent, setRegionName |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected final org.apache.commons.logging.Log log
| Constructor Detail |
|---|
public RegionFactoryBean()
| Method Detail |
|---|
public void afterPropertiesSet()
throws Exception
afterPropertiesSet in interface InitializingBeanafterPropertiesSet in class RegionLookupFactoryBean<K,V>Exception
protected com.gemstone.gemfire.cache.Region<K,V> lookupFallback(com.gemstone.gemfire.cache.GemFireCache gemfireCache,
String regionName)
throws Exception
RegionLookupFactoryBean
lookupFallback in class RegionLookupFactoryBean<K,V>gemfireCache - a reference to the GemFire Cache.regionName - the name of the GemFire Cache Region.
Exception - if the lookup operation fails.protected void assertDataPolicyAndPersistentAttributesAreCompatible(com.gemstone.gemfire.cache.DataPolicy resolvedDataPolicy)
resolvedDataPolicy - the GemFire Data Policy resolved form the Spring GemFire XML namespace configuration
meta-data.isPersistent(),
isNotPersistent(),
DataPolicyprotected boolean isPersistentUnspecified()
isPersistent(),
isNotPersistent()protected boolean isPersistent()
isNotPersistent(),
isPersistentUnspecified()protected boolean isNotPersistent()
isPersistent(),
isPersistentUnspecified()protected com.gemstone.gemfire.cache.RegionFactory<K,V> createRegionFactory(com.gemstone.gemfire.cache.Cache cache)
cache - the GemFire Cache instance.
Cache.createRegionFactory(),
Cache.createRegionFactory(com.gemstone.gemfire.cache.RegionAttributes),
Cache.createRegionFactory(com.gemstone.gemfire.cache.RegionShortcut),
RegionFactory
protected <K,V> com.gemstone.gemfire.cache.RegionFactory<K,V> mergeRegionAttributes(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory,
com.gemstone.gemfire.cache.RegionAttributes<K,V> regionAttributes)
K - the Class type fo the Region key.V - the Class type of the Region value.regionFactory - the GemFire RegionFactory used to configure and create the Region that is the product
of this RegionFactoryBean.regionAttributes - the RegionAttributes containing the Region configuration settings to merge to the
RegionFactory.
hasUserSpecifiedEvictionAttributes(com.gemstone.gemfire.cache.RegionAttributes),
validateRegionAttributes(com.gemstone.gemfire.cache.RegionAttributes),
RegionAttributes,
RegionFactory
protected <K,V> void mergePartitionAttributes(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory,
com.gemstone.gemfire.cache.RegionAttributes<K,V> regionAttributes)
protected void postProcess(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory)
regionFactory - the GemFire RegionFactory used to create the Region for post-processing.RegionFactoryprotected void postProcess(com.gemstone.gemfire.cache.Region<K,V> region)
region - the GemFire Region to post-process.Region
protected void resolveDataPolicy(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory,
Boolean persistent,
com.gemstone.gemfire.cache.DataPolicy dataPolicy)
regionFactory - the RegionFactory used by this FactoryBean to create and configure the Region.persistent - a boolean value indicating whether the Region should be persistent and persist it's
data to disk.dataPolicy - the configured Data Policy for the Region.resolveDataPolicy(com.gemstone.gemfire.cache.RegionFactory, Boolean, String),
DataPolicy,
RegionFactory
protected void resolveDataPolicy(com.gemstone.gemfire.cache.RegionFactory<K,V> regionFactory,
Boolean persistent,
String dataPolicy)
regionFactory - the GemFire RegionFactory used to create the desired Region.persistent - a boolean value indicating whether the Region should persist it's data to disk.dataPolicy - requested Data Policy as set by the user in the Spring GemFire configuration meta-data.DataPolicy,
RegionFactory
public void destroy()
throws Exception
destroy in interface DisposableBeanExceptionpublic void setAsyncEventQueues(Object[] asyncEventQueues)
asyncEventQueues - defined as Object for backwards compatibility with Gemfire 6.public void setAttributes(com.gemstone.gemfire.cache.RegionAttributes<K,V> attributes)
attributes - the attributes to set on a newly created regionpublic com.gemstone.gemfire.cache.RegionAttributes getAttributes()
RegionAttributespublic void setCacheListeners(com.gemstone.gemfire.cache.CacheListener<K,V>[] cacheListeners)
setAttributes(RegionAttributes).
cacheListeners - the cacheListeners to set on a newly created regionpublic void setCacheLoader(com.gemstone.gemfire.cache.CacheLoader<K,V> cacheLoader)
setAttributes(RegionAttributes).
cacheLoader - the cacheLoader to set on a newly created regionpublic void setCacheWriter(com.gemstone.gemfire.cache.CacheWriter<K,V> cacheWriter)
setAttributes(RegionAttributes).
cacheWriter - the cacheWriter to set on a newly created regionpublic void setClose(boolean close)
close - a boolean value indicating whether this Region should be closed on member shutdown.setDestroy(boolean)public void setDestroy(boolean destroy)
destroy - a boolean value indicating whether the Region is to be destroy on member shutdown.setDestroy(boolean)public void setDataPolicy(com.gemstone.gemfire.cache.DataPolicy dataPolicy)
dataPolicy - the GemFire DataPolicy to use when configuring the Region.public void setDataPolicy(String dataPolicyName)
dataPolicyName - the name of the DataPolicy (e.g. REPLICATE, PARTITION)setDataPolicy(com.gemstone.gemfire.cache.DataPolicy)public com.gemstone.gemfire.cache.DataPolicy getDataPolicy()
DataPolicypublic void setDiskStoreName(String diskStoreName)
diskStoreName - the name of the Disk Store bean in context used for overflow/persistence.public void setEnableGateway(boolean enableGateway)
public void setGatewaySenders(Object[] gatewaySenders)
gatewaySenders - defined as Object for backward compatibility with
Gemfire 6public void setHubId(String hubId)
public void setPersistent(Boolean persistent)
public void setScope(com.gemstone.gemfire.cache.Scope scope)
setAttributes(RegionAttributes).
scope - the region scopeScopeprotected final com.gemstone.gemfire.cache.RegionShortcut getShortcut()
public void setShortcut(com.gemstone.gemfire.cache.RegionShortcut shortcut)
shortcut - the RegionShortcut used to configure pre-defined default for the Region created
by this FactoryBean.RegionShortcutpublic void setSnapshot(Resource snapshot)
snapshot - the snapshot to setRegionLookupFactoryBean.setName(String)public void start()
start in interface Lifecyclepublic void stop()
stop in interface Lifecyclepublic boolean isRunning()
isRunning in interface Lifecyclepublic int getPhase()
getPhase in interface Phasedpublic boolean isAutoStartup()
isAutoStartup in interface SmartLifecyclepublic void stop(Runnable callback)
stop in interface SmartLifecycle
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||