|
GemFire 6.6.3 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.gemstone.gemfire.cache.RegionFactory<K,V>
public class RegionFactory<K,V>
RegionFactory
is used to create regions
in a cache
.
Instances of this interface can be created:
shortcut
by calling Cache.createRegionFactory(RegionShortcut)
which will initialize the factory with the shortcut's region attributes
Cache.createRegionFactory(String)
which will initialize the factory the named region attributes
Cache.createRegionFactory(RegionAttributes)
which will initialize the factory with the given region attributes
Cache.createRegionFactory()
which will initialize the factory with defaults
The final step is to produce a Region
by calling create(String)
.
Example: Create a replicate region with a CacheListener
Cache c = new CacheFactory().create(); // Create replicate region. // Add a cache listener before creating region Region r = c.createRegionFactory(REPLICATE) .addCacheListener(myListener) .create("replicate");
Example: Create a partition region that has redundancy
Cache c = new CacheFactory().create(); // Create replicate region. // Add a cache listener before creating region Region r = c.createRegionFactory(PARTITION_REDUNDANT) .create("partition");
Constructor Summary | |
---|---|
RegionFactory()
Deprecated. as of 6.5 use Cache.createRegionFactory() instead. |
|
RegionFactory(Properties distributedSystemProperties)
Deprecated. as of 6.5 use CacheFactory.CacheFactory(Properties) and Cache.createRegionFactory() instead. |
|
RegionFactory(Properties distributedSystemProperties,
RegionAttributes<K,V> regionAttributes)
Deprecated. as of 6.5 use CacheFactory.CacheFactory(Properties) and Cache.createRegionFactory(RegionAttributes) instead. |
|
RegionFactory(Properties distributedSystemProperties,
String regionAttributesId)
Deprecated. as of 6.5 use CacheFactory.CacheFactory(Properties) and Cache.createRegionFactory(String) instead. |
|
RegionFactory(RegionAttributes<K,V> regionAttributes)
Deprecated. as of 6.5 use Cache.createRegionFactory(RegionAttributes) instead. |
|
RegionFactory(String regionAttributesId)
Deprecated. as of 6.5 use Cache.createRegionFactory(String) instead. |
Method Summary | |
---|---|
RegionFactory<K,V> |
addCacheListener(CacheListener<K,V> aListener)
Adds a cache listener to the end of the list of cache listeners on this factory. |
Region<K,V> |
create(String name)
Creates a region with the given name in this factory's Cache
using the configuration contained in this factory. |
RegionFactory<K,V> |
initCacheListeners(CacheListener<K,V>[] newListeners)
Removes all cache listeners and then adds each listener in the specified array. |
RegionFactory<K,V> |
setCacheLoader(CacheLoader<K,V> cacheLoader)
Sets the cache loader for the next RegionAttributes created. |
RegionFactory<K,V> |
setCacheWriter(CacheWriter<K,V> cacheWriter)
Sets the cache writer for the next RegionAttributes created. |
RegionFactory<K,V> |
setCloningEnabled(boolean cloningEnable)
Sets cloning on region |
RegionFactory<K,V> |
setConcurrencyLevel(int concurrencyLevel)
Sets the concurrency level tof the next RegionAttributes
created. |
RegionFactory<K,V> |
setCustomEntryIdleTimeout(CustomExpiry<K,V> custom)
Sets the custom idleTimeout for the next RegionAttributes
created. |
RegionFactory<K,V> |
setCustomEntryTimeToLive(CustomExpiry<K,V> custom)
Sets the custom timeToLive expiration method for the next RegionAttributes created. |
RegionFactory<K,V> |
setDataPolicy(DataPolicy dataPolicy)
Sets the data policy for the next RegionAttributes created. |
RegionFactory<K,V> |
setDiskDirs(File[] diskDirs)
Deprecated. as of 6.5 use DiskStoreFactory.setDiskDirs(java.io.File[]) instead |
RegionFactory<K,V> |
setDiskDirsAndSizes(File[] diskDirs,
int[] diskSizes)
Deprecated. as of 6.5 use DiskStoreFactory.setDiskDirsAndSizes(java.io.File[], int[]) instead |
RegionFactory<K,V> |
setDiskStoreName(String name)
Sets the DiskStore name attribute. |
RegionFactory<K,V> |
setDiskSynchronous(boolean isSynchronous)
Sets whether or not the writing to the disk is synchronous. |
RegionFactory<K,V> |
setDiskWriteAttributes(DiskWriteAttributes attrs)
Deprecated. as of 6.5 use setDiskStoreName(java.lang.String) instead |
RegionFactory<K,V> |
setEarlyAck(boolean earlyAck)
Deprecated. As of 6.5 this setting no longer has any effect. |
RegionFactory<K,V> |
setEnableAsyncConflation(boolean value)
Sets whether or not conflation is enabled for sending messages to async peers. |
RegionFactory<K,V> |
setEnableGateway(boolean value)
Sets whether or not updates are sent to defined Gateway s. |
RegionFactory<K,V> |
setEnableSubscriptionConflation(boolean value)
Sets whether or not conflation is enabled for sending messages from a cache server to its clients. |
RegionFactory<K,V> |
setEntryIdleTimeout(ExpirationAttributes idleTimeout)
Sets the idleTimeout expiration attributes for region entries for the next RegionAttributes created. |
RegionFactory<K,V> |
setEntryTimeToLive(ExpirationAttributes timeToLive)
Sets the timeToLive expiration attributes for region entries for the next RegionAttributes created. |
RegionFactory<K,V> |
setEvictionAttributes(EvictionAttributes evictionAttributes)
Sets the eviction attributes that controls growth of the Region to be created. |
RegionFactory<K,V> |
setGatewayHubId(String id)
Sets the id of the GatewayHub to which this region sends events. |
RegionFactory<K,V> |
setIgnoreJTA(boolean flag)
Sets whether operations on this region should be controlled by JTA transactions or not |
RegionFactory<K,V> |
setIndexMaintenanceSynchronous(boolean synchronous)
Sets how indexes on this region are kept current. |
RegionFactory<K,V> |
setInitialCapacity(int initialCapacity)
Sets the entry initial capacity for the next RegionAttributes
created. |
RegionFactory<K,V> |
setKeyConstraint(Class<K> keyConstraint)
Sets the key constraint for the next RegionAttributes
created. |
RegionFactory<K,V> |
setLoadFactor(float loadFactor)
Sets the entry load factor for the next RegionAttributes
created. |
RegionFactory<K,V> |
setLockGrantor(boolean isLockGrantor)
Sets whether this region should become lock grantor. |
RegionFactory<K,V> |
setMembershipAttributes(MembershipAttributes ra)
Sets the MembershipAttributes that describe the membership
roles required for reliable access to the region. |
RegionFactory<K,V> |
setMulticastEnabled(boolean value)
Sets whether distributed operations on this region should attempt to use multicast. |
RegionFactory<K,V> |
setPartitionAttributes(PartitionAttributes partition)
Sets the PartitionAttributes that describe how the region is
partitioned among members of the distributed system. |
RegionFactory<K,V> |
setPoolName(String poolName)
Sets the pool name attribute. |
void |
setPublisher(boolean v)
Deprecated. as of 6.5 |
RegionFactory<K,V> |
setRegionIdleTimeout(ExpirationAttributes idleTimeout)
Sets the idleTimeout expiration attributes for the region itself for the next RegionAttributes created. |
RegionFactory<K,V> |
setRegionTimeToLive(ExpirationAttributes timeToLive)
Sets the timeToLive expiration attributes for the region itself for the next RegionAttributes created. |
RegionFactory<K,V> |
setScope(Scope scopeType)
Sets the scope for the next RegionAttributes created. |
RegionFactory<K,V> |
setStatisticsEnabled(boolean statisticsEnabled)
Sets whether statistics are enabled for this region and its entries. |
RegionFactory<K,V> |
setSubscriptionAttributes(SubscriptionAttributes sa)
Sets the kind of interest this region has in events occuring in other caches that define the region by the same name. |
RegionFactory<K,V> |
setValueConstraint(Class<V> valueConstraint)
Sets the value constraint for the next RegionAttributes
created. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
@Deprecated public RegionFactory() throws CacheWriterException, RegionExistsException, TimeoutException
Cache.createRegionFactory()
instead.
CacheException
- if unable to connect the DistributedSystem or create a Cache
CacheWriterException
RegionExistsException
TimeoutException
@Deprecated public RegionFactory(RegionAttributes<K,V> regionAttributes) throws CacheWriterException, RegionExistsException, TimeoutException
Cache.createRegionFactory(RegionAttributes)
instead.
CacheException
- if unable to connect the DistributedSystem or create a Cache
CacheWriterException
RegionExistsException
TimeoutException
@Deprecated public RegionFactory(String regionAttributesId) throws CacheWriterException, RegionExistsException, TimeoutException
Cache.createRegionFactory(String)
instead.
regionAttributesId
- that identifies a set of RegionAttributes in the cache-xml file.
IllegalArgumentException
- if there are no attributes associated with the id
CacheException
- if unable to connect the DistributedSystem or create a Cache
CacheWriterException
RegionExistsException
TimeoutException
GemFireCache.getRegionAttributes(java.lang.String)
@Deprecated public RegionFactory(Properties distributedSystemProperties) throws CacheWriterException, RegionExistsException, TimeoutException
CacheFactory.CacheFactory(Properties)
and Cache.createRegionFactory()
instead.
distributedSystemProperties
- an instance of Properties containing
DistributedSystem
Throws:
CacheException
- if unable to connect the DistributedSystem or create a Cache
CacheWriterException
RegionExistsException
TimeoutException
@Deprecated public RegionFactory(Properties distributedSystemProperties, RegionAttributes<K,V> regionAttributes) throws CacheWriterException, RegionExistsException, TimeoutException
CacheFactory.CacheFactory(Properties)
and Cache.createRegionFactory(RegionAttributes)
instead.
distributedSystemProperties
- properties used to either find or create a DistributedSystem.regionAttributes
- the initial Region configuration for this RegionFactory.
CacheException
- if unable to connect the DistributedSystem or create a Cache
CacheWriterException
RegionExistsException
TimeoutException
@Deprecated public RegionFactory(Properties distributedSystemProperties, String regionAttributesId) throws CacheWriterException, RegionExistsException, TimeoutException
CacheFactory.CacheFactory(Properties)
and Cache.createRegionFactory(String)
instead.
distributedSystemProperties
- properties used to either find or create a DistributedSystem.regionAttributesId
- the identifier for set of RegionAttributes in the cache.xml file
used as the initial Region configuration for this RegionFactory.
IllegalArgumentException
- if there are no attributes associated with the id
CacheException
- if unable to connect the DistributedSystem or create a Cache
CacheWriterException
RegionExistsException
TimeoutException
Method Detail |
---|
public RegionFactory<K,V> setCacheLoader(CacheLoader<K,V> cacheLoader)
RegionAttributes
created.
cacheLoader
- the cache loader or null if no loader
AttributesFactory.setCacheLoader(com.gemstone.gemfire.cache.CacheLoader)
public RegionFactory<K,V> setCacheWriter(CacheWriter<K,V> cacheWriter)
RegionAttributes
created.
cacheWriter
- the cache writer or null if no cache writer
AttributesFactory.setCacheWriter(com.gemstone.gemfire.cache.CacheWriter)
public RegionFactory<K,V> addCacheListener(CacheListener<K,V> aListener)
aListener
- the cache listener to add
IllegalArgumentException
- if aListener
is nullAttributesFactory.addCacheListener(com.gemstone.gemfire.cache.CacheListener)
public RegionFactory<K,V> initCacheListeners(CacheListener<K,V>[] newListeners)
RegionAttributes
created.
newListeners
- a possibly null or empty array of listeners to add to this factory.
IllegalArgumentException
- if the newListeners
array has a null elementAttributesFactory.initCacheListeners(com.gemstone.gemfire.cache.CacheListener[])
public RegionFactory<K,V> setEvictionAttributes(EvictionAttributes evictionAttributes)
evictionAttributes
- for the Region to create
public RegionFactory<K,V> setEntryIdleTimeout(ExpirationAttributes idleTimeout)
RegionAttributes
created.
idleTimeout
- the idleTimeout ExpirationAttributes for entries in this region
IllegalArgumentException
- if idleTimeout is nullAttributesFactory.setEntryIdleTimeout(com.gemstone.gemfire.cache.ExpirationAttributes)
public RegionFactory<K,V> setCustomEntryIdleTimeout(CustomExpiry<K,V> custom)
RegionAttributes
created.
custom
- the custom method
AttributesFactory.setCustomEntryIdleTimeout(CustomExpiry)
public RegionFactory<K,V> setEntryTimeToLive(ExpirationAttributes timeToLive)
RegionAttributes
created.
timeToLive
- the timeToLive ExpirationAttributes for entries in this region
IllegalArgumentException
- if timeToLive is nullAttributesFactory.setEntryTimeToLive(com.gemstone.gemfire.cache.ExpirationAttributes)
public RegionFactory<K,V> setCustomEntryTimeToLive(CustomExpiry<K,V> custom)
RegionAttributes
created.
custom
- the custom method
AttributesFactory.setCustomEntryTimeToLive(CustomExpiry)
public RegionFactory<K,V> setRegionIdleTimeout(ExpirationAttributes idleTimeout)
RegionAttributes
created.
idleTimeout
- the ExpirationAttributes for this region idleTimeout
IllegalArgumentException
- if idleTimeout is nullAttributesFactory.setRegionIdleTimeout(com.gemstone.gemfire.cache.ExpirationAttributes)
public RegionFactory<K,V> setRegionTimeToLive(ExpirationAttributes timeToLive)
RegionAttributes
created.
timeToLive
- the ExpirationAttributes for this region timeToLive
IllegalArgumentException
- if timeToLive is nullAttributesFactory.setRegionTimeToLive(com.gemstone.gemfire.cache.ExpirationAttributes)
public RegionFactory<K,V> setScope(Scope scopeType)
RegionAttributes
created.
scopeType
- the type of Scope to use for the region
IllegalArgumentException
- if scopeType is nullAttributesFactory.setScope(com.gemstone.gemfire.cache.Scope)
public RegionFactory<K,V> setDataPolicy(DataPolicy dataPolicy)
RegionAttributes
created.
dataPolicy
- The type of mirroring to use for the region
IllegalArgumentException
- if dataPolicy is nullAttributesFactory.setDataPolicy(com.gemstone.gemfire.cache.DataPolicy)
@Deprecated public RegionFactory<K,V> setEarlyAck(boolean earlyAck)
earlyAck
- set to true for the acknowledgement to be sent prior to processing the update
AttributesFactory.setEarlyAck(boolean)
public RegionFactory<K,V> setMulticastEnabled(boolean value)
value
- true to enable multicast
AttributesFactory.setMulticastEnabled(boolean)
public RegionFactory<K,V> setPoolName(String poolName)
If this attribute is set to null
or ""
then the connection pool is disabled causing regions that use these attributes
to be communicate with peers instead of servers.
The named connection pool must exist on the cache at the time these
attributes are used to create a region. See PoolManager.createFactory()
for how to create a connection pool.
poolName
- the name of the connection pool to use; if null
or ""
then the connection pool attribute is disabled for regions
using these attributes.
IllegalStateException
- if a cache loader or cache writer has already
been set.public RegionFactory<K,V> setEnableGateway(boolean value)
Gateway
s.
value
- true to enable Gateway
AttributesFactory.setEnableGateway(boolean)
@Deprecated public void setPublisher(boolean v)
public RegionFactory<K,V> setEnableAsyncConflation(boolean value)
value
- true to enable async conflation
AttributesFactory.setEnableAsyncConflation(boolean)
public RegionFactory<K,V> setEnableSubscriptionConflation(boolean value)
value
- true to enable subscription conflation
AttributesFactory.setEnableSubscriptionConflation(boolean)
public RegionFactory<K,V> setKeyConstraint(Class<K> keyConstraint)
RegionAttributes
created. Keys in the region will be constrained to this class (or
subclass). Any attempt to store a key of an incompatible type in the region
will cause a ClassCastException
to be thrown.
keyConstraint
- The Class to constrain the keys to, or null if no constraint
IllegalArgumentException
- if keyConstraint
is a class denoting a primitive
typeAttributesFactory.setKeyConstraint(java.lang.Class)
public RegionFactory<K,V> setValueConstraint(Class<V> valueConstraint)
RegionAttributes
created. Values in the region will be constrained to this class (or
subclass). Any attempt to store a value of an incompatible type in the
region will cause a ClassCastException
to be thrown.
valueConstraint
- The Class to constrain the values to, or null if no constraint
IllegalArgumentException
- if valueConstraint
is a class denoting a primitive
typeAttributesFactory.setValueConstraint(java.lang.Class)
public RegionFactory<K,V> setInitialCapacity(int initialCapacity)
RegionAttributes
created. This value is used in initializing the map that holds the entries.
initialCapacity
- the initial capacity of the entry map
IllegalArgumentException
- if initialCapacity is negative.HashMap
,
AttributesFactory.setInitialCapacity(int)
public RegionFactory<K,V> setLoadFactor(float loadFactor)
RegionAttributes
created. This value is used in initializing the map that holds the entries.
loadFactor
- the load factor of the entry map
IllegalArgumentException
- if loadFactor is nonpositiveHashMap
,
AttributesFactory.setLoadFactor(float)
public RegionFactory<K,V> setConcurrencyLevel(int concurrencyLevel)
RegionAttributes
created. This value is used in initializing the map that holds the entries.
concurrencyLevel
- the concurrency level of the entry map
IllegalArgumentException
- if concurrencyLevel is nonpositiveAttributesFactory.setConcurrencyLevel(int)
@Deprecated public RegionFactory<K,V> setDiskWriteAttributes(DiskWriteAttributes attrs)
setDiskStoreName(java.lang.String)
instead
Region.writeToDisk()
,
AttributesFactory.setDiskWriteAttributes(com.gemstone.gemfire.cache.DiskWriteAttributes)
public RegionFactory<K,V> setDiskStoreName(String name)
name
- the name of the diskstore
AttributesFactory.setDiskStoreName(java.lang.String)
public RegionFactory<K,V> setDiskSynchronous(boolean isSynchronous)
isSynchronous
- boolean if true indicates synchronous writes
@Deprecated public RegionFactory<K,V> setDiskDirs(File[] diskDirs)
DiskStoreFactory.setDiskDirs(java.io.File[])
instead
IllegalArgumentException
- if a directory does not existAttributesFactory.setDiskDirs(java.io.File[])
@Deprecated public RegionFactory<K,V> setDiskDirsAndSizes(File[] diskDirs, int[] diskSizes)
DiskStoreFactory.setDiskDirsAndSizes(java.io.File[], int[])
instead
IllegalArgumentException
- if a dir does not exist or the length of the size array
does not match to the length of the dir arrayAttributesFactory.setDiskDirsAndSizes(java.io.File[], int[])
public RegionFactory<K,V> setPartitionAttributes(PartitionAttributes partition)
PartitionAttributes
that describe how the region is
partitioned among members of the distributed system.
AttributesFactory.setPartitionAttributes(com.gemstone.gemfire.cache.PartitionAttributes)
public RegionFactory<K,V> setMembershipAttributes(MembershipAttributes ra)
MembershipAttributes
that describe the membership
roles required for reliable access to the region.
ra
- the MembershipAttributes to use
AttributesFactory.setMembershipAttributes(com.gemstone.gemfire.cache.MembershipAttributes)
public RegionFactory<K,V> setIndexMaintenanceSynchronous(boolean synchronous)
synchronous
- whether indexes are maintained in a synchronized fashion
public RegionFactory<K,V> setStatisticsEnabled(boolean statisticsEnabled)
statisticsEnabled
- whether statistics are enabled
AttributesFactory.setStatisticsEnabled(boolean)
public RegionFactory<K,V> setIgnoreJTA(boolean flag)
public RegionFactory<K,V> setLockGrantor(boolean isLockGrantor)
isLockGrantor
- whether this region should become lock grantor
AttributesFactory.setLockGrantor(boolean)
public RegionFactory<K,V> setSubscriptionAttributes(SubscriptionAttributes sa)
sa
- the attributes decribing the interest
AttributesFactory.setSubscriptionAttributes(SubscriptionAttributes)
public RegionFactory<K,V> setGatewayHubId(String id)
GatewayHub
to which this region sends events.
id
- the id of the GatewayHub
AttributesFactory.setGatewayHubId(String)
public Region<K,V> create(String name) throws CacheExistsException, RegionExistsException, CacheWriterException, TimeoutException
Cache
using the configuration contained in this factory. Validation of the
provided attributes may cause exceptions to be thrown if there are problems
with the configuration data.
name
- the name of the region to create
LeaseExpiredException
- if lease expired on distributed lock for Scope.GLOBAL
RegionExistsException
- if a region, shared or unshared, is already in this cache
TimeoutException
- if timed out getting distributed lock for Scope.GLOBAL
CacheClosedException
- if the cache is closed
IllegalStateException
- if the supplied RegionAttributes are incompatible with this region
in another cache in the distributed system (see
AttributesFactory
for compatibility rules)
CacheExistsException
CacheWriterException
public RegionFactory<K,V> setCloningEnabled(boolean cloningEnable)
cloningEnable
-
AttributesFactory.setCloningEnabled(boolean)
|
GemFire 6.6.3 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |