Package org.apache.geode.cache

Interface Region<K,V>

All Superinterfaces:
ConcurrentMap<K,V>, Map<K,V>
public interface Region<K,V> extends ConcurrentMap<K,V>
Manages subregions and cached data. Each region can contain multiple subregions and entries for data. Regions provide a hierarchical name space within the cache. Also, a region can be used to group cached objects for management purposes.

The Region interface basically contains two set of APIs: Region management APIs; and (potentially) distributed operations on entries. Non-distributed operations on entries are provided by the inner interface, Region.Entry.

Each Cache defines a single top region called the root region. User applications can use the root region to create subregions for isolated name space and object grouping.

A region's name can be any String except that it should not contain the region name separator, a forward slash (/). Regions can be referenced by a relative path name from any region higher in the hierarchy in getSubregion(java.lang.String). You can get the relative path from the root region with getFullPath(). The name separator is used to concatenate all the region names together from the root, starting with the root's subregions.

Relative region names can provide a convenient method to locate a subregion directly from some higher region. For example, a region structure is as follows: a region named 3rd_level_region has parent region 2nd_level_region; region 2nd_level_region in turn has parent region 1st_level_region; and region 1st_level_region is a child of the root region. Then,the user can get the region 3rd_level_region from the root region by issuing: 

  
  region3 = root.getSubregion("1st_level_region/2nd_level_region/3rd_level_region");
or the user can get the region 3rd_level_region from region 1st_level_region by issuing 
  
  region3 = region1.getSubregion("2nd_level_region/3rd_level_region");

Region entries are identified by their key. Any Object can be used as a key as long as the key Object is region-wide unique and implements both the equals and hashCode methods. For regions with distributed scope, the key must also be Serializable.

Regions and their entries can be locked. The Lock obtained from getRegionDistributedLock() is a distributed lock on the entire Region, and the Lock obtained from getDistributedLock(java.lang.Object) is a distributed lock on the individual entry.

If the scope is Scope.GLOBAL, the methods that modify, destroy, or invalidate the entries in this region will also get a distributed lock. See the documentations for getDistributedLock(java.lang.Object) and getRegionDistributedLock() for details on the implicit locking that occurs for regions with Scope.GLOBAL.

Unless otherwise specified, all of these methods throw a CacheClosedException if the Cache is closed at the time of invocation, or a RegionDestroyedException if this region has been destroyed. Serializability Requirements for arguments: Several methods in the region API take parameters such as key, value and callback parameters.All of these parameters are typed as objects. For distributed regions, keys, values and callback parameters have to be serializable Failure to meet these serialization requirements causes API methods to throw IllegalArgumentException.

Implementation of the java.util.concurrent.ConcurrentMap interface was added in version 6.5. These methods give various levels of concurrency guarantees based on the scope and data policy of the region. They are implemented in the peer cache and client/server cache but are disallowed in peer Regions having NORMAL or EMPTY data policies.

The semantics of the ConcurrentMap methods on a Partitioned Region are consistent with those expected on a ConcurrentMap. In particular multiple writers in different JVMs of the same key in the same Partitioned Region will be done atomically.

The same is true for a region with GLOBAL scope. All operations will be done atomically since a distributed lock will be held while the operation is done.

The same is true for a region with LOCAL scope. All ops will be done atomically since the underlying map is a concurrent hash map and no distribution is involved.

For peer REPLICATE and PRELOADED regions atomicity is limited to threads in the JVM the operation starts in. There is no coordination with other members of the system unless the operation is performed in a transaction.

For client server regions the atomicity is determined by the scope and data policy of the server region as described above. The operation is actually performed on the server as described above. Clients will always send the ConcurrentMap operation to the server and the result returned by the ConcurrentMap method in client will reflect what was done on the server. Same goes for any CacheListener called on the client. Any local state on the client will be updated to be consistent with the state change made on the server.

Since:
GemFire 2.0
See Also:

  • Field Details

    • SEPARATOR_CHAR

      static final char SEPARATOR_CHAR
      The region name separator character.
      See Also:

    • SEPARATOR

      static final String SEPARATOR
      The region name separator character, represented as a string for convenience.
      See Also:

  • Method Details

    • getName

      String getName()
      Returns the name of this region. A region's name can be any non-empty String providing it does not contain the name separator, a forward slash (/). If this is the root region, returns "root".

      Does not throw a CacheClosedException or a RegionDestroyedException.

      Returns:
      the name of this region

    • getFullPath

      String getFullPath()
      Returns the full path of this region starting with a forward slash, followed by the root, including every subregion in the path to this region. The path separator is a forward slash.

      Does not throw a CacheClosedException or a RegionDestroyedException.

      Returns:
      the full path of this region

    • getParentRegion

      <PK, PV> Region<PK,PV> getParentRegion()
      Gets the parent region of this region. If this region is a root region (i.e. has no parents), returns null.

      Does not throw a CacheClosedException or a RegionDestroyedException.

      Type Parameters:
      PK - the type of keys in the parent region
      PV - the type of values in the parent region
      Returns:
      the parent region which contains this region; null, if this region is the root region
      See Also:

    • getAttributes

      RegionAttributes<K,V> getAttributes()
      Returns the RegionAttributes for this region. This object is backed by this region, so if attributes are modified using this region's AttributesMutator, this RegionAttributes object will immediately reflect the change.

      Does not throw a CacheClosedException or a RegionDestroyedException.

      Returns:
      the RegionAttributes of this region
      See Also:

    • getAttributesMutator

      AttributesMutator<K,V> getAttributesMutator()
      Returns a mutator object used for modifying this region's attributes after region creation. Note that some attributes are immutable after region creation.
      Returns:
      the AttributesMutator object
      See Also:

    • getStatistics

      CacheStatistics getStatistics() throws StatisticsDisabledException
      Returns the CacheStatistics for this region. If the region is a partitioned proxy region then the values for all the statistics will be 0.
      Returns:
      the CacheStatistics of this region
      Throws:
      StatisticsDisabledException - if statistics have been disabled for this region

    • invalidateRegion

      void invalidateRegion() throws TimeoutException
      Invalidates this region. Invalidation cascades to all entries and subregions. After the invalidateRegion, this region and the entries in it still exist. To remove all the entries and this region, destroyRegion should be used. The region invalidate will be distributed to other caches if the scope is not Scope.LOCAL.

      Does not update any CacheStatistics.

      Throws:
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      See Also:

    • invalidateRegion

      void invalidateRegion(Object aCallbackArgument) throws TimeoutException
      Invalidates this region. The invalidation will cascade to all the subregions and cached entries. After the invalidateRegion, the region and the entries in it still exist. In order to remove all the entries and the region, destroyRegion should be used. The region invalidate will be distributed to other caches if the scope is not Scope.LOCAL.

      Does not update any CacheStatistics.

      Parameters:
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. Can be null. Should be serializable.
      Throws:
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      IllegalArgumentException - if aCallbackArgument is not serializable
      See Also:

    • localInvalidateRegion

      void localInvalidateRegion()
      Invalidates this region in the local cache only. Invalidation cascades to all entries and subregions. After the invalidateRegion, this region and the entries in it still exist. To remove all the entries and this region, destroyRegion should be used. Does not update any CacheStatistics.
      Throws:
      IllegalStateException - if this region is distributed and replicated
      UnsupportedOperationException - If the region is a partitioned region
      See Also:

    • localInvalidateRegion

      void localInvalidateRegion(Object aCallbackArgument)
      Invalidates this region in the local cache only, and provides a user-defined argument to the CacheListener. The invalidation will cascade to all the subregions and cached entries. After the invalidateRegion, the region and the entries in it still exist. In order to remove all the entries and the region, destroyRegion should be used. Does not update any CacheStatistics.
      Parameters:
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. Can be null.
      Throws:
      IllegalStateException - if the region is distributed and replicated
      UnsupportedOperationException - If the region is a partitioned region
      See Also:

    • destroyRegion

      void destroyRegion() throws CacheWriterException, TimeoutException
      Destroys the whole region. Destroy cascades to all entries and subregions. After the destroy, this region object can not be used any more and any attempt to use this region object will get RegionDestroyedException. The region destroy will be distributed to other caches if the scope is not Scope.LOCAL.

      Does not update any CacheStatistics.

      Throws:
      CacheWriterException - if a CacheWriter aborts the operation; if this occurs some subregions may have already been successfully destroyed.
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      See Also:

    • destroyRegion

      void destroyRegion(Object aCallbackArgument) throws CacheWriterException, TimeoutException
      Destroys the whole region and provides a user-defined parameter object to any CacheWriter invoked in the process. Destroy cascades to all entries and subregions. After the destroy, this region object can not be used any more. Any attempt to use this region object will get a RegionDestroyedException exception. The region destroy is distributed to other caches if the scope is not Scope.LOCAL.

      Does not update any CacheStatistics.

      Parameters:
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. Can be null. Should be serializable.
      Throws:
      CacheWriterException - if a CacheWriter aborts the operation; if this occurs some subregions may have already been successfully destroyed.
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      IllegalArgumentException - if aCallbackArgument is not serializable
      See Also:

    • localDestroyRegion

      void localDestroyRegion()
      Destroys the whole region in the local cache only. No CacheWriter is invoked. Destroy cascades to all entries and subregions. After the destroy, this region object can not be used any more and any attempt to use this region object will get RegionDestroyedException exception. This operation is not distributed to any other cache.

      Does not update any CacheStatistics.

      See Also:

    • localDestroyRegion

      void localDestroyRegion(Object aCallbackArgument)
      Destroys the whole region in the local cache only, and provides a user-defined argument to a CacheListener if any. No CacheWriter is invoked. Destroy will cascade to all the entries and subregions. After the destroy, this region object can not be used any more. Any attempt to use this region object will get RegionDestroyedException exception.

      Does not update any CacheStatistics.

      Parameters:
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this call. Can be null.
      See Also:

    • close

      void close()
      Does a localDestroyRegion, but leaves behind the disk files if this is a region with persistBackup set to true. Calls CacheListener.afterRegionDestroy(org.apache.geode.cache.RegionEvent<K, V>) on each cache listener on the closed region(s). Also calls CacheCallback.close() on each callback on the closed region(s).

      Does not update any CacheStatistics.

      See Also:

    • getSnapshotService

      RegionSnapshotService<K,V> getSnapshotService()
      Obtains the snapshot service to allow the cache data to be imported or exported.
      Returns:
      the snapshot service for the region

    • saveSnapshot

      @Deprecated void saveSnapshot(OutputStream outputStream) throws IOException
      Deprecated.
      as of 7.0 use getSnapshotService()
      Saves the data in this region in a snapshot file. The data is a "concurrent" snapshot in that modifications to the region while the snapshot is being written are not guaranteed to be included or excluded from the snapshot. In other words, if there are concurrent modifications to the region while the snapshot is being written, the snapshot may not reflect a consistent state of the entire region at any moment in time.
      Parameters:
      outputStream - the output stream to write to
      Throws:
      IOException - if encountered while writing the file
      UnsupportedOperationException - If the region is a partitioned region
      See Also:

    • loadSnapshot

      @Deprecated void loadSnapshot(InputStream inputStream) throws IOException, ClassNotFoundException, CacheWriterException, TimeoutException
      Deprecated.
      as of 7.0 use getSnapshotService()
      Loads data from a file that was previously created with the saveSnapshot method. This method essentially destroys the region and automatically recreates it with the data in the snapshot. Any current data in the region is lost, replaced with the data in the snapshot file. Causes this region and all other regions with the same name in remote caches in this distributed system to be reinitialized: remote regions are cleared of all data and distributed replicated remote regions will do a new getInitialImage operation to get the data from this snapshot. Any existing references to this region or any region that is reinitialized in this manner become unusable in that any subsequent methods invoked on those references will throw a RegionReinitializedException (which is a subclass of RegionDestroyedException).

      In order to continue working with this region, a new reference needs to be acquired using Cache#getRegion or Region#getSubregion (which will block until reinitialization is complete).

      NOTE: SUBREGIONS ARE DESTROYED. Since loading a snapshot effectively destroys the region and recreates it, all subregions of this region in this cache as well as other remote caches in the same distributed system are destroyed.

      If any error occurs while loading the snapshot, this region is destroyed and threads in remote caches that are attempting to get a reference to this region will get null instead of a region reference. The only callbacks that are invoked are called for the destroyRegion operation, i.e. the CacheWriter and the close methods on callbacks. CacheListeners and other callback objects have their close() methods called when the region is destroyed, and then those same callback objects will be reinstalled on the new region. Therefore, the callback objects should be able to handle a close() followed by events associated with the newly created region.

      Parameters:
      inputStream - the inputStream to load the snapshot from
      Throws:
      ClassNotFoundException - if a class cannot be found while loading data
      IOException - if error encountered while reading file.
      CacheWriterException - if a CacheWriter aborts the destroyRegion operation; if this occurs some subregions may have already been successfully destroyed.
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      UnsupportedOperationException - If the region is a partitioned region
      See Also:

    • getSubregion

      <SK, SV> Region<SK,SV> getSubregion(String path)
      Returns a subregion with the specified name or null if doesn't exist. The name is relative from this region, so it can be either a simple region name or a relative region path. If regionName is the empty string, then this region itself is returned.
      Type Parameters:
      SK - the type of keys in the subregion
      SV - the type of values in the subregion
      Parameters:
      path - the path to the subregion
      Returns:
      a subregion with the specified relative path from this region, or null if it doesn't exist
      Throws:
      IllegalArgumentException - if path starts with a forward slash or
      See Also:

    • createSubregion

      @Deprecated <SK, SV> Region<SK,SV> createSubregion(String subregionName, RegionAttributes<SK,SV> aRegionAttributes) throws RegionExistsException, TimeoutException
      Deprecated.
      as of 7.0 use RegionFactory.createSubregion(Region, String) or ClientRegionFactory.createSubregion(Region, String).
      Creates a subregion with the specified name and RegionAttributes. The name must not contain a region name separator. If the subregion is a distributed replicated region, it will be initialized with data from all other caches in this distributed system that have the same region.

      Updates the CacheStatistics.getLastAccessedTime() and CacheStatistics.getLastModifiedTime() for this region.

      Type Parameters:
      SK - the type of keys in the subregion
      SV - the type of values in the subregion
      Parameters:
      subregionName - the subregion name
      aRegionAttributes - the RegionAttributes to be used for the subregion
      Returns:
      a subregion with the specified name
      Throws:
      IllegalArgumentException - if aRegionAttributes is null or if regionName is null, the empty string, or contains a '/'
      IllegalStateException - If the supplied RegionAttributes violate the region creation constraints with a region of the same name in another cache in the distributed system or with this (parent) region.
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      RegionExistsException - if a subregion by the specified name already exists
      UnsupportedOperationException - If the region is a partitioned region
      See Also:

    • subregions

      Set<Region<?,?>> subregions(boolean recursive)
      Returns a Set of all subregions. If the recursive parameter is set to true, this call will recursively collect all subregions contained in this region. Otherwise, this call will only return the Set of direct subregions.

      This Set is unmodifiable. It is backed by this region. Synchronization is not necessary to access or iterate over this set. No ConcurrentModificationExceptions will be thrown, but subregions may be added or removed while a thread is iterating. Iterators are intended to be used by one thread at a time. If a stable "snapshot" view of the set is required, then call one of the toArray methods on the set and iterate over the array.

      Parameters:
      recursive - if false, collects direct subregions only; if true, collects all subregions recursively
      Returns:
      a Set of subregions

    • getEntry

      Region.Entry<K,V> getEntry(Object key)
      Returns the Region.Entry for the specified key, or null if it doesn't exist.
      Parameters:
      key - the key corresponding to the Entry to return
      Returns:
      the Region.Entry for the specified key or null if not found in this region
      Throws:
      NullPointerException - if key is null

    • get

      V get(Object key) throws CacheLoaderException, TimeoutException
      Returns the value associated with the specified key. If the value is not present locally for this entry, a netSearch and/or a CacheLoader may be invoked to get the value, depending on the scope of this region. A netSearch looks for a value in every node of the system that defines this region. A netLoad invokes remote loaders one at a time until one returns a value or throws an exception. If any of these methods successfully retrieves a value than the value is immediately returned.

      For local scope, a local CacheLoader will be invoked if there is one. For global scope, the order is netSearch, localLoad, netLoad. For any other distributed scope, the order is localLoad, netSearch, netLoad.

      netSearch and netLoad are never performed more than once, so if a loader attempts to do a netSearch and one was already done, then another one will not be done.

      The value returned by get is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods.

      Updates the CacheStatistics.getLastAccessedTime(), CacheStatistics.getHitCount(), CacheStatistics.getMissCount(), and CacheStatistics.getLastModifiedTime() (if a new value is loaded) for this region and the entry.

      If the CacheWriter throws a CacheWriterException when a new value is retrieved from a loader, the value will not be put into the cache (a new entry will not be created) but the get will return the value and not propagate the exception.

      Specified by:
      get in interface Map<K,V>
      Parameters:
      key - whose associated value is to be returned. The key Object must implement the equals and hashCode methods. Note that even though key is typed as "Object" if a CacheLoader is used then make sure you only pass instances of "K" in this parameter.
      Returns:
      the value with specified key, or null if the value is not found and can't be loaded
      Throws:
      NullPointerException - if the key is null
      IllegalArgumentException - if the key does not meet the serializability requirements
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out doing a search for distributed or getting a distributed lock for Scope.GLOBAL
      CacheLoaderException - if a cache loader throws an exception, or if the cache loader returns an object that is not serializable and this is a distributed region
      PartitionedRegionStorageException - for a partitioned region fails to invoke a CacheLoader
      See Also:

    • get

      V get(Object key, Object aCallbackArgument) throws TimeoutException, CacheLoaderException
      Returns the value associated with the specified key, passing the callback argument to any cache loaders or cache writers that are invoked in the operation. If the value is not present locally for this entry, a netSearch and/or a CacheLoader may be invoked to get the value, depending on the scope of this region. A netSearch looks for a value in every node of the system that defines this region. A netLoad invokes remote loaders one at a time until one returns a value or throws an exception. If any of these methods successfully retrieves a value than the value is immediately returned.

      For local scope, a local CacheLoader will be invoked if there is one. For global scope, the order is netSearch, localLoad, netLoad. For any other distributed scope, the order is localLoad, netSearch, netLoad.

      netSearch and netLoad are never performed more than once, so if a loader attempts to do a netSearch and one was already done, then another one will not be done.

      The value returned by get is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods.

      Updates the CacheStatistics.getLastAccessedTime(), CacheStatistics.getHitCount(), CacheStatistics.getMissCount(), and CacheStatistics.getLastModifiedTime() (if a new value is loaded) for this region and the entry. If the CacheWriter throws a CacheWriterException when a new value is retrieved from a loader, then the value will not be put into the cache (a new entry will not be created) but the get will return the value and not propagate the exception.

      Parameters:
      key - whose associated value is to be returned. The key Object must implement the equals and hashCode methods. Note that even though key is typed as "Object" if a CacheLoader is used then make sure you only pass instances of "K" in this parameter.
      aCallbackArgument - an argument passed into the CacheLoader if loader is used. This same argument will also be subsequently passed to a CacheWriter if the loader returns a non-null value to be placed in the cache. Modifications to this argument made in the CacheLoader will be visible to the CacheWriter even if the loader and the writer are installed in different cache VMs. It will also be passed to any other callback events triggered by this method. May be null. Should be serializable.
      Returns:
      the value with specified key, or null if the value is not found and can't be loaded
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if aCallbackArgument is not serializable
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out doing a search for distributed or getting a distributed lock for Scope.GLOBAL
      CacheLoaderException - if a cache loader throws an exception, or if the cache loader returns an object that is not serializable and this is a distributed region
      PartitionedRegionStorageException - for a partitioned region fails to invoke a CacheLoader
      See Also:

    • put

      V put(K key, V value) throws TimeoutException, CacheWriterException
      Places a new value into an entry in this region with the specified key. If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

      Updates the CacheStatistics.getLastAccessedTime() and CacheStatistics.getLastModifiedTime() for this region and the entry.

      Specified by:
      put in interface Map<K,V>
      Parameters:
      key - a key associated with the value to be put into this region. The key object must implement the equals and hashCode methods.
      value - the value to be put into the cache
      Returns:
      the previous value stored locally for the key. If the entry did not exist then null is returned. If the entry was "invalid" then null is returned. In some cases null may be returned even if a previous value exists. If the region is a client proxy then null is returned. If the region is partitioned and the put is done on a non-primary then null is returned. If the value is not currently stored in memory but is on disk and if the region does not have cqs then null is returned.
      Throws:
      NullPointerException - if key is null or if value is null (use invalidate instead), or if the key or value do not meet serializability requirements
      ClassCastException - if key does not satisfy the keyConstraint
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region.
      LowMemoryException - if a low memory condition is detected.
      See Also:

    • put

      V put(K key, V value, Object aCallbackArgument) throws TimeoutException, CacheWriterException
      Places a new value into an entry in this region with the specified key, providing a user-defined parameter object to any CacheWriter invoked in the process. If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

      Updates the CacheStatistics.getLastAccessedTime() and CacheStatistics.getLastModifiedTime() for this region and the entry.

      Parameters:
      key - a key associated with the value to be put into this region. The key object must implement the equals and hashCode methods.
      value - the value to be put into the cache
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. Can be null. Should be serializable.
      Returns:
      the previous value stored locally for the key. If the entry did not exist then null is returned. If the entry was "invalid" then null is returned. In some cases null may be returned even if a previous value exists. If the region is a client proxy then null is returned. If the region is off-heap and the old value was stored in off-heap memory then null is returned. If the region is partitioned and the put is done on a non-primary then null is returned. If the value is not currently stored in memory but is on disk and if the region does not have cqs then null is returned.
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if key, value, or aCallbackArgument do not meet serializability requirements
      ClassCastException - if key does not satisfy the keyConstraint
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region.
      LowMemoryException - if a low memory condition is detected.
      See Also:

    • create

      void create(K key, V value) throws TimeoutException, EntryExistsException, CacheWriterException
      Creates a new entry in this region with the specified key and value if and only if an entry does not already exist for the specified key. If an entry already exists for the specified key, throws EntryExistsException.

      Updates the CacheStatistics.getLastAccessedTime() and CacheStatistics.getLastModifiedTime() for this region and the entry.

      If this region has a distributed scope, this operation may cause update events in caches that already have this region with this entry, and it will cause create events in other caches that have all events configured.

      This operation gets a distributed lock on the entry if the scope is Scope.GLOBAL.

      Parameters:
      key - the key for which to create the entry in this region
      value - the value for the new entry, which may be null meaning the new entry starts as if it had been locally invalidated
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if the key or value is not serializable and this is a distributed region
      ClassCastException - if key does not satisfy the keyConstraint
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      EntryExistsException - if an entry with this key already exists
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region.
      LowMemoryException - if a low memory condition is detected.
      See Also:

    • create

      void create(K key, V value, Object aCallbackArgument) throws TimeoutException, EntryExistsException, CacheWriterException
      Creates a new entry in this region with the specified key and value, providing a user-defined parameter object to any CacheWriter invoked in the process. If this region has a distributed scope, then the value may be updated subsequently if other caches update the value.

      Updates the CacheStatistics.getLastAccessedTime() and CacheStatistics.getLastModifiedTime() for this region and the entry.

      If this region has a distributed scope, this operation may cause update events in caches that already have this region with this entry, and it will cause create events in other caches that have all events configured.

      Parameters:
      key - the key for which to create the entry in this region
      value - the value for the new entry, which may be null meaning the new entry starts as if it had been locally invalidated.
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. Can be null. Should be serializable.
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if the key, value, or aCallbackArgument do not meet serializability requirements
      ClassCastException - if key does not satisfy the keyConstraint
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      EntryExistsException - if an entry with this key already exists
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region.
      LowMemoryException - if a low memory condition is detected.
      See Also:

    • invalidate

      void invalidate(Object key) throws TimeoutException, EntryNotFoundException
      Invalidates the entry with the specified key. Invalidate only removes the value from the entry, the key is kept intact. To completely remove the entry, destroy should be used. The invalidate will be distributed to other caches if the scope is not Scope.LOCAL.

      Does not update any CacheStatistics.

      Parameters:
      key - the key of the value to be invalidated
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if the key does not meet serializability requirements
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      EntryNotFoundException - if the entry does not exist in this region
      See Also:

    • invalidate

      void invalidate(Object key, Object aCallbackArgument) throws TimeoutException, EntryNotFoundException
      Invalidates the entry with the specified key, and provides a user-defined argument to the CacheListener. Invalidate only removes the value from the entry, the key is kept intact. To completely remove the entry, destroy should be used.

      Does not update any CacheStatistics.

      Parameters:
      key - the key of the value to be invalidated
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. Can be null. Should be serializable.
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if the key or the aCallbackArgument do not meet serializability requirements
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      EntryNotFoundException - if this entry does not exist in this region
      See Also:

    • localInvalidate

      void localInvalidate(Object key) throws EntryNotFoundException
      Invalidates the value with the specified key in the local cache only. Invalidate will only remove the value from the entry, the key will be kept intact. In order to completely remove the key, entry and value, destroy should be called.

      Does not update any CacheStatistics.

      Parameters:
      key - the key of the value to be invalidated
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if the key does not meet serializability requirements
      IllegalStateException - if this region is distributed and replicated
      EntryNotFoundException - if the entry does not exist in this region locally
      UnsupportedOperationException - If the region is a partitioned region
      UnsupportedOperationInTransactionException - If called in a transactional context
      See Also:

    • localInvalidate

      void localInvalidate(Object key, Object aCallbackArgument) throws EntryNotFoundException
      Invalidates the value with the specified key in the local cache only, and provides a user-defined argument to the CacheListener. Invalidate will only remove the value from the entry, the key will be kept intact. In order to completely remove the key, entry and value, destroy should be called.

      Does not update any CacheStatistics.

      Parameters:
      key - the key of the value to be invalidated
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. Can be null.
      Throws:
      NullPointerException - if key is null
      IllegalStateException - if this region is distributed and replicated
      EntryNotFoundException - if this entry does not exist in this region locally
      UnsupportedOperationException - If the region is a partitioned region
      UnsupportedOperationInTransactionException - If called in a transactional context
      See Also:

    • destroy

      V destroy(Object key) throws TimeoutException, EntryNotFoundException, CacheWriterException
      Destroys the entry with the specified key. Destroy removes not only the value but also the key and entry from this region. Destroy will be distributed to other caches if the scope is not Scope.LOCAL.

      Does not update any CacheStatistics.

      Parameters:
      key - the key of the entry
      Returns:
      the previous value stored locally for the key. If the entry was "invalid" then null is returned. In some cases null may be returned even if a previous value exists. If the region is a client proxy then null is returned. If the region is off-heap and the old value was stored in off-heap memory then null is returned. If the region is partitioned and the destroy is done on a non-primary then null is returned. If the value is not currently stored in memory but is on disk and if the region does not have cqs then null is returned.
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if key does not meet serializability requirements
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      EntryNotFoundException - if the entry does not exist in this region
      CacheWriterException - if a CacheWriter aborts the operation
      See Also:

    • destroy

      V destroy(Object key, Object aCallbackArgument) throws TimeoutException, EntryNotFoundException, CacheWriterException
      Destroys the entry with the specified key, and provides a user-defined parameter object to any CacheWriter invoked in the process. Destroy removes not only the value but also the key and entry from this region. Destroy will be distributed to other caches if the scope is not Scope.LOCAL.

      Does not update any CacheStatistics.

      Parameters:
      key - the key of the entry to destroy
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. Can be null. Should be serializable.
      Returns:
      the previous value stored locally for the key. If the entry was "invalid" then null is returned. In some cases null may be returned even if a previous value exists. If the region is a client proxy then null is returned. If the region is off-heap and the old value was stored in off-heap memory then null is returned. If the region is partitioned and the destroy is done on a non-primary then null is returned. If the value is not currently stored in memory but is on disk and if the region does not have cqs then null is returned.
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if the key or aCallbackArgument do not meet serializability requirements
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      EntryNotFoundException - if the entry does not exist in this region
      CacheWriterException - if a CacheWriter aborts the operation
      See Also:

    • localDestroy

      void localDestroy(Object key) throws EntryNotFoundException
      Destroys the value with the specified key in the local cache only, No CacheWriter is invoked. Destroy removes not only the value but also the key and entry from this region.

      Does not update any CacheStatistics.

      Parameters:
      key - the key of the entry to destroy
      Throws:
      NullPointerException - if key is null
      IllegalStateException - if this region is distributed and replicated
      EntryNotFoundException - if the entry does not exist in this region locally
      UnsupportedOperationException - If the region is a partitioned region
      UnsupportedOperationInTransactionException - If called in a transactional context
      See Also:

    • localDestroy

      void localDestroy(Object key, Object aCallbackArgument) throws EntryNotFoundException
      Destroys the value with the specified key in the local cache only, and provides a user-defined parameter object to the CacheListener, if any. No CacheWriter is invoked. Destroy removes not only the value but also the key and entry from this region.

      Does not update any CacheStatistics.

      Parameters:
      key - the key of the entry to destroy
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. Can be null.
      Throws:
      NullPointerException - if key is null
      IllegalStateException - if this region is distributed and replicated
      EntryNotFoundException - if the entry does not exist in this region locally
      UnsupportedOperationException - If the region is a partitioned region
      UnsupportedOperationInTransactionException - If called in a transactional context
      See Also:

    • keySet

      Set<K> keySet()
      Returns a set of keys in the region.

      This Set is unmodifiable. It is backed by this region. Synchronization is not necessary to access or iterate over this set. No ConcurrentModificationExceptions will be thrown, but keys may be added or removed to this set while a thread is iterating. Iterators are intended to be used by one thread at a time. If a stable "snapshot" view of the set is required, then call one of the toArray methods on the set and iterate over the array. If you need to lock down the region so this set is not modified while it is being accessed, use global scope with a distributed lock.

      Specified by:
      keySet in interface Map<K,V>
      Returns:
      a Set of all the keys

    • values

      Collection<V> values()
      Returns a Collection of values in this region.

      This Collection is unmodifiable. It is backed by this region. Synchronization is not necessary to access or iterate over this collection. No ConcurrentModificationExceptions will be thrown, but values may be added or removed to this collection while a thread is iterating. Iterators are intended to be used by one thread at a time. If a stable "snapshot" view of the collection is required, then call one of the toArray methods on the collection and iterate over the array. If you need to lock down the region so this set is not modified while it is being accessed, use global scope with a distributed lock on the region.

      Null values are not included in the result collection.

      Specified by:
      values in interface Map<K,V>
      Returns:
      a Collection of all the objects cached in this region

    • entrySet

      Set<Region.Entry<?,?>> entrySet(boolean recursive)
      Returns the Set of Region.Entry objects in this region. If the recursive parameter is set to true, this call will recursively collect all the entries in this region and its subregions and return them in the Set; if false, it only returns entries directly contained in this region.

      This Set is unmodifiable. It is backed by this region. Synchronization is not necessary to access or iterate over this set. No ConcurrentModificationExceptions will be thrown, but entries may be added or removed to this set while a thread is iterating. Iterators are intended to be used by one thread at a time. If a stable "snapshot" view of the set is required, then call one of the toArray methods on the set and iterate over the array. If you need to lock down the region so this set is not modified while it is being accessed, use global scope with a distributed lock.

      Parameters:
      recursive - if true, this call recursively collects all the entries in this region and its subregions; if false, it only returns the entries directly contained in this region
      Returns:
      a Set of all the cached objects
      See Also:

    • getCache

      @Deprecated Cache getCache()
      Deprecated.
      as of 6.5 use getRegionService() instead.
      Returns the Cache associated with this region.

      Does not throw a CacheClosedException if the Cache is closed.

      Returns:
      the Cache

    • getRegionService

      RegionService getRegionService()
      Returns the cache associated with this region.

      Does not throw a CacheClosedException if the cache is closed.

      Returns:
      the cache
      Since:
      GemFire 6.5

    • getUserAttribute

      Object getUserAttribute()
      Returns the application-defined object associated with this region. GemFire does not use this object for any purpose.
      Returns:
      the user attribute object or null if it has not been set

    • setUserAttribute

      void setUserAttribute(Object value)
      Sets the application-defined object associated with this region. GemFire does not use this object for any purpose.
      Parameters:
      value - the application-defined object

    • isDestroyed

      boolean isDestroyed()
      Returns whether this region has been destroyed.

      Does not throw a RegionDestroyedException if this region has been destroyed.

      Returns:
      true if this region has been destroyed

    • containsValueForKey

      boolean containsValueForKey(Object key)
      Returns whether there is a valid (non-null) value present for the specified key. This method is equivalent to: 
       Entry e = getEntry(key);
 return e != null && e.getValue() != null;
      Parameters:
      key - the key to check for a valid value
      Returns:
      true if there is an entry in this region for the specified key and it has a valid value

    • containsKey

      boolean containsKey(Object key)
      Returns whether the specified key currently exists in this region. This method is equivalent to getEntry(key) != null.
      Specified by:
      containsKey in interface Map<K,V>
      Parameters:
      key - the key to check for an existing entry
      Returns:
      true if there is an entry in this region for the specified key

    • getRegionDistributedLock

      Lock getRegionDistributedLock() throws IllegalStateException
      For Scope.GLOBAL regions, gets a distributed lock on this whole region. This region lock cannot be acquired until all other caches release both region locks and any entry locks they hold in this region. Likewise, new entry locks cannot be acquired until outstanding region locks are released. The only place that a region distributed lock is acquired automatically is during region creation for distributed replicated regions when they acquire their initial data.

      The operations invalidateRegion and destroyRegion do not automatically acquire a distributed lock at all, so it is possible for these operations to cause an entry to be invalidated or the region to be destroyed even if a distributed lock is held on an entry. If an application requires all entry level locks to be released when a region is destroyed or invalidated as a whole, then it can call this method explicitly to get a ock on the entire region before calling invalidateRegion or destroyRegion.

      See getDistributedLock(java.lang.Object) for the list of operations that automatically acquire distributed entry locks for regions with global scope.

      Note that Region locks are potentially very expensive to acquire.

      Returns:
      a Lock used for acquiring a distributed lock on the entire region
      Throws:
      IllegalStateException - if the scope of this region is not global
      UnsupportedOperationException - If the region is a partitioned region

    • getDistributedLock

      Lock getDistributedLock(Object key) throws IllegalStateException
      For Scope.GLOBAL regions, gets a distributed lock on the entry with the specified key. Use of this Lock enables an application to synchronize operations on entries at a higher level than provided for by Scope.GLOBAL. This is the same lock that GemFire uses internally for operations that modify the cache with global scope, so this lock can be used for high-level synchronization with other caches that have this region with global scope. For example, if an application needs to get two values out of a region with global scope and guarantee that the first value is not modified before the second value is retrieved, it can use this lock in the following manner: 
       Lock entry1Lock = myRegion.getDistributedLock(key1);
 Lock entry2Lock = myRegion.getDistributedLock(key2);
 entry1Lock.lock();
 entry2Lock.lock();
 try {
   Object val1 = myRegion.get(key1);
   Object val2 = myRegion.get(key2);
   // do something with val1 and val2
 } finally {
   entry2Lock.unlock();
   entry1Lock.unlock();
 }
      You can also get a lock on an entry that does not exist in the local cache. Doing so guarantees that no other cache with the same region using global scope or using the same lock will create or update that entry while you have the lock. When a region has global scope, the following operations automatically acquire a distributed lock on an entry: create, put, destroy, invalidate, and get that causes a loader to be invoked.
      Parameters:
      key - the key on which to get a distributed lock
      Returns:
      a Lock used for acquiring a distributed lock on an entry
      Throws:
      IllegalStateException - if the scope of this region is not global
      NullPointerException - if key is null
      UnsupportedOperationException - If the region is a partitioned region

    • writeToDisk

      @Deprecated void writeToDisk()
      Deprecated.
      use DiskStore.flush() instead.
      Initiates a flush to asynchronously write unwritten region entries to disk.
      Throws:
      IllegalStateException - If this region is not configured to write to disk
      DiskAccessException - If problems are encounter while writing to disk
      UnsupportedOperationException - If the region is a partitioned region
      Since:
      GemFire 3.2
      See Also:

    • existsValue

      boolean existsValue(String queryPredicate) throws FunctionDomainException, TypeMismatchException, NameResolutionException, QueryInvocationTargetException
      Determines whether there is a value in this Region that matches the given queryPredicate. Filters the values of this region using the predicate given as a string with the syntax of the WHERE clause of the query language. The predefined variable this may be used inside the predicate to denote the current value being filtered.
      Parameters:
      queryPredicate - A query language boolean query predicate.
      Returns:
      true if there is a value in region that matches the predicate, otherwise false.
      Throws:
      QueryInvalidException - If predicate does not correspond to valid query language syntax.
      FunctionDomainException - If more than one element evaluates to true.
      TypeMismatchException - If a bound parameter is not of the expected type
      NameResolutionException - If a name in the query cannot be resolved.
      QueryInvocationTargetException - If the data referenced in from clause is not available for querying
      Since:
      GemFire 4.0
      See Also:

    • query

      <E> SelectResults<E> query(String queryPredicate) throws FunctionDomainException, TypeMismatchException, NameResolutionException, QueryInvocationTargetException
      Filters the values of this region using the queryPredicate. The queryPredicate should follow the syntax of query WHERE clause. When executed from a client, this method always runs on the server. However application should use QueryService to execute queries.
      Type Parameters:
      E - the type of elements in the SelectResults
      Parameters:
      queryPredicate - A query language boolean query predicate.
      Returns:
      A SelectResults containing the values of this Region that match the predicate.
      Throws:
      QueryInvalidException - If exception occurs during query compilation or processing.
      FunctionDomainException - If more than one element evaluates to true.
      TypeMismatchException - If a bound parameter is not of the expected type
      NameResolutionException - If a name in the query cannot be resolved.
      QueryInvocationTargetException - If the data referenced in from clause is not available for querying
      Since:
      GemFire 4.0
      See Also:

    • selectValue

      Object selectValue(String queryPredicate) throws FunctionDomainException, TypeMismatchException, NameResolutionException, QueryInvocationTargetException
      Selects the single value in this Region that matches the given query predicate. Filters the values of this region using the predicate given as a string with the syntax of the where clause of the query language. The predefined variable this may be used inside the predicate to denote the element currently being filtered.
      Parameters:
      queryPredicate - A query language boolean query predicate.
      Returns:
      The single element that evaluates to true for the predicate. If no value in this Region matches the predicate, null is returned.
      Throws:
      QueryInvalidException - If predicate does not correspond to valid query language syntax.
      FunctionDomainException - If more than one element evaluates to true.
      TypeMismatchException - If a bound parameter is not of the expected type
      NameResolutionException - If a name in the query cannot be resolved.
      QueryInvocationTargetException - If the data referenced in from clause is not available for querying
      Since:
      GemFire 4.0
      See Also:

    • forceRolling

      @Deprecated void forceRolling()
      Deprecated.
      use DiskStore.forceRoll() instead.
      Asks the region to start writing to a new oplog (if persistence/overflow is turned on). The old one will be asynchronously compressed if compaction is set to true. If the region is not persistent/overflow no change in the region will be reflected. The new log will be created in the next available directory with free space. If there is no directory with free space available and compaction is set to false, then a DiskAccessException saying that the disk is full will be thrown. If compaction is true, the application will wait for the other oplogs to be compressed and more space to be created.
      Since:
      GemFire 5.1

    • becomeLockGrantor

      void becomeLockGrantor()
      Specifies this member to become the grantor for this region's lock service. The grantor will be the lock authority which is responsible for handling all lock requests for this service. Other members will request locks from this member. Locking for this member will be optimal as it will not require messaging to acquire a given lock.

      Calls to this method will block until grantor authority has been transferred to this member.

      If another member later calls becomeLockGrantor, that member will transfer grantor authority from this member to itself. Multiple calls to this operation will have no effect unless another member has transferred grantor authority, in which case, this member will transfer grantor authority back to itself.

      This region's scope must be Scope.GLOBAL to become a lock grantor.

      This operation should not be invoked repeatedly in an application. It is possible to create a lock service and have two or more members endlessly calling becomeLockGrantor to transfer grantorship back and forth.

      Throws:
      IllegalStateException - if scope is not GLOBAL
      UnsupportedOperationException - If the region is a partitioned region
      Since:
      GemFire 4.0

    • localClear

      void localClear()
      Removes all local entries from this region. This is not a distributed operation. This operation is not allowed on replicated regions.
      Throws:
      UnsupportedOperationException - If the region is a replicated region
      UnsupportedOperationException - If the region is a partitioned region
      Since:
      GemFire 5.0
      See Also:

    • clear

      void clear()
      Removes all entries from this region. Clear will be distributed to other caches if the scope is not Scope.LOCAL.

      Specified by:
      clear in interface Map<K,V>
      Throws:
      UnsupportedOperationException - If the region is a partitioned region
      Since:
      GemFire 5.0
      See Also:

    • containsValue

      boolean containsValue(Object value)
      Returns true if this region maps one or more keys to the specified value. More formally, returns true if and only if this region contains at least one entry to a value v such that (value==null ? v==null : value.equals(v)). This operation is not distributed and only the current region will be checked for this value.
      Specified by:
      containsValue in interface Map<K,V>
      Since:
      GemFire 5.0
      See Also:

    • entrySet

      Set<Map.Entry<K,V>> entrySet()
      Returns the Set of Region.Entry objects in this region.

      This Set is unmodifiable. It is backed by this region. Synchronization is not necessary to access or iterate over this set. No ConcurrentModificationExceptions will be thrown, but entries may be added or removed to this set while a thread is iterating. Iterators are intended to be used by one thread at a time. If a stable "snapshot" view of the set is required, then call one of the toArray methods on the set and iterate over the array. If you need to lock down the region so this set is not modified while it is being accessed, use global scope with a distributed lock. A remove called on an entry via the iterator will result in an UnsupportedOperationException The Region.Entry obtained via the iterator is backed by the region. If a setValue on that entry is called, it will be similar in effect as calling a put on that key.

      Specified by:
      entrySet in interface Map<K,V>
      Returns:
      a Set of all the Region.Entry instances in this region locally
      Since:
      GemFire 5.0
      See Also:

    • isEmpty

      boolean isEmpty()
      Returns true if this region contains no entries.
      Specified by:
      isEmpty in interface Map<K,V>
      Returns:
      true if this region contains no entries.
      Since:
      GemFire 5.0
      See Also:

    • putAll

      void putAll(Map<? extends K,? extends V> map)
      Copies all of the entries from the specified map to this region. The effect of this call is equivalent to that of calling put(Object, Object) on this region once for each entry in the specified map. This operation will be distributed to other caches if the scope is not Scope.LOCAL. If an exception is thrown due to this call, it can imply that there may have been a partial update performed on the region.

      Specified by:
      putAll in interface Map<K,V>
      Parameters:
      map - the key/value pairs to put in this region
      Throws:
      ServerOperationException - if called from a client, and the server throws an exception such as CacheWriterException, PartitionedRegionStorageException or LowMemoryException. These server exceptions become the ServerOperationException cause
      ServerConnectivityException - if called from a client, and the server throws CancelException. CancelException will be the ServerConnectivityException cause
      NullPointerException - if the key is null, if the value is null (use invalidate instead), or if the key or value do not meet serialization requirements
      ClassCastException - if key does not satisfy the keyConstraint
      LeaseExpiredException - if the lease expired on a distributed lock, for regions with Scope.GLOBAL
      TimeoutException - if the call timed out waiting to acquire a distributed lock for regions with Scope.GLOBAL
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region
      LowMemoryException - if a low memory condition is detected
      Since:
      GemFire 5.0
      See Also:

    • putAll

      void putAll(Map<? extends K,? extends V> map, Object aCallbackArgument)
      Copies all of the entries from the specified map to this region. The effect of this call is equivalent to that of calling put(Object, Object) on this region once for each entry in the specified map. This operation will be distributed to other caches if the scope is not Scope.LOCAL. If an exception is thrown due to this call, it can imply that there may have been a partial update performed on the region.

      Parameters:
      map - the key/value pairs to put in this region
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. May be null. Must be serializable if this operation is distributed
      Throws:
      ServerOperationException - if called from a client, and the server throws an exception such as CacheWriterException, PartitionedRegionStorageException or LowMemoryException. These server exceptions become the ServerOperationException cause
      ServerConnectivityException - if called from a client, and the server throws CancelException. CancelException will be the ServerConnectivityException cause
      NullPointerException - if the key is null, if the value is null (use invalidate instead), or if the key or value do not meet serialization requirements
      ClassCastException - if key does not satisfy the keyConstraint
      LeaseExpiredException - if the lease expired on a distributed lock, for regions with Scope.GLOBAL
      TimeoutException - if the call timed out waiting to acquire a distributed lock for regions with Scope.GLOBAL
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region
      LowMemoryException - if a low memory condition is detected
      Since:
      GemFire 8.1
      See Also:

    • removeAll

      void removeAll(Collection<? extends K> keys)
      Removes all of the entries for the specified keys from this region. The effect of this call is equivalent to that of calling destroy(Object) on this region once for each key in the specified collection. If an entry does not exist that key is skipped; EntryNotFoundException is not thrown. This operation will be distributed to other caches if the scope is not Scope.LOCAL.
      Parameters:
      keys - the keys to remove from this region.
      Since:
      GemFire 8.1
      See Also:

    • removeAll

      void removeAll(Collection<? extends K> keys, Object aCallbackArgument)
      Removes all of the entries for the specified keys from this region. The effect of this call is equivalent to that of calling destroy(Object, Object) on this region once for each key in the specified collection. If an entry does not exist that key is skipped; EntryNotFoundException is not thrown. This operation will be distributed to other caches if the scope is not Scope.LOCAL.
      Parameters:
      keys - the keys to remove from this region.
      aCallbackArgument - a user-defined parameter to pass to callback events triggered by this method. May be null. Must be serializable if this operation is distributed.
      Since:
      GemFire 8.1
      See Also:

    • getAll

      Map<K,V> getAll(Collection<?> keys)
      Gets values for all the keys in the input Collection. If a given key does not exist in the region then that key's value in the returned map will be null.

      Note that the keys collection should extend K since a load may be done and the key in that case will be stored in the region. The keys parameter was not changed to extend K for backwards compatibility.

      Parameters:
      keys - A Collection of keys
      Returns:
      A Map of values for the input keys
      Since:
      GemFire 5.7

    • getAll

      <T extends K> Map<T,V> getAll(Collection<T> keys, Object aCallbackArgument)
      Gets and returns values for all the keys in the input Collection. If a given key does not exist in the region then that key's value in the returned map will be null.
      Type Parameters:
      T - the type of the keys passed to getAll
      Parameters:
      keys - A Collection of keys
      aCallbackArgument - an argument passed into the CacheLoader if a loader is used. This same argument will also be subsequently passed to a CacheWriter if the loader returns a non-null value to be placed in the cache. Modifications to this argument made in the CacheLoader will be visible to the CacheWriter even if the loader and the writer are installed in different cache VMs. It will also be passed to any other callback events triggered by this method. May be null. Must be serializable if this operation is distributed.
      Returns:
      A Map of values for the input keys
      Since:
      GemFire 8.1

    • remove

      V remove(Object key)
      Removes the entry with the specified key. The operation removes not only the value but also the key and entry from this region. Remove will be distributed to other caches if the scope is not Scope.LOCAL.

      Does not update any CacheStatistics.

      Specified by:
      remove in interface Map<K,V>
      Parameters:
      key - the key of the entry
      Returns:
      null is returned if an entry for key does not exist otherwise the value that was stored locally for the removed entry is returned. If the entry was "invalid" then null is returned. In some cases null may be returned even if a previous value exists. If the region is a client proxy then null is returned. If the region is off-heap and the old value was stored in off-heap memory then null is returned. If the region is partitioned and the remove is done on a non-primary then null is returned. If the value is not currently stored in memory but is on disk and if the region does not have cqs then null is returned.
      Throws:
      NullPointerException - if key is null
      IllegalArgumentException - if key does not meet serializability requirements
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      CacheWriterException - if a CacheWriter aborts the operation
      Since:
      GemFire 5.0
      See Also:

    • size

      int size()
      Returns the number of entries present in this region. For DataPolicy.PARTITION, this is a distributed operation that returns the number of entries present in entire region. For all other types of regions, it returns the number of entries present locally, and it is not a distributed operation.
      Specified by:
      size in interface Map<K,V>
      Returns:
      the number of entries present in this region
      Since:
      GemFire 5.0
      See Also:

    • equals

      boolean equals(Object other)
      Compares the specified object with this region for equality. Regions are only equal to themselves (identity based) so Object.equals(java.lang.Object) is used. Note that some other class that implements Map may say that it is equal to an instance of Region (since Region implements Map) even though Region will never say that it is equal to that instance.
      Specified by:
      equals in interface Map<K,V>
      Overrides:
      equals in class Object
      Parameters:
      other - Object object to be compared against the this
      Returns:
      true if the specified object is equal to this region.
      See Also:

    • hashCode

      int hashCode()
      Returns the hash code value for this region. The hash code of a region is based on identity and uses Object.hashCode().
      Specified by:
      hashCode in interface Map<K,V>
      Overrides:
      hashCode in class Object
      Returns:
      the hash code value for this region.
      See Also:

    • registerInterest

      void registerInterest(K key)
      Sends a request to the CacheServer to register interest in a key for this client. Updates to this key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. This key is first locally cleared from the client and current value for this key is inserted into the local cache before this call returns.
      Parameters:
      key - The key on which to register interest.

      ###Deprecated behavior###

      The following List and 'ALL_KEYS' behavior is now deprecated. As an alternative, please use

      registerInterestForKeys(Iterable, InterestResultPolicy)

      registerInterestForAllKeys(InterestResultPolicy)

      If the key is a List, then all the keys in the List will be registered. The key can also be the special token 'ALL_KEYS', which will register interest in all keys in the region. In effect, this will cause an update to any key in this region in the CacheServer to be pushed to the client.

      Using 'ALL_KEYS' is the same as calling registerInterestRegex(String) with ".*" as the argument. This means that all keys of any type are pushed to the client and inserted into the local cache.

      ###End of deprecation###

      This method uses the default InterestResultPolicy.

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 4.2
      See Also:

    • registerInterest

      void registerInterest(K key, InterestResultPolicy policy)
      Sends a request to the CacheServer to register interest in a key for this client. Updates to this key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. This key is first locally cleared from the client and current value for this key is inserted into the local cache before this call returns. (if requested).

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      key - The key on which to register interest.

      ###Deprecated behavior###

      The following List and 'ALL_KEYS' behavior is now deprecated. As an alternative, please use

      registerInterestForKeys(Iterable, InterestResultPolicy)

      registerInterestForAllKeys(InterestResultPolicy)

      If the key is a List, then all the keys in the List will be registered. The key can also be the special token 'ALL_KEYS', which will register interest in all keys in the region. In effect, this will cause an update to any key in this region in the CacheServer to be pushed to the client.

      Using 'ALL_KEYS' is the same as calling registerInterestRegex(String) with ".*" as the argument. This means that all keys of any type are pushed to the client and inserted into the local cache.

      ###End of deprecation###

      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subcriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 4.2.3
      See Also:

    • registerInterestForAllKeys

      default void registerInterestForAllKeys()
      Sends a request to the CacheServer to register interest in all keys for this client. Updates to any key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. The keys are first locally cleared from the client and current value for the keys are inserted into the local cache before this call returns.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      Geode 1.5

    • registerInterestForAllKeys

      default void registerInterestForAllKeys(InterestResultPolicy policy)
      Sends a request to the CacheServer to register interest in for all keys for this client. Updates to any key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. The keys are first locally cleared from the client and current value for the keys are inserted into the local cache before this call returns. (if requested).

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subcriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      Geode 1.5
      See Also:

    • registerInterestForAllKeys

      default void registerInterestForAllKeys(InterestResultPolicy policy, boolean isDurable)
      Sends a request to the CacheServer to register interest in all keys for this client. Updates to any key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. The keys are first locally cleared from the client and the current value for the keys are inserted into the local cache before this call returns (if requested).
      Parameters:
      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      isDurable - true if the register interest is durable
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      Geode 1.5
      See Also:

    • registerInterestForAllKeys

      default void registerInterestForAllKeys(InterestResultPolicy policy, boolean isDurable, boolean receiveValues)
      Sends a request to the CacheServer to register interest in all keys for this client. Updates to any key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. The keys are first locally cleared from the client and the current value for the keys are inserted into the local cache before this call returns (if requested).

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      isDurable - true if the register interest is durable
      receiveValues - defaults to true. set to false to receive create or update events as invalidates similar to notify-by-subscription false.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      Geode 1.5
      See Also:

    • registerInterestForKeys

      default void registerInterestForKeys(Iterable<K> iterable)
      Sends a request to the CacheServer to register interest for all key in the iterable for this client. Updates to any of the keys in the iterable by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. The keys are first locally cleared from the client and current value for the keys are inserted into the local cache before this call returns. (if requested).

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      iterable - The Iterable of keys on which to register interest.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subcriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      Geode 1.5

    • registerInterestForKeys

      default void registerInterestForKeys(Iterable<K> iterable, InterestResultPolicy policy)
      Sends a request to the CacheServer to register interest for all key in the iterable for this client. Updates to any of the keys in the iterable by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. The keys are first locally cleared from the client and current value for the keys are inserted into the local cache before this call returns. (if requested).

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      iterable - The Iterable of keys on which to register interest.
      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subcriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      Geode 1.5
      See Also:

    • registerInterestForKeys

      default void registerInterestForKeys(Iterable<K> iterable, InterestResultPolicy policy, boolean isDurable)
      Sends a request to the CacheServer to register interest for all key in the iterable for this client. Updates to any of the keys in the iterable by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. The keys are first locally cleared from the client and current value for the keys are inserted into the local cache before this call returns. (if requested).

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      iterable - The Iterable of keys on which to register interest.
      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      isDurable - true if the register interest is durable
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subcriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      Geode 1.5
      See Also:

    • registerInterestForKeys

      default void registerInterestForKeys(Iterable<K> iterable, InterestResultPolicy policy, boolean isDurable, boolean receiveValues)
      Sends a request to the CacheServer to register interest for all key in the iterable for this client. Updates to any of the keys in the iterable by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. The keys are first locally cleared from the client and current value for the keys are inserted into the local cache before this call returns. (if requested).

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      iterable - The Iterable of keys on which to register interest.
      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      isDurable - true if the register interest is durable
      receiveValues - defaults to true. set to false to receive create or update events as invalidates similar to notify-by-subscription false.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subcriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      Geode 1.5
      See Also:

    • registerInterestRegex

      void registerInterestRegex(String regex)
      Sends a request to the CacheServer to register interest in a regular expression pattern for this client. Updates to any keys of type String satisfying this regular expression by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. These keys are first locally cleared from the client and the current values for keys of type String that satisfy the regular expression are inserted into the local cache before this call returns.

      Note that if the regex is ".*" then all keys of any type will be pushed to the client.

      This method uses the default InterestResultPolicy.

      The regular expression string is compiled using the Pattern class.

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      regex - The regular expression on which to register interest.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 4.2.3
      See Also:

    • registerInterestRegex

      void registerInterestRegex(String regex, InterestResultPolicy policy)
      Sends a request to the CacheServer to register interest in a regular expression pattern for this client. Updates to any keys of type String satisfying this regular expression by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. These keys are first locally cleared from the client and the current values for keys of type String that satisfy the regular expression are inserted into the local cache before this call returns.

      The regular expression string is compiled using the Pattern class.

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      regex - The regular expression on which to register interest.
      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 4.2.3
      See Also:

    • unregisterInterest

      void unregisterInterest(K key)
      Sends a request to the CacheServer to unregister interest in a key for this client. Updates to this key by other clients will be no longer be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology.
      Parameters:
      key - The key on which to register interest. If the key is a List, then all the keys in the List will be unregistered.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      Since:
      GemFire 4.2

    • unregisterInterestRegex

      void unregisterInterestRegex(String regex)
      Sends a request to the CacheServer to unregister interest in a regular expression pattern for this client. Updates to any keys satisfying this regular expression by other clients will no longer be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology.
      Parameters:
      regex - The regular expression on which to unregister interest.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      Since:
      GemFire 4.2.3

    • getInterestList

      List<K> getInterestList()
      Returns the list of keys on which this client is interested and will be notified of changes. This method is currently supported only on clients in a client server topology.
      Returns:
      The list of keys on which this client is interested
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      Since:
      GemFire 4.2

    • registerInterest

      void registerInterest(K key, boolean isDurable)
      Sends a request to the CacheServer to register interest in a key for this client. Updates to this key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. This key is first locally cleared from the client and the current value for this key is inserted into the local cache before this call returns.
      Parameters:
      key - The key on which to register interest.

      ###Deprecated behavior###

      The following List and 'ALL_KEYS' behavior is now deprecated. As an alternative, please use

      registerInterestForKeys(Iterable, InterestResultPolicy)

      registerInterestForAllKeys(InterestResultPolicy)

      If the key is a List, then all the keys in the List will be registered. The key can also be the special token 'ALL_KEYS', which will register interest in all keys in the region. In effect, this will cause an update to any key in this region in the CacheServer to be pushed to the client.

      Using 'ALL_KEYS' is the same as calling registerInterestRegex(String) with ".*" as the argument. This means that all keys of any type are pushed to the client and inserted into the local cache.

      ###End of deprecation###

      This method uses the default InterestResultPolicy.

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      isDurable - true if the register interest is durable
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 5.5
      See Also:

    • registerInterest

      void registerInterest(K key, boolean isDurable, boolean receiveValues)
      Sends a request to the CacheServer to register interest in a key for this client. Updates to this key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. This key is first locally cleared from the client and the current value for this key is inserted into the local cache before this call returns.

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      key - The key on which to register interest.

      ###Deprecated behavior###

      The following List and 'ALL_KEYS' behavior is now deprecated. As an alternative, please use

      registerInterestForKeys(Iterable, InterestResultPolicy)

      registerInterestForAllKeys(InterestResultPolicy)

      If the key is a List, then all the keys in the List will be registered. The key can also be the special token 'ALL_KEYS', which will register interest in all keys in the region. In effect, this will cause an update to any key in this region in the CacheServer to be pushed to the client.

      Using 'ALL_KEYS' is the same as calling registerInterestRegex(String) with ".*" as the argument. This means that all keys of any type are pushed to the client and inserted into the local cache.

      ###End of deprecation###

      This method uses the default InterestResultPolicy.

      isDurable - true if the register interest is durable
      receiveValues - defaults to true. set to false to receive create or update events as invalidates similar to notify-by-subscription false.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 6.0.3
      See Also:

    • registerInterest

      void registerInterest(K key, InterestResultPolicy policy, boolean isDurable, boolean receiveValues)
      Sends a request to the CacheServer to register interest in a key for this client. Updates to this key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. This key is first locally cleared from the client and the current value for this key is inserted into the local cache before this call returns (if requested).

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      key - The key on which to register interest.

      ###Deprecated behavior###

      The following List and 'ALL_KEYS' behavior is now deprecated. As an alternative, please use

      registerInterestForKeys(Iterable, InterestResultPolicy)

      registerInterestForAllKeys(InterestResultPolicy)

      If the key is a List, then all the keys in the List will be registered. The key can also be the special token 'ALL_KEYS', which will register interest in all keys in the region. In effect, this will cause an update to any key in this region in the CacheServer to be pushed to the client.

      Using 'ALL_KEYS' is the same as calling registerInterestRegex(String) with ".*" as the argument. This means that all keys of any type are pushed to the client and inserted into the local cache.

      ###End of deprecation###

      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      isDurable - true if the register interest is durable
      receiveValues - defaults to true. set to false to receive create or update events as invalidates similar to notify-by-subscription false.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 6.0.3
      See Also:

    • registerInterest

      void registerInterest(K key, InterestResultPolicy policy, boolean isDurable)
      Sends a request to the CacheServer to register interest in a key for this client. Updates to this key by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. This key is first locally cleared from the client and the current value for this key is inserted into the local cache before this call returns (if requested).
      Parameters:
      key - The key on which to register interest.

      ###Deprecated behavior###

      The following List and 'ALL_KEYS' behavior is now deprecated. As an alternative, please use

      registerInterestForKeys(Iterable, InterestResultPolicy)

      registerInterestForAllKeys(InterestResultPolicy)

      If the key is a List, then all the keys in the List will be registered. The key can also be the special token 'ALL_KEYS', which will register interest in all keys in the region. In effect, this will cause an update to any key in this region in the CacheServer to be pushed to the client.

      Using 'ALL_KEYS' is the same as calling registerInterestRegex(String) with ".*" as the argument. This means that all keys of any type are pushed to the client and inserted into the local cache.

      ###End of deprecation###

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      isDurable - true if the register interest is durable
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 5.5
      See Also:

    • registerInterestRegex

      void registerInterestRegex(String regex, boolean isDurable)
      Sends a request to the CacheServer to register interest in a regular expression pattern for this client. Updates to any keys of type String satisfying this regular expression by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. These keys are first locally cleared from the client and the current values for keys of type String that satisfy the regular expression are inserted into the local cache before this call returns.

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Note that if the regex is ".*" then all keys of any type will be pushed to the client.

      This method uses the default InterestResultPolicy.

      The regular expression string is compiled using the Pattern class.

      Parameters:
      regex - The regular expression on which to register interest.
      isDurable - true if the register interest is durable
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 5.5
      See Also:

    • registerInterestRegex

      void registerInterestRegex(String regex, boolean isDurable, boolean receiveValues)
      Sends a request to the CacheServer to register interest in a regular expression pattern for this client. Updates to any keys of type String satisfying this regular expression by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. These keys are first locally cleared from the client and the current values for keys of type String that satisfy the regular expression are inserted into the local cache before this call returns.

      Note that if the regex is ".*" then all keys of any type will be pushed to the client.

      This method uses the default InterestResultPolicy.

      The regular expression string is compiled using the Pattern class.

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      regex - The regular expression on which to register interest.
      isDurable - true if the register interest is durable
      receiveValues - defaults to true. set to false to receive create or update events as invalidates similar to notify-by-subscription false.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 6.0.3
      See Also:

    • registerInterestRegex

      void registerInterestRegex(String regex, InterestResultPolicy policy, boolean isDurable)
      Sends a request to the CacheServer to register interest in a regular expression pattern for this client. Updates to any keys of type String satisfying this regular expression by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. These keys are first locally cleared from the client and the current values for keys of type String that satisfy the regular expression are inserted into the local cache before this call returns.

      The regular expression string is compiled using the Pattern class.

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      regex - The regular expression on which to register interest.
      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      isDurable - true if the register interest is durable
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 5.5
      See Also:

    • registerInterestRegex

      void registerInterestRegex(String regex, InterestResultPolicy policy, boolean isDurable, boolean receiveValues)
      Sends a request to the CacheServer to register interest in a regular expression pattern for this client. Updates to any keys of type String satisfying this regular expression by other clients will be pushed to this client by the CacheServer. This method is currently supported only on clients in a client server topology. These keys are first locally cleared from the client and the current values for keys of type String that satisfy the regular expression are inserted into the local cache before this call returns.

      The regular expression string is compiled using the Pattern class.

      If you locally-destroy a key and your region has concurrency-checks-enabled turned off you will not receive invalidation events from your interest subscription for that key. When concurrency-checks-enabled is turned on GemFire will accept invalidation and deliver these events to your client cache.

      Parameters:
      regex - The regular expression on which to register interest.
      policy - The interest result policy. This can be one of:
      • InterestResultPolicy.NONE - does not initialize the local cache
      • InterestResultPolicy.KEYS - initializes the local cache with the keys satisfying the request
      • InterestResultPolicy.KEYS_VALUES - initializes the local cache with the keys and current values satisfying the request
      isDurable - true if the register interest is durable
      receiveValues - defaults to true. set to false to receive create or update events as invalidates similar to notify-by-subscription false.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      SubscriptionNotEnabledException - if the region's pool does not have subscriptions enabled.
      UnsupportedOperationException - if the region is a replicate with distributed scope.
      Since:
      GemFire 6.0.3
      See Also:

    • getInterestListRegex

      List<String> getInterestListRegex()
      Returns the list of regular expresssions on which this client is interested and will be notified of changes. This method is currently supported only on clients in a client server topology.
      Returns:
      The list of regular expresssions on which this client is interested
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      Since:
      GemFire 4.2.3

    • keySetOnServer

      Set<K> keySetOnServer()
      Returns a set of keys in the region on the server.
      Returns:
      a Set of all the keys in the region on the server
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      Since:
      GemFire 5.0.2

    • containsKeyOnServer

      boolean containsKeyOnServer(Object key)
      Returns whether the specified key currently exists in this region on the server.
      Parameters:
      key - the key to check for an existing entry
      Returns:
      true if there is an entry in this region for the specified key on the server
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      Since:
      GemFire 5.0.2

    • sizeOnServer

      int sizeOnServer()
      Returns the number of entries present in this region on the server. Entries stored in this client region are ignored.
      Returns:
      the number of entries present in this region on the server.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      Since:
      Geode 1.2.0

    • isEmptyOnServer

      boolean isEmptyOnServer()
      Returns true if this region contains no entries on the server.
      Returns:
      true if this region contains no entries on the server.
      Throws:
      UnsupportedOperationException - if the region is not configured with a pool name.
      Since:
      Geode 1.2.0

    • putIfAbsent

      V putIfAbsent(K key, V value)
      If the specified key is not already associated with a value, associate it with the given value. This is equivalent to 
       if (!map.containsKey(key))
   return map.put(key, value);
 else
   return map.get(key);
      except that the action is performed atomically.

      ConcurrentMap operations are supported on partitioned and replicated regions and in client caches. They are also supported on non-empty local regions.

      Please read the notes on ConcurrentMap operations in the javadoc for Region.

      Region allows the value parameter to be null, which will create an invalid entry.

      Specified by:
      putIfAbsent in interface ConcurrentMap<K,V>
      Specified by:
      putIfAbsent in interface Map<K,V>
      Parameters:
      key - key with which the specified value is to be associated
      value - value to be associated with the specified key
      Returns:
      the previous value associated with the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)
      Throws:
      UnsupportedOperationException - if the put operation is not supported by this map
      ClassCastException - if the class of the specified key or value prevents it from being stored in this map
      NullPointerException - if the specified key or value is null, and this map does not permit null keys or values
      IllegalArgumentException - if some property of the specified key or value prevents it from being stored in this map
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region.
      LowMemoryException - if a low memory condition is detected.
      Since:
      GemFire 6.5

    • remove

      boolean remove(Object key, Object value)
      Removes the entry for a key only if currently mapped to a given value. This is equivalent to 
       if (map.containsKey(key) && map.get(key).equals(value)) {
   map.remove(key);
   return true;
 } else
   return false;
      except that the action is performed atomically.

      As of 8.5, if value is an Array then Arrays.equals or Arrays.deepEquals is used instead of Object.equals.

      ConcurrentMap operations are supported on partitioned and replicated regions and in client caches. They are also supported on non-empty local regions.

      Please read the notes on ConcurrentMap operations in the javadoc for Region.

      Region allows the value parameter to be null, which will match an invalid entry.

      Specified by:
      remove in interface ConcurrentMap<K,V>
      Specified by:
      remove in interface Map<K,V>
      Parameters:
      key - key with which the specified value is associated
      value - value expected to be associated with the specified key
      Returns:
      true if the value was removed
      Throws:
      UnsupportedOperationException - if the remove operation is not supported by this map
      ClassCastException - if the key or value is of an inappropriate type for this map (optional)
      NullPointerException - if the specified key or value is null, and this map does not permit null keys or values (optional)
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region.
      LowMemoryException - if a low memory condition is detected.
      Since:
      GemFire 6.5

    • replace

      boolean replace(K key, V oldValue, V newValue)
      Replaces the entry for a key only if currently mapped to a given value. This is equivalent to 
       if (map.containsKey(key) && map.get(key).equals(oldValue)) {
   map.put(key, newValue);
   return true;
 } else
   return false;
      except that the action is performed atomically.

      As of 8.5, if value is an Array then Arrays.equals or Arrays.deepEquals is used instead of Object.equals.

      ConcurrentMap operations are supported on partitioned and replicated regions and in client caches. They are also supported on non-empty local regions.

      Please read the notes on ConcurrentMap operations in the javadoc for Region.

      Region allows the oldValue parameter to be null, which will match an invalid entry.

      Specified by:
      replace in interface ConcurrentMap<K,V>
      Specified by:
      replace in interface Map<K,V>
      Parameters:
      key - key with which the specified value is associated
      oldValue - value expected to be associated with the specified key
      newValue - value to be associated with the specified key
      Returns:
      true if the value was replaced
      Throws:
      UnsupportedOperationException - if the replace operation is not supported by this map
      ClassCastException - if the class of a specified key or value prevents it from being stored in this map
      NullPointerException - if a specified key is null, and this map does not permit null keys
      IllegalArgumentException - if some property of a specified key or value prevents it from being stored in this map
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region.
      LowMemoryException - if a low memory condition is detected.
      Since:
      GemFire 6.5

    • replace

      V replace(K key, V value)
      Replaces the entry for a key only if currently mapped to some value. This is equivalent to 
       if (map.containsKey(key)) {
   return map.put(key, value);
 } else
   return null;
      except that the action is performed atomically.

      ConcurrentMap operations are supported on partitioned and replicated regions and in client caches. They are also supported on non-empty local regions.

      Please read the notes on ConcurrentMap operations in the javadoc for Region.

      Specified by:
      replace in interface ConcurrentMap<K,V>
      Specified by:
      replace in interface Map<K,V>
      Parameters:
      key - key with which the specified value is associated
      value - value to be associated with the specified key
      Returns:
      the previous value associated with the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)
      Throws:
      UnsupportedOperationException - if the put operation is not supported by this map
      ClassCastException - if the class of the specified key or value prevents it from being stored in this map
      NullPointerException - if the specified key or value is null, and this map does not permit null keys or values
      IllegalArgumentException - if some property of the specified key or value prevents it from being stored in this map
      LeaseExpiredException - if lease expired on distributed lock for Scope.GLOBAL
      TimeoutException - if timed out getting distributed lock for Scope.GLOBAL
      CacheWriterException - if a CacheWriter aborts the operation
      PartitionedRegionStorageException - if the operation could not be completed on a partitioned region.
      LowMemoryException - if a low memory condition is detected.
      Since:
      GemFire 6.5