Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 545FD200BB7 for ; Wed, 26 Oct 2016 00:19:12 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 52E69160B04; Tue, 25 Oct 2016 22:19:12 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id C565A160AD8 for ; Wed, 26 Oct 2016 00:19:09 +0200 (CEST) Received: (qmail 60621 invoked by uid 500); 25 Oct 2016 22:19:09 -0000 Mailing-List: contact commits-help@geode.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.incubator.apache.org Delivered-To: mailing list commits@geode.incubator.apache.org Received: (qmail 60612 invoked by uid 99); 25 Oct 2016 22:19:08 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 25 Oct 2016 22:19:08 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 64B13C6C8B for ; Tue, 25 Oct 2016 22:19:08 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -5.019 X-Spam-Level: X-Spam-Status: No, score=-5.019 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, KAM_MANYCOMMENTS=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-2.999] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id rUin9wrwHsh9 for ; Tue, 25 Oct 2016 22:19:02 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 6A9605FB57 for ; Tue, 25 Oct 2016 22:19:01 +0000 (UTC) Received: (qmail 72432 invoked by uid 99); 25 Oct 2016 21:51:58 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 25 Oct 2016 21:51:58 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 113C2E0BCE; Tue, 25 Oct 2016 21:51:58 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: sbawaskar@apache.org To: commits@geode.incubator.apache.org Date: Tue, 25 Oct 2016 21:52:00 -0000 Message-Id: <494ab34cba544a469bdf0fb9f7d4dfee@git.apache.org> In-Reply-To: <4e2243667d854ff08eecf532f23fe07d@git.apache.org> References: <4e2243667d854ff08eecf532f23fe07d@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [03/51] [abbrv] [partial] incubator-geode git commit: Adding javadocs for the 1.0.0-incubating release archived-at: Tue, 25 Oct 2016 22:19:12 -0000 http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionFactory.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionFactory.html b/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionFactory.html new file mode 100644 index 0000000..72914ba --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionFactory.html @@ -0,0 +1,697 @@ + + + + + +DynamicRegionFactory (Apache Geode (incubating) 1.0.0-incubating) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.geode.cache
+

Class DynamicRegionFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.apache.geode.cache.DynamicRegionFactory
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class DynamicRegionFactory
+extends java.lang.Object
    +
    DynamicRegionFactory provides a distributed region creation service. + Any other member of the GemFire DistributedSystem that has created + an instance of this class will automatically instantiate regions created + through the factory from anywhere else in the DistributedSystem. +

    + Instructions for Use:
    +

      +
    • If your application is a client in a client/server installation, + either specify the pool name in the + DynamicRegionFactory.Config you'll use to create a + DynamicRegionFactory or specify it + in a dynamic-region-factory element in your cache.xml. + +
    • Before you've created a GemFire Cache in your application, add a + line of code as follows:
      + 
        DynamicRegionFactory factory = DynamicRegionFactory.get();
+  factory.open(config);
      + 
        DynamicRegionFactory myFactoryHandle = DynamicRegionFactory.get().open(config);
      + or just use a dynamic-region-factory element in the cache.xml. + +
    • Create the GemFire Cache. During cache creation, the list of dynamic Regions will either be discovered + by recovering + their names from disk (see DynamicRegionFactory.Config.persistBackup) or from other members of the + distributed system. + These dynamic Regions will be created before Cache creation completes. + +
    • Thereafter, when you want to create dynamic distributed Regions, + create them using the createDynamicRegion(java.lang.String, java.lang.String). Regions created with the factory will + inherit their RegionAttributes from their parent Region, though you can override + callbacks when you configure the factory. + +

      All other instances of GemFire across the distributed system that + instantiate and open a DynamicRegionFactory will also get the dynamic distributed Regions. + +

    • Non-dynamic parent Regions should be declared in cache.xml so that they can be created before + the dynamic Region factory goes active and starts creating Regions. You will have cache creation + problems if this isn't done. + +
    • A DynamicRegionListener can be registered before open is called and before cache creation + so that the listener will be called if dynamic Regions are created during cache creation. + +
    +

    Saving the factory on disk: + If DynamicRegionFactory.Config.persistBackup is configured for the factory, dynamic Region information + is written to disk for recovery. + By default the current directory is used for this information. The DynamicRegionFactory.Config.diskDir + can be used to change this default. +

    + Registering interest in cache server information: The DynamicRegionFactory.Config.registerInterest + setting determines whether clients will register interest in server keys or not. You will generally want + this to be turned on so that clients will see updates made to servers. In server processes, DynamicRegionFactory + forces use of NotifyBySubscription. +

+

+ Notes: +

    +
  • DynamicRegionFactories in non-client VMs must not be configured with a pool. +
  • If open() is called before cache creation and the cache.xml has a dynamic-region-factory + element then the cache.xml will override the open call's configuration. + +
  • Since the RegionAttributes of a dynamically created Region are copied + from the parent Region, any callbacks, (CacheListener, + CacheWriter, and CacheLoader + are shared by the parent and all its dynamic children + so make sure the callback is thread-safe and that its + CacheCallback.close() implementation does not stop it from functioning. + However the products LRUAlgorithm instances will + be cloned so that each dynamic Region has its own callback. + +
  • The root Region name "DynamicRegions" is reserved. The factory creates a root Region of + that name and uses it to keep track of what dynamic Regions exist. Applications should + not directly access this Region; instead use the methods on this factory. +
+
+
Since:
+
GemFire 4.3
+
+ + +
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class DynamicRegionFactory.Config +
      Configuration for dynamic region factory.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringdynamicRegionListName 
      +
      • +
    + + + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        dynamicRegionListName

        +
        public static final java.lang.String dynamicRegionListName
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DynamicRegionFactory

        +
        public DynamicRegionFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        open

        +
        public void open()
        +
        Opens the DynamicRegionFactory with default settings.
        +
        • +
      + + + +
        +
      • +

        open

        +
        public void open(DynamicRegionFactory.Config conf)
        +
        Opens the factory with the given settings. + This should be sent to the factory before creating a cache. The cache + will otherwise open a factory with default settings. + This does not need to be sent if the cache.xml declares the use of dynamic regions.
        +
        +
        Parameters:
        +
        conf - the configuration for this factory.
        +
        +
        • +
      + + + +
        +
      • +

        _close

        +
        protected void _close()
        +
        Closes the dynamic region factory, disabling any further creation or + destruction of dynamic regions in this cache.
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
        +
        Returns true if dynamic region factory is open; false if closed.
        +
        • +
      + + + +
        +
      • +

        isActive

        +
        public boolean isActive()
        +
        Returns true if this factory is open and can produce dynamic regions. + Factories are only active after their cache has been created.
        +
        • +
      + + + +
        +
      • +

        isClosed

        +
        public boolean isClosed()
        +
        Returns true if dynamic region factory is closed.
        +
        • +
      + + + +
        +
      • +

        getConfig

        +
        public DynamicRegionFactory.Config getConfig()
        +
        Returns the configuration for this factory. + Returns null if the factory is closed;
        +
        • +
      + + + +
        +
      • +

        regionIsDynamicRegionList

        +
        public static boolean regionIsDynamicRegionList(java.lang.String regionPath)
        +
        • +
      + + + +
        +
      • +

        _internalInit

        +
        protected void _internalInit(org.apache.geode.internal.cache.GemFireCacheImpl theCache)
+                      throws CacheException
        +
        The method is for internal use only. It is called implicitly during cache creation.
        +
        +
        Parameters:
        +
        theCache - The GemFire Cache
        +
        Throws:
        +
        CacheException
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static DynamicRegionFactory get()
        +
        Returns the DynamicRegionFactory singleton instance.
        +
        +
        Returns:
        +
        the DynamicRegionFactory singleton instance
        +
        +
        • +
      + + + +
        +
      • +

        registerDynamicRegionListener

        +
        public void registerDynamicRegionListener(DynamicRegionListener listener)
        +
        Registers a DynamicRegionListener for callbacks.
        +
        +
        Parameters:
        +
        listener - The DynamicRegionListener to be registered
        +
        +
        • +
      + + + +
        +
      • +

        unregisterDynamicRegionListener

        +
        public void unregisterDynamicRegionListener(DynamicRegionListener listener)
        +
        Unregisters a DynamicRegionListener for callbacks.
        +
        +
        Parameters:
        +
        listener - The DynamicRegionListener to be unregistered
        +
        +
        • +
      + + + +
        +
      • +

        createDynamicRegion

        +
        public Region createDynamicRegion(java.lang.String parentRegionName,
+                                  java.lang.String regionName)
+                           throws CacheException
        +
        Creates the dynamic Region in the local cache and distributes the + creation to other caches.
        +
        +
        Parameters:
        +
        parentRegionName - the new region is created as a subregion of the region having this path
        +
        regionName - the name of the new subregion
        +
        Returns:
        +
        the Region created
        +
        Throws:
        +
        CacheException
        +
        +
        • +
      + + + +
        +
      • +

        destroyDynamicRegion

        +
        public void destroyDynamicRegion(java.lang.String fullRegionName)
+                          throws CacheException
        +
        Destroys the dynamic Region in the local cache and distributes the + destruction to other caches.
        +
        +
        Parameters:
        +
        fullRegionName - The full path of the Region to be + dynamically destroyed
        +
        Throws:
        +
        CacheException
        +
        RegionDestroyedException - if the dynamic region was never created + or has already been destroyed
        +
        +
        • +
      + + + +
        +
      • +

        buildDynamicRegion

        +
        protected void buildDynamicRegion(EntryEvent event)
        +
        • +
      + + + +
        +
      • +

        razeDynamicRegion

        +
        protected void razeDynamicRegion(EntryEvent event)
        +
        • +
      +
      • +
    +
    • +
+
+ + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionListener.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionListener.html b/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionListener.html new file mode 100644 index 0000000..fe7e30e --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionListener.html @@ -0,0 +1,308 @@ + + + + + +DynamicRegionListener (Apache Geode (incubating) 1.0.0-incubating) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.geode.cache
+

Interface DynamicRegionListener

+
+
+
+
    +
  • +
    +
    +
    public interface DynamicRegionListener
    +
    DynamicRegionListener is an interface that can be + implemented to handle dynamic region-related events. + + The methods on a DynamicRegionListener are invoked synchronously. + If the listener method takes a long time to execute then it will cause the + operation that caused it to be invoked to take a long time. +

    + Note: It is possible to receive duplicate create events when the DynamicRegionFactory + goes active due to Cache creation. +

    + See DynamicRegionFactory

    +
    +
    Since:
    +
    GemFire 4.3
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        beforeRegionCreate

        +
        void beforeRegionCreate(java.lang.String parentRegionName,
+                        java.lang.String regionName)
        +
        Handles the 'before region creation' event of a dynamic region. This method + is invoked before the dynamic region is created in the local VM.
        +
        +
        Parameters:
        +
        parentRegionName - The name of the parent region
        +
        regionName - The name of the region being created
        +
        +
        • +
      + + + +
        +
      • +

        afterRegionCreate

        +
        void afterRegionCreate(RegionEvent<?,?> event)
        +
        Handles the 'after region creation' event of a dynamic region. This method + is invoked after the dynamic region is created in the local VM.
        +
        +
        Parameters:
        +
        event - A RegionEvent describing the event
        +
        +
        • +
      + + + +
        +
      • +

        beforeRegionDestroy

        +
        void beforeRegionDestroy(RegionEvent<?,?> event)
        +
        Handles the 'before region destroyed' event of a dynamic region. This method + is invoked before the dynamic region is destroyed in the local VM.
        +
        +
        Parameters:
        +
        event - A RegionEvent describing the event
        +
        +
        • +
      + + + +
        +
      • +

        afterRegionDestroy

        +
        void afterRegionDestroy(RegionEvent<?,?> event)
        +
        Handles the 'after region destroyed' event of a dynamic region. This method + is invoked after the dynamic region is destroyed in the local VM.
        +
        +
        Parameters:
        +
        event - A RegionEvent describing the event
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/EntryDestroyedException.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/EntryDestroyedException.html b/releases/latest/javadoc/org/apache/geode/cache/EntryDestroyedException.html new file mode 100644 index 0000000..28a5a34 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/EntryDestroyedException.html @@ -0,0 +1,358 @@ + + + + + +EntryDestroyedException (Apache Geode (incubating) 1.0.0-incubating) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.geode.cache
+

Class EntryDestroyedException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class EntryDestroyedException
+extends CacheRuntimeException
    +
    Indicates that a method was invoked on an entry that has been destroyed.
    +
    +
    Since:
    +
    GemFire 3.0
    +
    See Also:
    +
    Region.Entry, +Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      EntryDestroyedException() +
      Constructs a new EntryDestroyedException.
      +
      EntryDestroyedException(java.lang.String s) +
      Constructs a new EntryDestroyedException with the message.
      +
      EntryDestroyedException(java.lang.String s, + java.lang.Throwable ex) +
      Constructs a new EntryDestroyedException with a detailed message + and a causal exception.
      +
      EntryDestroyedException(java.lang.Throwable ex) +
      Construct a EntryDestroyedException with a cause.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntryDestroyedException

        +
        public EntryDestroyedException()
        +
        Constructs a new EntryDestroyedException.
        +
        • +
      + + + +
        +
      • +

        EntryDestroyedException

        +
        public EntryDestroyedException(java.lang.String s)
        +
        Constructs a new EntryDestroyedException with the message.
        +
        +
        Parameters:
        +
        s - the detailed message for this exception
        +
        +
        • +
      + + + +
        +
      • +

        EntryDestroyedException

        +
        public EntryDestroyedException(java.lang.String s,
+                               java.lang.Throwable ex)
        +
        Constructs a new EntryDestroyedException with a detailed message + and a causal exception.
        +
        +
        Parameters:
        +
        s - the message
        +
        ex - a causal Throwable
        +
        +
        • +
      + + + +
        +
      • +

        EntryDestroyedException

        +
        public EntryDestroyedException(java.lang.Throwable ex)
        +
        Construct a EntryDestroyedException with a cause.
        +
        +
        Parameters:
        +
        ex - the causal Throwable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/EntryEvent.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/EntryEvent.html b/releases/latest/javadoc/org/apache/geode/cache/EntryEvent.html new file mode 100644 index 0000000..108d412 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/EntryEvent.html @@ -0,0 +1,562 @@ + + + + + +EntryEvent (Apache Geode (incubating) 1.0.0-incubating) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.geode.cache
+

Interface EntryEvent<K,V>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    CacheEvent<K,V>
    +
    +
    +
    All Known Subinterfaces:
    +
    TimestampedEntryEvent
    +
    +
    +
    +
    public interface EntryEvent<K,V>
+extends CacheEvent<K,V>
    +
    Contains information about an event affecting an entry, including + its identity and the the circumstances of the event. + It is passed in to CacheListener, CapacityController, and CacheWriter. +

    + If this event originated from a region stored off heap then this event can + only be used as long as the notification method that obtained it has not returned. + For example in your implementation of CacheListener.afterUpdate(EntryEvent) the event parameter + is only valid until your afterUpdate method returns. It is not safe to store instances of this + class and use them later when using off heap storage. + Attempts to access off-heap data from this event after it has expired will result in an + IllegalStateException.

    +
    +
    Since:
    +
    GemFire 3.0
    +
    See Also:
    +
    CacheListener, +CacheWriter, +RegionEvent
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKey

        +
        K getKey()
        +
        Returns the key.
        +
        +
        Returns:
        +
        the key
        +
        +
        • +
      + + + +
        +
      • +

        getOldValue

        +
        V getOldValue()
        +
        Returns the value in the cache prior to this event. + When passed to an event handler after an event occurs, this value + reflects the value that was in the cache in this VM, not necessarily + the value that was in the cache VM that initiated the operation. + In certain scenarios the old value may no longer be available in which + case null is returned. + This can happen for disk regions when the old value is on disk only.
        +
        +
        Returns:
        +
        the old value in the cache prior to this event. + If the entry did not exist, was invalid, or was not available, + then null is returned.
        +
        Throws:
        +
        java.lang.IllegalStateException - if off-heap and called after the method that was passed this EntryEvent returns.
        +
        +
        • +
      + + + +
        +
      • +

        getSerializedOldValue

        +
        SerializedCacheValue<V> getSerializedOldValue()
        +
        Returns the serialized form of the value in the cache before this event.
        +
        +
        Returns:
        +
        the serialized form of the value in the cache before this event
        +
        Throws:
        +
        java.lang.IllegalStateException - if off-heap and called after the method that was passed this EntryEvent returns.
        +
        Since:
        +
        GemFire 5.5
        +
        +
        • +
      + + + +
        +
      • +

        getNewValue

        +
        V getNewValue()
        +
        Returns the value in the cache after this event.
        +
        +
        Returns:
        +
        the value in the cache after this event
        +
        Throws:
        +
        java.lang.IllegalStateException - if off-heap and called after the method that was passed this EntryEvent returns.
        +
        +
        • +
      + + + +
        +
      • +

        getSerializedNewValue

        +
        SerializedCacheValue<V> getSerializedNewValue()
        +
        Returns the serialized form of the value in the cache after this event.
        +
        +
        Returns:
        +
        the serialized form of the value in the cache after this event
        +
        Throws:
        +
        java.lang.IllegalStateException - if off-heap and called after the method that was passed this EntryEvent returns.
        +
        Since:
        +
        GemFire 5.5
        +
        +
        • +
      + + + +
        +
      • +

        isLocalLoad

        +
        @Deprecated
+boolean isLocalLoad()
        +
        Deprecated. as of GemFire 5.0, use Operation.isLocalLoad() instead.
        +
        Returns true if this event resulted from a loader running in this cache. + Note that this will be true even if the local loader called netSearch. + + If this event is for a Partitioned Region, then true will be returned if the + loader ran in the same VM as where the data is hosted. If true is returned, and CacheEvent.isOriginRemote() + is true, it means the data is not hosted locally, but the loader was run local to the data.
        +
        +
        Returns:
        +
        true if this event resulted from local loader execution
        +
        +
        • +
      + + + +
        +
      • +

        isNetLoad

        +
        @Deprecated
+boolean isNetLoad()
        +
        Deprecated. as of GemFire 5.0, use Operation.isNetLoad() instead.
        +
        Returns true if this event resulted from a loader running that was remote + from the cache that requested it, i.e., a netLoad. Note that the cache + that requested the netLoad may not be this cache in which case + isOriginRemote will also return true.
        +
        +
        Returns:
        +
        true if this event resulted from a netLoad
        +
        +
        • +
      + + + +
        +
      • +

        isLoad

        +
        @Deprecated
+boolean isLoad()
        +
        Deprecated. as of GemFire 5.0, use Operation.isLoad() instead.
        +
        Returns true if this event resulted from a loader.
        +
        +
        Returns:
        +
        true if isLocalLoad or isNetLoad
        +
        +
        • +
      + + + +
        +
      • +

        isNetSearch

        +
        @Deprecated
+boolean isNetSearch()
        +
        Deprecated. as of GemFire 5.0, use Operation.isNetSearch() instead.
        +
        Returns true if this event resulted from a netSearch. If the netSearch + was invoked by a loader however, this will return false and isLocalLoad() + or isNetLoad() will return true instead.
        +
        +
        Returns:
        +
        true if this event resulted from a netSearch
        +
        +
        • +
      + + + +
        +
      • +

        getTransactionId

        +
        TransactionId getTransactionId()
        +
        Gets the TransactionId for this EntryEvent.
        +
        +
        Returns:
        +
        the ID of the transaction that performed the operation that + generated this event; null if no transaction involved.
        +
        Since:
        +
        GemFire 4.0
        +
        +
        • +
      + + + +
        +
      • +

        isBridgeEvent

        +
        @Deprecated
+boolean isBridgeEvent()
        +
        Deprecated. as of 5.7 use hasClientOrigin() instead.
        +
        Returns true if this event originated on a client.
        +
        +
        Returns:
        +
        true if this event originated on a client.
        +
        Since:
        +
        GemFire 5.1
        +
        +
        • +
      + + + +
        +
      • +

        hasClientOrigin

        +
        boolean hasClientOrigin()
        +
        Returns true if this event originated on a client.
        +
        +
        Returns:
        +
        true if this event originated on a client.
        +
        Since:
        +
        GemFire 5.7
        +
        +
        • +
      + + + +
        +
      • +

        isOldValueAvailable

        +
        boolean isOldValueAvailable()
        +
        Returns true if the old value is "available". + Not available means that an old value existed but it could not be obtained + or it was deemed too expensive to obtain. + Note that getOldValue() will return null when this + method returns false.
        +
        +
        Since:
        +
        GemFire 6.0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +