GemFire 6.5

com.gemstone.gemfire.admin
Interface SystemMemberRegion


public interface SystemMemberRegion

Administrative interface that represent's the SystemMember's view of one of its cache's Regions. If the region in the remote system member is closed or destroyed, the methods of SystemMemberRegion will throw RegionNotFoundException.

Since:
3.5

Method Summary
 SystemMemberRegion createSubregion(String name, RegionAttributes attrs)
          Creates a subregion of this region.
 String getCacheListener()
          Deprecated. as of 6.0 use getCacheListeners() instead
 String[] getCacheListeners()
          This method will return an empty array if there are no CacheListeners defined on the region.
 String getCacheLoader()
          Returns a description of any CacheLoader associated with this region.
 String getCacheWriter()
          Returns a description of any CacheWriter associated with this region.
 int getConcurrencyLevel()
          Returns the ConcurrencyLevel in this region's attributes.
 String getCustomEntryIdleTimeout()
          string describing the CustomExpiry for entry-idle-timeout
 String getCustomEntryTimeToLive()
          string describing the CustomExpiry for entry-time-to-live
 DataPolicy getDataPolicy()
          Returns the DataPolicy in this region's attributes.
 File[] getDiskDirs()
          Returns the directories to which the region's data are written.
 DiskWriteAttributes getDiskWriteAttributes()
          Returns the DiskWriteAttributes that configure how the region is written to disk.
 boolean getEarlyAck()
          Returns whether or not acks are sent after an update is processed.
 int getEntryCount()
          Returns the number of entries currently in this region.
 ExpirationAction getEntryIdleTimeoutAction()
          Returns the EntryIdleTimeout action in this region's attributes.
 int getEntryIdleTimeoutTimeLimit()
          Returns the EntryIdleTimeout time limit in this region's attributes.
 ExpirationAction getEntryTimeToLiveAction()
          Returns the EntryTimeToLive action in this region's attributes.
 int getEntryTimeToLiveTimeLimit()
          Returns the EntryTimeToLive time limit in this region's attributes.
 EvictionAttributes getEvictionAttributes()
          Returns the EvictionAttributes that configure how entries in the the region are evicted
 String getFullPath()
          Returns the full path name that identifies this region in its cache.
 long getHitCount()
          Returns the HitCount obtained from this region's statistics.
 float getHitRatio()
          Returns the HitRatio obtained from this region's statistics.
 int getInitialCapacity()
          Returns the InitialCapacity in this region's attributes.
 String getKeyConstraint()
          Returns the KeyConstraint in this region's attributes.
 long getLastAccessedTime()
          Returns the LastAccessedTime obtained from this region's statistics.
 long getLastModifiedTime()
          Returns the LastModifiedTime obtained from this region's statistics.
 float getLoadFactor()
          Returns the LoadFactor in this region's attributes.
 MembershipAttributes getMembershipAttributes()
          Returns the MembershipAttributes that configure required roles for reliable access to the region.
 MirrorType getMirrorType()
          Deprecated. as of 5.0, you should use getDataPolicy instead
 long getMissCount()
          Returns the MissCount obtained from this region's statistics.
 String getName()
          Returns the name that identifies this region in its cache.
 PartitionAttributes getPartitionAttributes()
          Returns the PartitionAttributes for the region.
 boolean getPersistBackup()
          Returns whether or not a persistent backup should be made of the region (as opposed to just writing the overflow data to disk).
 ExpirationAction getRegionIdleTimeoutAction()
          Returns the RegionIdleTimeout action in this region's attributes.
 int getRegionIdleTimeoutTimeLimit()
          Returns the RegionIdleTimeout time limit in this region's attributes.
 ExpirationAction getRegionTimeToLiveAction()
          Returns the RegionTimeToLive action in this region's attributes.
 int getRegionTimeToLiveTimeLimit()
          Returns the RegionTimeToLive time limit in this region's attributes.
 Scope getScope()
          /** Returns the Scope in this region's attributes.
 boolean getStatisticsEnabled()
          Returns the StatisticsEnabled in this region's attributes.
 int getSubregionCount()
          Returns the number of subregions currently in this region.
 Set getSubregionFullPaths()
          Returns the full path of each of the subregions of this region.
 Set getSubregionNames()
          Returns the names of all the subregions of this region.
 SubscriptionAttributes getSubscriptionAttributes()
          Returns the SubscriptionAttributes for the region.
 String getUserAttribute()
          Returns a description of any user attribute associated with this region.
 String getValueConstraint()
          Returns the ValueConstraint in this region's attributes.
 void refresh()
          Updates the state of this region instance.
 

Method Detail

getName

String getName()
Returns the name that identifies this region in its cache.

See Also:
Region.getName()

getFullPath

String getFullPath()
Returns the full path name that identifies this region in its cache.

See Also:
Region.getFullPath()

getSubregionNames

Set getSubregionNames()
Returns the names of all the subregions of this region.


getSubregionFullPaths

Set getSubregionFullPaths()
Returns the full path of each of the subregions of this region. These paths are suitable for use with SystemMemberCache.getRegion(java.lang.String).


getUserAttribute

String getUserAttribute()
Returns a description of any user attribute associated with this region. The description includes the classname of the user attribute object as well as its toString representation.


getCacheLoader

String getCacheLoader()
Returns a description of any CacheLoader associated with this region.


getCacheWriter

String getCacheWriter()
Returns a description of any CacheWriter associated with this region.


getEvictionAttributes

EvictionAttributes getEvictionAttributes()
Returns the EvictionAttributes that configure how entries in the the region are evicted


getCacheListener

@Deprecated
String getCacheListener()
Deprecated. as of 6.0 use getCacheListeners() instead

Returns a description of the CacheListener in this region's attributes. If there is more than 1 CacheListener defined for a region this method will return the description of the 1st CacheListener returned from getCacheListeners()


getCacheListeners

String[] getCacheListeners()
This method will return an empty array if there are no CacheListeners defined on the region. If there are one or more than 1 CacheListeners defined, this method will return an array which has the names of all the CacheListeners

Returns:
String[] the region's CacheListeners as a String array
Since:
6.0

getKeyConstraint

String getKeyConstraint()
Returns the KeyConstraint in this region's attributes.


getValueConstraint

String getValueConstraint()
Returns the ValueConstraint in this region's attributes.


getRegionTimeToLiveTimeLimit

int getRegionTimeToLiveTimeLimit()
Returns the RegionTimeToLive time limit in this region's attributes.


getRegionTimeToLiveAction

ExpirationAction getRegionTimeToLiveAction()
Returns the RegionTimeToLive action in this region's attributes.


getEntryTimeToLiveTimeLimit

int getEntryTimeToLiveTimeLimit()
Returns the EntryTimeToLive time limit in this region's attributes.


getEntryTimeToLiveAction

ExpirationAction getEntryTimeToLiveAction()
Returns the EntryTimeToLive action in this region's attributes.


getCustomEntryTimeToLive

String getCustomEntryTimeToLive()
string describing the CustomExpiry for entry-time-to-live

Returns:
the CustomExpiry for entry-time-to-live

getRegionIdleTimeoutTimeLimit

int getRegionIdleTimeoutTimeLimit()
Returns the RegionIdleTimeout time limit in this region's attributes.


getRegionIdleTimeoutAction

ExpirationAction getRegionIdleTimeoutAction()
Returns the RegionIdleTimeout action in this region's attributes.


getEntryIdleTimeoutTimeLimit

int getEntryIdleTimeoutTimeLimit()
Returns the EntryIdleTimeout time limit in this region's attributes.


getEntryIdleTimeoutAction

ExpirationAction getEntryIdleTimeoutAction()
Returns the EntryIdleTimeout action in this region's attributes.


getCustomEntryIdleTimeout

String getCustomEntryIdleTimeout()
string describing the CustomExpiry for entry-idle-timeout

Returns:
the CustomExpiry for entry-idle-timeout

getMirrorType

@Deprecated
MirrorType getMirrorType()
Deprecated. as of 5.0, you should use getDataPolicy instead

Returns the MirrorType in this region's attributes.


getDataPolicy

DataPolicy getDataPolicy()
Returns the DataPolicy in this region's attributes.


getScope

Scope getScope()
/** Returns the Scope in this region's attributes.


getInitialCapacity

int getInitialCapacity()
Returns the InitialCapacity in this region's attributes.


getLoadFactor

float getLoadFactor()
Returns the LoadFactor in this region's attributes.


getConcurrencyLevel

int getConcurrencyLevel()
Returns the ConcurrencyLevel in this region's attributes.


getStatisticsEnabled

boolean getStatisticsEnabled()
Returns the StatisticsEnabled in this region's attributes.


getPersistBackup

boolean getPersistBackup()
Returns whether or not a persistent backup should be made of the region (as opposed to just writing the overflow data to disk).


getDiskWriteAttributes

DiskWriteAttributes getDiskWriteAttributes()
Returns the DiskWriteAttributes that configure how the region is written to disk.


getDiskDirs

File[] getDiskDirs()
Returns the directories to which the region's data are written. If multiple directories are used, GemFire will attempt to distribute the data evenly amongst them.


getEntryCount

int getEntryCount()
Returns the number of entries currently in this region.


getSubregionCount

int getSubregionCount()
Returns the number of subregions currently in this region.


getLastModifiedTime

long getLastModifiedTime()
Returns the LastModifiedTime obtained from this region's statistics.


getLastAccessedTime

long getLastAccessedTime()
Returns the LastAccessedTime obtained from this region's statistics.


getHitCount

long getHitCount()
Returns the HitCount obtained from this region's statistics.


getMissCount

long getMissCount()
Returns the MissCount obtained from this region's statistics.


getHitRatio

float getHitRatio()
Returns the HitRatio obtained from this region's statistics.


getEarlyAck

boolean getEarlyAck()
Returns whether or not acks are sent after an update is processed.

Returns:
False if acks are sent after updates are processed; true if acks are sent before updates are processed.
Since:
4.1

refresh

void refresh()
Updates the state of this region instance. Note that once a cache instance is closed refresh will never change the state of its regions.


createSubregion

SystemMemberRegion createSubregion(String name,
                                   RegionAttributes attrs)
                                   throws AdminException
Creates a subregion of this region.

Parameters:
name - The name of the region to create
attrs - The attributes of the root region
Throws:
AdminException - If the region cannot be created
Since:
4.0

getMembershipAttributes

MembershipAttributes getMembershipAttributes()
Returns the MembershipAttributes that configure required roles for reliable access to the region.

Since:
5.0

getSubscriptionAttributes

SubscriptionAttributes getSubscriptionAttributes()
Returns the SubscriptionAttributes for the region.

Since:
5.0

getPartitionAttributes

PartitionAttributes getPartitionAttributes()
Returns the PartitionAttributes for the region.

Since:
5.7

GemFire 6.5

Copyright © 2002-2010 GemStone Systems, Inc. All Rights Reserved.