GemFire 6.0.1

com.gemstone.gemfire.admin
Interface SystemMemberCache


public interface SystemMemberCache

Administrative interface that represent's the SystemMember's view of its Cache.

Since:
3.5

Method Summary
 SystemMemberBridgeServer addBridgeServer()
          Deprecated. as of 5.7 use addCacheServer() instead.
 SystemMemberCacheServer addCacheServer()
          Adds a new, unstarted cache server that will serve the contents of this cache to clients.
 SystemMemberRegion createRegion(String name, RegionAttributes attrs)
          Creates a root Region in this cache.
 SystemMemberRegion createVMRegion(String name, RegionAttributes attrs)
          Deprecated. as of GemFire 5.0, use createRegion(java.lang.String, com.gemstone.gemfire.cache.RegionAttributes) instead
 SystemMemberBridgeServer[] getBridgeServers()
          Deprecated. as of 5.7 use getCacheServers() instead.
 SystemMemberCacheServer[] getCacheServers()
          Returns the cache servers that run in this member's VM.
 int getId()
          Value that uniquely identifies an instance of a cache for a given member.
 int getLockLease()
          Gets the length, in seconds, of distributed lock leases obtained by this cache.
 int getLockTimeout()
          Gets the number of seconds a cache operation will wait to obtain a distributed lock lease.
 String getName()
          The name of the cache.
 SystemMemberRegion getRegion(String path)
          Return the existing region (or subregion) with the specified path that already exists in the cache.
 Set getRootRegionNames()
          Returns the names of all the root regions currently in this cache.
 int getSearchTimeout()
          Gets the number of seconds a cache get operation can spend searching for a value before it times out.
 Statistic[] getStatistics()
          Returns statistics related to this cache's performance.
 int getUpTime()
          Returns number of seconds since this member's cache has been created.
 boolean isClosed()
          Indicates if this cache has been closed.
 boolean isServer()
          Returns whether or not this cache acts as a server.
 void refresh()
          Updates the state of this cache instance.
 void setLockLease(int seconds)
          Sets the length, in seconds, of distributed lock leases obtained by this cache.
 void setLockTimeout(int seconds)
          Sets the number of seconds a cache operation may wait to obtain a distributed lock lease before timing out.
 void setSearchTimeout(int seconds)
          Sets the number of seconds a cache get operation can spend searching for a value.
 

Method Detail

getName

String getName()
The name of the cache.


getId

int getId()
Value that uniquely identifies an instance of a cache for a given member.


isClosed

boolean isClosed()
Indicates if this cache has been closed.

Returns:
true, if this cache is closed; false, otherwise

getLockTimeout

int getLockTimeout()
Gets the number of seconds a cache operation will wait to obtain a distributed lock lease.


setLockTimeout

void setLockTimeout(int seconds)
                    throws AdminException
Sets the number of seconds a cache operation may wait to obtain a distributed lock lease before timing out.

Throws:
AdminException - If a problem is encountered while setting the lock timeout
See Also:
Cache.setLockTimeout(int)

getLockLease

int getLockLease()
Gets the length, in seconds, of distributed lock leases obtained by this cache.


setLockLease

void setLockLease(int seconds)
                  throws AdminException
Sets the length, in seconds, of distributed lock leases obtained by this cache.

Throws:
AdminException - If a problem is encountered while setting the lock lease
See Also:
Cache.setLockLease(int)

getSearchTimeout

int getSearchTimeout()
Gets the number of seconds a cache get operation can spend searching for a value before it times out. The search includes any time spent loading the object. When the search times out it causes the get to fail by throwing an exception.


setSearchTimeout

void setSearchTimeout(int seconds)
                      throws AdminException
Sets the number of seconds a cache get operation can spend searching for a value.

Throws:
AdminException - If a problem is encountered while setting the search timeout
See Also:
Cache.setSearchTimeout(int)

getUpTime

int getUpTime()
Returns number of seconds since this member's cache has been created. Returns -1 if this member does not have a cache or its cache has been closed.


getRootRegionNames

Set getRootRegionNames()
Returns the names of all the root regions currently in this cache.


getStatistics

Statistic[] getStatistics()
Returns statistics related to this cache's performance.


getRegion

SystemMemberRegion getRegion(String path)
                             throws AdminException
Return the existing region (or subregion) with the specified path that already exists in the cache. Whether or not the path starts with a forward slash it is interpreted as a full path starting at a root.

Parameters:
path - the path to the region
Returns:
the Region or null if not found
Throws:
IllegalArgumentException - if path is null, the empty string, or "/"
AdminException

createVMRegion

@Deprecated
SystemMemberRegion createVMRegion(String name,
                                             RegionAttributes attrs)
                                  throws AdminException
Deprecated. as of GemFire 5.0, use createRegion(java.lang.String, com.gemstone.gemfire.cache.RegionAttributes) instead

Creates a VM root Region in this cache.

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

createRegion

SystemMemberRegion createRegion(String name,
                                RegionAttributes attrs)
                                throws AdminException
Creates a root Region in this cache.

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:
5.0

refresh

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


addBridgeServer

@Deprecated
SystemMemberBridgeServer addBridgeServer()
                                         throws AdminException
Deprecated. as of 5.7 use addCacheServer() instead.

Adds a new, unstarted bridge server that will serve the contents of this cache.

Throws:
AdminException
Since:
4.0
See Also:
Cache.addBridgeServer()

getBridgeServers

@Deprecated
SystemMemberBridgeServer[] getBridgeServers()
                                            throws AdminException
Deprecated. as of 5.7 use getCacheServers() instead.

Returns the bridge servers that run in this member's VM. Note that this list will not be updated until refresh() is called.

Throws:
AdminException
Since:
4.0
See Also:
Cache.getBridgeServers()

addCacheServer

SystemMemberCacheServer addCacheServer()
                                       throws AdminException
Adds a new, unstarted cache server that will serve the contents of this cache to clients.

Throws:
AdminException
Since:
5.7
See Also:
Cache.addCacheServer()

getCacheServers

SystemMemberCacheServer[] getCacheServers()
                                          throws AdminException
Returns the cache servers that run in this member's VM. Note that this list will not be updated until refresh() is called.

Throws:
AdminException
Since:
5.7
See Also:
Cache.getCacheServers()

isServer

boolean isServer()
                 throws AdminException
Returns whether or not this cache acts as a server. This method will always return true for the SystemMemberCache obtained from a CacheServer. Note that this value will not be updated until refresh() is invoked.

Throws:
AdminException
Since:
4.0

GemFire 6.0.1

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