Introduce Cache.putIfNoDuplicate function and unit tests

Author: RushanNanayakkara

components/claim-mgt/org.wso2.carbon.identity.claim.metadata.mgt/src/main/java/org/wso2/carbon/identity/claim/metadata/mgt/cache/LocalClaimCache.java

@@ -38,44 +38,4 @@ private LocalClaimCache() {
     public static LocalClaimCache getInstance() {
         return instance;
     }
-
-    /**
-     * Add a cache entry. Avoid adding entry if the current entry value is the same.
-     *
-     * @param key      Key which cache entry is indexed.
-     * @param entry    Actual object where cache entry is placed.
-     * @param tenantId The tenant Id where the cache is maintained.
-     */
-    @Override
-    public void addToCache(Integer key, ArrayList<LocalClaim> entry, int tenantId) {
-
-        if (key == null ) {
-            return;
-        }
-        ArrayList<LocalClaim> currentEntry = getValueFromCache(key, tenantId);
-        if (currentEntry != null && currentEntry.equals(entry)) {
-            return;
-        }
-        super.addToCache(key, entry, tenantId);
-    }
-
-    /**
-     * Add a cache entry. Avoid adding entry if the current entry value is the same.
-     *
-     * @param key      Key which cache entry is indexed.
-     * @param entry    Actual object where cache entry is placed.
-     * @param tenantDomain The tenant domain where the cache is maintained.
-     */
-    @Override
-    public void addToCache(Integer key, ArrayList<LocalClaim> entry, String tenantDomain) {
-
-        if (key == null ) {
-            return;
-        }
-        ArrayList<LocalClaim> currentEntry = getValueFromCache(key, tenantDomain);
-        if (currentEntry != null && currentEntry.equals(entry)) {
-            return;
-        }
-        super.addToCache(key, entry, tenantDomain);
-    }
 }

components/claim-mgt/org.wso2.carbon.identity.claim.metadata.mgt/src/main/java/org/wso2/carbon/identity/claim/metadata/mgt/dao/CacheBackedLocalClaimDAO.java

@@ -57,7 +57,7 @@ public List<LocalClaim> getLocalClaims(int tenantId) throws ClaimMetadataExcepti
                 log.debug("Cache miss for local claim list for tenant: " + tenantId);
             }
             localClaimList = localClaimDAO.getLocalClaims(tenantId);
-            localClaimInvalidationCache.addToCache(tenantId, new ArrayList<>(localClaimList), tenantId);
+            localClaimInvalidationCache.addToCacheIfNoDuplicate(tenantId, new ArrayList<>(localClaimList), tenantId);
         } else {
             if (log.isDebugEnabled()) {
                 log.debug("Cache hit for local claim list for tenant: " + tenantId);

components/claim-mgt/org.wso2.carbon.identity.claim.metadata.mgt/src/test/java/org/wso2/carbon/identity/claim/metadata/mgt/LocalClaimCacheTest.java

@@ -182,6 +182,52 @@ public void addToCache(K key, V entry, int tenantId) {
         }
     }
 
+    /**
+     * Add a cache entry if the same value is not already there.
+     *
+     * @param key   Key which cache entry is indexed.
+     * @param entry Actual object where cache entry is placed.
+     */
+    public void addToCacheIfNoDuplicate(K key, V entry, String tenantDomain) {
+
+        if (!isEnabled()) {
+            return;
+        }
+
+        try {
+            startTenantFlow(tenantDomain);
+            Cache<K, V> cache = getBaseCache();
+            if (cache != null) {
+                cache.putIfNoDuplicate(key, entry);
+            }
+        } finally {
+            PrivilegedCarbonContext.endTenantFlow();
+        }
+    }
+
+    /**
+     * Add a cache entry if the same value is not already there.
+     *
+     * @param key   Key which cache entry is indexed.
+     * @param entry Actual object where cache entry is placed.
+     */
+    public void addToCacheIfNoDuplicate(K key, V entry, int tenantId) {
+
+        if (!isEnabled()) {
+            return;
+        }
+
+        try {
+            startTenantFlow(tenantId);
+            Cache<K, V> cache = getBaseCache();
+            if (cache != null) {
+                cache.putIfNoDuplicate(key, entry);
+            }
+        } finally {
+            PrivilegedCarbonContext.endTenantFlow();
+        }
+    }
+
     /**
      * Retrieves a cache entry.
      *

components/identity-core/org.wso2.carbon.identity.core/src/main/java/org/wso2/carbon/identity/core/cache/BaseCache.java

@@ -90,6 +90,20 @@ public void testAddition() {
         assertNull(entry);
     }
 
+    @Test
+    public void testAdditionWithoutDuplicate() {
+
+        TestCache.getInstance().addToCacheIfNoDuplicate(new TestCacheKey("test"), new TestCacheEntry("value"), 1);
+
+        TestCacheEntry entry = TestCache.getInstance().getValueFromCache(new TestCacheKey("test"), 1);
+        assertEquals(entry.getValue(), "value");
+        entry = TestCache.getInstance().getValueFromCache(new TestCacheKey("test"), "foo.com");
+        assertEquals(entry.getValue(), "value");
+
+        entry = TestCache.getInstance().getValueFromCache(new TestCacheKey("test"), "bar.com");
+        assertNull(entry);
+    }
+
     @Test
     public void testUpdate() {