management
package instead@Deprecated public interface SystemMemberCache
SystemMember
's view of its
Cache
.Modifier and Type | Method and Description |
---|---|
SystemMemberCacheServer |
addCacheServer()
Deprecated.
Adds a new, unstarted cache server that will serve the contents of this cache to clients.
|
SystemMemberRegion |
createRegion(String name,
RegionAttributes attrs)
Deprecated.
Creates a root
Region in this cache. |
SystemMemberRegion |
createVMRegion(String name,
RegionAttributes attrs)
Deprecated.
as of GemFire 5.0, use
createRegion(java.lang.String, org.apache.geode.cache.RegionAttributes) instead |
SystemMemberCacheServer[] |
getCacheServers()
Deprecated.
Returns the cache servers that run in this member's VM.
|
int |
getId()
Deprecated.
Value that uniquely identifies an instance of a cache for a given member.
|
int |
getLockLease()
Deprecated.
Gets the length, in seconds, of distributed lock leases obtained by this cache.
|
int |
getLockTimeout()
Deprecated.
Gets the number of seconds a cache operation will wait to obtain a distributed lock lease.
|
String |
getName()
Deprecated.
The name of the cache.
|
SystemMemberRegion |
getRegion(String path)
Deprecated.
Return the existing region (or subregion) with the specified path that already exists in the
cache.
|
Set |
getRootRegionNames()
Deprecated.
Returns the names of all the root regions currently in this cache.
|
int |
getSearchTimeout()
Deprecated.
Gets the number of seconds a cache
get
operation can spend searching for a value before it times out. |
Statistic[] |
getStatistics()
Deprecated.
Returns statistics related to this cache's performance.
|
int |
getUpTime()
Deprecated.
Returns number of seconds since this member's cache has been created.
|
boolean |
isClosed()
Deprecated.
Indicates if this cache has been closed.
|
boolean |
isServer()
Deprecated.
Returns whether or not this cache acts as a server.
|
void |
refresh()
Deprecated.
Updates the state of this cache instance.
|
void |
setLockLease(int seconds)
Deprecated.
Sets the length, in seconds, of distributed lock leases obtained by this cache.
|
void |
setLockTimeout(int seconds)
Deprecated.
Sets the number of seconds a cache operation may wait to obtain a distributed lock lease before
timing out.
|
void |
setSearchTimeout(int seconds)
Deprecated.
Sets the number of seconds a cache get operation can spend searching for a value.
|
String getName()
int getId()
boolean isClosed()
int getLockTimeout()
void setLockTimeout(int seconds) throws AdminException
seconds
- the number of seconds a cache operation may wait to obtain a distributed lock
lease before timing outAdminException
- If a problem is encountered while setting the lock timeoutCache.setLockTimeout(int)
int getLockLease()
void setLockLease(int seconds) throws AdminException
seconds
- the length, in seconds, of distributed lock leases obtained by this cacheAdminException
- If a problem is encountered while setting the lock leaseCache.setLockLease(int)
int getSearchTimeout()
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.void setSearchTimeout(int seconds) throws AdminException
seconds
- the number of seconds a cache get operation can spend searching for a valueAdminException
- If a problem is encountered while setting the search timeoutCache.setSearchTimeout(int)
int getUpTime()
-1
if this member does not have a cache or its cache has been closed.Set getRootRegionNames()
Statistic[] getStatistics()
SystemMemberRegion getRegion(String path) throws AdminException
path
- the path to the regionIllegalArgumentException
- if path is null, the empty string, or "/"AdminException
- If the region cannot be retrieved@Deprecated SystemMemberRegion createVMRegion(String name, RegionAttributes attrs) throws AdminException
createRegion(java.lang.String, org.apache.geode.cache.RegionAttributes)
insteadRegion
in this cache.name
- The name of the region to createattrs
- The attributes of the root regionRegion
AdminException
- If the region cannot be createdSystemMemberRegion createRegion(String name, RegionAttributes attrs) throws AdminException
Region
in this cache.name
- The name of the region to createattrs
- The attributes of the root regionRegion
AdminException
- If the region cannot be createdvoid refresh()
SystemMemberCacheServer addCacheServer() throws AdminException
AdminException
- if an exception is encounteredCache.addCacheServer()
SystemMemberCacheServer[] getCacheServers() throws AdminException
refresh()
is called.AdminException
- if an exception is encounteredCache.getCacheServers()
boolean isServer() throws AdminException
true
for the SystemMemberCache
obtained from a CacheServer
.
Note that this value will not be updated until refresh()
is invoked.AdminException
- if an exception is encountered