SAK-31645 replace duplicated cache evict method with a common one. Fi…

…x a few other broken windows (sakaiproject#3148)

profile2/api/src/java/org/sakaiproject/profile2/cache/CacheManager.java

@@ -30,5 +30,14 @@ public interface CacheManager {
 	 * @param cacheName
 	 * @return
 	 */
-	public Cache createCache(String cacheName);
+	@SuppressWarnings("rawtypes")
+	Cache createCache(String cacheName);
+
+	/**
+	 * Helper to evict an item from a given cache. 
+	 * @param cache the cache to evict from
+	 * @param cacheKey	the id for the data in the cache
+	 */
+	@SuppressWarnings("rawtypes")
+	void evictFromCache(Cache cache, String cacheKey);
 }

profile2/impl/src/java/org/sakaiproject/profile2/cache/CacheManagerImpl.java

@@ -15,10 +15,12 @@
  */
 package org.sakaiproject.profile2.cache;
 
-import lombok.Setter;
-
 import org.sakaiproject.memory.api.Cache;
 import org.sakaiproject.memory.api.MemoryService;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import lombok.Setter;
 
 /**
  * Implementation of CacheManager for Profile2.
@@ -28,13 +30,22 @@
  */
 public class CacheManagerImpl implements CacheManager {
 
-	/**
- 	* {@inheritDoc}
- 	*/
+	private static final Logger log = LoggerFactory.getLogger(CacheManagerImpl.class);
+
+	@Override
+	@SuppressWarnings("rawtypes")
 	public Cache createCache(String cacheName) {
-		return memoryService.newCache(cacheName);
+		return memoryService.getCache(cacheName);
 	}
-
+
+	@Override
+	@SuppressWarnings({"unchecked", "rawtypes"})
+	public void evictFromCache(Cache cache, String cacheKey) {
+		cache.remove(cacheKey);
+		log.debug("Evicted data in cache: " + cache.getName() + ", key: " + cacheKey);
+	}
+
 	@Setter
 	private MemoryService memoryService;
+
 }

profile2/impl/src/java/org/sakaiproject/profile2/logic/ProfileConnectionsLogicImpl.java

@@ -295,8 +295,8 @@ public boolean confirmFriendRequest(final String fromUser, final String toUser)
 			sakaiProxy.postEvent(ProfileConstants.EVENT_FRIEND_CONFIRM, "/profile/"+fromUser, true);
 
 			//invalidate the confirmed connection caches for each user as they are now stale
-			evictFromCache(fromUser);
-			evictFromCache(toUser);
+			this.cacheManager.evictFromCache(this.cache, fromUser);
+			this.cacheManager.evictFromCache(this.cache, toUser);
 
 			return true;
 		} 
@@ -371,8 +371,8 @@ public boolean removeFriend(String userId, String friendId) {
 			log.info("User: " + userId + " removed friend: " + friendId);  
 
 			//invalidate the confirmed connection caches for each user as they are now stale
-			evictFromCache(userId);
-			evictFromCache(friendId);
+			this.cacheManager.evictFromCache(this.cache, userId);
+			this.cacheManager.evictFromCache(this.cache, friendId);
 
 			return true;
 		}
@@ -538,7 +538,7 @@ private List<String> getConfirmedConnectionUserIdsForUser(final String userUuid)
 			if(userUuids == null) {
 				// This means that the cache has expired. evict the key from the cache
 				log.debug("Connections cache appears to have expired for " + userUuid);
-				evictFromCache(userUuid);
+				this.cacheManager.evictFromCache(this.cache, userUuid);
 			}
 		}
 		if(userUuids == null) {
@@ -605,16 +605,6 @@ private void sendConnectionEmailNotification(String toUuid, final String fromUui
 
 	}
 
-	/**
-	 * Helper to evict an item from a cache. 
-	 * @param cacheKey	the id for the data in the cache
-	 */
-	private void evictFromCache(String cacheKey) {
-		cache.remove(cacheKey);
-		log.debug("Evicted data in cache for key: " + cacheKey);
-	}
-
-
 	public void init() {
 		cache = cacheManager.createCache(CACHE_NAME);
 	}

profile2/impl/src/java/org/sakaiproject/profile2/logic/ProfileExternalIntegrationLogicImpl.java

@@ -18,16 +18,15 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import lombok.Setter;
-
 import org.apache.commons.lang.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.sakaiproject.profile2.dao.ProfileDao;
 import org.sakaiproject.profile2.model.ExternalIntegrationInfo;
 import org.sakaiproject.profile2.util.ProfileConstants;
 import org.sakaiproject.profile2.util.ProfileUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
+import lombok.Setter;
 import twitter4j.Twitter;
 import twitter4j.TwitterException;
 import twitter4j.TwitterFactory;
@@ -52,6 +51,7 @@ public class ProfileExternalIntegrationLogicImpl implements ProfileExternalInteg
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public ExternalIntegrationInfo getExternalIntegrationInfo(String userUuid) {
 		ExternalIntegrationInfo info = dao.getExternalIntegrationInfo(userUuid);
 		if(info != null) {
@@ -63,6 +63,7 @@ public ExternalIntegrationInfo getExternalIntegrationInfo(String userUuid) {
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public boolean updateExternalIntegrationInfo(ExternalIntegrationInfo info) {
 		if(dao.updateExternalIntegrationInfo(info)){
 			log.info("ExternalIntegrationInfo updated for user: " + info.getUserUuid());
@@ -74,6 +75,7 @@ public boolean updateExternalIntegrationInfo(ExternalIntegrationInfo info) {
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public Map<String,String> getTwitterOAuthConsumerDetails() {
 
 		Map<String,String> map = new HashMap<String,String>();
@@ -86,6 +88,7 @@ public Map<String,String> getTwitterOAuthConsumerDetails() {
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public String getTwitterName(ExternalIntegrationInfo info) {
 
 		if(info == null){
@@ -123,13 +126,15 @@ public String getTwitterName(ExternalIntegrationInfo info) {
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public boolean validateTwitterCredentials(ExternalIntegrationInfo info) {
 		return StringUtils.isNotBlank(getTwitterName(info));
 	}
 
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public void sendMessageToTwitter(final String userUuid, String message){
 		//setup class thread to call later
 		class TwitterUpdater implements Runnable{
@@ -151,6 +156,7 @@ public TwitterUpdater(String userUuid, String userToken, String userSecret, Stri
 
 
 			//do it!
+			@Override
 			public synchronized void run() {
 
 				//global config
@@ -202,6 +208,7 @@ public synchronized void run() {
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public String getGoogleAuthenticationUrl() {
 
 		String clientId = sakaiProxy.getServerConfigurationParameter("profile2.integration.google.client-id", null);

profile2/impl/src/java/org/sakaiproject/profile2/logic/ProfileKudosLogicImpl.java

@@ -18,14 +18,14 @@
 import java.math.BigDecimal;
 import java.util.Date;
 
-import lombok.Setter;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.sakaiproject.memory.api.Cache;
 import org.sakaiproject.profile2.cache.CacheManager;
 import org.sakaiproject.profile2.dao.ProfileDao;
 import org.sakaiproject.profile2.hbm.model.ProfileKudos;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import lombok.Setter;
 
 /**
  * Implementation of ProfileKudosLogic API
@@ -44,6 +44,7 @@ public class ProfileKudosLogicImpl implements ProfileKudosLogic {
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public int getKudos(String userUuid){
 
 		ProfileKudos k = null;
@@ -54,7 +55,7 @@ public int getKudos(String userUuid){
 			if(k == null) {
 				// This means that the cache has expired. evict the key from the cache
 				log.debug("Kudos cache appears to have expired for " + userUuid);
-				evictFromCache(userUuid);
+				this.cacheManager.evictFromCache(this.cache, userUuid);
 			}
 		}
 		if(k == null) {
@@ -75,6 +76,7 @@ public int getKudos(String userUuid){
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public BigDecimal getRawKudos(String userUuid){
 		ProfileKudos k = dao.getKudos(userUuid);
 		if(k == null){
@@ -86,6 +88,7 @@ public BigDecimal getRawKudos(String userUuid){
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public boolean updateKudos(String userUuid, int score, BigDecimal percentage) {
 		ProfileKudos k = new ProfileKudos();
 		k.setUserUuid(userUuid);
@@ -100,15 +103,6 @@ public boolean updateKudos(String userUuid, int score, BigDecimal percentage) {
 		}
 		return false;
 	}
-
-	/**
-	 * Helper to evict an item from a cache. 
-	 * @param cacheKey	the id for the data in the cache
-	 */
-	private void evictFromCache(String cacheKey) {
-		cache.remove(cacheKey);
-		log.debug("Evicted data in cache for key: " + cacheKey);
-	}
 
 	public void init() {
 		cache = cacheManager.createCache(CACHE_NAME);

profile2/impl/src/java/org/sakaiproject/profile2/logic/ProfilePreferencesLogicImpl.java

@@ -15,16 +15,16 @@
  */
 package org.sakaiproject.profile2.logic;
 
-import lombok.Setter;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.sakaiproject.memory.api.Cache;
 import org.sakaiproject.profile2.cache.CacheManager;
 import org.sakaiproject.profile2.dao.ProfileDao;
 import org.sakaiproject.profile2.model.ProfilePreferences;
 import org.sakaiproject.profile2.types.PreferenceType;
 import org.sakaiproject.profile2.util.ProfileConstants;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import lombok.Setter;
 
 /**
  * Implementation of ProfilePreferencesLogic API
@@ -42,13 +42,15 @@ public class ProfilePreferencesLogicImpl implements ProfilePreferencesLogic {
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public ProfilePreferences getPreferencesRecordForUser(final String userId) {
 		return getPreferencesRecordForUser(userId, true);
 	}
 
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public ProfilePreferences getPreferencesRecordForUser(final String userId, final boolean useCache) {
 
 		if(userId == null){
@@ -68,7 +70,7 @@ public ProfilePreferences getPreferencesRecordForUser(final String userId, final
 				}
 				// This means that the cache has expired. evict the key from the cache
 				log.debug("Preferences cache appears to have expired for " + userId);
-				evictFromCache(userId);
+				this.cacheManager.evictFromCache(this.cache, userId);
 			}
 		}
 
@@ -102,6 +104,7 @@ public ProfilePreferences getPreferencesRecordForUser(final String userId, final
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public boolean savePreferencesRecord(ProfilePreferences prefs) {
 
 		if(dao.savePreferencesRecord(prefs)){
@@ -120,6 +123,7 @@ public boolean savePreferencesRecord(ProfilePreferences prefs) {
 	/**
  	 * {@inheritDoc}
  	 */
+	@Override
 	public boolean isPreferenceEnabled(final String userUuid, final PreferenceType type) {
 
 		//get preferences record for this user
@@ -172,16 +176,6 @@ private ProfilePreferences getDefaultPreferencesRecord(final String userId) {
 		return prefs;
 	}
 
-
-	/**
-	 * Helper to evict an item from a cache. 
-	 * @param cacheKey	the id for the data in the cache
-	 */
-	private void evictFromCache(String cacheKey) {
-		cache.remove(cacheKey);
-		log.debug("Evicted data in cache for key: " + cacheKey);
-	}
-
 	public void init() {
 		cache = cacheManager.createCache(CACHE_NAME);
 	}

profile2/impl/src/java/org/sakaiproject/profile2/logic/ProfilePrivacyLogicImpl.java

@@ -73,7 +73,7 @@ public ProfilePrivacy getPrivacyRecordForUser(final String userId, final boolean
 				}
 				// This means that the cache has expired. evict the key from the cache
 				log.debug("Privacy cache appears to have expired for " + userId);
-				evictFromCache(userId);
+				this.cacheManager.evictFromCache(this.cache, userId);
 			}
 		}
 
@@ -522,14 +522,6 @@ private ProfilePrivacy getDefaultPrivacyRecord(String userId) {
 		return privacy;
 	}
 
-	/**
-	 * Helper to evict an item from a cache. 
-	 * @param cacheKey	the id for the data in the cache
-	 */
-	private void evictFromCache(String cacheKey) {
-		cache.remove(cacheKey);
-		log.debug("Evicted data in cache for key: " + cacheKey);
-	}
 
 	public void init() {
 		cache = cacheManager.createCache(CACHE_NAME);