Package org.apache.geode.cache

Interface Summary

Interface	Description
AttributesMutator<K,V>	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<K,V>	A region- or entry-related event affecting the cache.
CacheListener<K,V>	A listener to handle region or entry related events.
CacheLoader<K,V>	Allows data from outside of the VM to be placed into a region.
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<K,V>	A user-defined object defined in the RegionAttributes that is called synchronously before a region or entry in the cache is modified.
ClientSession	Class ClientSession represents a client connection on the server.
CustomExpiry<K,V>	This is the contract that a custom-expiry element must honor.
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
DynamicRegionListener	DynamicRegionListener is an interface that can be implemented to handle dynamic region-related events.
EntryEvent<K,V>	Contains information about an event affecting an entry, including its identity and the the circumstances of the event.
EntryOperation<K,V>	Gemfire Context passed to PartitionResolver to compute the data location
EvictionAttributesMutator	The EvictionAttributesMutator allows changes to be made to a EvictionAttributes.
FixedPartitionResolver<K,V>	Implementers of interface FixedPartitionResolver helps to achieve explicit mapping of a "user defined" partition to a data member node.
GemFireCache	GemFireCache represents the singleton cache that must be created in order to use GemFire in a Java virtual machine.
InterestRegistrationEvent	Interface InterestRegistrationEvent encapsulated interest event information like region and keys of interest.
InterestRegistrationListener	Interface InterestRegisterationListener provides the ability for applications to be notified of interest registration and unregistration events.
LoaderHelper<K,V>	Provides a set of APIs to help the implementation of the CacheLoader load method.
PartitionAttributes<K,V>	Attributes that define the partitioned character of a Partitioned Region.
PartitionResolver<K,V>	Implementers of interface PartitionResolver enable custom standard partitioning on the PartitionedRegion. See FixedPartitionResolver to enable custom fixed partitioning.
Region<K,V>	Manages subregions and cached data.
Region.Entry<K,V>	A key-value pair containing the cached data in a region.
RegionAttributes<K,V>	Defines attributes for configuring a region.
RegionEvent<K,V>	Contains information about an event affecting a region, including its identity and the circumstances of the event.
RegionMembershipListener<K,V>	A listener that can be implemented to handle region membership events.
RegionRoleListener<K,V>	Deprecated this feature is scheduled to be removed
RegionService	A RegionService provides access to existing regions that exist in a GemFire cache.
RoleEvent<K,V>	Deprecated this feature is scheduled to be removed
SerializedCacheValue<V>	Class SerializedCacheValue represents a serialized cache value.
TransactionEvent	An event that describes the culmination of an entire 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.

Class Summary

Class	Description
AttributesFactory<K,V>	Deprecated as of 6.5 use Cache.createRegionFactory(RegionShortcut) or ClientCache.createClientRegionFactory(ClientRegionShortcut) instead.
CacheFactory	Factory class used to create the singleton cache and connect to the GemFire singleton distributed system.
DataPolicy	Enumerated type for region data policy.
DiskWriteAttributesFactory	Deprecated as of 6.5 use DiskStoreFactory instead
DynamicRegionFactory	Deprecated This class is deprecated.
DynamicRegionFactory.Config	Configuration for dynamic region factory.
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.
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.
InterestPolicy	Enumerated type for region subscription interest policy.
InterestResultPolicy	Class InterestResultPolicy is an enumerated type for a register interest result.
LossAction	Deprecated this feature is scheduled to be removed
MembershipAttributes	Deprecated this feature is scheduled to be removed
MirrorType	Deprecated as of GemFire 5.0, use DataPolicy instead.
Operation	Enumerated type for an event operation.
PartitionAttributesFactory<K,V>	A factory that creates instances of PartitionAttributes which are used to create a partitioned Region.
RegionFactory<K,V>	RegionFactory is used to create regions in a cache.
RequiredRoles	Deprecated this feature is scheduled to be removed
ResumptionAction	Deprecated this API is scheduled to be removed
Scope	Enumerated type for region distribution scope.
SubscriptionAttributes	Configuration attributes for defining subscriber requirements and behavior for a Region.

Enum Summary

Enum	Description
RegionShortcut	Each enum represents a predefined RegionAttributes in a Cache.

Exception Summary

Exception	Description
CacheClosedException	Indicates that the caching system has been closed.
CacheException	A generic exception, which indicates a cache error has occurred.
CacheExistsException	Thrown when attempting to create a Cache if one already exists.
CacheLoaderException	Thrown from the CacheLoader.load(org.apache.geode.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.
CacheWriterException	An exception thrown by a CacheWriter method.
CacheXmlException	Thrown when a problem is encountered while parsing a declarative caching XML file.
CommitConflictException	Thrown when a commit fails due to a write conflict.
CommitDistributionException	Indicates that an attempt to notify required participants of a transaction involving one or more regions that are configured with MembershipAttributes may have failed.
CommitIncompleteException	Thrown when a commit fails to complete due to errors
DiskAccessException	Indicates that an IOException during a disk region operation.
DuplicatePrimaryPartitionException	This exception is thrown when two nodes are defined with same primary partitions
EntryDestroyedException	Indicates that a method was invoked on an entry that has been destroyed.
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.
FailedSynchronizationException	Thrown when a cache transaction fails to register with the UserTransaction (aka JTA transaction), most likely the cause of the UserTransaction's javax.transaction.Status#STATUS_MARKED_ROLLBACK status.
GatewayConfigurationException	An exception indicating that a gateway configuration will not work with the remote side of the gateway's configuration.
GatewayException	An exception thrown by a Gateway.
IncompatibleVersionException	An IncompatibleVersionException that the client version was not compatible with the server version.
LowMemoryException	Indicates a low memory condition either on the local or a remote Cache.
NoQueueServersAvailableException	Indicates that this client cannot contact any queue servers and therefore cannot perform operations that require a queue, such as registering interest.
NoSubscriptionServersAvailableException	Indicates that this client cannot contact any servers and therefore cannot perform operations that require subscriptions, such as registering interest.
OperationAbortedException	Indicates that the operation that would have otherwise affected the cache has been aborted.
PartitionedRegionDistributionException	Indicates a failure to perform a distributed operation on a Partitioned Region after multiple attempts.
PartitionedRegionStorageException	Description of the conditions under which this exception is thrown
RegionAccessException	Deprecated the MembershipAttributes API is scheduled to be removed
RegionDestroyedException	Indicates that the region has been destroyed.
RegionDistributionException	Deprecated the MembershipAttributes API is scheduled to be removed
RegionExistsException	Indicates that the requested region already exists when a region is being created.
RegionReinitializedException	Indicates that the region has been reinitialized.
RegionRoleException	Deprecated this feature is scheduled to be removed
ResourceException	A Generic exception to indicate that a resource exception has occurred.
RoleException	Deprecated this feature is scheduled to be removed
StatisticsDisabledException	Thrown if statistics are requested when statistics are disabled on the region.
SynchronizationCommitConflictException	Thrown when a commit operation of a JTA enlisted cache transaction fails
TimeoutException	Thrown if a netSearch times out without getting a response back from a cache, or when attempting to acquire a distributed lock.
TransactionDataNodeHasDepartedException	Thrown when the transactional data host has shutdown or no longer has the data being modified by the transaction.
TransactionDataNotColocatedException	Indicates that an attempt was made to transactionally modify multiple keys that are not colocated on the same data host.
TransactionDataRebalancedException	Thrown when a RebalanceOperation occurs concurrently with a transaction.
TransactionException	This is the superclass for all Exceptions that may be thrown by a GemFire transaction.
TransactionInDoubtException	This Exception is thrown in presence of node failures, when GemFire cannot know with certainty about the outcome of the transaction.
TransactionWriterException	Exception thrown by implementors of TransactionWriter.beforeCommit(org.apache.geode.cache.TransactionEvent) to signal that the current transaction should be aborted.
UnsupportedOperationInTransactionException	Indicates that an attempt was mode to invoke an operation that is not allowed in a transaction.
UnsupportedVersionException	An UnsupportedVersionException indicates an unsupported version.
VersionException	An VersionException is an exception that indicates a client / server version mismatch exception has occurred.