Uses of Package
com.gemstone.gemfire.cache

Packages that use com.gemstone.gemfire.cache

Package	Description
com.gemstone.gemfire	The base package of the GemFire Java product, featuring highly concurrent distributed caching with cache event delivery, OQL querying, and remote cache administration, built using a DistributedSystem which includes a DistributedLockService.
com.gemstone.gemfire.admin	Provides an API for administering various GemFire components such as a GemFire distributed system, and processes that host GemFire Caches.
com.gemstone.gemfire.cache	Provides an implementation of distributed object caching that can leverage GemFire's distribution capabilities.
com.gemstone.gemfire.cache.asyncqueue
com.gemstone.gemfire.cache.client	The com.gemstone.gemfire.cache.client package provides APIs used for client connectivity and caching.
com.gemstone.gemfire.cache.execute	The com.gemstone.gemfire.cache.execute package provides APIs used for function execution on gemfire system members.
com.gemstone.gemfire.cache.operations	Contains the OperationContext interface that encapsulates an operation and the data associated with it for both the pre-operation and post-operation cases.
com.gemstone.gemfire.cache.partition	Provides classes which operate on partitioned regions.
com.gemstone.gemfire.cache.query	GemFire's query service, an implementation of an OQL/SQL-style query processor with supporting indexes.
com.gemstone.gemfire.cache.server	The com.gemstone.gemfire.cache.server package provides APIs used for the server side of client/server caching.
com.gemstone.gemfire.cache.util	Provides utilities for use with the Caching API in the com.gemstone.gemfire.cache.util package.
com.gemstone.gemfire.cache.wan
com.gemstone.gemfire.distributed	Provides information about, access to, and common tools for GemFire distributed systems.
com.gemstone.gemfire.management	A set of APIs for retrieving information and statistics for GemFire components as well as controlling the startup, shutdown and runtime of those components.
com.gemstone.gemfire.management.cli	The Command Line Interface (CLI) package provides a set of APIs for writing commands that can be used to manage and monitor GemFire components.
com.gemstone.gemfire.pdx	The com.gemstone.gemfire.pdx package provides APIs used for object serialization.
com.gemstone.gemfire.security	Provides an API for plugging in authentication and authorization for members of a distributed system and clients.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire

Class and Description
CacheException A generic exception, which indicates a cache error has occurred.
CacheRuntimeException A generic runtime exception that indicates a cache error has occurred.
Region Manages subregions and cached data.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.admin

Class and Description
Cache Caches are obtained from the CacheFactory.create() method.
CacheRuntimeException A generic runtime exception that indicates a cache error has occurred.
DataPolicy Enumerated type for region data policy.
DiskWriteAttributes Deprecated. as of 6.5 use DiskStore instead
EvictionAttributes Attributes that describe how a Region's size is managed through an eviction controller.
ExpirationAction Enumerated type for expiration actions.
MembershipAttributes Configuration attributes for defining reliability requirements and behavior for a Region.
MirrorType Deprecated. as of GemFire 5.0, use DataPolicy instead.
Operation Enumerated type for an event operation.
PartitionAttributes Attributes that define the partitioned character of a Partitioned Region.
Region Manages subregions and cached data.
RegionAttributes Defines attributes for configuring a region.
Scope Enumerated type for region distribution scope.
SubscriptionAttributes Configuration attributes for defining subscriber requirements and behavior for a Region.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache

Class and Description
AttributesMutator Supports modification of certain region attributes after the region has been created.
Cache Caches are obtained from the CacheFactory.create() method.
CacheCallback User-defined objects that can be plugged into caching to receive callback notifications.
CacheEvent A region- or entry-related event affecting the cache.
CacheException A generic exception, which indicates a cache error has occurred.
CacheExistsException Thrown when attempting to create a Cache if one already exists.
CacheFactory Factory class used to create the singleton cache and connect to the GemFire singleton distributed system.
CacheListener A listener to handle region or entry related events.
CacheLoader Allows data from outside of the VM to be placed into a region.
CacheLoaderException Thrown from the CacheLoader.load(com.gemstone.gemfire.cache.LoaderHelper<K, V>) method indicating that an error occurred when a CacheLoader was attempting to load a value.
CacheRuntimeException A generic runtime exception that indicates a cache error has occurred.
CacheStatistics Defines common statistics information for both region and entries.
CacheTransactionManager The CacheTransactionManager interface allows applications to manage transactions on a per Cache basis.
CacheWriter A user-defined object defined in the RegionAttributes that is called synchronously before a region or entry in the cache is modified.
CacheWriterException An exception thrown by a CacheWriter method.
ClientSession Class ClientSession represents a client connection on the server.
CommitConflictException Thrown when a commit fails due to a write conflict.
CustomExpiry This is the contract that a custom-expiry element must honor.
DataPolicy Enumerated type for region data policy.
Declarable An object that can be described in a declarative caching XML file.
DiskStore Provides disk storage for one or more regions.
DiskStoreFactory Factory for creating instances of DiskStore.
DiskWriteAttributes Deprecated. as of 6.5 use DiskStore instead
DynamicRegionFactory DynamicRegionFactory provides a distributed region creation service.
DynamicRegionFactory.Config Configuration for dynamic region factory.
DynamicRegionListener DynamicRegionListener is an interface that can be implemented to handle dynamic region-related events.
EntryEvent Contains information about an event affecting an entry, including its identity and the the circumstances of the event.
EntryExistsException Thrown when attempting to create a Region.Entry that already exists in the Region.
EntryNotFoundException Thrown when an operation is invoked on Region for an entry that doesn't exist in the Region.
EntryOperation Gemfire Context passed to PartitionedResolver to compute the data location
EvictionAction The action that an EvictionAlgorithm takes.
EvictionAlgorithm The algorithm used to determine when to perform an EvictionAction
EvictionAttributes Attributes that describe how a Region's size is managed through an eviction controller.
EvictionAttributesMutator The EvictionAttributesMutator allows changes to be made to a EvictionAttributes.
ExpirationAction Enumerated type for expiration actions.
ExpirationAttributes Immutable parameter object for accessing and setting the attributes associated with timeToLive and idleTimeout.
FixedPartitionAttributes Composite date type used to distribute the attributes for a fixed partition.
GatewayException An exception thrown by a Gateway.
GemFireCache GemFireCache represents the singleton cache that must be created in order to use GemFire in a Java virtual machine.
InterestPolicy Enumerated type for region subscription interest policy.
InterestRegistrationEvent Interface InterestRegistrationEvent encapsulated interest event information like region and keys of interest.
InterestResultPolicy Class InterestResultPolicy is an enumerated type for a register interest result.
LoaderHelper Provides a set of APIs to help the implementation of the CacheLoader load method.
LossAction Specifies how access to the region is affected when one or more required roles are lost.
MembershipAttributes Configuration attributes for defining reliability requirements and behavior for a Region.
MirrorType Deprecated. as of GemFire 5.0, use DataPolicy instead.
Operation Enumerated type for an event operation.
OperationAbortedException Indicates that the operation that would have otherwise affected the cache has been aborted.
PartitionAttributes Attributes that define the partitioned character of a Partitioned Region.
PartitionAttributesFactory A factory that creates instances of PartitionAttributes which are used to create a partitioned Region.
PartitionResolver Implementers of interface PartitionResolver enable custom partitioning on the PartitionedRegion.
Region Manages subregions and cached data.
Region.Entry A key-value pair containing the cached data in a region.
RegionAttributes Defines attributes for configuring a region.
RegionDestroyedException Indicates that the region has been destroyed.
RegionEvent Contains information about an event affecting a region, including its identity and the circumstances of the event.
RegionExistsException Indicates that the requested region already exists when a region is being created.
RegionFactory RegionFactory is used to create regions in a cache.
RegionRoleException Indicates that a Region reliability failure has occurred.
RegionService A RegionService provides access to existing regions that exist in a GemFire cache.
RegionShortcut Each enum represents a predefined RegionAttributes in a Cache.
ResourceException A Generic exception to indicate that a resource exception has occurred.
ResumptionAction Specifies how the region is affected by resumption of reliability when one or more missing required roles return to the distributed membership.
RoleEvent Contains information about an event affecting a region reliability, including its identity and the circumstances of the event.
RoleException RoleException is the superclass of those exceptions that can be thrown to indicate a reliability failure on one or more regions that have been configured with required roles using MembershipAttributes.
Scope Enumerated type for region distribution scope.
SerializedCacheValue Class SerializedCacheValue represents a serialized cache value.
StatisticsDisabledException Thrown if statistics are requested when statistics are disabled on the region.
SubscriptionAttributes Configuration attributes for defining subscriber requirements and behavior for a Region.
TimeoutException Thrown if a netSearch times out without getting a response back from a cache, or when attempting to acquire a distributed lock.
TransactionEvent An event that describes the culmination of an entire transaction.
TransactionException This is the superclass for all Exceptions that may be thrown by a GemFire transaction.
TransactionId The TransactionId interface is a "marker" interface that represents a unique GemFire transaction.
TransactionListener A listener that can be implemented to handle transaction related events.
TransactionWriter A callback that is allowed to veto a transaction.
TransactionWriterException Exception thrown by implementors of TransactionWriter.beforeCommit(com.gemstone.gemfire.cache.TransactionEvent) to signal that the current transaction should be aborted.
VersionException An VersionException is an exception that indicates a client / server version mismatch exception has occurred.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache.asyncqueue

Class and Description
CacheCallback User-defined objects that can be plugged into caching to receive callback notifications.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache.client

Class and Description
CacheListener A listener to handle region or entry related events.
CacheRuntimeException A generic runtime exception that indicates a cache error has occurred.
CustomExpiry This is the contract that a custom-expiry element must honor.
EvictionAttributes Attributes that describe how a Region's size is managed through an eviction controller.
ExpirationAttributes Immutable parameter object for accessing and setting the attributes associated with timeToLive and idleTimeout.
GemFireCache GemFireCache represents the singleton cache that must be created in order to use GemFire in a Java virtual machine.
OperationAbortedException Indicates that the operation that would have otherwise affected the cache has been aborted.
Region Manages subregions and cached data.
RegionExistsException Indicates that the requested region already exists when a region is being created.
RegionService A RegionService provides access to existing regions that exist in a GemFire cache.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache.execute

Class and Description
Region Manages subregions and cached data.
RegionService A RegionService provides access to existing regions that exist in a GemFire cache.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache.operations

Class and Description
InterestResultPolicy Class InterestResultPolicy is an enumerated type for a register interest result.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache.partition

Class and Description
Cache Caches are obtained from the CacheFactory.create() method.
Region Manages subregions and cached data.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache.query

Class and Description
CacheCallback User-defined objects that can be plugged into caching to receive callback notifications.
CacheRuntimeException A generic runtime exception that indicates a cache error has occurred.
Operation Enumerated type for an event operation.
Region Manages subregions and cached data.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache.server

Class and Description
CacheCallback User-defined objects that can be plugged into caching to receive callback notifications.
ClientSession Class ClientSession represents a client connection on the server.
InterestRegistrationListener Interface InterestRegisterationListener provides the ability for applications to be notified of interest registration and unregistration events.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache.util

Class and Description
Cache Caches are obtained from the CacheFactory.create() method.
CacheCallback User-defined objects that can be plugged into caching to receive callback notifications.
CacheEvent A region- or entry-related event affecting the cache.
CacheListener A listener to handle region or entry related events.
CacheLoader Allows data from outside of the VM to be placed into a region.
CacheLoaderException Thrown from the CacheLoader.load(com.gemstone.gemfire.cache.LoaderHelper<K, V>) method indicating that an error occurred when a CacheLoader was attempting to load a value.
CacheRuntimeException A generic runtime exception that indicates a cache error has occurred.
CacheWriter A user-defined object defined in the RegionAttributes that is called synchronously before a region or entry in the cache is modified.
CacheWriterException An exception thrown by a CacheWriter method.
ClientSession Class ClientSession represents a client connection on the server.
Declarable An object that can be described in a declarative caching XML file.
EntryEvent Contains information about an event affecting an entry, including its identity and the the circumstances of the event.
GatewayException An exception thrown by a Gateway.
LoaderHelper Provides a set of APIs to help the implementation of the CacheLoader load method.
Operation Enumerated type for an event operation.
OperationAbortedException Indicates that the operation that would have otherwise affected the cache has been aborted.
Region Manages subregions and cached data.
RegionEvent Contains information about an event affecting a region, including its identity and the circumstances of the event.
RegionMembershipListener A listener that can be implemented to handle region membership events.
RegionRoleListener A listener that can be implemented to handle region reliability membership events.
RoleEvent Contains information about an event affecting a region reliability, including its identity and the circumstances of the event.
TransactionEvent An event that describes the culmination of an entire transaction.
TransactionListener A listener that can be implemented to handle transaction related events.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.cache.wan

Class and Description
CacheCallback User-defined objects that can be plugged into caching to receive callback notifications.
EntryEvent Contains information about an event affecting an entry, including its identity and the the circumstances of the event.
Operation Enumerated type for an event operation.
Region Manages subregions and cached data.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.distributed

Class and Description
CacheRuntimeException A generic runtime exception that indicates a cache error has occurred.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.management

Class and Description
Cache Caches are obtained from the CacheFactory.create() method.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.management.cli

Class and Description
Cache Caches are obtained from the CacheFactory.create() method.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.pdx

Class and Description
Declarable An object that can be described in a declarative caching XML file.
RegionService A RegionService provides access to existing regions that exist in a GemFire cache.

Classes in com.gemstone.gemfire.cache used by com.gemstone.gemfire.security

Class and Description
Cache Caches are obtained from the CacheFactory.create() method.
CacheCallback User-defined objects that can be plugged into caching to receive callback notifications.