Adapt PCE code for OTN services
[transportpce.git] / pce / src / main / java / org / opendaylight / transportpce / pce / networkanalyzer / PceNode.java
index 52e01056ac19ec6af2a7aa5c992528536922b1a8..74d71bd68bccad06540fce7f9007703a00342fe4 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2017 AT&T, Inc. and others.  All rights reserved.
+ * Copyright © 2020 Orange, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 
 package org.opendaylight.transportpce.pce.networkanalyzer;
 
-import java.util.ArrayList;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
-import java.util.TreeMap;
 
-import org.opendaylight.transportpce.common.NetworkUtils;
-import org.opendaylight.transportpce.pce.SortPortsByName;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.TerminationPoint1;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130.Node1;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130.networks.network.node.termination.point.pp.attributes.UsedWavelength;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmNodeType;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmTpType;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
-public class PceNode {
-    /* Logging. */
-    private static final Logger LOG = LoggerFactory.getLogger(PceCalculation.class);
-    ////////////////////////// NODES ///////////////////////////
-    /*
-     */
+public interface PceNode {
+    String getPceNodeType();
 
-    private boolean valid = true;
+    String getSupNetworkNodeId();
 
-    protected final Node node;
-    protected final NodeId nodeId;
-    protected final OpenroadmNodeType nodeType;
-    private final String supNodeId;
-    private final String supNetworkNodeId;
-    private final String clli;
+    String getSupClliNodeId();
 
-    // wavelength calculation per node type
-    private List<Long> availableWLindex = new ArrayList<Long>();
-    private Map<String, OpenroadmTpType> availableSrgPp = new TreeMap<String, OpenroadmTpType>();
-    private Map<String, OpenroadmTpType> availableSrgCp = new TreeMap<String, OpenroadmTpType>();
-    private List<String> usedXpndrNWTps = new ArrayList<String>();
-    private List<PceLink> outgoingLinks = new ArrayList<PceLink>();
-    private Map<String, String> clientPerNwTp = new HashMap<String, String>();
-    private Map<String,List<Integer>> tpAvailableTribPort = new TreeMap<String,List<Integer>>();
-    private Map<String,List<Integer>> tpAvailableTribSlot = new TreeMap<String,List<Integer>>();
+    void addOutgoingLink(PceLink outLink);
 
-    public PceNode(Node node, OpenroadmNodeType nodeType, NodeId nodeId) {
-        this.node = node;
-        this.nodeId = nodeId;
-        this.nodeType = nodeType;
-        this.supNodeId = getSupNodeId(node);
-        this.supNetworkNodeId = getNetworkSupNodeId(node);
-        //this.clli = MapUtils.getCLLI(node);
-        this.clli = getClliSupNodeId(node);
-        this.tpAvailableTribPort.clear();
-        this.tpAvailableTribSlot.clear();
+    String getRdmSrgClient(String tp);
 
-        if ((node == null) || (nodeId == null) || (nodeType == null)) {
-            LOG.error("PceNode: one of parameters is not populated : nodeId, node type");
-            this.valid = false;
-        }
-    }
+    String getXpdrClient(String tp);
 
-    public void initSrgTps() {
-        this.availableSrgPp.clear();
-        this.availableSrgCp.clear();
-        if (!isValid()) {
-            return;
-        }
-        LOG.info("initSrgTpList: getting SRG tps from ROADM node {}", this.nodeId);
-        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1 nodeTp =
-                this.node.augmentation(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology
-                                .rev180226.Node1.class);
-        List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
-            .node.TerminationPoint> allTps =
-                nodeTp.getTerminationPoint();
-        if (allTps == null) {
-            LOG.error("initSrgTpList: ROADM TerminationPoint list is empty for node {}", this.toString());
-            this.valid = false;
-            return;
-        }
-        for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
-            .node.TerminationPoint tp : allTps) {
-            TerminationPoint1 cntp1 = tp.augmentation(TerminationPoint1.class);
-            org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130.TerminationPoint1 nttp1 = tp
-                .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130
-                .TerminationPoint1.class);
-            OpenroadmTpType type = cntp1.getTpType();
-            LOG.info("type = {} for tp {}", type.getName(), tp.toString());
+    boolean checkTP(String tp);
 
-            switch (type) {
-                case SRGTXRXCP:
-                case SRGRXCP:
-                case SRGTXCP:
-                    LOG.info("initSrgTpList: adding SRG-CP tp = {} ", tp.getTpId().getValue());
-                    this.availableSrgCp.put(tp.getTpId().getValue(), cntp1.getTpType());
-                    break;
-                case SRGRXPP:
-                case SRGTXPP:
-                case SRGTXRXPP:
-                    boolean used = true;
-                    LOG.info("initSrgTpList: SRG-PP tp = {} found", tp.getTpId().getValue());
-                    try {
-                        List<UsedWavelength> usedWavelengths = nttp1.getPpAttributes().getUsedWavelength();
-                        if (usedWavelengths.isEmpty()) {
-                            used = false;
-                        }
-                    } catch (NullPointerException e) {
-                        LOG.warn("initSrgTpList: 'usedWavelengths' for tp={} is null !", tp.getTpId().getValue());
-                        used = false;
-                    }
-                    if (!used) {
-                        LOG.info("initSrgTpList: adding SRG-PP tp '{}'", tp.getTpId().getValue());
-                        this.availableSrgPp.put(tp.getTpId().getValue(), cntp1.getTpType());
-                    } else {
-                        LOG.warn("initSrgTpList: SRG-PP tp = {} found is busy !!");
-                    }
-                    break;
-                default:
-                    break;
-            }
-        }
-        if (this.availableSrgPp.isEmpty() && this.availableSrgCp.isEmpty()) {
-            LOG.error("initSrgTpList: ROADM SRG TerminationPoint list is empty for node {}", this.toString());
-            this.valid = false;
-            return;
-        }
-        LOG.info("initSrgTpList: availableSrgPp size = {} && availableSrgCp size = {} in {}", this.availableSrgPp
-                .size(), this.availableSrgCp.size(), this.toString());
-        return;
-    }
+    List<PceLink> getOutgoingLinks();
 
-    public void initWLlist() {
-        this.availableWLindex.clear();
-        if (!isValid()) {
-            return;
-        }
-        Node1 node1 = this.node.augmentation(Node1.class);
-        switch (this.nodeType) {
-            case SRG :
-                List<org.opendaylight.yang.gen.v1.http.org.openroadm.srg.rev181130.srg.node.attributes
-                    .AvailableWavelengths> srgAvailableWL =
-                        node1.getSrgAttributes().getAvailableWavelengths();
-                if (srgAvailableWL == null) {
-                    this.valid = false;
-                    LOG.error("initWLlist: SRG AvailableWavelengths is empty for node  {}", this.toString());
-                    return;
-                }
-                for (org.opendaylight.yang.gen.v1.http.org.openroadm.srg.rev181130.srg.node.attributes
-                        .AvailableWavelengths awl : srgAvailableWL) {
-                    this.availableWLindex.add(awl.getIndex());
-                    LOG.debug("initWLlist: SRG next = {} in {}", awl.getIndex(), this.toString());
-                }
-                break;
-            case DEGREE :
-                List<org.opendaylight.yang.gen.v1.http.org.openroadm.degree.rev181130.degree.node.attributes
-                    .AvailableWavelengths> degAvailableWL = node1.getDegreeAttributes().getAvailableWavelengths();
-                if (degAvailableWL == null) {
-                    this.valid = false;
-                    LOG.error("initWLlist: DEG AvailableWavelengths is empty for node  {}", this.toString());
-                    return;
-                }
-                for (org.opendaylight.yang.gen.v1.http.org.openroadm.degree.rev181130.degree.node.attributes
-                            .AvailableWavelengths awl : degAvailableWL) {
-                    this.availableWLindex.add(awl.getIndex());
-                    LOG.debug("initWLlist: DEGREE next = {} in {}", awl.getIndex(), this.toString());
-                }
-                break;
-            case XPONDER :
-                // HARD CODED 96
-                for (long i = 1; i <= 96; i++) {
-                    this.availableWLindex.add(i);
-                }
-                break;
-            default:
-                LOG.error("initWLlist: unsupported node type {} in node {}", this.nodeType, this.toString());
-                break;
-        }
-        if (this.availableWLindex.size() == 0) {
-            LOG.debug("initWLlist: There are no available wavelengths in node {}", this.toString());
-            this.valid = false;
-        }
-        LOG.debug("initWLlist: availableWLindex size = {} in {}", this.availableWLindex.size(), this.toString());
-        return;
-    }
+    NodeId getNodeId();
 
-    public void initXndrTps() {
-        LOG.info("initXndrTps for node : {}", this.nodeId);
-        if (!isValid()) {
-            return;
-        }
-        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1 nodeTp =
-                this.node.augmentation(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology
-                        .rev180226.Node1.class);
-        List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
-            .node.TerminationPoint> allTps = nodeTp.getTerminationPoint();
-        if (allTps == null) {
-            this.valid = false;
-            LOG.error("initXndrTps: XPONDER TerminationPoint list is empty for node {}", this.toString());
-            return;
-        }
-        this.valid = false;
-        for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
-            .node.TerminationPoint tp : allTps) {
-            TerminationPoint1 cntp1 = tp.augmentation(TerminationPoint1.class);
-            org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130.TerminationPoint1 nttp1 = tp
-                .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130
-                .TerminationPoint1.class);
-            if (cntp1.getTpType() == OpenroadmTpType.XPONDERNETWORK) {
-                if (nttp1 != null && nttp1.getXpdrNetworkAttributes().getWavelength() != null) {
-                    this.usedXpndrNWTps.add(tp.getTpId().getValue());
-                    LOG.info("initXndrTps: XPONDER tp = {} is used", tp.getTpId().getValue());
-                } else {
-                    this.valid = true;
-                }
-                // find Client of this network TP
-                org.opendaylight.yang.gen.v1.http.transportpce.topology.rev200123.TerminationPoint1 tpceTp1 =
-                    tp.augmentation(org.opendaylight.yang.gen.v1.http.transportpce.topology.rev200123
-                        .TerminationPoint1.class);
-                String client = tpceTp1.getAssociatedConnectionMapPort();
-                if ((client.equals("")) || (client == null)) {
-                    LOG.error("initXndrTps: XPONDER {} NW TP doesn't have defined Client {}", this.toString(), tp
-                            .getTpId().getValue());
-                    this.valid = false;
-                }
-                this.clientPerNwTp.put(tp.getTpId().getValue(), client);
-            }
-        }
-        if (!isValid()) {
-            LOG.error("initXndrTps: XPONDER doesn't have available wavelengths for node  {}", this.toString());
-            return;
-        }
-    }
+    boolean checkWL(long index);
 
-    public String getRdmSrgClient(String tp, Boolean aend) {
-        LOG.info("getRdmSrgClient: Getting PP client for tp '{}' on node : {}", tp, this.nodeId);
-        OpenroadmTpType srgType = null;
-        OpenroadmTpType cpType = this.availableSrgCp.get(tp);
-        if (cpType == null) {
-            LOG.error("getRdmSrgClient: tp {} not existed in SRG CPterminationPoint list");
-            return null;
-        }
-        switch (cpType) {
-            case SRGTXRXCP:
-                LOG.info("getRdmSrgClient: Getting BI Directional PP port ...");
-                srgType = OpenroadmTpType.SRGTXRXPP;
-                break;
-            case SRGTXCP:
-                LOG.info("getRdmSrgClient: Getting UNI Rx PP port ...");
-                srgType = OpenroadmTpType.SRGRXPP;
-                break;
-            case SRGRXCP:
-                LOG.info("getRdmSrgClient: Getting UNI Tx PP port ...");
-                srgType = OpenroadmTpType.SRGTXPP;
-                break;
-            default:
-                break;
-        }
-        LOG.info("getRdmSrgClient:  Getting client PP for CP '{}'", tp);
-        if (!this.availableSrgPp.isEmpty()) {
-            Optional<String> client = null;
-            final OpenroadmTpType openType = srgType;
-            client = this.availableSrgPp.entrySet()
-                    .stream().filter(pp -> pp.getValue().getName().equals(openType.getName()))
-                    .map(Map.Entry::getKey)
-                    .sorted(new SortPortsByName())
-                    .findFirst();
-            if (!client.isPresent()) {
-                LOG.error("getRdmSrgClient: ROADM {} doesn't have PP Client for CP {}", this.toString(), tp);
-                return null;
-            }
-            LOG.info("getRdmSrgClient: client PP {} for CP {} found !", client, tp);
-            return client.get();
-        } else {
-            LOG.error("getRdmSrgClient: SRG TerminationPoint PP list is not available for node {}", this.toString());
-            return null;
-        }
-    }
-
-    private String getSupNodeId(Node inputNode) {
-        // TODO: supporting IDs exist as a List. this code takes just the
-        // first element
-        if (MapUtils.getSupNode(inputNode) != null) {
-            return MapUtils.getSupNode(inputNode);
-        } else {
-            LOG.error("getSupNodeId: Empty Supporting node for node: [{}]. Node is ignored", inputNode.getNodeId());
-            return "";
-        }
-    }
-
-    private String getClliSupNodeId(Node inputNode) {
-        TreeMap<String, String> allSupNodes = new TreeMap<String, String>();
-        String tempNetworkSupNodeId = "";
-        allSupNodes = MapUtils.getAllSupNode(inputNode);
-        if (allSupNodes.get(NetworkUtils.CLLI_NETWORK_ID) == null) {
-            LOG.error("getClliSupNodeId: No Supporting node at CLLI layer for node: [{}].", inputNode.getNodeId());
-        } else {
-            tempNetworkSupNodeId = allSupNodes.get(NetworkUtils.CLLI_NETWORK_ID);
-        }
-        return tempNetworkSupNodeId;
-    }
-
-    public String getClliSupNodeId() {
-        return clli;
-    }
-
-    private String getNetworkSupNodeId(Node inputNode) {
-        TreeMap<String, String> allSupNodes = new TreeMap<String, String>();
-        String tempNetworkSupNodeId = "";
-        allSupNodes = MapUtils.getAllSupNode(inputNode);
-        if (allSupNodes.get(NetworkUtils.UNDERLAY_NETWORK_ID) == null) {
-            LOG.error(
-                "getNetworkSupNodeId: No Supporting node at NETWORK layer for node: [{}].", inputNode.getNodeId());
-        } else {
-            tempNetworkSupNodeId = allSupNodes.get(NetworkUtils.UNDERLAY_NETWORK_ID);
-        }
-        return tempNetworkSupNodeId;
-    }
-
-
-    public void validateAZxponder(String anodeId, String znodeId) {
-        if (!isValid()) {
-            return;
-        }
-        if (this.nodeType != OpenroadmNodeType.XPONDER) {
-            return;
-        }
-        // Detect A and Z
-        if (this.supNetworkNodeId.equals(anodeId) || (this.supNetworkNodeId.equals(znodeId))) {
-            LOG.info("validateAZxponder: A or Z node detected == {}", nodeId.getValue());
-            initXndrTps();
-            return;
-        }
-        LOG.debug("validateAZxponder: XPONDER is ignored == {}", nodeId.getValue());
-        valid = false;
-    }
-
-    public String getXpdrClient(String tp) {
-        return this.clientPerNwTp.get(tp);
-    }
-
-    public boolean checkTP(String tp) {
-        return !(this.usedXpndrNWTps.contains(tp));
-    }
-
-    public boolean checkWL(long index) {
-        return (this.availableWLindex.contains(index));
-    }
-
-    public boolean isValid() {
-        if ((node == null) || (nodeId == null) || (nodeType == null) || (supNetworkNodeId == null) || (clli == null)) {
-            LOG.error("PceNode: one of parameters is not populated : nodeId, node type, supporting nodeId");
-            valid = false;
-        }
-        return valid;
-    }
-
-    public List<Long> getAvailableWLs() {
-        return availableWLindex;
-    }
-
-    public void addOutgoingLink(PceLink outLink) {
-        this.outgoingLinks.add(outLink);
-    }
-
-    public List<PceLink> getOutgoingLinks() {
-        return outgoingLinks;
-    }
-
-    public String getClient(String tp) {
-        return clientPerNwTp.get(tp);
-    }
-
-    public NodeId getNodeId() {
-        return nodeId;
-    }
-
-    public String getSupNodeIdPceNode() {
-        return supNodeId;
-    }
-
-    public String getSupNetworkNodeIdPceNode() {
-        return supNetworkNodeId;
-    }
-
-    public String getCLLI() {
-        return clli;
-    }
-
-    public String toString() {
-        return "PceNode type=" + nodeType + " ID=" + nodeId.getValue() + " CLLI=" + clli;
-    }
-
-    public void printLinksOfNode() {
-        LOG.info(" outgoing links of node {} : {} ", nodeId.getValue(), this.getOutgoingLinks().toString());
-    }
-
-    public Map<String,List<Integer>> getAvailableTribPorts() {
-        return tpAvailableTribPort;
-    }
-
-    public Map<String,List<Integer>> getAvailableTribSlots() {
-        return tpAvailableTribSlot;
-    }
+    Map<String, List<Integer>> getAvailableTribPorts();
 
+    Map<String, List<Integer>> getAvailableTribSlots();
 }