Updated readme notes

Issue-ID: PORTAL-254

portal/SDK release 2.3.0, domain, sdk aaf modules

Change-Id: I426c210d9465341590851325491e46a79eea6909
Signed-off-by: Kishore Reddy, Gujja (kg811t) <kg811t@research.att.com>

5 files changed, 199 insertions, 0 deletions

diff --git a/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/conf/MusicSessionRepositoryHandler.java b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/conf/MusicSessionRepositoryHandler.java
index ad90d4ec..7d2e51ff 100644
--- a/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/conf/MusicSessionRepositoryHandler.java
+++ b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/conf/MusicSessionRepositoryHandler.java
@@ -85,6 +85,7 @@ public class MusicSessionRepositoryHandler {
 		sessions.put(id, musicSession);
 		try {
 			MusicService.setMetaAttribute(musicSession);
+			MusicService.cleanUpMusic();
 		} catch (Exception e) {
 			logger.error(EELFLoggerDelegate.errorLogger, "setMetaAttribute failed with id " + id, e);
 		}
diff --git a/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/service/MusicService.java b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/service/MusicService.java
index 4ceac22c..801e9c03 100644
--- a/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/service/MusicService.java
+++ b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/service/MusicService.java
@@ -38,7 +38,12 @@
 
 package org.onap.portalapp.music.service;
 
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.util.ArrayList;
+import java.util.Date;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 import org.onap.music.datastore.PreparedQueryObject;
@@ -61,6 +66,7 @@ import org.springframework.session.Session;
 import org.springframework.web.client.RestTemplate;
 
 import com.datastax.driver.core.ResultSet;
+import com.datastax.driver.core.Row;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
@@ -539,5 +545,108 @@ public class MusicService {
 		path.append("/");
 		return path.toString();
 	}
+	
+	/**
+	 * Get a list of sessions that need to be cleaned up
+	 * 
+	 * @return List<String>
+	 */
+	private static List<String> getSessionToBeDeleted(){
+		logger.debug(EELFLoggerDelegate.debugLogger, "initial getSessionToBeDeleted ...");
+
+		PreparedQueryObject queryObject = new PreparedQueryObject();
+		ResultSet result = null;
+		List<String> sessionIDList = new ArrayList<>();
+		DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
+		StringBuilder querySB = new StringBuilder();
+		String cleanUpThreshold = MusicProperties.getProperty(MusicProperties.MUSIC_CLEAN_UP_THRESHOLD); //Clean up sessions that's cleanUpThreshold hours ago 
+		Date dateForCleanup = new Date(System.currentTimeMillis() - 3600 * 1000 * Integer.valueOf(cleanUpThreshold)); // Get the threshold date that needs to be clean up 
+		String dateForCleanupCondition = dateFormat.format(dateForCleanup);
+		querySB.append("SELECT ").append(MusicProperties.PRIMARY_ID).append(" FROM ").append(musicKeySpace)
+		.append(".").append(getTableName(true)).append(" WHERE ").append(MusicProperties.LAST_ACCESS_TIME)
+		.append("< ? ").append(" ALLOW FILTERING");
+		queryObject.appendQueryString(querySB.toString());
+		queryObject.addValue(dateForCleanupCondition);
+		
+		try{
+			if (isAtomicGet)
+				result = MusicCore.atomicGet(musicKeySpace, musicMetaTable, null, queryObject);
+			else
+				result = MusicCore.get(queryObject);
+			Row row = result.one();
+			while(row!=null){
+				sessionIDList.add(row.get(MusicProperties.PRIMARY_ID, String.class));
+				row = result.one();
+			}
+		}catch(Exception e){
+			logger.error(EELFLoggerDelegate.errorLogger, "Error while cleaning up music tables" , e);
+		}
+		return sessionIDList;
+	}
+	
+	/**
+	 * Remove session data in music base on the defined frequency
+	 * 
+	 * @return List<String>
+	 */
+	public static void cleanUpMusic() {
+		boolean timeToCleanUp = MusicUtil.cleanUp(); // Decide whether to clean up or not
+		ReturnType result = null;
+		if(timeToCleanUp){
+			/**Getting a list of sessions that need to be cleaned up*/
+			List<String> sessionIDList = getSessionToBeDeleted();
+			if(sessionIDList!=null || sessionIDList.size()!=0){
+				StringBuilder sessionIDListCondition = new StringBuilder();
+				sessionIDListCondition.append("('");
+				for(String s : sessionIDList){
+					sessionIDListCondition.append(s);
+					sessionIDListCondition.append("','");
+				}
+				sessionIDListCondition.deleteCharAt(sessionIDListCondition.length()-1);
+				sessionIDListCondition.deleteCharAt(sessionIDListCondition.length()-1);
+				sessionIDListCondition.append(")");
+				StringBuilder querySB = new StringBuilder();			
+				PreparedQueryObject queryObject = new PreparedQueryObject();
+				/**Deleting attributes table**/
+				querySB = new StringBuilder();
+				queryObject = new PreparedQueryObject();
+				querySB.append("DELETE FROM ").append(musicKeySpace)
+				.append(".").append(getTableName(false)).append(" WHERE ").append(MusicProperties.PRIMARY_ID)
+				.append(" in ").append(sessionIDListCondition);
+				queryObject.appendQueryString(querySB.toString());
+				try{
+					if (isAtomicPut)
+						result = MusicCore.atomicPut(musicKeySpace, null, null, queryObject, null);
+					else
+						result = MusicCore.eventualPut(queryObject);
+				}catch(Exception e){
+					logger.error(EELFLoggerDelegate.errorLogger, "Error while cleaning up music attributes tables" , e);
+				}
+				logger.debug(EELFLoggerDelegate.debugLogger, "Music sessions have been cleaned up !");
+				
+				/**Deleting meta table**/
+				logger.debug(EELFLoggerDelegate.debugLogger, "Cleaning up meta table ...");
+				querySB = new StringBuilder();
+				queryObject = new PreparedQueryObject();
+				querySB.append("DELETE FROM ").append(musicKeySpace)
+				.append(".").append(getTableName(true)).append(" WHERE ").append(MusicProperties.PRIMARY_ID)
+				.append(" in ").append(sessionIDListCondition);
+				queryObject.appendQueryString(querySB.toString());
+				try{
+					if (isAtomicPut)
+						result = MusicCore.atomicPut(musicKeySpace, null, null, queryObject, null);
+					else
+						result = MusicCore.eventualPut(queryObject);
+				}catch(Exception e){
+					logger.error(EELFLoggerDelegate.errorLogger, "Error while cleaning up music meta tables" , e);
+				}
+				
+				logger.debug(EELFLoggerDelegate.debugLogger, "Cleaned up attributes table ... ");
+			}else{
+				logger.debug(EELFLoggerDelegate.debugLogger, "No Session needs to be cleaned up");
+			}
+			
+		}	
+	}
 
 }
diff --git a/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicCleanUp.java b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicCleanUp.java
new file mode 100644
index 00000000..aab04eaf
--- /dev/null
+++ b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicCleanUp.java
@@ -0,0 +1,62 @@
+/*
+ * ============LICENSE_START==========================================
+ * ONAP Portal SDK
+ * ===================================================================
+ * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+ * ===================================================================
+ *
+ * Unless otherwise specified, all software contained herein is licensed
+ * under the Apache License, Version 2.0 (the "License");
+ * you may not use this software except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *             http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed
+ * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
+ * you may not use this documentation except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *             https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * ============LICENSE_END============================================
+ *
+ *.
+ */
+
+package org.onap.portalapp.music.util;
+
+import java.util.Date;
+
+public class MusicCleanUp {
+	private static volatile MusicCleanUp musicCleanUp = new MusicCleanUp();
+	// private constructor restricted to this class itself
+	private MusicCleanUp(){
+	}
+
+	private Date lastCleanUpTime = new Date();
+
+	public static MusicCleanUp getInstance(){
+		return musicCleanUp;
+	}
+	
+	public Date getLastCleanUpTime(){
+		return lastCleanUpTime;
+	}
+	
+	public synchronized void updateLastCleanUpTimeToCurrent() {
+		lastCleanUpTime = new Date();
+	}
+}
diff --git a/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicProperties.java b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicProperties.java
index bdc9c543..34b0a5b9 100644
--- a/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicProperties.java
+++ b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicProperties.java
@@ -93,6 +93,10 @@ public class MusicProperties {
 		
 	public static final String MUSIC_ATOMIC_POST = "music.atomic.post";
 	
+	public static final String MUSIC_CLEAN_UP_FREQUENCY = "music.cleanup.frequency";
+	
+	public static final String MUSIC_CLEAN_UP_THRESHOLD = "music.cleanup.threshold";
+	
 	public static final String SESSION_MAX_INACTIVE_INTERVAL_SECONDS = "music.session.max.inactive.interval.seconds";
 	
 	public static final String ATTRIBUTE_NAME = "ATTRIBUTE_NAME";
diff --git a/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicUtil.java b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicUtil.java
index 2744796e..8819af25 100644
--- a/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicUtil.java
+++ b/ecomp-sdk/epsdk-music/src/main/java/org/onap/portalapp/music/util/MusicUtil.java
@@ -46,6 +46,7 @@ import java.nio.ByteBuffer;
 import java.time.Duration;
 import java.time.Instant;
 import java.util.Arrays;
+import java.util.Date;
 import java.util.HashSet;
 import java.util.Set;
 import java.util.zip.GZIPInputStream;
@@ -64,6 +65,7 @@ public class MusicUtil {
 	private static String atomicPut = MusicProperties.getProperty(MusicProperties.MUSIC_ATOMIC_PUT);
 	private static String atomicGet = MusicProperties.getProperty(MusicProperties.MUSIC_ATOMIC_GET);
 	private static String cached = MusicProperties.getProperty(MusicProperties.MUSIC_CACHE);
+	private static String cleanUpFreq = MusicProperties.getProperty(MusicProperties.MUSIC_CLEAN_UP_FREQUENCY);
 	private static String musicSerializeCompress = MusicProperties.getProperty(MusicProperties.MUSIC_SERIALIZE_COMPRESS);
 	public static boolean isSessionMetaAttr(String key){
 		return sessionAttrNameSet.contains(key);
@@ -159,4 +161,25 @@ public class MusicUtil {
 		}
 		return cached.trim().equalsIgnoreCase("true");
 	}
+	
+	public static int convertHoursToMillSec(int hour){
+		return hour*3600000;
+	}
+	
+	public static boolean cleanUp(){
+		Date lastCleanUpDate = MusicCleanUp.getInstance().getLastCleanUpTime();
+		if(lastCleanUpDate==null)
+			return false;
+		else{
+			int cleanUpDurationMili = convertHoursToMillSec(Integer.valueOf(cleanUpFreq));
+			Date currentTime = new Date();
+			long diffInMillies = Math.abs(currentTime.getTime() - lastCleanUpDate.getTime());
+			if(diffInMillies > cleanUpDurationMili){
+				MusicCleanUp.getInstance().updateLastCleanUpTimeToCurrent();
+				return true;
+			}
+			else 
+				return false;
+		}
+	}
 }