Handle L-Interface in AaiCtxBuilder3.0.1-ONAP

Also adapted the sprintframework to aaiCtxBuilder and  added more junit test cases

Issue-ID: LOG-766

Change-Id: Ibcc81e7ad3602666ff17c660d33b9ab7b57620df
Signed-off-by: Leigh, Phillip (pl876u) <phillip.leigh@amdocs.com>

4 files changed, 387 insertions, 3 deletions

diff --git a/src/main/java/org/onap/pomba/contextbuilder/aai/datatype/LInterfaceInstance.java b/src/main/java/org/onap/pomba/contextbuilder/aai/datatype/LInterfaceInstance.java
new file mode 100644
index 0000000..db992b1
--- /dev/null
+++ b/src/main/java/org/onap/pomba/contextbuilder/aai/datatype/LInterfaceInstance.java
@@ -0,0 +1,226 @@
+/*
+ * ============LICENSE_START===================================================
+ * Copyright (c) 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.pomba.contextbuilder.aai.datatype;
+
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.annotations.Expose;
+import com.google.gson.annotations.SerializedName;
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+import org.apache.commons.lang3.builder.ToStringBuilder;
+import org.onap.pomba.contextbuilder.aai.exception.AuditError;
+import org.onap.pomba.contextbuilder.aai.exception.AuditException;
+
+public class LInterfaceInstance {
+
+    @SerializedName("interface-id")
+    @Expose
+    private String interfaceId;
+
+    @SerializedName("interface-name")
+    @Expose
+    private String interfaceName;
+    @SerializedName("interface-role")
+    @Expose
+    private String interfaceRole;
+    @SerializedName("is-port-mirrored")
+    @Expose
+    private String isPortMirrored;
+    @SerializedName("admin-status")
+    @Expose
+    private String adminStatus;
+    @SerializedName("network-name")
+    @Expose
+    private String networkName;
+    @SerializedName("macaddr")
+    @Expose
+    private String macAddr;
+    @SerializedName("in-maint")
+    @Expose
+    private String inMaint;
+
+    private static final Gson gson = new GsonBuilder().disableHtmlEscaping().create();
+
+    public String toJson() {
+        return gson.toJson(this);
+    }
+
+    public String getInterfaceId() {
+        return interfaceId;
+    }
+
+    public void setInterfaceId(String interfaceId) {
+        this.interfaceId = interfaceId;
+    }
+
+    public String getInterfaceName() {
+        return interfaceName;
+    }
+
+    public void setInterfaceName(String interfaceName) {
+        this.interfaceName = interfaceName;
+    }
+
+    public String getInterfaceRole() {
+        return interfaceRole;
+    }
+
+    public void setInterfaceRole(String interfaceRole) {
+        this.interfaceRole = interfaceRole;
+    }
+
+    public String getIsPortMirrored() {
+        return isPortMirrored;
+    }
+
+    public void setIsPortMirrored(String isPortMirrored) {
+        this.isPortMirrored = isPortMirrored;
+    }
+
+    public String getAdminStatus() {
+        return adminStatus;
+    }
+
+    public void setAdminStatus(String adminStatus) {
+        this.adminStatus = adminStatus;
+    }
+
+    public String getNetworkName() {
+        return networkName;
+    }
+
+    public void setNetworkName(String networkName) {
+        this.networkName = networkName;
+    }
+
+    public String getMacAddr() {
+        return macAddr;
+    }
+
+    public void setMacAddr(String macAddr) {
+        this.macAddr = macAddr;
+    }
+
+    public String getInMaint() {
+        return inMaint;
+    }
+
+    public void setInMaint(String inMaint) {
+        this.inMaint = inMaint;
+    }
+
+    public static LInterfaceInstance fromJson(String payload) throws AuditException {
+        try {
+            if (payload == null || payload.isEmpty()) {
+                throw new AuditException("Empty Json response");
+            }
+            return gson.fromJson(payload, LInterfaceInstance.class);
+        } catch (Exception ex) {
+            throw new AuditException(AuditError.JSON_READER_PARSE_ERROR, ex);
+        }
+    }
+
+    /**
+     * No args constructor for use in serialization
+     *
+     */
+    public LInterfaceInstance() {
+    }
+
+    /**
+    *
+    * @param interfaceId
+    * @param interfaceName
+    * @param interfaceRole
+    * @param isPortMirrored
+    * @param adminStatus
+    * @param networkName
+    * @param macAddr
+    * @param inMaint
+    *
+    */
+   public LInterfaceInstance(String interfaceId, String interfaceName, String interfaceRole,
+           String isPortMirrored, String adminStatus, String networkName,
+           String macAddr,String inMaint
+           ) {
+       super();
+       this.interfaceId = interfaceId;
+       this.interfaceName = interfaceName;
+       this.interfaceRole = interfaceRole;
+       this.isPortMirrored = isPortMirrored;
+       this.adminStatus = adminStatus;
+       this.networkName = networkName;
+       this.macAddr = macAddr;
+       this.inMaint = inMaint;
+   }
+
+
+
+    /////////// common functions //////////////////////
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .append("interfaceId", interfaceId)
+                .append("interfaceName", interfaceName)
+                .append("interfaceRole", interfaceRole)
+                .append("isPortMirrored", isPortMirrored)
+                .append("adminStatus", adminStatus)
+                .append("networkName", networkName)
+                .append("macAddr", macAddr)
+                .append("inMaint", inMaint)
+               .toString();
+    }
+
+    @Override
+    public int hashCode() {
+        return new HashCodeBuilder()
+                .append(interfaceId)
+                .append(interfaceName)
+                .append(interfaceRole)
+                .append(isPortMirrored)
+                .append(adminStatus)
+                .append(networkName)
+                .append(macAddr)
+                .append(inMaint)
+                .toHashCode();
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if (other == this) {
+            return true;
+        }
+        if (!(other instanceof LInterfaceInstance)) {
+            return false;
+        }
+        LInterfaceInstance rhs = ((LInterfaceInstance) other);
+        return new EqualsBuilder()
+                .append(interfaceId, rhs.interfaceId)
+                .append(interfaceName, rhs.interfaceName)
+                .append(interfaceRole, rhs.interfaceRole)
+                .append(isPortMirrored, rhs.isPortMirrored)
+                .append(adminStatus, rhs.adminStatus)
+                .append(networkName, rhs.networkName)
+                .append(macAddr, rhs.macAddr)
+                .append(inMaint, rhs.inMaint)
+               .isEquals();
+    }
+}
diff --git a/src/main/java/org/onap/pomba/contextbuilder/aai/datatype/Vserver.java b/src/main/java/org/onap/pomba/contextbuilder/aai/datatype/Vserver.java
index d7b8896..803e65d 100644
--- a/src/main/java/org/onap/pomba/contextbuilder/aai/datatype/Vserver.java
+++ b/src/main/java/org/onap/pomba/contextbuilder/aai/datatype/Vserver.java
@@ -62,6 +62,7 @@ public class Vserver {
     private RelationshipList relationshipList;
 
     private List<PserverInstance> pserverInstanceList;
+    private List<LInterfaceInstance> lInterfaceInstanceList;
     public List<PserverInstance> getPserverInstanceList() {
         return pserverInstanceList;
     }
@@ -70,6 +71,14 @@ public class Vserver {
         this.pserverInstanceList = pserverInstanceList;
     }
 
+    public List<LInterfaceInstance> getlInterfaceInstanceList() {
+        return lInterfaceInstanceList;
+    }
+
+    public void setlInterfaceInstanceList(List<LInterfaceInstance> lInterfaceInstanceList) {
+        this.lInterfaceInstanceList = lInterfaceInstanceList;
+    }
+
     private static final Gson gson = new GsonBuilder().disableHtmlEscaping().create();
 
     public String toJson() {
diff --git a/src/main/java/org/onap/pomba/contextbuilder/aai/service/rs/RestServiceImpl.java b/src/main/java/org/onap/pomba/contextbuilder/aai/service/rs/RestServiceImpl.java
index 7fd27fb..19e81df 100644
--- a/src/main/java/org/onap/pomba/contextbuilder/aai/service/rs/RestServiceImpl.java
+++ b/src/main/java/org/onap/pomba/contextbuilder/aai/service/rs/RestServiceImpl.java
@@ -32,7 +32,9 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import java.util.UUID;
+import org.springframework.stereotype.Component;
 
+@Component
 public class RestServiceImpl implements RestService {
     private static Logger log = LoggerFactory.getLogger(RestService.class);
     private static final String EMPTY_JSON_STRING = "{}";
diff --git a/src/main/java/org/onap/pomba/contextbuilder/aai/util/RestUtil.java b/src/main/java/org/onap/pomba/contextbuilder/aai/util/RestUtil.java
index 0d09eb4..e3a1b15 100644
--- a/src/main/java/org/onap/pomba/contextbuilder/aai/util/RestUtil.java
+++ b/src/main/java/org/onap/pomba/contextbuilder/aai/util/RestUtil.java
@@ -53,6 +53,7 @@ import org.onap.pomba.contextbuilder.aai.datatype.Vserver;
 import org.onap.pomba.contextbuilder.aai.datatype.PserverInstance;
 import org.onap.pomba.contextbuilder.aai.datatype.PInterfaceInstance;
 import org.onap.pomba.contextbuilder.aai.datatype.L3networkInstance;
+import org.onap.pomba.contextbuilder.aai.datatype.LInterfaceInstance;
 import org.onap.pomba.contextbuilder.aai.exception.AuditError;
 import org.onap.pomba.contextbuilder.aai.exception.AuditException;
 import org.slf4j.Logger;
@@ -63,6 +64,8 @@ import org.onap.pomba.common.datatypes.PNF;
 import org.onap.pomba.common.datatypes.PInterface;
 import com.bazaarvoice.jolt.JsonUtils;
 import org.onap.pomba.common.datatypes.Pserver;
+import org.onap.pomba.common.datatypes.LInterface;
+
 
 public class RestUtil {
 
@@ -87,10 +90,13 @@ public class RestUtil {
     private static final String CATALOG_IMAGE = "image";
     private static final String CATALOG_PSERVER = "pserver";
     private static final String CATALOG_L3_NETWORK = "l3-network";
+    private static final String CATALOG_PNF = "pnf";
+    private static final String CATALOG_L_INTERFACE = "l-interface";
+
     private static final String VF_MODULES = "vf-modules";
     private static final String VF_MODULE = "vf-module";
 
-    private static final String CATALOG_PNF = "pnf";
+
 
     // Relationship Json Path
     private static final String RELATIONSHIP_LIST = "relationship-list";
@@ -136,7 +142,10 @@ public class RestUtil {
     private static final String ATTRIBUTE_NETWORK_TECHNOLOGY = "networkTechnology";
     private static final String ATTRIBUTE_PHYSICAL_NETWORK_NAME = "physicalNetworkName";
     private static final String ATTRIBUTE_SHARED_NETWORK_BOOLEAN = "sharedNetworkBoolean";
-
+    private static final String ATTRIBUTE_IS_PORT_MIRRORED = "isPortMirrored";
+    private static final String ATTRIBUTE_NETWORK_NAME = "networkName";
+    private static final String ATTRIBUTE_MAC_ADDR = "macAddr";
+    private static final String ATTRIBUTE_ADMIN_STATUS = "adminStatus";
 
 
     /**
@@ -482,7 +491,19 @@ public class RestUtil {
                     } else {
                         // Logic to Create the Vserver POJO object
                         Vserver vserver = Vserver.fromJson(vserverPayload);
-                        vserver.setPserverInstanceList(getPserverInfoFromAai(vserverPayload, aaiClient, baseURL, transactionId, aaiBasicAuthorization));
+
+                        // add pserver if any
+                        List<PserverInstance> pserverInstanceLst = getPserverInfoFromAai(vserverPayload, aaiClient, baseURL, transactionId, aaiBasicAuthorization);
+                        if ((pserverInstanceLst != null) && (!pserverInstanceLst.isEmpty())) {
+                            vserver.setPserverInstanceList(pserverInstanceLst);
+                        }
+
+                        // add L-interface List if any
+                        List<LInterfaceInstance> lInterfaceInstanceLst = getLInterfaceInstanceInfoFromAai(vserverPayload, aaiClient, baseURL, transactionId, aaiBasicAuthorization);
+                        if ((lInterfaceInstanceLst != null) && (!lInterfaceInstanceLst.isEmpty())) {
+                            vserver.setlInterfaceInstanceList(lInterfaceInstanceLst);
+                        }
+
                         vserverLst.add(vserver);
                     }
                 }
@@ -532,6 +553,38 @@ public class RestUtil {
         return pserverLst;
     }
 
+    private static List<LInterfaceInstance> getLInterfaceInstanceInfoFromAai (String vserverPayload, RestClient aaiClient, String baseURL, String transactionId, String aaiBasicAuthorization) throws AuditException {
+        if (vserverPayload == null) {
+            //already reported.
+            return null;
+        }
+
+        //Obtain related L-Interface instance info
+        List<String> lInterfaceRelatedLinkList = handleRelationshipGeneral (vserverPayload,CATALOG_L_INTERFACE );
+        List<LInterfaceInstance> lInterfaceLst = null;
+        if ((lInterfaceRelatedLinkList == null) || (lInterfaceRelatedLinkList.isEmpty())){
+            // already reported
+            return null;
+        }
+        lInterfaceLst = new ArrayList<>();
+        for (String lInterfaceRelatedLink : lInterfaceRelatedLinkList) {
+            String lInterfaceURL = baseURL + lInterfaceRelatedLink + DEPTH;;
+            String lInterfacePayload = getResource(aaiClient, lInterfaceURL, aaiBasicAuthorization,  transactionId,
+                    MediaType.valueOf(MediaType.APPLICATION_XML));
+
+            if (isEmptyJson(lInterfacePayload)) {
+                log.info(LogMessages.NOT_FOUND, "L-INTERFACE with url", lInterfaceURL);
+            } else {
+                log.info("Message from AAI for L-INTERFACE %s ,message body: %s", lInterfaceURL,lInterfacePayload);
+                // Logic to Create the Pserver POJO object
+                LInterfaceInstance lInterfaceInstance = LInterfaceInstance.fromJson(lInterfacePayload);
+
+                //update P-Interface if any.
+                lInterfaceLst.add(lInterfaceInstance);
+            }
+        }
+        return lInterfaceLst;
+    }
 
     private static String getVnfId(String genericVNFPayload) throws AuditException {
 
@@ -682,6 +735,17 @@ public class RestUtil {
                                             pServer = getPserverInfo (pserverInstanceList);
                                         }
                                         vm.setPServer(pServer);
+
+                                        //Update L-Interface here
+                                        List<LInterfaceInstance> lInterfaceInstanceList = vserver.getlInterfaceInstanceList();
+                                        List<LInterface> lInterfacelst = null;
+                                        if (lInterfaceInstanceList != null) {
+                                            lInterfacelst = getLInterfaceLstInfo (lInterfaceInstanceList);
+                                        }
+                                        if ((lInterfacelst != null) && (!lInterfacelst.isEmpty())) {
+                                            vm.setLInterfaceList(lInterfacelst);
+                                        }
+
                                         vmList.add(vm);
                                     }
 
@@ -835,6 +899,89 @@ public class RestUtil {
          return pserver;
     }
 
+    private static List<LInterface>  getLInterfaceLstInfo (List<LInterfaceInstance> lInterfaceInstanceList) {
+        if (lInterfaceInstanceList == null) {
+           return null;
+        }
+
+        List<LInterface> lInterfaceLst = new ArrayList<>();
+
+        for (LInterfaceInstance lInterfaceInstance: lInterfaceInstanceList) {
+            LInterface lInterface = new LInterface();
+            lInterface.setUuid(lInterfaceInstance.getInterfaceId());
+            lInterface.setName(lInterfaceInstance.getInterfaceName());
+
+            List<Attribute>  attributeList = new ArrayList<>();
+            // Iterate through the ENUM Attribute list
+            for (Attribute.Name  name: Attribute.Name.values()) {
+                if ((name.name().equals(ATTRIBUTE_INTERFACE_ROLE))
+                        && isValid(lInterfaceInstance.getInterfaceRole())){
+                    Attribute att = new Attribute();
+                    att.setDataQuality(DataQuality.ok());
+                    att.setName(Attribute.Name.interfaceRole);
+                    att.setValue(String.valueOf(lInterfaceInstance.getInterfaceRole()));
+                    attributeList.add(att);
+                }
+
+                if ((name.name().equals(ATTRIBUTE_IS_PORT_MIRRORED))
+                        && isValid(lInterfaceInstance.getIsPortMirrored())){
+                    Attribute att = new Attribute();
+                    att.setDataQuality(DataQuality.ok());
+                    att.setName(Attribute.Name.isPortMirrored);
+                    att.setValue(String.valueOf(lInterfaceInstance.getIsPortMirrored()));
+                    attributeList.add(att);
+                }
+
+                if ((name.name().equals(ATTRIBUTE_ADMIN_STATUS ))
+                        && isValid(lInterfaceInstance.getAdminStatus())){
+                    Attribute att = new Attribute();
+                    att.setDataQuality(DataQuality.ok());
+                    att.setName(Attribute.Name.adminStatus);
+                    att.setValue(String.valueOf(lInterfaceInstance.getAdminStatus()));
+                    attributeList.add(att);
+                }
+
+                if ((name.name().equals(ATTRIBUTE_NETWORK_NAME ))
+                        && isValid(lInterfaceInstance.getNetworkName())){
+                    Attribute att = new Attribute();
+                    att.setDataQuality(DataQuality.ok());
+                    att.setName(Attribute.Name.networkName);
+                    att.setValue(String.valueOf(lInterfaceInstance.getNetworkName()));
+                    attributeList.add(att);
+                }
+
+                if ((name.name().equals(ATTRIBUTE_MAC_ADDR ))
+                        && isValid(lInterfaceInstance.getMacAddr())){
+                    Attribute att = new Attribute();
+                    att.setDataQuality(DataQuality.ok());
+                    att.setName(Attribute.Name.macAddress);
+                    att.setValue(String.valueOf(lInterfaceInstance.getMacAddr()));
+                    attributeList.add(att);
+                }
+
+                if ((name.name().equals(ATTRIBUTE_LOCKEDBOOLEAN))
+                        && isValid(lInterfaceInstance.getInMaint())){
+                    Attribute att = new Attribute();
+                    att.setDataQuality(DataQuality.ok());
+                    att.setName(Attribute.Name.lockedBoolean);
+                    att.setValue(String.valueOf(lInterfaceInstance.getInMaint()));
+                    attributeList.add(att);
+                }
+
+            }
+
+            if (!attributeList.isEmpty()) {
+                lInterface.setAttributes(attributeList);
+            }
+            lInterfaceLst.add(lInterface);
+        }
+
+        if (lInterfaceLst.isEmpty()) {
+            return null;
+        }
+        return lInterfaceLst;
+   }
+
     private static Pserver updatePserverInfoWithPInterface (Pserver pserver, List<PInterfaceInstance> pInterfaceInstanceList) {
 
         List<PInterface> pInterfaceList = new ArrayList<>();