com.gemstone.gemfire.management
Class RegionAttributesData

java.lang.Object
  com.gemstone.gemfire.management.RegionAttributesData

public class RegionAttributesData
extends Object

Composite Data type for RegionAttributes

Since:

7.0

Constructor Summary

RegionAttributesData(String cacheLoaderClassName, String cacheWriteClassName, String keyConstraintClassName, String valueContstraintClassName, int regionTimeToLive, int regionIdleTimeout, int entryTimeToLive, int entryIdleTimeout, String customEntryTimeToLive, String customEntryIdleTimeout, boolean ignoreJTA, String dataPolicy, String scope, int initialCapacity, float loadFactor, boolean lockGrantor, boolean multicastEnabled, int concurrencyLevel, boolean indexMaintenanceSynchronous, boolean statisticsEnabled, boolean gatewayEnabled, String gatewayHubId, boolean publisher, boolean subsciptionConflationEnabled, boolean asyncConflationEnabled, String poolName, boolean cloningEnabled, String diskStoreName, String interestPolicy, boolean diskSynchronous, String cacheListeners)

Method Summary

String	getCacheListeners()
String	getCacheLoaderClassName() Returns the cache loader associated with this region.
String	getCacheWriteClassName() Returns the cache writer associated with this region.
int	getConcurrencyLevel() Returns the concurrencyLevel of the entries map.
String	getCustomEntryIdleTimeout() Gets the idleTimeout CustomExpiry, if any for entries in this region
String	getCustomEntryTimeToLive() Gets the entryTimeToLive CustomExpiry, if any for entries in this region
String	getDataPolicy() Returns the data policy for this region.
String	getDiskStoreName() Returns true if configured synchronous disk writes.
int	getEntryIdleTimeout() Gets the idleTimeout expiration attributes for entries in this region.
int	getEntryTimeToLive() Gets the timeToLive expiration attributes for entries in this region.
String	getGatewayHubId() Returns the id of the GatewayHub to which events are distributed.
int	getInitialCapacity() Returns the initial capacity of the entries map.
String	getInterestPolicy() this subscriber's interest policy
String	getKeyConstraintClassName() Returns the class that the keys in this region are constrained to.
float	getLoadFactor() Returns the load factor of the entries map.
String	getPoolName() Returns the name of the Pool that this region will use to communicate with servers, if any.
int	getRegionIdleTimeout() Gets the idleTimeout expiration attributes for the region as a whole.
int	getRegionTimeToLive() Gets the timeToLive expiration attributes for the region as a whole.
String	getScope() Returns the scope of the region.
String	getValueContstraintClassName() Returns the class that the values in this region are constrained to.
boolean	isAsyncConflationEnabled() Returns whether or not async conflation is enabled for sending messages to async peers.
boolean	isCloningEnabled() Returns whether or not cloning is enabled on region
boolean	isDiskSynchronous() Returns true if configured synchronous disk writes.
boolean	isGatewayEnabled() Returns whether or not a Gateway is enabled.
boolean	isIgnoreJTA() Gets the flag telling a region to ignore JTA transactions
boolean	isIndexMaintenanceSynchronous() Returns whether query service index maintenance should be done synchronously.
boolean	isLockGrantor() Returns true if this member is configured to be lock grantor for the region.
boolean	isMulticastEnabled() Returns true if multicast communications are enabled for this region.
boolean	isPublisher() Returns whether or not this region is a publisher.
boolean	isStatisticsEnabled() Returns whether the statistics are enabled for this region and its entries.
boolean	isSubsciptionConflationEnabled() Returns whether or not conflation is enabled for sending messages from a cache server to its clients.
void	setAsyncConflationEnabled(boolean asyncConflationEnabled)
void	setCacheListeners(String cacheListeners)
void	setCacheLoaderClassName(String cacheLoaderClassName)
void	setCacheWriteClassName(String cacheWriteClassName)
void	setCloningEnabled(boolean cloningEnabled)
void	setConcurrencyLevel(int concurrencyLevel)
void	setCustomEntryIdleTimeout(String customEntryIdleTimeout)
void	setCustomEntryTimeToLive(String customEntryTimeToLive)
void	setDataPolicy(String dataPolicy)
void	setDiskStoreName(String diskStoreName)
void	setDiskSynchronous(boolean diskSynchronous)
void	setEntryIdleTimeout(int entryIdleTimeout)
void	setEntryTimeToLive(int entryTimeToLive)
void	setGatewayEnabled(boolean gatewayEnabled)
void	setGatewayHubId(String gatewayHubId)
void	setIgnoreJTA(boolean ignoreJTA)
void	setIndexMaintenanceSynchronous(boolean indexMaintenanceSynchronous)
void	setInitialCapacity(int initialCapacity)
void	setInterestPolicy(String interestPolicy)
void	setKeyConstraintClassName(String keyConstraintClassName)
void	setLoadFactor(float loadFactor)
void	setLockGrantor(boolean lockGrantor)
void	setMulticastEnabled(boolean multicastEnabled)
void	setPoolName(String poolName)
void	setPublisher(boolean publisher)
void	setRegionIdleTimeout(int regionIdleTimeout)
void	setRegionTimeToLive(int regionTimeToLive)
void	setScope(String scope)
void	setStatisticsEnabled(boolean statisticsEnabled)
void	setSubsciptionConflationEnabled(boolean subsciptionConflationEnabled)
void	setValueContstraintClassName(String valueContstraintClassName)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegionAttributesData

@ConstructorProperties(value={"cacheLoaderClassName","cacheWriteClassName","keyConstraintClassName","valueContstraintClassName","regionTimeToLive","regionIdleTimeout","entryTimeToLive","entryIdleTimeout","customEntryTimeToLive","customEntryIdleTimeout","ignoreJTA","dataPolicy","scope","initialCapacity","loadFactor","lockGrantor","multicastEnabled","concurrencyLevel","indexMaintenanceSynchronous","statisticsEnabled","gatewayEnabled","gatewayHubId","publisher","subsciptionConflationEnabled","asyncConflationEnabled","poolName","cloningEnabled","diskStoreName","interestPolicy","diskSynchronous","cacheListeners"})
public RegionAttributesData(String cacheLoaderClassName,
                                                       String cacheWriteClassName,
                                                       String keyConstraintClassName,
                                                       String valueContstraintClassName,
                                                       int regionTimeToLive,
                                                       int regionIdleTimeout,
                                                       int entryTimeToLive,
                                                       int entryIdleTimeout,
                                                       String customEntryTimeToLive,
                                                       String customEntryIdleTimeout,
                                                       boolean ignoreJTA,
                                                       String dataPolicy,
                                                       String scope,
                                                       int initialCapacity,
                                                       float loadFactor,
                                                       boolean lockGrantor,
                                                       boolean multicastEnabled,
                                                       int concurrencyLevel,
                                                       boolean indexMaintenanceSynchronous,
                                                       boolean statisticsEnabled,
                                                       boolean gatewayEnabled,
                                                       String gatewayHubId,
                                                       boolean publisher,
                                                       boolean subsciptionConflationEnabled,
                                                       boolean asyncConflationEnabled,
                                                       String poolName,
                                                       boolean cloningEnabled,
                                                       String diskStoreName,
                                                       String interestPolicy,
                                                       boolean diskSynchronous,
                                                       String cacheListeners)

Method Detail

getCacheLoaderClassName

public String getCacheLoaderClassName()

Returns the cache loader associated with this region.

Returns:

the cache loader

getCacheWriteClassName

public String getCacheWriteClassName()

Returns the cache writer associated with this region.

Returns:

the cache writer

getKeyConstraintClassName

public String getKeyConstraintClassName()

Returns the class that the keys in this region are constrained to.

Returns:

the Class the keys must be an instanceof

getValueContstraintClassName

public String getValueContstraintClassName()

Returns the class that the values in this region are constrained to.

Returns:

the Class the values must be an instanceof

getRegionTimeToLive

public int getRegionTimeToLive()

Gets the timeToLive expiration attributes for the region as a whole.

Returns:

the timeToLive expiration attributes for this region

getRegionIdleTimeout

public int getRegionIdleTimeout()

Gets the idleTimeout expiration attributes for the region as a whole.

Returns:

the IdleTimeout expiration attributes for this region

getEntryTimeToLive

public int getEntryTimeToLive()

Gets the timeToLive expiration attributes for entries in this region.

Returns:

the timeToLive expiration attributes for entries in this region

getEntryIdleTimeout

public int getEntryIdleTimeout()

Gets the idleTimeout expiration attributes for entries in this region.

Returns:

the idleTimeout expiration attributes for entries in this region

getCustomEntryTimeToLive

public String getCustomEntryTimeToLive()

Gets the entryTimeToLive CustomExpiry, if any for entries in this region

Returns:

the entryTimeToLive CustomExpiry for entries in this region

getCustomEntryIdleTimeout

public String getCustomEntryIdleTimeout()

Gets the idleTimeout CustomExpiry, if any for entries in this region

Returns:

the idleTimeout CustomExpiry for entries in this region

isIgnoreJTA

public boolean isIgnoreJTA()

Gets the flag telling a region to ignore JTA transactions

Since:

5.0

getDataPolicy

public String getDataPolicy()

Returns the data policy for this region.

Returns:

the region's DataPolicy

Since:

5.0

getScope

public String getScope()

Returns the scope of the region.

Returns:

the region's Scope

getInitialCapacity

public int getInitialCapacity()

Returns the initial capacity of the entries map.

Returns:

the initial capacity of the entries map

See Also:

HashMap

getLoadFactor

public float getLoadFactor()

Returns the load factor of the entries map.

Returns:

the load factor of the entries map

See Also:

HashMap

isLockGrantor

public boolean isLockGrantor()

Returns true if this member is configured to be lock grantor for the region. Result will always be false if the scope is not 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.

Returns:

true if this member is configured to be lock grantor for the region

isMulticastEnabled

public boolean isMulticastEnabled()

Returns true if multicast communications are enabled for this region. Multicast must also be enabled in the DistributedSystem.

Returns:

true if this region is configured to allow use of multicast for distributed messaging

Since:

5.0

getConcurrencyLevel

public int getConcurrencyLevel()

Returns the concurrencyLevel of the entries map.

Returns:

the concurrencyLevel

isIndexMaintenanceSynchronous

public boolean isIndexMaintenanceSynchronous()

Returns whether query service index maintenance should be done synchronously. If false, then index maintenance is done asynchronously. The default is false.

Since:

4.0

isStatisticsEnabled

public boolean isStatisticsEnabled()

Returns whether the statistics are enabled for this region and its entries.

Returns:

true if statistics are enabled

isGatewayEnabled

public boolean isGatewayEnabled()

Returns whether or not a Gateway is enabled.

Returns:

True if a Gateway is enabled; false if no Gateway is enabled (default).

getGatewayHubId

public String getGatewayHubId()

Returns the id of the GatewayHub to which events are distributed.

Returns:

the id of the GatewayHub to which events are distributed

isPublisher

public boolean isPublisher()

Returns whether or not this region is a publisher. Publishers are regions on which distributed write operations are done.

Returns:

True if a publisher; false if not (default).

isSubsciptionConflationEnabled

public boolean isSubsciptionConflationEnabled()

Returns whether or not conflation is enabled for sending messages from a cache server to its clients. Note: This parameter is only valid for cache server to client communication. It has no effect in peer to peer communication.

Returns:

True if conflation is enabled; false conflation is not enabled (default).

isAsyncConflationEnabled

public boolean isAsyncConflationEnabled()

Returns whether or not async conflation is enabled for sending messages to async peers.

Returns:

True if async conflation is enabled; false async conflation is not enabled (default).

getPoolName

public String getPoolName()

Returns the name of the Pool that this region will use to communicate with servers, if any. Returns null if this region communicates with peers.

Returns:

the name of the client-server Pool this region will use for server communication; null is returned if the region communicates with peers.

isCloningEnabled

public boolean isCloningEnabled()

Returns whether or not cloning is enabled on region

Returns:

True if cloning is enabled (default); false cloning is not enabled.

getDiskStoreName

public String getDiskStoreName()

Returns true if configured synchronous disk writes.

Returns:

Returns true if writes to disk are synchronous and false otherwise

getInterestPolicy

public String getInterestPolicy()

this subscriber's interest policy

isDiskSynchronous

public boolean isDiskSynchronous()

Returns true if configured synchronous disk writes.

Returns:

Returns true if writes to disk are synchronous and false otherwise

getCacheListeners

public String getCacheListeners()

setCacheLoaderClassName

public void setCacheLoaderClassName(String cacheLoaderClassName)

setCacheWriteClassName

public void setCacheWriteClassName(String cacheWriteClassName)

setKeyConstraintClassName

public void setKeyConstraintClassName(String keyConstraintClassName)

setValueContstraintClassName

public void setValueContstraintClassName(String valueContstraintClassName)

setRegionTimeToLive

public void setRegionTimeToLive(int regionTimeToLive)

setRegionIdleTimeout

public void setRegionIdleTimeout(int regionIdleTimeout)

setEntryTimeToLive

public void setEntryTimeToLive(int entryTimeToLive)

setEntryIdleTimeout

public void setEntryIdleTimeout(int entryIdleTimeout)

setCustomEntryTimeToLive

public void setCustomEntryTimeToLive(String customEntryTimeToLive)

setCustomEntryIdleTimeout

public void setCustomEntryIdleTimeout(String customEntryIdleTimeout)

setIgnoreJTA

public void setIgnoreJTA(boolean ignoreJTA)

setDataPolicy

public void setDataPolicy(String dataPolicy)

setScope

public void setScope(String scope)

setInitialCapacity

public void setInitialCapacity(int initialCapacity)

setLoadFactor

public void setLoadFactor(float loadFactor)

setLockGrantor

public void setLockGrantor(boolean lockGrantor)

setMulticastEnabled

public void setMulticastEnabled(boolean multicastEnabled)

setConcurrencyLevel

public void setConcurrencyLevel(int concurrencyLevel)

setIndexMaintenanceSynchronous

public void setIndexMaintenanceSynchronous(boolean indexMaintenanceSynchronous)

setStatisticsEnabled

public void setStatisticsEnabled(boolean statisticsEnabled)

setGatewayEnabled

public void setGatewayEnabled(boolean gatewayEnabled)

setGatewayHubId

public void setGatewayHubId(String gatewayHubId)

setPublisher

public void setPublisher(boolean publisher)

setSubsciptionConflationEnabled

public void setSubsciptionConflationEnabled(boolean subsciptionConflationEnabled)

setAsyncConflationEnabled

public void setAsyncConflationEnabled(boolean asyncConflationEnabled)

setPoolName

public void setPoolName(String poolName)

setCloningEnabled

public void setCloningEnabled(boolean cloningEnabled)

setDiskStoreName

public void setDiskStoreName(String diskStoreName)

setInterestPolicy

public void setInterestPolicy(String interestPolicy)

setDiskSynchronous

public void setDiskSynchronous(boolean diskSynchronous)

setCacheListeners

public void setCacheListeners(String cacheListeners)