public interface RegionAttributes<K,V>
EvictionAttributes
,
CacheListener
, CacheLoader
, CacheWriter
,
scope, data policy, and expiration attributes
for the region itself, expiration attributes for the region entries,
and whether statistics are enabled for the region and its entries.
To create an instance of this interface use AttributesFactory.createRegionAttributes()
.
For compatibility rules and default values, see AttributesFactory
.
Note that the RegionAttributes
are not distributed with the region.
AttributesFactory
,
AttributesMutator
,
Region.getAttributes()
,
EvictionAttributes
Modifier and Type | Method and Description |
---|---|
Set<String> |
getAsyncEventQueueIds()
Returns a set of AsyncEventQueueIds added to the region
|
CacheListener<K,V> |
getCacheListener()
Deprecated.
as of GemFire 5.0, use
getCacheListeners() instead |
CacheListener<K,V>[] |
getCacheListeners()
Returns an array of all the cache listeners on this attributes.
|
CacheLoader<K,V> |
getCacheLoader()
Returns the cache loader associated with this region.
|
CacheWriter<K,V> |
getCacheWriter()
Returns the cache writer associated with this region.
|
boolean |
getCloningEnabled()
Returns whether or not cloning is enabled on region.
|
Compressor |
getCompressor()
Returns the compressor used by this region's entry values.
|
boolean |
getConcurrencyChecksEnabled()
Returns true if concurrent update checks are turned on for this region.
|
int |
getConcurrencyLevel()
Returns the concurrencyLevel of the entries map.
|
CustomExpiry<K,V> |
getCustomEntryIdleTimeout()
Gets the
idleTimeout CustomExpiry , if any
for entries in this region |
CustomExpiry<K,V> |
getCustomEntryTimeToLive()
Gets the
entryTimeToLive CustomExpiry , if any
for entries in this region |
DataPolicy |
getDataPolicy()
Returns the data policy for this region.
|
File[] |
getDiskDirs()
Deprecated.
as of 6.5 use
DiskStore.getDiskDirs() instead. |
int[] |
getDiskDirSizes()
Deprecated.
as of 6.5 use
DiskStore.getDiskDirSizes() instead. |
String |
getDiskStoreName()
Returns the name of the
DiskStore that this region belongs
to, if any. |
DiskWriteAttributes |
getDiskWriteAttributes()
Deprecated.
as of 6.5 use
getDiskStoreName() instead. |
boolean |
getEarlyAck()
Deprecated.
Setting early ack no longer has any effect.
|
boolean |
getEnableAsyncConflation()
Returns whether or not async conflation is enabled for sending
messages to async peers.
|
boolean |
getEnableBridgeConflation()
Deprecated.
as of GemFire 5.0, use
getEnableSubscriptionConflation() instead |
boolean |
getEnableConflation()
Deprecated.
as of GemFire 5.0, use
getEnableSubscriptionConflation() instead
# |
boolean |
getEnableGateway()
Returns whether or not a Gateway is enabled.
|
boolean |
getEnableSubscriptionConflation()
Returns whether or not conflation is enabled for sending
messages from a cache server to its clients.
|
boolean |
getEnableWAN()
Deprecated.
as of GemFire 5.0, use getEnableGateway instead
|
ExpirationAttributes |
getEntryIdleTimeout()
Gets the
idleTimeout expiration attributes for entries in this region. |
ExpirationAttributes |
getEntryTimeToLive()
Gets the
timeToLive expiration attributes for entries in this region. |
EvictionAttributes |
getEvictionAttributes()
|
String |
getGatewayHubId()
Returns the id of the
GatewayHub to which events are
distributed. |
Set<String> |
getGatewaySenderIds()
Returns a set of gatewaysenderIds
|
boolean |
getIgnoreJTA()
Gets the flag telling a region to ignore JTA transactions.
|
boolean |
getIndexMaintenanceSynchronous()
Returns the value of
IndexMaintenanceSynchronous which
specifies whether the region indexes are updated synchronously when a
region is modified or asynchronously in a background thread. |
int |
getInitialCapacity()
Returns the initial capacity of the entries map.
|
Class<K> |
getKeyConstraint()
Returns the class that the keys in this region are constrained to.
|
float |
getLoadFactor()
Returns the load factor of the entries map.
|
MembershipAttributes |
getMembershipAttributes()
Returns the
MembershipAttributes that configure required
roles for reliable access to the region. |
MirrorType |
getMirrorType()
Deprecated.
as of GemFire 5.0, use
getDataPolicy() instead. |
boolean |
getMulticastEnabled()
Returns true if multicast communications are enabled for this region.
|
PartitionAttributes |
getPartitionAttributes()
Returns the
PartitionAttributes that configure how
the region is partitioned. |
boolean |
getPersistBackup()
Deprecated.
as of GemFire 5.0, use
DataPolicy.PERSISTENT_REPLICATE instead |
String |
getPoolName()
Returns the name of the
Pool that this region
will use to communicate with servers, if any. |
boolean |
getPublisher()
Deprecated.
as of 6.5
|
ExpirationAttributes |
getRegionIdleTimeout()
Gets the idleTimeout expiration attributes for the region as a whole.
|
ExpirationAttributes |
getRegionTimeToLive()
Gets the
timeToLive expiration attributes for the region as a whole. |
Scope |
getScope()
Returns the scope of the region.
|
boolean |
getStatisticsEnabled()
Returns whether the statistics are enabled for this region and its
entries.
|
SubscriptionAttributes |
getSubscriptionAttributes()
Returns the
SubscriptionAttributes that configure
how this region behaves as a subscriber to remote caches. |
Class<V> |
getValueConstraint()
Returns the class that the values in this region are constrained to.
|
boolean |
isDiskSynchronous()
Returns true if configured synchronous disk writes.
|
boolean |
isLockGrantor()
Returns true if this member is configured to be lock grantor for the
region.
|
CacheLoader<K,V> getCacheLoader()
CacheWriter<K,V> getCacheWriter()
Class<K> getKeyConstraint()
Class
the keys must be an
instanceof
Class<V> getValueConstraint()
Class
the values must be an
instanceof
ExpirationAttributes getRegionTimeToLive()
timeToLive
expiration attributes for the region as a whole.
Default is 0 which indicates that no expiration of this type will happen.ExpirationAttributes getRegionIdleTimeout()
ExpirationAttributes getEntryTimeToLive()
timeToLive
expiration attributes for entries in this region.
Default is 0 which indicates that no expiration of this type is set.ExpirationAttributes getEntryIdleTimeout()
idleTimeout
expiration attributes for entries in this region.
Default is 0 which indicates that no expiration of this type is set.
Note that the XML element that corresponds to this method "entry-idle-time", does not include "out" in its name.CustomExpiry<K,V> getCustomEntryTimeToLive()
entryTimeToLive
CustomExpiry
, if any
for entries in this regionCustomExpiry<K,V> getCustomEntryIdleTimeout()
idleTimeout
CustomExpiry
, if any
for entries in this regionboolean getIgnoreJTA()
@Deprecated MirrorType getMirrorType()
getDataPolicy()
instead.MirrorType
DataPolicy getDataPolicy()
DataPolicy
Scope getScope()
Scope
EvictionAttributes getEvictionAttributes()
@Deprecated CacheListener<K,V> getCacheListener()
getCacheListeners()
insteadCacheListener
IllegalStateException
- if more than one cache listener exists on this attributesCacheListener<K,V>[] getCacheListeners()
CacheListener
s; an empty array if no listenersint getInitialCapacity()
HashMap
float getLoadFactor()
HashMap
boolean isLockGrantor()
Scope.GLOBAL
.
This attribute does not indicate whether or not this member is currently lock grantor. It only indicates that at the time of region creation, this member should attempt to become lock grantor. Default value is false.
AttributesFactory
,
Region.becomeLockGrantor()
boolean getMulticastEnabled()
AttributesFactory.setMulticastEnabled(boolean)
int getConcurrencyLevel()
AttributesFactory
@Deprecated boolean getPersistBackup()
DataPolicy.PERSISTENT_REPLICATE
instead@Deprecated DiskWriteAttributes getDiskWriteAttributes()
getDiskStoreName()
instead.DiskWriteAttributes
that configure how
the region is written to disk.@Deprecated File[] getDiskDirs()
DiskStore.getDiskDirs()
instead.boolean getIndexMaintenanceSynchronous()
IndexMaintenanceSynchronous
which
specifies whether the region indexes are updated synchronously when a
region is modified or asynchronously in a background thread.
Default value is true.PartitionAttributes getPartitionAttributes()
PartitionAttributes
that configure how
the region is partitioned.MembershipAttributes getMembershipAttributes()
MembershipAttributes
that configure required
roles for reliable access to the region.SubscriptionAttributes getSubscriptionAttributes()
SubscriptionAttributes
that configure
how this region behaves as a subscriber to remote caches.boolean getStatisticsEnabled()
@Deprecated boolean getEarlyAck()
@Deprecated boolean getEnableWAN()
boolean getEnableGateway()
String getGatewayHubId()
GatewayHub
to which events are
distributed.GatewayHub
to which events are
distributedboolean getPublisher()
@Deprecated boolean getEnableConflation()
getEnableSubscriptionConflation()
instead
#@Deprecated boolean getEnableBridgeConflation()
getEnableSubscriptionConflation()
insteadboolean getEnableSubscriptionConflation()
boolean getEnableAsyncConflation()
int[] getDiskDirSizes()
DiskStore.getDiskDirSizes()
instead.String getPoolName()
Pool
that this region
will use to communicate with servers, if any.
Returns null
if this region communicates with peers.Pool
this region will use for server communication; null
is returned if
the region communicates with peers.boolean getCloningEnabled()
String getDiskStoreName()
boolean isDiskSynchronous()
Set<String> getAsyncEventQueueIds()
boolean getConcurrencyChecksEnabled()
When this is enabled, concurrent updates will be conflated if they are applied out of order.
All members must set this attribute the same. Default is set to true.
Compressor getCompressor()
Copyright © 1997-2017 Pivotal Software, Inc. All rights reserved.