GEODE-231: Remove deprecated AttributesMutator.setCacheListener

Removed setCacheListener method from AttributesMutator and AbstractRegion. Changed tests to use either initCacheListeners or addCacheListener methods from AttributesMutator. This closes #507
apache · Jul 27, 2017 · e24438b · e24438b
1 parent 7dc15b2
commit e24438b
Show file tree

Hide file tree

Showing 20 changed files with 29 additions and 81 deletions.
diff --git a/geode-core/src/main/java/org/apache/geode/cache/AttributesMutator.java b/geode-core/src/main/java/org/apache/geode/cache/AttributesMutator.java
@@ -106,19 +106,6 @@ public interface AttributesMutator<K, V> {
    */
   public CustomExpiry<K, V> setCustomEntryIdleTimeout(CustomExpiry<K, V> custom);
 
-  /**
-   * Changes the CacheListener for the region. Removes listeners already added and calls
-   * {@link CacheCallback#close} on each of them.
-   * 
-   * @param aListener a user defined cache listener
-   * @return the previous CacheListener if a single one exists; otherwise null.
-   * @throws IllegalStateException if more than one cache listener has already been added
-   * @deprecated as of GemFire 5.0, use {@link #addCacheListener} or {@link #initCacheListeners}
-   *             instead.
-   */
-  @Deprecated
-  public CacheListener<K, V> setCacheListener(CacheListener<K, V> aListener);
-
   /**
    * Adds a cache listener to the end of the list of cache listeners on this region.
    * 

diff --git a/geode-core/src/main/java/org/apache/geode/cache/RegionRoleListener.java b/geode-core/src/main/java/org/apache/geode/cache/RegionRoleListener.java
@@ -25,7 +25,7 @@
  * 
  * @see AttributesFactory#setCacheListener
  * @see RegionAttributes#getCacheListener
- * @see AttributesMutator#setCacheListener
+ * @see AttributesMutator#addCacheListener
  * @deprecated this feature is scheduled to be removed
  */
 public interface RegionRoleListener<K, V> extends CacheListener<K, V> {

diff --git a/geode-core/src/main/java/org/apache/geode/internal/cache/AbstractRegion.java b/geode-core/src/main/java/org/apache/geode/internal/cache/AbstractRegion.java
@@ -855,42 +855,6 @@ public Region getRegion() {
     return this;
   }
 
-  @Override
-  public CacheListener setCacheListener(CacheListener aListener) {
-    checkReadiness();
-    CacheListener[] oldListeners;
-    synchronized (this.clSync) {
-      oldListeners = this.cacheListeners;
-      if (oldListeners != null && oldListeners.length > 1) {
-        throw new IllegalStateException(
-            LocalizedStrings.AbstractRegion_MORE_THAN_ONE_CACHE_LISTENER_EXISTS
-                .toLocalizedString());
-      }
-      this.cacheListeners = new CacheListener[] {aListener};
-    }
-    // moved the following out of the sync for bug 34512
-    CacheListener result = null;
-    if (oldListeners != null && oldListeners.length > 0) {
-      if (oldListeners.length == 1) {
-        result = oldListeners[0];
-      }
-      for (CacheListener oldListener : oldListeners) {
-        if (aListener != oldListener) {
-          closeCacheCallback(oldListener);
-        }
-      }
-      if (aListener == null) {
-        cacheListenersChanged(false);
-      }
-    } else { // we have no old listeners
-      if (aListener != null) {
-        // we have added a new listener
-        cacheListenersChanged(true);
-      }
-    }
-    return result;
-  }
-
   @Override
   public void addGatewaySenderId(String gatewaySenderId) {
     getGatewaySenderIds().add(gatewaySenderId);

diff --git a/geode-core/src/test/java/org/apache/geode/TXJUnitTest.java b/geode-core/src/test/java/org/apache/geode/TXJUnitTest.java
@@ -1061,7 +1061,7 @@ public int getAfterDestroyCalls(boolean fetchLocal) {
         return fetchLocal ? this.aLocalDestroyCalls : this.aDestroyCalls;
       }
     };
-    mutator.setCacheListener(cntListener);
+    mutator.addCacheListener(cntListener);
     CountingCacheWriter cntWriter = new CountingCacheWriter() {
       int bCreateCalls, bUpdateCalls, bDestroyCalls, bLocalDestroyCalls;
 
@@ -2928,7 +2928,7 @@ public void close() {
   public void testNoCallbacksOnRollback() throws CacheException {
     // install listeners
     AttributesMutator<String, String> mutator = this.region.getAttributesMutator();
-    mutator.setCacheListener(new CacheListenerAdapter<String, String>() {
+    mutator.addCacheListener(new CacheListenerAdapter<String, String>() {
       @Override
       public void close() {
         cbCount++;
@@ -3396,7 +3396,7 @@ public int getCallCount() {
     };
 
     vCl.setValidator(cbv);
-    mutator.setCacheListener(vCl);
+    mutator.addCacheListener(vCl);
 
     // CacheWriter
     ValidatableCacheWriter vCw = new ValidatableCacheWriter() {

diff --git a/geode-core/src/test/java/org/apache/geode/TXWriterTestCase.java b/geode-core/src/test/java/org/apache/geode/TXWriterTestCase.java
@@ -113,7 +113,7 @@ public static void afterClass() {
 
   void installCacheListenerAndWriter() {
     AttributesMutator<String, String> mutator = this.region.getAttributesMutator();
-    mutator.setCacheListener(new CacheListenerAdapter<String, String>() {
+    mutator.addCacheListener(new CacheListenerAdapter<String, String>() {
       @Override
       public void close() {
         cbCount++;

diff --git a/geode-core/src/test/java/org/apache/geode/cache/CacheListenerJUnitTest.java b/geode-core/src/test/java/org/apache/geode/cache/CacheListenerJUnitTest.java
@@ -155,11 +155,7 @@ public void testBasicMutator() throws Exception {
       fail("expected IllegalStateException");
     } catch (IllegalStateException expected) {
     }
-    try {
-      am.setCacheListener(cl1);
-      fail("expected IllegalStateException");
-    } catch (IllegalStateException expected) {
-    }
+
     am.removeCacheListener(cl1);
     assertEquals(Arrays.asList(new CacheListener[] {cl2}), Arrays.asList(ra.getCacheListeners()));
     am.removeCacheListener(cl1);

diff --git a/geode-core/src/test/java/org/apache/geode/cache/ConnectionPoolDUnitTest.java b/geode-core/src/test/java/org/apache/geode/cache/ConnectionPoolDUnitTest.java
@@ -3462,7 +3462,7 @@ public void run2() throws CacheException {
             null);
 
         region1 = createRegion(regionName1, regionFactory.create());
-        region1.getAttributesMutator().setCacheListener(new CertifiableTestCacheListener(
+        region1.getAttributesMutator().addCacheListener(new CertifiableTestCacheListener(
             org.apache.geode.test.dunit.LogWriterUtils.getLogWriter()));
       }
     };
@@ -5310,7 +5310,7 @@ public void afterInvalidate(EntryEvent e) {
                 .info("vm2 numberOfAfterInvalidates: " + numberOfAfterInvalidates);
           }
         };
-        region.getAttributesMutator().setCacheListener(listener);
+        region.getAttributesMutator().addCacheListener(listener);
         region.registerInterestRegex(".*", false, false);
       }
     });
@@ -5334,7 +5334,7 @@ public void afterInvalidate(EntryEvent e) {
             // getLogWriter().info("vm3 numberOfAfterInvalidates: " + numberOfAfterInvalidates);
           }
         };
-        region.getAttributesMutator().setCacheListener(listener);
+        region.getAttributesMutator().addCacheListener(listener);
         region.registerInterestRegex(".*", false, false);
       }
     });

diff --git a/geode-core/src/test/java/org/apache/geode/cache30/CacheLoaderTestCase.java b/geode-core/src/test/java/org/apache/geode/cache30/CacheLoaderTestCase.java
@@ -310,7 +310,7 @@ public void afterUpdate2(EntryEvent event) {
       }
     };
 
-    region.getAttributesMutator().setCacheListener(listener);
+    region.getAttributesMutator().addCacheListener(listener);
 
     region.put(key, newValue);
     Wait.pause(500);

diff --git a/geode-core/src/test/java/org/apache/geode/cache30/DiskRegionDUnitTest.java b/geode-core/src/test/java/org/apache/geode/cache30/DiskRegionDUnitTest.java
@@ -493,7 +493,7 @@ public void afterCreate2(EntryEvent event) {
       public void close2() {}
     };
 
-    region.getAttributesMutator().setCacheListener(listener);
+    region.getAttributesMutator().addCacheListener(listener);
 
     for (int i = 0; i < total; i++) {
       String value = (String) region.get(new Integer(i));
@@ -513,7 +513,7 @@ public void afterUpdate2(EntryEvent event) {
       }
     };
 
-    region.getAttributesMutator().setCacheListener(listener);
+    region.getAttributesMutator().addCacheListener(listener);
 
     for (int i = 0; i < 20; i++) {
       region.put(new Integer(i), new byte[i]);

diff --git a/geode-core/src/test/java/org/apache/geode/cache30/RegionAttributesTestCase.java b/geode-core/src/test/java/org/apache/geode/cache30/RegionAttributesTestCase.java
@@ -104,7 +104,7 @@ public Object load2(LoaderHelper helper) {
     assertEquals(region, mutator.getRegion());
     assertSame(region, mutator);
 
-    mutator.setCacheListener(listener);
+    mutator.addCacheListener(listener);
     mutator.setCacheLoader(loader);
     mutator.setCacheWriter(writer);
     mutator.setEntryIdleTimeout(entryIdle);
@@ -140,7 +140,8 @@ public Object load2(LoaderHelper helper) {
     ExpirationAttributes regionIdle2 = new ExpirationAttributes(7, ExpirationAction.DESTROY);
     ExpirationAttributes regionTTL2 = new ExpirationAttributes(8, ExpirationAction.INVALIDATE);
 
-    assertEquals(listener, mutator.setCacheListener(listener2));
+    mutator.initCacheListeners(new CacheListener[] {listener2});
+    assertEquals(listener2, attrs.getCacheListener());
     assertEquals(loader, mutator.setCacheLoader(loader2));
     assertEquals(writer, mutator.setCacheWriter(writer2));
     assertEquals(entryIdle, mutator.setEntryIdleTimeout(entryIdle2));

diff --git a/geode-core/src/test/java/org/apache/geode/internal/cache/DiskRegCbkChkJUnitTest.java b/geode-core/src/test/java/org/apache/geode/internal/cache/DiskRegCbkChkJUnitTest.java
@@ -50,7 +50,7 @@ public void testAfterCallbacks() {
         Scope.LOCAL);
 
     // testing create callbacks
-    region.getAttributesMutator().setCacheListener(new CacheListenerAdapter() {
+    region.getAttributesMutator().addCacheListener(new CacheListenerAdapter() {
       public void afterCreate(EntryEvent event) {
         intoCreateAfterCbk = true;
       }
@@ -64,7 +64,7 @@ public void beforeCreate(EntryEvent event) {
     assertTrue("Create callback not called", intoCreateAfterCbk);
 
     // testing update callbacks
-    region.getAttributesMutator().setCacheListener(new CacheListenerAdapter() {
+    region.getAttributesMutator().addCacheListener(new CacheListenerAdapter() {
       public void afterUpdate(EntryEvent event) {
         intoUpdateAfterCbk = true;
       }
@@ -79,7 +79,7 @@ public void beforeUpdate(EntryEvent event) {
     assertTrue("Update callback not called", intoUpdateAfterCbk);
 
     // testing destroy callbacks
-    region.getAttributesMutator().setCacheListener(new CacheListenerAdapter() {
+    region.getAttributesMutator().addCacheListener(new CacheListenerAdapter() {
       public void afterDestroy(EntryEvent event) {
         intoDestroyAfterCbk = true;
       }

diff --git a/geode-core/src/test/java/org/apache/geode/internal/cache/DiskRegionJUnitTest.java b/geode-core/src/test/java/org/apache/geode/internal/cache/DiskRegionJUnitTest.java
@@ -1527,7 +1527,7 @@ public void run() {
       }
     });
 
-    region.getAttributesMutator().setCacheListener(new CacheListenerAdapter() {
+    region.getAttributesMutator().addCacheListener(new CacheListenerAdapter() {
       public void afterCreate(EntryEvent event) {
         th.start();
       }

diff --git a/geode-core/src/test/java/org/apache/geode/internal/cache/MapInterface2JUnitTest.java b/geode-core/src/test/java/org/apache/geode/internal/cache/MapInterface2JUnitTest.java
@@ -110,7 +110,7 @@ public void testBasicMapClearTrnxn() {
   public void testBasicMapAfterClearCalback() {
     Region rgn = CacheUtils.getRegion("Portfolios");
     AttributesMutator atm = rgn.getAttributesMutator();
-    atm.setCacheListener(new CacheListenerAdapter() {
+    atm.addCacheListener(new CacheListenerAdapter() {
 
       public void afterRegionClear(RegionEvent event) {
         synchronized (MapInterface2JUnitTest.this) {

diff --git a/...ore/src/test/java/org/apache/geode/internal/cache/tier/sockets/InterestListDUnitTest.java b/...ore/src/test/java/org/apache/geode/internal/cache/tier/sockets/InterestListDUnitTest.java
@@ -676,7 +676,7 @@ private static void addCacheLoader() {
   private static void addCacheListener(int expectedCreates) {
     // Add a cache listener to count the number of create and update events
     Region region = cache.getRegion(REGION_NAME);
-    region.getAttributesMutator().setCacheListener(new EventCountingCacheListener(expectedCreates));
+    region.getAttributesMutator().addCacheListener(new EventCountingCacheListener(expectedCreates));
   }
 
   private static void doGets(int numGets) {

diff --git a/geode-cq/src/test/java/org/apache/geode/cache/query/cq/dunit/CqDataDUnitTest.java b/geode-cq/src/test/java/org/apache/geode/cache/query/cq/dunit/CqDataDUnitTest.java
@@ -461,7 +461,7 @@ public void run2() throws CacheException {
           Region region = createRegion(cqDUnitTest.regions[i], factory.createRegionAttributes());
           // Set CacheListener.
           region.getAttributesMutator()
-              .setCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
+              .addCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
         }
         Wait.pause(2000);
 

diff --git a/geode-cq/src/test/java/org/apache/geode/cache/query/cq/dunit/CqDataUsingPoolDUnitTest.java b/geode-cq/src/test/java/org/apache/geode/cache/query/cq/dunit/CqDataUsingPoolDUnitTest.java
@@ -475,7 +475,7 @@ public void run2() throws CacheException {
           Region region = createRegion(cqDUnitTest.regions[i], factory.createRegionAttributes());
           // Set CacheListener.
           region.getAttributesMutator()
-              .setCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
+              .addCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
         }
         Wait.pause(2000);
 

diff --git a/geode-cq/src/test/java/org/apache/geode/cache/query/cq/dunit/CqQueryDUnitTest.java b/geode-cq/src/test/java/org/apache/geode/cache/query/cq/dunit/CqQueryDUnitTest.java
@@ -973,7 +973,7 @@ public void run2() throws CacheException {
         try {
           region = getRootRegion().getSubregion(regionName);
           region.getAttributesMutator()
-              .setCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
+              .addCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
         } catch (Exception cqe) {
           AssertionError err = new AssertionError("Failed to get Region.");
           err.initCause(cqe);

diff --git a/geode-cq/src/test/java/org/apache/geode/cache/query/cq/dunit/CqQueryUsingPoolDUnitTest.java b/geode-cq/src/test/java/org/apache/geode/cache/query/cq/dunit/CqQueryUsingPoolDUnitTest.java
@@ -843,7 +843,7 @@ public void run2() throws CacheException {
         try {
           region = getRootRegion().getSubregion(regionName);
           region.getAttributesMutator()
-              .setCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
+              .addCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
         } catch (Exception cqe) {
           fail("Failed to get Region.", cqe);
         }

diff --git a/geode-cq/src/test/java/org/apache/geode/cache/query/dunit/QueryIndexUpdateRIDUnitTest.java b/geode-cq/src/test/java/org/apache/geode/cache/query/dunit/QueryIndexUpdateRIDUnitTest.java
@@ -492,7 +492,7 @@ public void run2() throws CacheException {
             region = getRootRegion().getSubregion(regionName);
           }
           region.getAttributesMutator()
-              .setCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
+              .addCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
         } catch (Exception cqe) {
           AssertionError err = new AssertionError("Failed to get Region.");
           err.initCause(cqe);
@@ -537,7 +537,7 @@ public void run2() throws CacheException {
             region = getRootRegion().getSubregion(regionName);
           }
           region.getAttributesMutator()
-              .setCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
+              .addCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
         } catch (Exception cqe) {
           AssertionError err = new AssertionError("Failed to get Region.");
           err.initCause(cqe);
@@ -802,7 +802,7 @@ public void run2() throws CacheException {
             region = getRootRegion().getSubregion(regionName);
           }
           region.getAttributesMutator()
-              .setCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
+              .addCacheListener(new CertifiableTestCacheListener(LogWriterUtils.getLogWriter()));
         } catch (Exception cqe) {
           AssertionError err = new AssertionError("Failed to get Region.");
           err.initCause(cqe);

diff --git a/geode-cq/src/test/java/org/apache/geode/internal/cache/ha/CQListGIIDUnitTest.java b/geode-cq/src/test/java/org/apache/geode/internal/cache/ha/CQListGIIDUnitTest.java
@@ -425,7 +425,7 @@ public static void registerInterestListCQ(String regionName, int keySize) {
     Region region = null;
     try {
       region = cache.getRegion("root").getSubregion(regionName);
-      region.getAttributesMutator().setCacheListener(new CertifiableTestCacheListener(
+      region.getAttributesMutator().addCacheListener(new CertifiableTestCacheListener(
           org.apache.geode.test.dunit.LogWriterUtils.getLogWriter()));
     } catch (Exception e) {
       fail("Failed to get Region.", e);