aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/aai/sa/searchdbabstraction/util/ElasticSearchPayloadTranslator.java
blob: d73001bb7da00e988e33bb5a93747e78ee05b92b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
 * Copyright © 2017-2018 Amdocs
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file 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.
 * ============LICENSE_END=========================================================
 */
package org.onap.aai.sa.searchdbabstraction.util;

import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.JsonPath;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import org.apache.commons.io.IOUtils;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.onap.aai.cl.api.Logger;
import org.onap.aai.cl.eelf.LoggerFactory;
import org.onap.aai.sa.searchdbabstraction.logging.SearchDbMsgs;


/**
 * This class as the name suggests is to translate the payload of PUT & POST requests
 * to ElasticSearch (ES) to its compatible syntax, specially compatible with ES v6 or above.
 * 
 * For example, data type such as "string" is now replaced by "text" or "keyword". 
 * 
 * So this class will make those translations reading off from a json configuration file, therefore
 * the configuration can be updated with new translations as and when required without touching the code. 
 * 
 * @author EDWINL
 *
 */
public class ElasticSearchPayloadTranslator {

	private static Logger logger = LoggerFactory.getInstance().getLogger(ElasticSearchPayloadTranslator.class.getName());
	private static final String CONFIG_DIRECTORY = System.getProperty("CONFIG_HOME");
	private static final String ES_PAYLOAD_TRANSLATION_FILE = "es-payload-translation.json";


	/**
	 *  Using JSON Path query to filter objects to translate the payload to ES compatible version
	 *  The filter queries and the replacement attributes are configured in the es-payload-translation.json file.
	 *  
	 * @param source
	 * @return translated payload in String
	 * @throws IOException
	 */
	public static String translateESPayload(String source) throws IOException {
		logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "translateESPayload, method-params[ source=" + source + "]");
		String pathToTranslationFile = CONFIG_DIRECTORY + File.separator + ES_PAYLOAD_TRANSLATION_FILE;

		try {
			
			JSONObject translationConfigPayload = new JSONObject(IOUtils.toString(
					new FileInputStream(new File(pathToTranslationFile)), "UTF-8"));
			JSONArray attrTranslations = translationConfigPayload.getJSONArray("attr-translations");
			DocumentContext payloadToTranslate = JsonPath.parse(source);

			for(Object obj : attrTranslations) {
				JSONObject jsonObj = ((JSONObject) obj);
				String query = jsonObj.get("query").toString();
				JSONObject attrToUpdate = (JSONObject) jsonObj.get("update");
				List<Map<String, Object>> filteredObjects = payloadToTranslate.read(query);
				for(Map<String, Object> objMap : filteredObjects) {
					objMap.putAll(attrToUpdate.toMap());
				}
			}
			
			logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "Payload after translation: "+payloadToTranslate.jsonString());
			return payloadToTranslate.jsonString();
			
		} catch (JSONException | IOException e) {
			logger.error(SearchDbMsgs.FILTERS_CONFIG_FAILURE, e, ES_PAYLOAD_TRANSLATION_FILE, e.getMessage());
			if(e instanceof JSONException) {
				throw new IOException("Payload translation configuration looks corrupted. Please correct!", e);
			}
			throw new IOException("Error in configuring payload translation file. Please check if it exists.", e);
		}	
	}
}