com.gemstone.gemfire.cache
Interface GemFireCache

All Superinterfaces:

RegionService

All Known Subinterfaces:

Cache, ClientCache

public interface GemFireCache
extends RegionService

GemFireCache represents the singleton cache that must be created in order to use GemFire in a Java virtual machine. Users must create either a Cache for a peer/server JVM or a ClientCache for a client JVM. Instances of this interface are created using one of the following methods:

• CacheFactory.create() creates a peer/server instance of Cache.
• ClientCacheFactory.create() creates a client instance of ClientCache.

Since:

6.5

Method Summary

DiskStoreFactory	createDiskStoreFactory() create diskstore factory
DiskStore	findDiskStore(String name) Returns the DiskStore by name or null if no disk store is found.
boolean	getCopyOnRead() Indicates whether the "copy on read" is enabled for this cache.
DistributedSystem	getDistributedSystem() Returns the distributed system used by this cache.
LogWriter	getLogger() Gets the logging object for GemFire.
String	getName() Returns the name of this cache.
<K,V> RegionAttributes<K,V>	getRegionAttributes(String id) Returns the RegionAttributes with the given id or null if no RegionAttributes with that id exists.
ResourceManager	getResourceManager() Returns the ResourceManager for managing this cache's resources.
LogWriter	getSecurityLogger() Gets the security logging object for GemFire.
<K,V> Map<String,RegionAttributes<K,V>>	listRegionAttributes() Returns an unmodifiable mapping of ids to region attributes.
void	loadCacheXml(InputStream is) Loads the cache configuration described in a declarative caching XML file into this cache.
void	setCopyOnRead(boolean copyOnRead) Sets the "copy on read" feature for cache read operations.
<K,V> void	setRegionAttributes(String id, RegionAttributes<K,V> attrs) Sets the id of the given RegionAttributes.

Methods inherited from interface com.gemstone.gemfire.cache.RegionService

close, getCancelCriterion, getQueryService, getRegion, isClosed, rootRegions

Method Detail

getName

String getName()

Returns the name of this cache. This method does not throw CacheClosedException if the cache is closed.

Returns:

the String name of this cache

getDistributedSystem

DistributedSystem getDistributedSystem()

Returns the distributed system used by this cache. This method does not throw CacheClosedException if the cache is closed.

getResourceManager

ResourceManager getResourceManager()

Returns the ResourceManager for managing this cache's resources.

Returns:

ResourceManager for managing this cache's resources

Since:

6.0

setCopyOnRead

void setCopyOnRead(boolean copyOnRead)

Sets the "copy on read" feature for cache read operations.

Since:

4.0

getCopyOnRead

boolean getCopyOnRead()

Indicates whether the "copy on read" is enabled for this cache.

Returns:

true if "copy on read" is enabled, false otherwise.

Since:

4.0

getRegionAttributes

<K,V> RegionAttributes<K,V> getRegionAttributes(String id)

Returns the RegionAttributes with the given id or null if no RegionAttributes with that id exists.

Since:

4.1

See Also:

setRegionAttributes(java.lang.String, com.gemstone.gemfire.cache.RegionAttributes)

setRegionAttributes

<K,V> void setRegionAttributes(String id,
                               RegionAttributes<K,V> attrs)

Sets the id of the given RegionAttributes. If a region attributes named name already exists, the mapping will be overwritten with attrs. However, changing the mapping will not effect existing regions.

Parameters:

id - The id of the region attributes

attrs - The attributes to associate with id. If attrs is null, any existing RegionAttributes associated with id will be removed.

Since:

4.1

See Also:

getRegionAttributes(java.lang.String)

listRegionAttributes

<K,V> Map<String,RegionAttributes<K,V>> listRegionAttributes()

Returns an unmodifiable mapping of ids to region attributes. The keys of the map are Strings and the values of the map are RegionAttributes.

Since:

4.1

loadCacheXml

void loadCacheXml(InputStream is)
                  throws TimeoutException,
                         CacheWriterException,
                         GatewayException,
                         RegionExistsException

Loads the cache configuration described in a declarative caching XML file into this cache. If the XML describes a region that already exists, any mutable region attributes, indexes, and region entries that are defined in the XML are updated/added.

Because this method may perform a put on a Region, it declares that it throws a TimeoutException, CacheWriterException, GatewayException, or RegionExistsException.

Throws:

CacheXmlException - If the XML read from is does not conform to the dtd or if an IOException occurs while reading the XML.

TimeoutException

CacheWriterException

GatewayException

RegionExistsException

Since:

4.1

getLogger

LogWriter getLogger()

Gets the logging object for GemFire. This method does not throw CacheClosedException if the cache is closed.

Returns:

the logging object

getSecurityLogger

LogWriter getSecurityLogger()

Gets the security logging object for GemFire. This method does not throw CacheClosedException if the cache is closed.

Returns:

the security logging object

findDiskStore

DiskStore findDiskStore(String name)

Returns the DiskStore by name or null if no disk store is found.

Parameters:

name - the name of the disk store to find. If null then the default disk store, if it exists, is returned.

Since:

6.5

createDiskStoreFactory

DiskStoreFactory createDiskStoreFactory()

create diskstore factory

Since:

6.5