Initial ONAP Synapse commit

Change-Id: I3a0ed659dbb8f8faeeb54093b5d6f10414cd886e
Signed-off-by: abatos <adrian.batos-parac@amdocs.com>

12 files changed, 1263 insertions, 0 deletions

diff --git a/src/main/java/org/openecomp/datarouter/util/CrossEntityReference.java b/src/main/java/org/openecomp/datarouter/util/CrossEntityReference.java
new file mode 100644
index 0000000..48f3c27
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/CrossEntityReference.java
@@ -0,0 +1,97 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Processing and entity wrapper for property transposition logic and UEB processing
+ * 
+ * @author DAVEA
+ */
+public class CrossEntityReference {
+
+  private String targetEntityType;
+
+  private List<String> attributeNames;
+
+  public CrossEntityReference() {
+    this.targetEntityType = null;
+    this.attributeNames = new ArrayList<String>();
+  }
+
+  public String getTargetEntityType() {
+    return targetEntityType;
+  }
+
+  public void setTargetEntityType(String targetEntityType) {
+    this.targetEntityType = targetEntityType;
+  }
+
+  public List<String> getAttributeNames() {
+    return attributeNames;
+  }
+
+  public void setAttributeNames(List<String> attributeNames) {
+    this.attributeNames = attributeNames;
+  }
+
+  public void addAttributeName(String attributeName) {
+    if (!this.attributeNames.contains(attributeName)) {
+      this.attributeNames.add(attributeName);
+    }
+  }
+
+  public void initialize(String crossEntityReferenceValueFromModel) {
+
+    if (crossEntityReferenceValueFromModel == null
+        || crossEntityReferenceValueFromModel.length() == 0) {
+      // or throw an exception due to failure to initialize
+      return;
+    }
+
+    String[] tokens = crossEntityReferenceValueFromModel.split(",");
+
+    if (tokens.length >= 2) {
+      this.targetEntityType = tokens[0];
+
+      for (int x = 1; x < tokens.length; x++) {
+        this.attributeNames.add(tokens[x]);
+      }
+    } else {
+      // throw a CrossEntityReferenceInitializationException??
+    }
+
+  }
+
+  @Override
+  public String toString() {
+    return "CrossEntityReference ["
+        + (targetEntityType != null ? "entityType=" + targetEntityType + ", " : "")
+        + (attributeNames != null ? "attributeNames=" + attributeNames : "") + "]";
+  }
+
+}
diff --git a/src/main/java/org/openecomp/datarouter/util/DataRouterConstants.java b/src/main/java/org/openecomp/datarouter/util/DataRouterConstants.java
new file mode 100644
index 0000000..f9f5df3
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/DataRouterConstants.java
@@ -0,0 +1,57 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+public class DataRouterConstants {
+  public static final String DR_FILESEP = (System.getProperty("file.separator") == null) ? "/"
+      : System.getProperty("file.separator");
+
+  public static final String DR_SPECIFIC_CONFIG = System.getProperty("CONFIG_HOME") + DR_FILESEP;
+  
+  public static final String DR_BUNDLECONFIG_NAME = (System.getProperty("BUNDLECONFIG_DIR") == null)
+      ? "bundleconfig" : System.getProperty("BUNDLECONFIG_DIR");
+
+  public static final String DR_HOME_BUNDLECONFIG = (System.getProperty("AJSC_HOME") == null)
+      ? DR_FILESEP + "opt" + DR_FILESEP + "app" + DR_FILESEP 
+          + "datalayer" + DR_FILESEP + DR_BUNDLECONFIG_NAME
+      : System.getProperty("AJSC_HOME") + DR_FILESEP + DR_BUNDLECONFIG_NAME;
+
+  /** This is the etc directory, relative to AAI_HOME. */
+  public static final String DR_HOME_ETC = DR_HOME_BUNDLECONFIG + DR_FILESEP + "etc" + DR_FILESEP;
+
+  public static final String DR_HOME_MODEL = DR_SPECIFIC_CONFIG + "model" + DR_FILESEP;
+  public static final String DR_HOME_AUTH = DR_SPECIFIC_CONFIG + "auth" + DR_FILESEP;
+
+  public static final String DR_CONFIG_FILE = DR_SPECIFIC_CONFIG + "data-router.properties";
+
+  public static final String DR_HOME_ETC_OXM = DR_HOME_ETC + "oxm" + DR_FILESEP;
+  
+
+  // AAI Related
+  public static final String AAI_ECHO_SERVICE = "/util/echo";
+
+  // Logging related
+  public static final String DATA_ROUTER_SERVICE_NAME = "DataRouter";
+}
diff --git a/src/main/java/org/openecomp/datarouter/util/DataRouterProperties.java b/src/main/java/org/openecomp/datarouter/util/DataRouterProperties.java
new file mode 100644
index 0000000..7e18363
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/DataRouterProperties.java
@@ -0,0 +1,53 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.util.Properties;
+
+public class DataRouterProperties {
+
+  private static Properties properties;
+
+  static {
+    properties = new Properties();
+    File file = new File(DataRouterConstants.DR_CONFIG_FILE);
+    try {
+      properties.load(new FileInputStream(file));
+    } catch (FileNotFoundException e) {
+      e.printStackTrace();
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+  }
+
+  public static String get(String key) {
+    return properties.getProperty(key);
+  }
+
+}
diff --git a/src/main/java/org/openecomp/datarouter/util/EntityOxmReferenceHelper.java b/src/main/java/org/openecomp/datarouter/util/EntityOxmReferenceHelper.java
new file mode 100644
index 0000000..c9e1746
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/EntityOxmReferenceHelper.java
@@ -0,0 +1,62 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import java.util.HashMap;
+
+import org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContext;
+
+public class EntityOxmReferenceHelper implements ExternalOxmModelProcessor {
+
+   private static EntityOxmReferenceHelper _instance = null;
+   
+   private HashMap<Version, VersionedOxmEntities> versionedModels;
+   
+   protected EntityOxmReferenceHelper() {
+      this.versionedModels = new HashMap<Version,VersionedOxmEntities>();
+   }
+   
+   public static EntityOxmReferenceHelper getInstance() {
+      if ( _instance == null ) {
+         _instance = new EntityOxmReferenceHelper();
+      }
+      
+      return _instance;
+   }
+   
+   
+   @Override
+   public void onOxmVersionChange(Version version, DynamicJAXBContext context) {
+      VersionedOxmEntities oxmEntities = new VersionedOxmEntities();
+      oxmEntities.initialize(context);
+      this.versionedModels.put(version, oxmEntities);
+      
+   }
+   
+   public VersionedOxmEntities getVersionedOxmEntities(Version version){ 
+      return this.versionedModels.get(version);
+   }
+
+}
\ No newline at end of file
diff --git a/src/main/java/org/openecomp/datarouter/util/ExternalOxmModelProcessor.java b/src/main/java/org/openecomp/datarouter/util/ExternalOxmModelProcessor.java
new file mode 100644
index 0000000..9fcef6f
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/ExternalOxmModelProcessor.java
@@ -0,0 +1,37 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContext;
+
+/**
+ * Exposes a registration and processing contract so that any load/change of an oxm version will
+ * inform registered model processors.
+ * 
+ * @author davea
+ */
+public interface ExternalOxmModelProcessor {
+  public void onOxmVersionChange(Version version, DynamicJAXBContext context);
+}
diff --git a/src/main/java/org/openecomp/datarouter/util/FileWatcher.java b/src/main/java/org/openecomp/datarouter/util/FileWatcher.java
new file mode 100644
index 0000000..e382c21
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/FileWatcher.java
@@ -0,0 +1,49 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import java.io.File;
+import java.util.TimerTask;
+
+public abstract class FileWatcher extends TimerTask {
+  private long timeStamp;
+  private File file;
+
+  public FileWatcher(File file) {
+    this.file = file;
+    this.timeStamp = file.lastModified();
+  }
+
+  public final void run() {
+    long timeStamp = file.lastModified();
+
+    if ((timeStamp - this.timeStamp) > 500) {
+      this.timeStamp = timeStamp;
+      onChange(file);
+    }
+  }
+  
+  protected abstract void onChange(File file);
+}
\ No newline at end of file
diff --git a/src/main/java/org/openecomp/datarouter/util/NodeUtils.java b/src/main/java/org/openecomp/datarouter/util/NodeUtils.java
new file mode 100644
index 0000000..f957247
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/NodeUtils.java
@@ -0,0 +1,46 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import java.util.Arrays;
+
+public class NodeUtils {
+  /**
+  * Generate unique sha digest. This method is copy over from NodeUtils class in AAIUI
+  *
+  * @param keys the keys
+  * @return the string
+  */
+  public static String generateUniqueShaDigest(String... keys) {
+    if ((keys == null) || keys.length == 0) {
+      return null;
+    }
+  
+    final String keysStr = Arrays.asList(keys).toString();
+    final String hashedId = org.apache.commons.codec.digest.DigestUtils.sha256Hex(keysStr);
+  
+    return hashedId;
+  }
+}
diff --git a/src/main/java/org/openecomp/datarouter/util/OxmModelLoader.java b/src/main/java/org/openecomp/datarouter/util/OxmModelLoader.java
new file mode 100644
index 0000000..2919ba2
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/OxmModelLoader.java
@@ -0,0 +1,166 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Timer;
+import java.util.TimerTask;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import javax.ws.rs.core.Response.Status;
+import javax.xml.bind.JAXBException;
+
+import org.eclipse.persistence.jaxb.JAXBContextProperties;
+import org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContext;
+import org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContextFactory;
+import org.openecomp.cl.eelf.LoggerFactory;
+import org.openecomp.datarouter.logging.DataRouterMsgs;
+
+import org.openecomp.datarouter.util.ExternalOxmModelProcessor;
+
+public class OxmModelLoader {
+
+	private static Map<String, DynamicJAXBContext> versionContextMap = new ConcurrentHashMap<String, DynamicJAXBContext>();
+	private static Map<String, Timer> timers = new ConcurrentHashMap<String, Timer>();
+	private static List<ExternalOxmModelProcessor> oxmModelProcessorRegistry = new ArrayList<ExternalOxmModelProcessor>();
+	final static Pattern p = Pattern.compile("aai_oxm_(.*).xml");
+	
+	
+
+	private static org.openecomp.cl.api.Logger logger = LoggerFactory.getInstance()
+			.getLogger(OxmModelLoader.class.getName());
+
+	public synchronized static void loadModels() {
+		
+		File[] listOfFiles = new File(DataRouterConstants.DR_HOME_MODEL).listFiles();
+
+		if (listOfFiles != null) {
+			for (File file : listOfFiles) {
+				if (file.isFile()) {
+					Matcher m = p.matcher(file.getName());
+					if (m.matches()) {
+						try {
+							OxmModelLoader.loadModel(m.group(1), file);
+						} catch (Exception e) {
+							logger.error(DataRouterMsgs.INVALID_OXM_FILE, file.getName(), e.getMessage());
+						}
+					}
+
+				}
+			}
+		} else {
+			logger.error(DataRouterMsgs.INVALID_OXM_DIR, DataRouterConstants.DR_HOME_MODEL);
+		}
+
+
+	}
+	
+	private static void addtimer(String version,File file){
+		TimerTask task = null;
+		task = new FileWatcher(
+				file) {
+			protected void onChange(File file) {
+				// here we implement the onChange
+				logger.info(DataRouterMsgs.FILE_CHANGED, file.getName());
+
+				try {
+					OxmModelLoader.loadModel(version,file);
+				} catch (Exception e) {
+					e.printStackTrace();
+				}
+
+			}
+		};
+
+		if (!timers.containsKey(version)) {
+			Timer timer = new Timer("oxm-"+version);
+			timer.schedule(task, new Date(), 10000);
+			timers.put(version, timer);
+
+		}
+	}
+
+	private synchronized static void loadModel(String version,File file) throws JAXBException, FileNotFoundException {
+
+		
+		InputStream iStream = new FileInputStream(file);
+		Map<String, Object> properties = new HashMap<String, Object>();
+		properties.put(JAXBContextProperties.OXM_METADATA_SOURCE, iStream);
+		final DynamicJAXBContext jaxbContext = DynamicJAXBContextFactory
+				.createContextFromOXM(Thread.currentThread().getContextClassLoader(), properties);
+		versionContextMap.put(version, jaxbContext);
+		if ( oxmModelProcessorRegistry != null) {
+          for ( ExternalOxmModelProcessor processor : oxmModelProcessorRegistry ) {
+             processor.onOxmVersionChange(Version.valueOf(version),  jaxbContext );
+          }
+         }
+		addtimer(version,file);
+
+	}
+
+	public static DynamicJAXBContext getContextForVersion(String version) throws Exception {
+		if (versionContextMap == null || versionContextMap.isEmpty()) {
+			loadModels();
+		} else if (!versionContextMap.containsKey(version)) {
+			try {
+				loadModel(version,new File (DataRouterConstants.DR_HOME_MODEL + "aai_oxm_" + version + ".xml"));
+			} catch (Exception e) {
+				throw new Exception(Status.NOT_FOUND.toString());
+			}
+		}
+
+		return versionContextMap.get(version);
+	}
+
+	public static Map<String, DynamicJAXBContext> getVersionContextMap() {
+		return versionContextMap;
+	}
+
+	public static void setVersionContextMap(Map<String, DynamicJAXBContext> versionContextMap) {
+		OxmModelLoader.versionContextMap = versionContextMap;
+	}
+	
+	public synchronized static void registerExternalOxmModelProcessors(Collection<ExternalOxmModelProcessor> processors) {
+      if(processors != null) {
+         for(ExternalOxmModelProcessor processor : processors) {
+            if(!oxmModelProcessorRegistry.contains(processor)) {
+               oxmModelProcessorRegistry.add(processor);
+            }
+         }
+      }
+   }
+
+}
diff --git a/src/main/java/org/openecomp/datarouter/util/RouterServiceUtil.java b/src/main/java/org/openecomp/datarouter/util/RouterServiceUtil.java
new file mode 100644
index 0000000..b30c9f9
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/RouterServiceUtil.java
@@ -0,0 +1,226 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import com.fasterxml.jackson.databind.JsonNode;
+
+import org.json.JSONObject;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+public class RouterServiceUtil {
+
+  public static Map<String, String> parseJsonPayloadIntoMap(String jsonPayload) {
+
+    JSONObject jsonObject = new JSONObject(jsonPayload);
+    Map<String, String> map = new HashMap<String, String>();
+    Iterator iter = jsonObject.keys();
+    while (iter.hasNext()) {
+      String key = (String) iter.next();
+      String value = jsonObject.getString(key);
+      map.put(key, value);
+    }
+    return map;
+  }
+
+  public static String getNodeFieldAsText(JsonNode node, String fieldName) {
+
+    String fieldValue = null;
+
+    JsonNode valueNode = node.get(fieldName);
+
+    if (valueNode != null) {
+      fieldValue = valueNode.asText();
+    }
+
+    return fieldValue;
+  }
+
+  public static String concatArray(List<String> list) {
+    return concatArray(list, " ");
+  }
+
+  public static String concatArray(List<String> list, String delimiter) {
+
+    if (list == null || list.size() == 0) {
+      return "";
+    }
+
+    StringBuilder result = new StringBuilder(64);
+
+    boolean firstValue = true;
+
+    for (String item : list) {
+
+      if (firstValue) {
+        result.append(item);
+        firstValue = false;
+      } else {
+        result.append(delimiter).append(item);
+      }
+    }
+
+    return result.toString();
+
+  }
+
+  public static String concatArray(String[] values) {
+
+    if (values == null || values.length == 0) {
+      return "";
+    }
+
+    StringBuilder result = new StringBuilder(64);
+
+    boolean firstValue = true;
+
+    for (String item : values) {
+
+      if (firstValue) {
+        result.append(item);
+        firstValue = false;
+      } else {
+        result.append(".").append(item);
+      }
+
+    }
+
+    return result.toString();
+
+  }
+
+  public static String recursivelyLookupJsonPayload(JsonNode node, String key) {
+    String value = null;
+    if (node.isObject()) {
+      Iterator<Map.Entry<String, JsonNode>> nodeIterator = node.fields();
+
+      while (nodeIterator.hasNext()) {
+        Map.Entry<String, JsonNode> entry = (Map.Entry<String, JsonNode>) nodeIterator.next();
+        if (!entry.getValue().isValueNode()) {
+          value = recursivelyLookupJsonPayload(entry.getValue(), key);
+          if (value != null) {
+            return value;
+          }
+        }
+
+        String name = entry.getKey();
+        if (name.equalsIgnoreCase(key)) {
+          return entry.getValue().asText();
+        }
+      }
+    } else if (node.isArray()) {
+      Iterator<JsonNode> arrayItemsIterator = node.elements();
+      while (arrayItemsIterator.hasNext()) {
+        value = recursivelyLookupJsonPayload(arrayItemsIterator.next(), key);
+        if (value != null) {
+          return value;
+        }
+      }
+    }
+    return value;
+  }
+
+  public static void extractObjectsByKey(JsonNode node, String searchKey,
+      Collection<JsonNode> foundObjects) {
+
+    if (node.isObject()) {
+      Iterator<Map.Entry<String, JsonNode>> nodeIterator = node.fields();
+
+      while (nodeIterator.hasNext()) {
+        Map.Entry<String, JsonNode> entry = (Map.Entry<String, JsonNode>) nodeIterator.next();
+        if (!entry.getValue().isValueNode()) {
+          extractObjectsByKey(entry.getValue(), searchKey, foundObjects);
+        }
+
+        String name = entry.getKey();
+        if (name.equalsIgnoreCase(searchKey)) {
+
+          JsonNode entryValue = entry.getValue();
+
+          if (entryValue.isArray()) {
+
+            Iterator<JsonNode> arrayItemsIterator = entryValue.elements();
+            while (arrayItemsIterator.hasNext()) {
+              foundObjects.add(arrayItemsIterator.next());
+            }
+
+          } else {
+            foundObjects.add(entry.getValue());
+          }
+        }
+      }
+    } else if (node.isArray()) {
+      Iterator<JsonNode> arrayItemsIterator = node.elements();
+      while (arrayItemsIterator.hasNext()) {
+        extractObjectsByKey(arrayItemsIterator.next(), searchKey, foundObjects);
+      }
+    }
+  }
+
+  public static void convertArrayIntoList(JsonNode node, Collection<JsonNode> instances) {
+
+    if (node.isArray()) {
+      Iterator<JsonNode> arrayItemsIterator = node.elements();
+      while (arrayItemsIterator.hasNext()) {
+        instances.add(arrayItemsIterator.next());
+      }
+    } else {
+      instances.add(node);
+    }
+  }
+
+  public static void extractFieldValuesFromObject(JsonNode node,
+      Collection<String> attributesToExtract, Collection<String> fieldValues) {
+
+    if (node.isObject()) {
+
+      JsonNode valueNode = null;
+
+      for (String attrToExtract : attributesToExtract) {
+
+        valueNode = node.get(attrToExtract);
+
+        if (valueNode != null) {
+
+          if (valueNode.isValueNode()) {
+            fieldValues.add(valueNode.asText());
+          }
+        }
+      }
+    }
+  }
+
+
+  public static String objToJson(Object obj) {
+    JSONObject jsonObject = new JSONObject(obj);
+    String json = jsonObject.toString();
+    return json;
+  }
+}
diff --git a/src/main/java/org/openecomp/datarouter/util/SearchSuggestionPermutation.java b/src/main/java/org/openecomp/datarouter/util/SearchSuggestionPermutation.java
new file mode 100644
index 0000000..91f5910
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/SearchSuggestionPermutation.java
@@ -0,0 +1,89 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class SearchSuggestionPermutation {
+  /*
+   * Will return all the unique combinations of the suggestions provided.
+   * The order of the permutation is not taken into account when computing
+   * the uniqueness.
+   * e.g.: A list of A,B,C,D will return
+   * [[A], [A, B, C, D], [A, C, D], [A, D], [B], [B, C, D], [B, D], [C], [C, D], [D]]
+   * 
+   * @param list The list of statuses to create permutations of
+   * @return     A list which contains a array list of all possible combinations
+   */
+  @SuppressWarnings("serial")
+  public List<ArrayList<String>> getSuggestionsPermutation(List<String> list) {
+    List<String> statusList = new ArrayList<>(list);
+    List<String> dupStatusList;
+    ArrayList<ArrayList<String>> uniqueList = new ArrayList<>();
+    int mainLoopIndexCounter = 0;
+
+    for (String status : statusList) {
+      // Add the single entity subset
+      //This will add the unique single values eg [A],[B],[C],[D]
+      uniqueList.add(new ArrayList<String>() {
+        {
+          add(status);
+        }
+      });
+
+      // Remove all the elements to left till the current index
+      dupStatusList = truncateListUntill(statusList, mainLoopIndexCounter);
+
+      while (!dupStatusList.isEmpty()) {
+        ArrayList<String> suggListInIterate= new ArrayList<>();
+        suggListInIterate.add(status);
+
+        for (String dupStatus : dupStatusList) {
+          suggListInIterate.add(dupStatus);
+        }
+
+        uniqueList.add(suggListInIterate);
+        dupStatusList.remove(0);
+      }
+
+      mainLoopIndexCounter++;
+    }
+
+    return uniqueList;
+  }
+
+  private List<String> truncateListUntill(List<String> lists, int index) {
+    List<String> truncatedList = new ArrayList<>(lists);
+    int counter = 0;
+
+    while (counter <= index) {
+      truncatedList.remove(0);
+      counter++;
+    }
+
+    return truncatedList;
+  }
+}
diff --git a/src/main/java/org/openecomp/datarouter/util/Version.java b/src/main/java/org/openecomp/datarouter/util/Version.java
new file mode 100644
index 0000000..a0b3e5f
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/Version.java
@@ -0,0 +1,29 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+public enum Version {
+  v2, v3, v4, v5, v6, v7, v8, v9, v10;
+}
\ No newline at end of file
diff --git a/src/main/java/org/openecomp/datarouter/util/VersionedOxmEntities.java b/src/main/java/org/openecomp/datarouter/util/VersionedOxmEntities.java
new file mode 100644
index 0000000..46c4a76
--- /dev/null
+++ b/src/main/java/org/openecomp/datarouter/util/VersionedOxmEntities.java
@@ -0,0 +1,352 @@
+/**
+ * ============LICENSE_START=======================================================
+ * DataRouter
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+package org.openecomp.datarouter.util;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.Vector;
+
+import org.eclipse.persistence.dynamic.DynamicType;
+import org.eclipse.persistence.internal.helper.DatabaseField;
+import org.eclipse.persistence.internal.oxm.XPathFragment;
+import org.eclipse.persistence.internal.oxm.mappings.Descriptor;
+import org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContext;
+import org.eclipse.persistence.mappings.DatabaseMapping;
+import org.eclipse.persistence.oxm.XMLField;
+import org.openecomp.datarouter.entity.OxmEntityDescriptor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Builds up a representation of the versioned entities in a way that they can be cross referenced
+ * in a data-driven way
+ * @author DAVEA
+ */
+public class VersionedOxmEntities {
+
+   private static final Logger logger = LoggerFactory.getLogger(VersionedOxmEntities.class);
+   private static final String REST_ROOT_ENTITY = "inventory";
+
+   private HashMap<String,Boolean> crossEntityReferenceContainerLookup = new HashMap<String,Boolean>();
+   private HashMap<String,CrossEntityReference> crossEntityReferenceLookup = new HashMap<String,CrossEntityReference>();
+   private Map<String,DynamicType> entityTypeLookup = new LinkedHashMap<String,DynamicType>();
+   private Map<String, OxmEntityDescriptor> searchableEntityDescriptors = new HashMap<String, OxmEntityDescriptor>();
+   private Map<String, OxmEntityDescriptor> suggestableEntityDescriptors = new HashMap<String, OxmEntityDescriptor>();
+   private Map<String, OxmEntityDescriptor> entityAliasDescriptors = new HashMap<String, OxmEntityDescriptor>();
+
+   
+   public void initialize(DynamicJAXBContext context) {
+      parseOxmContext(context);
+      buildCrossEntityReferenceCollections(REST_ROOT_ENTITY, new HashSet<String>());
+      populateSearchableDescriptors(context);
+   }
+   
+   /**
+    * The big goal for these methods is to make the processing as generic and model driven as possible.  There are only two 
+    * exceptions to this rule, at the moment.  I needed to hard-coded the top level REST data model entity type, which is
+    * "inventory" for now.   And as this class is heavily focused and coupled towards building a version specific set of 
+    * lookup structures for the "crossEntityReference" model attribute, it possesses knowledge of that attribute whether it 
+    * exists or not in the DynamicJAXBContext we are currently analyzing.
+    * 
+    * This method will build two collections:
+    * 
+    * 1)  A list of entity types that can have nested entities containing cross entity reference definitions.  The purpose
+    *     of this collection is a fail-fast test when processing UEB events so we can quickly determine if it is necessary
+    *     to deeply parse the event looking for cross entity reference attributes which not exist.
+    *     
+    *     For example, looking at a service-instance <=> inventory path:
+    *     
+    *     inventory (true)
+    *     -> business (true)
+    *        -> customers  (true)
+    *           -> customer  (true)
+    *              -> service-subscriptions (true)
+    *                 -> service-subscription (CER defined here in the model)   (true)
+    *                    -> service-instances    (false)
+    *                       -> service-instance   (false)
+    *     
+    *     Because service-subscription contains a model definition of CER, in the first collection all the types in the tree will
+    *     indicate that it possesses one or more contained entity types with a cross-entity-reference definition.
+    *     
+    * 2)  A lookup for { entityType => CrossEntityReference } so we can quickly access the model definition of a CER for
+    *     a specific entity type when we begin extracting parent attributes for transposition into nested child entity types.
+    * 
+    * 
+    * @param entityType
+    * @param checked
+    * @return
+    */
+   protected boolean buildCrossEntityReferenceCollections(String entityType, HashSet<String> checked) {
+
+      /*
+       * To short-circuit infinite loops, make sure this entityType hasn't
+       * already been checked
+       */
+
+      if(checked.contains(entityType)) {
+         return false;
+      }
+      else {
+         checked.add(entityType);
+      }
+
+      DynamicType parentType = entityTypeLookup.get(entityType);
+      DynamicType childType = null;
+      boolean returnValue = false;
+
+      if(parentType == null) {
+         return returnValue;
+      }
+
+      /*
+       * Check if current descriptor contains the cross-entity-reference
+       * attribute. If it does not walk the entity model looking for nested
+       * entity types that may contain the reference.
+       */
+
+      Map<String, String> properties = parentType.getDescriptor().getProperties();
+      if(properties != null) {
+         for(Map.Entry<String, String> entry : properties.entrySet()) {
+            if(entry.getKey().equalsIgnoreCase("crossEntityReference")) {
+               returnValue = true;
+               CrossEntityReference cer = new CrossEntityReference();
+               cer.initialize(entry.getValue());
+               crossEntityReferenceLookup.put( entityType, cer);
+               //System.out.println("entityType = " + entityType + " contains a CER instance = " + returnValue);
+              // return true;
+            }
+         }
+      }
+
+      Vector<DatabaseField> fields = parentType.getDescriptor().getAllFields();
+
+      if(fields != null) {
+
+         XMLField xmlField = null;
+         for(DatabaseField f : fields) {
+
+            if(f instanceof XMLField) {
+               xmlField = (XMLField)f;
+               XPathFragment xpathFragment = xmlField.getXPathFragment();
+               String entityShortName = xpathFragment.getLocalName();
+
+               childType = entityTypeLookup.get(entityShortName);
+
+               if(childType != null) {
+
+                  if(!checked.contains(entityShortName)) {
+
+                     if(buildCrossEntityReferenceCollections(entityShortName,checked)) {
+                        returnValue = true;
+                     }
+
+                  }
+
+                  checked.add(entityShortName);
+
+               }
+
+            }
+
+         }
+
+      }
+
+      crossEntityReferenceContainerLookup.put(entityType, Boolean.valueOf(returnValue));
+      return returnValue;
+   }
+   
+   private void populateSearchableDescriptors(DynamicJAXBContext oxmContext) {
+      List<Descriptor> descriptorsList = oxmContext.getXMLContext().getDescriptors();
+      OxmEntityDescriptor newOxmEntity = null;
+      
+      for (Descriptor desc: descriptorsList) {
+         
+         DynamicType entity = (DynamicType) oxmContext.getDynamicType(desc.getAlias());
+         
+         //LinkedHashMap<String, String> oxmProperties = new LinkedHashMap<String, String>();
+         String primaryKeyAttributeNames = null;
+         
+         //Not all fields have key attributes
+         if (desc.getPrimaryKeyFields() != null) {
+            primaryKeyAttributeNames = desc.getPrimaryKeyFields().toString().replaceAll("/text\\(\\)", "").replaceAll("\\[", "").replaceAll("\\]", "");
+         }
+         
+         String entityName = desc.getDefaultRootElement();
+         
+         Map<String, String> properties = entity.getDescriptor().getProperties();
+         if (properties != null) {
+            for (Map.Entry<String, String> entry : properties.entrySet()) {
+               if (entry.getKey().equalsIgnoreCase("searchable")) {
+                  
+                  /*
+                   * we can do all the work here, we don't have a create additional collections for 
+                   * subsequent passes
+                   */
+                  newOxmEntity = new OxmEntityDescriptor();
+                  newOxmEntity.setEntityName(entityName);
+                  newOxmEntity.setPrimaryKeyAttributeName(Arrays.asList(primaryKeyAttributeNames.split(",")));
+                  newOxmEntity.setSearchableAttributes(Arrays.asList(entry.getValue().split(",")));
+                  searchableEntityDescriptors.put(entityName, newOxmEntity);
+               } else if (entry.getKey().equalsIgnoreCase("containsSuggestibleProps")) {
+                 newOxmEntity = new OxmEntityDescriptor();
+                 newOxmEntity.setEntityName(entityName);
+                 newOxmEntity.setSuggestableEntity(true);
+                 Vector<DatabaseMapping> descriptorMaps = entity.getDescriptor().getMappings();
+                 List<String> listOfSuggestableAttributes = new ArrayList<String>();
+                 
+                 for (DatabaseMapping descMap : descriptorMaps) {
+                   if (descMap.isAbstractDirectMapping()) {
+                     
+                     if (descMap.getProperties().get("suggestibleOnSearch") != null) {
+                       String suggestableOnSearchString = String.valueOf(
+                           descMap.getProperties().get("suggestibleOnSearch"));
+                       
+                       boolean isSuggestibleOnSearch = Boolean.valueOf(suggestableOnSearchString);
+
+                       if (isSuggestibleOnSearch) {
+                         /* Grab attribute types for suggestion */
+                         String attributeName = descMap.getField().getName()
+                             .replaceAll("/text\\(\\)", "");
+                         listOfSuggestableAttributes.add(attributeName);
+                       }
+                     }
+                   }
+                 }
+                 newOxmEntity.setSuggestableAttributes(listOfSuggestableAttributes);
+                 suggestableEntityDescriptors.put(entityName, newOxmEntity);
+               } else if (entry.getKey().equalsIgnoreCase("suggestionAliases")) {
+                 newOxmEntity = new OxmEntityDescriptor();
+                 newOxmEntity.setEntityName(entityName);
+                 newOxmEntity.setAlias(Arrays.asList(entry.getValue().split(",")));
+                 entityAliasDescriptors.put(entityName, newOxmEntity);
+               }
+            }
+         }
+         
+      }
+      
+   }
+   
+   public Map<String, OxmEntityDescriptor> getSearchableEntityDescriptors() {
+      return searchableEntityDescriptors;
+   }
+   
+   public OxmEntityDescriptor getSearchableEntityDescriptor(String entityType) {
+      return searchableEntityDescriptors.get(entityType);
+   }
+
+
+   public HashMap<String,Boolean> getCrossEntityReferenceContainers() {
+      return crossEntityReferenceContainerLookup;
+   }
+   
+   public HashMap<String,CrossEntityReference> getCrossEntityReferences() {
+      return crossEntityReferenceLookup;
+   }
+   
+
+   private void parseOxmContext(DynamicJAXBContext oxmContext) {
+      List<Descriptor> descriptorsList = oxmContext.getXMLContext().getDescriptors();
+
+      for(Descriptor desc : descriptorsList) {
+
+         DynamicType entity = (DynamicType)oxmContext.getDynamicType(desc.getAlias());
+
+         String entityName = desc.getDefaultRootElement();
+
+         entityTypeLookup.put(entityName, entity);
+
+      }
+
+   }
+
+   public boolean entityModelContainsCrossEntityReference(String containerEntityType) {
+      Boolean v = crossEntityReferenceContainerLookup.get(containerEntityType);
+
+      if(v == null) {
+         return false;
+      }
+
+      return v;
+   }
+   
+   public boolean entityContainsCrossEntityReference(String entityType) {
+      return (crossEntityReferenceLookup.get(entityType) != null);
+   }   
+
+   public CrossEntityReference getCrossEntityReference(String entityType) {
+      return crossEntityReferenceLookup.get(entityType);
+   }   
+   
+   public Map<String, OxmEntityDescriptor> getSuggestableEntityDescriptors() {
+    return suggestableEntityDescriptors;
+  }
+
+  public void setSuggestableEntityDescriptors(
+      Map<String, OxmEntityDescriptor> suggestableEntityDescriptors) {
+    this.suggestableEntityDescriptors = suggestableEntityDescriptors;
+  }
+
+  public Map<String, OxmEntityDescriptor> getEntityAliasDescriptors() {
+    return entityAliasDescriptors;
+  }
+
+  public void setEntityAliasDescriptors(Map<String, OxmEntityDescriptor> entityAliasDescriptors) {
+    this.entityAliasDescriptors = entityAliasDescriptors;
+  }
+
+  public void extractEntities(String entityType, DynamicJAXBContext context, Collection<DynamicType> entities) {
+      
+      
+      
+      
+   }
+   
+   public String dumpCrossEntityReferenceContainers() {
+      
+      Set<String> keys = crossEntityReferenceContainerLookup.keySet();
+      StringBuilder sb = new StringBuilder(128);
+      
+      for ( String key : keys ) {
+
+         if ( crossEntityReferenceContainerLookup.get(key) ) {
+            sb.append("\n").append("Entity-Type = '" + key + "' contains a Cross-Entity-Reference.");   
+         }
+      }
+      
+      
+      return sb.toString();
+      
+   }
+   
+}
\ No newline at end of file