GemFire 7.0.1

com.gemstone.gemfire.management
Class RegionAttributesData

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

public class RegionAttributesData
extends Object

Composite data type used to distribute attributes for a Region.

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 subscriptionConflationEnabled, boolean asyncConflationEnabled, String poolName, boolean cloningEnabled, String diskStoreName, String interestPolicy, boolean diskSynchronous, String cacheListeners)
           
 
Method Summary
 String getCacheListeners()
          Returns a list of CacheListeners for the Region.
 String getCacheLoaderClassName()
          Returns the Class of cache loader associated with this region.
 String getCacheWriteClassName()
          Returns the Class of the cache writer associated with this region.
 int getConcurrencyLevel()
          Returns the concurrency level for entries in the Region.
 String getCustomEntryIdleTimeout()
          Returns the custom idle timeout expiration for entries in the Region, if one exists.
 String getCustomEntryTimeToLive()
          Returns the custom time to live expiration for entries in the Region, if one exists.
 String getDataPolicy()
          Returns the data policy.
 String getDiskStoreName()
          Returns the name of the DiskStore associated with the Region.
 int getEntryIdleTimeout()
          Returns the idle timeout expiration for entries in the Region.
 int getEntryTimeToLive()
          Returns the time to live expiration for entries in the Region.
 String getGatewayHubId()
          Returns the ID of the GatewayHub to which events are distributed.
 int getInitialCapacity()
          Returns the initial capacity of entries in the Region.
 String getInterestPolicy()
          Returns the subscriber's interest policy.
 String getKeyConstraintClassName()
          Returns the Class that the keys in this region are constrained to (must be an instance of).
 float getLoadFactor()
          Returns the load factor of entries in the Region.
 String getPoolName()
          Returns the name of the Pool that this Region will use to communicate with servers, if any.
 int getRegionIdleTimeout()
          Returns the idle timeout expiration for the Region.
 int getRegionTimeToLive()
          Returns the time to live expiration for the Region.
 String getScope()
          Returns the scope.
 String getValueContstraintClassName()
          Returns the Class that the values in this region are constrained to (must be an instance of).
 boolean isAsyncConflationEnabled()
          Returns whether asynchronous conflation is enabled for sending messages to peers.
 boolean isCloningEnabled()
          Returns whether cloning is enabled.
 boolean isDiskSynchronous()
          Returns whether disk writes are synchronous.
 boolean isGatewayEnabled()
          Return whether a Gateway is enabled.
 boolean isIgnoreJTA()
          Returns whether JTA transactions are being ignored.
 boolean isIndexMaintenanceSynchronous()
          Returns whether query service index maintenance will be done synchronously.
 boolean isLockGrantor()
          Returns whether this member is configured to become the lock granter when the Region is created.
 boolean isMulticastEnabled()
          Returns whether multicast communication is enabled for the Region.
 boolean isPublisher()
          Deprecated. as of 6.5
 boolean isStatisticsEnabled()
          Returns whether statistic collection is enabled for the Region and its entries.
 boolean isSubsciptionConflationEnabled()
          Returns whether conflation is enabled for sending messages from a cache server to its clients.
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, 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 subscriptionConflationEnabled,
                                                       boolean asyncConflationEnabled,
                                                       String poolName,
                                                       boolean cloningEnabled,
                                                       String diskStoreName,
                                                       String interestPolicy,
                                                       boolean diskSynchronous,
                                                       String cacheListeners)
Method Detail

getCacheLoaderClassName

public String getCacheLoaderClassName()
Returns the Class of cache loader associated with this region.


getCacheWriteClassName

public String getCacheWriteClassName()
Returns the Class of the cache writer associated with this region.


getKeyConstraintClassName

public String getKeyConstraintClassName()
Returns the Class that the keys in this region are constrained to (must be an instance of).


getValueContstraintClassName

public String getValueContstraintClassName()
Returns the Class that the values in this region are constrained to (must be an instance of).


getRegionTimeToLive

public int getRegionTimeToLive()
Returns the time to live expiration for the Region.


getRegionIdleTimeout

public int getRegionIdleTimeout()
Returns the idle timeout expiration for the Region.


getEntryTimeToLive

public int getEntryTimeToLive()
Returns the time to live expiration for entries in the Region.


getEntryIdleTimeout

public int getEntryIdleTimeout()
Returns the idle timeout expiration for entries in the Region.


getCustomEntryTimeToLive

public String getCustomEntryTimeToLive()
Returns the custom time to live expiration for entries in the Region, if one exists.


getCustomEntryIdleTimeout

public String getCustomEntryIdleTimeout()
Returns the custom idle timeout expiration for entries in the Region, if one exists.


isIgnoreJTA

public boolean isIgnoreJTA()
Returns whether JTA transactions are being ignored.

Returns:
True if JTA transactions are being ignored, false otherwise.

getDataPolicy

public String getDataPolicy()
Returns the data policy.


getScope

public String getScope()
Returns the scope.


getInitialCapacity

public int getInitialCapacity()
Returns the initial capacity of entries in the Region.


getLoadFactor

public float getLoadFactor()
Returns the load factor of entries in the Region.


isLockGrantor

public boolean isLockGrantor()
Returns whether this member is configured to become the lock granter when the Region is created. It does not indicate whether this member is currently the lock granter for the Region.

Returns:
True if this member is configured to start the Region as the lock granter, false otherwise. Always returns false if the scope of the Region is not Scope.GLOBAL

isMulticastEnabled

public boolean isMulticastEnabled()
Returns whether multicast communication is enabled for the Region.

Returns:
True if multicast communication is enabled, false otherwise.

getConcurrencyLevel

public int getConcurrencyLevel()
Returns the concurrency level for entries in the Region.


isIndexMaintenanceSynchronous

public boolean isIndexMaintenanceSynchronous()
Returns whether query service index maintenance will be done synchronously.

Returns:
True if query service index maintenance will be done synchronously or false if it will be done asynchronously.

isStatisticsEnabled

public boolean isStatisticsEnabled()
Returns whether statistic collection is enabled for the Region and its entries.

Returns:
True if statistic collection is enabled, false otherwise.

isGatewayEnabled

public boolean isGatewayEnabled()
Return whether a Gateway is enabled.

Returns:
True if a Gateway is enabled, false otherwise.

getGatewayHubId

public String getGatewayHubId()
Returns the ID of the GatewayHub to which events are distributed.


isSubsciptionConflationEnabled

public boolean isSubsciptionConflationEnabled()
Returns whether conflation is enabled for sending messages from a cache server to its clients. This value only has meaning for client to server communication and is not relevant for peer to peer communication.

Returns:
True if conflation is enabled, false otherwise.

isAsyncConflationEnabled

public boolean isAsyncConflationEnabled()
Returns whether asynchronous conflation is enabled for sending messages to peers.

Returns:
True if asynchronous conflation is enabled, false otherwise.

getPoolName

public String getPoolName()
Returns the name of the Pool that this Region will use to communicate with servers, if any.

Returns:
The name of the Pool used to communicate with servers or null if the host member communicates with peers.

isCloningEnabled

public boolean isCloningEnabled()
Returns whether cloning is enabled.

Returns:
True if cloning is enabled, false otherwise.

getDiskStoreName

public String getDiskStoreName()
Returns the name of the DiskStore associated with the Region.


getInterestPolicy

public String getInterestPolicy()
Returns the subscriber's interest policy.


isDiskSynchronous

public boolean isDiskSynchronous()
Returns whether disk writes are synchronous.

Returns:
True if disk writes are synchronous, false otherwise.

getCacheListeners

public String getCacheListeners()
Returns a list of CacheListeners for the Region. An empty array if no listener is specified.


isPublisher

public boolean isPublisher()
Deprecated. as of 6.5

Returns whether the Region is a publisher. Publishers are Regions on which distributed write operations are done.

Returns:
True if the Region is a publisher, false otherwise.

toString

public String toString()
Overrides:
toString in class Object

GemFire 7.0.1

Copyright © 1997-2013 VMware, Inc. All rights reserved.