2 * Copyright © 2019 Orange, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.transportpce.tapi.topology;
10 import java.nio.charset.Charset;
11 import java.util.ArrayList;
12 import java.util.Collections;
13 import java.util.HashMap;
14 import java.util.Iterator;
15 import java.util.List;
17 import java.util.Map.Entry;
19 import java.util.UUID;
20 import java.util.stream.Collectors;
21 import org.opendaylight.transportpce.tapi.TapiStringConstants;
22 import org.opendaylight.transportpce.tapi.utils.TapiLink;
23 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.Link1;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev230526.OpenroadmNodeType;
27 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.AdministrativeState;
28 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.Direction;
29 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.ForwardingDirection;
30 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.LayerProtocolName;
31 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.LifecycleState;
32 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.OperationalState;
33 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.PortRole;
34 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.Uuid;
35 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.global._class.Name;
36 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.global._class.NameBuilder;
37 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.global._class.NameKey;
38 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.tapi.context.ServiceInterfacePoint;
39 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.tapi.context.ServiceInterfacePointKey;
40 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.photonic.media.rev221121.PHOTONICLAYERQUALIFIEROTS;
41 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.link.NodeEdgePoint;
42 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.link.NodeEdgePointBuilder;
43 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.link.NodeEdgePointKey;
44 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.NodeRuleGroup;
45 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.NodeRuleGroupKey;
46 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.OwnedNodeEdgePoint;
47 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.OwnedNodeEdgePointBuilder;
48 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.OwnedNodeEdgePointKey;
49 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.RiskParameterPac;
50 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.RiskParameterPacBuilder;
51 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.edge.point.SupportedCepLayerProtocolQualifierInstances;
52 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.edge.point.SupportedCepLayerProtocolQualifierInstancesBuilder;
53 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.risk.parameter.pac.RiskCharacteristic;
54 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.risk.parameter.pac.RiskCharacteristicBuilder;
55 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Link;
56 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.LinkBuilder;
57 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.LinkKey;
58 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.NodeBuilder;
59 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.NodeKey;
60 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.transfer.cost.pac.CostCharacteristic;
61 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.transfer.cost.pac.CostCharacteristicBuilder;
62 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.transfer.timing.pac.LatencyCharacteristic;
63 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.transfer.timing.pac.LatencyCharacteristicBuilder;
64 import org.opendaylight.yangtools.yang.common.Uint64;
65 import org.slf4j.Logger;
66 import org.slf4j.LoggerFactory;
69 public class ConvertORTopoToTapiTopo {
71 private static final Logger LOG = LoggerFactory.getLogger(ConvertORTopoToTapiTopo.class);
72 private Uuid tapiTopoUuid;
73 private Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
75 private Map<LinkKey, Link> tapiLinks;
76 private Map<ServiceInterfacePointKey, ServiceInterfacePoint> tapiSips;
77 private final TapiLink tapiLink;
80 public ConvertORTopoToTapiTopo(Uuid tapiTopoUuid, TapiLink tapiLink) {
81 this.tapiTopoUuid = tapiTopoUuid;
82 this.tapiNodes = new HashMap<>();
83 this.tapiLinks = new HashMap<>();
84 this.tapiSips = new HashMap<>();
85 this.tapiLink = tapiLink;
88 public void convertLinks(Map<
89 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
91 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
93 List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
94 .Link> otnLinkList = new ArrayList<>(otnLinkMap.values());
95 Collections.sort(otnLinkList, (l1, l2) -> l1.getLinkId().getValue()
96 .compareTo(l2.getLinkId().getValue()));
97 List<String> linksToNotConvert = new ArrayList<>();
98 LOG.info("creation of {} otn links", otnLinkMap.size() / 2);
99 for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
100 .Link otnlink : otnLinkList) {
101 if (!linksToNotConvert.contains(otnlink.getLinkId().getValue())) {
102 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks
103 .network.Link oppositeLink = otnLinkMap.get(new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns
104 .yang.ietf.network.topology.rev180226.networks.network.LinkKey(otnlink.augmentation(Link1.class)
105 .getOppositeLink()));
107 AdminStates oppLnkAdmState = null;
108 State oppLnkOpState = null;
109 String oppositeLinkId = null;
110 if (oppositeLink != null) {
111 oppLnkAdmState = oppositeLink.augmentation(Link1.class).getAdministrativeState();
112 oppLnkOpState = oppositeLink.augmentation(Link1.class).getOperationalState();
113 oppositeLinkId = oppositeLink.getLinkId().getValue();
116 otnlink.augmentation(Link1.class).getAdministrativeState() == null
117 || oppLnkAdmState == null
119 : this.tapiLink.setTapiAdminState(
120 otnlink.augmentation(Link1.class).getAdministrativeState(), oppLnkAdmState).getName();
121 String operState = otnlink.augmentation(Link1.class).getOperationalState() == null
122 || oppLnkOpState == null
124 : this.tapiLink.setTapiOperationalState(
125 otnlink.augmentation(Link1.class).getOperationalState(), oppLnkOpState).getName();
126 // TODO: Handle not only OTU4 but also other cases
127 String prefix = otnlink.getLinkId().getValue().split("-")[0];
128 String nodesQual = TapiStringConstants.XPDR;
129 String tpsQual = prefix.equals("OTU4") ? TapiStringConstants.I_OTSI : TapiStringConstants.E_ODU;
130 LayerProtocolName layerProtocolName = prefix.equals("OTU4") ? LayerProtocolName.PHOTONICMEDIA
131 : LayerProtocolName.ODU;
133 Link tapLink = this.tapiLink.createTapiLink(otnlink.getSource().getSourceNode().getValue(),
134 otnlink.getSource().getSourceTp().getValue(), otnlink.getDestination().getDestNode().getValue(),
135 otnlink.getDestination().getDestTp().getValue(), TapiStringConstants.OTN_XPDR_XPDR_LINK, nodesQual,
136 nodesQual, tpsQual, tpsQual, adminState, operState, Set.of(layerProtocolName),
137 Set.of(layerProtocolName.getName()), this.tapiTopoUuid);
138 linksToNotConvert.add(oppositeLinkId);
139 tapiLinks.put(tapLink.key(), tapLink);
140 LOG.debug("Links converted are as follow {}", tapiLinks.toString());
145 public void convertRoadmInfrastructure() {
146 LOG.info("abstraction of the ROADM infrastructure towards a photonic node");
147 Uuid nodeUuid = new Uuid(UUID.nameUUIDFromBytes(TapiStringConstants.RDM_INFRA
148 .getBytes(Charset.forName("UTF-8"))).toString());
149 Name nodeName = new NameBuilder().setValueName("otsi node name").setValue(TapiStringConstants.RDM_INFRA)
151 Name nameNodeType = new NameBuilder().setValueName("Node Type")
152 .setValue(OpenroadmNodeType.ROADM.getName()).build();
153 Set<LayerProtocolName> nodeLayerProtocols = Set.of(LayerProtocolName.PHOTONICMEDIA);
154 List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node> tapiPhotonicNodes
155 = pruneTapiPhotonicNodes();
156 //At that stage, there is no Roadm in the tapiPhotonicNodes Map / only the transponders
157 Map<String, String> photonicNepUuisMap = convertListNodeWithListNepToMapForUuidAndName(tapiPhotonicNodes);
158 // nep creation for rdm infra abstraction node
159 Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepMap = createNepForRdmNode(photonicNepUuisMap.size());
160 // node rule group creation
161 Map<NodeRuleGroupKey, NodeRuleGroup> nodeRuleGroupList
162 = new ConvertORToTapiTopology(this.tapiTopoUuid)
163 .createNodeRuleGroupForRdmNode("Abstracted", nodeUuid, null, onepMap.values());
164 // Empty random creation of mandatory fields for avoiding errors....
165 CostCharacteristic costCharacteristic = new CostCharacteristicBuilder()
166 .setCostAlgorithm("Restricted Shortest Path - RSP")
167 .setCostName("HOP_COUNT")
168 .setCostValue(TapiStringConstants.COST_HOP_VALUE)
170 LatencyCharacteristic latencyCharacteristic = new LatencyCharacteristicBuilder()
171 .setFixedLatencyCharacteristic(TapiStringConstants.FIXED_LATENCY_VALUE)
172 .setQueuingLatencyCharacteristic(TapiStringConstants.QUEING_LATENCY_VALUE)
173 .setJitterCharacteristic(TapiStringConstants.JITTER_VALUE)
174 .setWanderCharacteristic(TapiStringConstants.WANDER_VALUE)
175 .setTrafficPropertyName("FIXED_LATENCY")
177 RiskCharacteristic riskCharacteristic = new RiskCharacteristicBuilder()
178 .setRiskCharacteristicName("risk characteristic")
179 .setRiskIdentifierList(Set.of("risk identifier1", "risk identifier2"))
181 RiskParameterPac riskParamPac = new RiskParameterPacBuilder()
182 .setRiskCharacteristic(Map.of(riskCharacteristic.key(), riskCharacteristic))
184 // build RDM infra node abstraction
185 org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node rdmNode = new NodeBuilder()
187 .setName(Map.of(nodeName.key(), nodeName, nameNodeType.key(), nameNodeType))
188 .setLayerProtocolName(nodeLayerProtocols)
189 .setAdministrativeState(AdministrativeState.UNLOCKED)
190 .setOperationalState(OperationalState.ENABLED)
191 .setLifecycleState(LifecycleState.INSTALLED)
192 .setOwnedNodeEdgePoint(onepMap)
193 .setNodeRuleGroup(nodeRuleGroupList)
194 .setCostCharacteristic(Map.of(costCharacteristic.key(), costCharacteristic))
195 .setLatencyCharacteristic(Map.of(latencyCharacteristic.key(), latencyCharacteristic))
196 .setRiskParameterPac(riskParamPac)
198 tapiNodes.put(rdmNode.key(), rdmNode);
199 // OTS link creation between photonic nodes and RDM infra abstraction node :
200 //onepMap is a list of nep which Uuid is formed from THE ROADM node name, "nep" and an integer (order of the nep)
201 // It has absolutely no relationship with the real ROADM infrastructure (SRG ports)
202 //rdmInfraNepUuisMap is a Map <ROADMnodeUuuid--NepUuid; ROADMnodeName--nepName> built from onepMap
203 //photonicNepUuisMap is a Map <TSPnodeUuuid--eNepUuid; TSPnodeName--nepName> built from TapiPhotonicNode
204 Map<String, String> rdmInfraNepUuisMap = convertListNodeWithListNepToMapForUuidAndName(List.of(rdmNode));
205 if (photonicNepUuisMap.size() != rdmInfraNepUuisMap.size()) {
206 LOG.warn("Unable to build OTS links between photonics nodes and RDM infrasctructure abstraction");
208 //Tapi OtsLinks are created between Neps corresponding to the eNEPs of transponders (existing network ports)
209 //and Generic NEPS with abstracted names created in the ROADM infrastructure corresponding to tps mirroring
210 //transponders NETWORK PORTs. There is a simplification here considering that any network port of
211 //transponders will have a mirroring SRG client port in the ROADM infrastructure.
212 // TODO: Do not understand that we build OTS link without checking that existing transponder ports
213 //are effectively connected. Need some consolidation
214 createTapiOtsLinks(photonicNepUuisMap, rdmInfraNepUuisMap);
218 private List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
219 pruneTapiPhotonicNodes() {
220 List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
221 prunedTapiPhotonicNodes = new ArrayList<>();
222 List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node> tapiPhotonicNodes
223 = this.tapiNodes.values().stream()
224 .filter(n -> n.getLayerProtocolName().contains(LayerProtocolName.PHOTONICMEDIA))
225 .collect(Collectors.toList());
226 for (org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node node
227 : tapiPhotonicNodes) {
228 Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepM = new HashMap<>();
229 for (Map.Entry<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> entry : node.getOwnedNodeEdgePoint().entrySet()) {
230 if (entry.getValue().getName().values().stream()
231 .filter(name -> name.getValueName().equals("eNodeEdgePoint")).count() > 0) {
232 onepM.put(entry.getKey(), entry.getValue());
235 org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node prunedNode
236 = new NodeBuilder(node).setOwnedNodeEdgePoint(onepM).build();
237 prunedTapiPhotonicNodes.add(prunedNode);
239 return prunedTapiPhotonicNodes;
242 private Map<String, String> convertListNodeWithListNepToMapForUuidAndName(
243 List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node> nodes) {
244 Map<String, String> uuidNameMap = new HashMap<>();
245 for (org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node node : nodes) {
246 for (OwnedNodeEdgePoint nep : node.nonnullOwnedNodeEdgePoint().values()) {
247 String nodeUuid = node.getUuid().getValue();
248 String nepUuid = nep.getUuid().getValue();
249 String nodeName = node.getName().get(new NameKey("otsi node name")).getValue();
250 String nepName = nep.getName().get(new NameKey(nep.getName().keySet().stream().findFirst()
253 uuidNameMap.put(String.join("--", nodeUuid, nepUuid), String.join("--", nodeName, nepName));
259 private Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> createNepForRdmNode(int nbNep) {
260 Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepMap = new HashMap<>();
261 for (int i = 1; i <= nbNep; i++) {
262 Uuid nepUuid = new Uuid(UUID.nameUUIDFromBytes((String.join("+", "roadm node", "nep", String.valueOf(i)))
263 .getBytes(Charset.forName("UTF-8"))).toString());
264 Name nepName = new NameBuilder()
265 .setValueName("NodeEdgePoint name")
266 .setValue(new StringBuilder("NodeEdgePoint_").append(i).toString())
268 List<SupportedCepLayerProtocolQualifierInstances> sclpqiList = new ArrayList<>();
269 sclpqiList.add(new SupportedCepLayerProtocolQualifierInstancesBuilder()
270 .setLayerProtocolQualifier(PHOTONICLAYERQUALIFIEROTS.VALUE)
271 .setNumberOfCepInstances(Uint64.valueOf(1))
273 OwnedNodeEdgePoint onep = new OwnedNodeEdgePointBuilder()
275 .setLayerProtocolName(LayerProtocolName.PHOTONICMEDIA)
276 .setName(Map.of(nepName.key(), nepName))
277 .setSupportedCepLayerProtocolQualifierInstances(sclpqiList)
278 .setDirection(Direction.BIDIRECTIONAL).setLinkPortRole(PortRole.SYMMETRIC)
279 .setAdministrativeState(AdministrativeState.UNLOCKED).setOperationalState(OperationalState.ENABLED)
280 .setLifecycleState(LifecycleState.INSTALLED)
282 onepMap.put(onep.key(), onep);
287 private void createTapiOtsLinks(Map<String, String> photonicNepUuisMap, Map<String, String> rdmInfraNepUuisMap) {
288 Iterator<Entry<String, String>> it1 = photonicNepUuisMap.entrySet().iterator();
289 Iterator<Entry<String, String>> it2 = rdmInfraNepUuisMap.entrySet().iterator();
290 while (it1.hasNext()) {
291 Map<NodeEdgePointKey, NodeEdgePoint> nepMap = new HashMap<>();
292 Map.Entry<String, String> photonicEntry = it1.next();
293 Map.Entry<String, String> rdmEntry = it2.next();
294 Uuid sourceUuidTp = new Uuid(photonicEntry.getKey().split("--")[1]);
295 Uuid sourceUuidNode = new Uuid(photonicEntry.getKey().split("--")[0]);
296 Uuid destUuidTp = new Uuid(rdmEntry.getKey().split("--")[1]);
297 Uuid destUuidNode = new Uuid(rdmEntry.getKey().split("--")[0]);
298 NodeEdgePoint sourceNep = new NodeEdgePointBuilder()
299 .setTopologyUuid(this.tapiTopoUuid)
300 .setNodeUuid(sourceUuidNode)
301 .setNodeEdgePointUuid(sourceUuidTp)
303 nepMap.put(sourceNep.key(), sourceNep);
304 NodeEdgePoint destNep = new NodeEdgePointBuilder()
305 .setTopologyUuid(this.tapiTopoUuid)
306 .setNodeUuid(destUuidNode)
307 .setNodeEdgePointUuid(destUuidTp)
309 nepMap.put(destNep.key(), destNep);
310 Name linkName = new NameBuilder().setValueName("OTS link name")
311 .setValue(String.join(" and ", photonicEntry.getValue(), rdmEntry.getValue()))
313 Link otsLink = new LinkBuilder()
315 UUID.nameUUIDFromBytes((String.join(" and ", photonicEntry.getValue(), rdmEntry.getValue()))
316 .getBytes(Charset.forName("UTF-8")))
318 .setName(Map.of(linkName.key(), linkName))
319 .setLayerProtocolName(Set.of(LayerProtocolName.PHOTONICMEDIA))
320 .setNodeEdgePoint(nepMap)
321 .setDirection(ForwardingDirection.BIDIRECTIONAL)
323 this.tapiLinks.put(otsLink.key(), otsLink);
327 public void setTapiNodes(Map<NodeKey,
328 org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node> nodeMap) {
329 this.tapiNodes.putAll(nodeMap);
332 public Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
337 public Map<LinkKey, Link> getTapiLinks() {
341 public Map<ServiceInterfacePointKey, ServiceInterfacePoint> getTapiSips() {
345 public void setTapiSips(Map<ServiceInterfacePointKey, ServiceInterfacePoint> tapiSip) {
346 this.tapiSips.putAll(tapiSip);