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.InterRuleGroup;
45 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.InterRuleGroupKey;
46 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.NodeRuleGroup;
47 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.NodeRuleGroupKey;
48 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.OwnedNodeEdgePoint;
49 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.OwnedNodeEdgePointBuilder;
50 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.OwnedNodeEdgePointKey;
51 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.RiskParameterPac;
52 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.RiskParameterPacBuilder;
53 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.edge.point.SupportedCepLayerProtocolQualifierInstances;
54 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.edge.point.SupportedCepLayerProtocolQualifierInstancesBuilder;
55 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.risk.parameter.pac.RiskCharacteristic;
56 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.risk.parameter.pac.RiskCharacteristicBuilder;
57 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Link;
58 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.LinkBuilder;
59 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.LinkKey;
60 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.NodeBuilder;
61 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.NodeKey;
62 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.transfer.cost.pac.CostCharacteristic;
63 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.transfer.cost.pac.CostCharacteristicBuilder;
64 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.transfer.timing.pac.LatencyCharacteristic;
65 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.transfer.timing.pac.LatencyCharacteristicBuilder;
66 import org.opendaylight.yangtools.yang.common.Uint64;
67 import org.slf4j.Logger;
68 import org.slf4j.LoggerFactory;
71 public class ConvertORTopoToTapiTopo {
73 private static final Logger LOG = LoggerFactory.getLogger(ConvertORTopoToTapiTopo.class);
74 private Uuid tapiTopoUuid;
75 private Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
77 private Map<LinkKey, Link> tapiLinks;
78 private Map<ServiceInterfacePointKey, ServiceInterfacePoint> tapiSips;
79 private final TapiLink tapiLink;
82 public ConvertORTopoToTapiTopo(Uuid tapiTopoUuid, TapiLink tapiLink) {
83 this.tapiTopoUuid = tapiTopoUuid;
84 this.tapiNodes = new HashMap<>();
85 this.tapiLinks = new HashMap<>();
86 this.tapiSips = new HashMap<>();
87 this.tapiLink = tapiLink;
90 public void convertLinks(Map<
91 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
93 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
95 List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
96 .Link> otnLinkList = new ArrayList<>(otnLinkMap.values());
97 Collections.sort(otnLinkList, (l1, l2) -> l1.getLinkId().getValue()
98 .compareTo(l2.getLinkId().getValue()));
99 List<String> linksToNotConvert = new ArrayList<>();
100 LOG.info("creation of {} otn links", otnLinkMap.size() / 2);
101 for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
102 .Link otnlink : otnLinkList) {
103 if (!linksToNotConvert.contains(otnlink.getLinkId().getValue())) {
104 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks
105 .network.Link oppositeLink = otnLinkMap.get(new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns
106 .yang.ietf.network.topology.rev180226.networks.network.LinkKey(otnlink.augmentation(Link1.class)
107 .getOppositeLink()));
109 AdminStates oppLnkAdmState = null;
110 State oppLnkOpState = null;
111 String oppositeLinkId = null;
112 if (oppositeLink != null) {
113 oppLnkAdmState = oppositeLink.augmentation(Link1.class).getAdministrativeState();
114 oppLnkOpState = oppositeLink.augmentation(Link1.class).getOperationalState();
115 oppositeLinkId = oppositeLink.getLinkId().getValue();
118 otnlink.augmentation(Link1.class).getAdministrativeState() == null
119 || oppLnkAdmState == null
121 : this.tapiLink.setTapiAdminState(
122 otnlink.augmentation(Link1.class).getAdministrativeState(), oppLnkAdmState).getName();
123 String operState = otnlink.augmentation(Link1.class).getOperationalState() == null
124 || oppLnkOpState == null
126 : this.tapiLink.setTapiOperationalState(
127 otnlink.augmentation(Link1.class).getOperationalState(), oppLnkOpState).getName();
128 // TODO: Handle not only OTU4 but also other cases
129 String prefix = otnlink.getLinkId().getValue().split("-")[0];
130 String nodesQual = TapiStringConstants.XPDR;
131 String tpsQual = prefix.equals("OTU4") ? TapiStringConstants.I_OTSI : TapiStringConstants.E_ODU;
132 LayerProtocolName layerProtocolName = prefix.equals("OTU4") ? LayerProtocolName.PHOTONICMEDIA
133 : LayerProtocolName.ODU;
135 Link tapLink = this.tapiLink.createTapiLink(otnlink.getSource().getSourceNode().getValue(),
136 otnlink.getSource().getSourceTp().getValue(), otnlink.getDestination().getDestNode().getValue(),
137 otnlink.getDestination().getDestTp().getValue(), TapiStringConstants.OTN_XPDR_XPDR_LINK, nodesQual,
138 nodesQual, tpsQual, tpsQual, adminState, operState, Set.of(layerProtocolName),
139 Set.of(layerProtocolName.getName()), this.tapiTopoUuid);
140 linksToNotConvert.add(oppositeLinkId);
141 tapiLinks.put(tapLink.key(), tapLink);
142 LOG.debug("Links converted are as follow {}", tapiLinks.toString());
147 public void convertRoadmInfrastructure() {
148 LOG.info("abstraction of the ROADM infrastructure towards a photonic node");
149 Uuid nodeUuid = new Uuid(UUID.nameUUIDFromBytes(TapiStringConstants.RDM_INFRA
150 .getBytes(Charset.forName("UTF-8"))).toString());
152 new NameBuilder().setValueName("otsi node name").setValue(TapiStringConstants.RDM_INFRA).build();
154 new NameBuilder().setValueName("roadm node name").setValue(TapiStringConstants.RDM_INFRA).build();
155 Name nameNodeType = new NameBuilder().setValueName("Node Type")
156 .setValue(OpenroadmNodeType.ROADM.getName()).build();
157 Set<LayerProtocolName> nodeLayerProtocols = Set.of(LayerProtocolName.PHOTONICMEDIA);
158 List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node> tapiPhotonicNodes
159 = pruneTapiPhotonicNodes();
160 //At that stage, there is no Roadm in the tapiPhotonicNodes Map / only the transponders
161 Map<String, String> photonicNepUuisMap = convertListNodeWithListNepToMapForUuidAndName(tapiPhotonicNodes);
162 // nep creation for rdm infra abstraction node
163 Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepMap = createNepForRdmNode(photonicNepUuisMap.size());
164 // node rule group creation
165 var tapiFactory = new ConvertORToTapiTopology(this.tapiTopoUuid);
166 Map<NodeRuleGroupKey, NodeRuleGroup> nodeRuleGroupMap
167 = tapiFactory.createAllNodeRuleGroupForRdmNode("T0ML", nodeUuid, null, onepMap.values());
168 Map<InterRuleGroupKey, InterRuleGroup> interRuleGroupMap
169 = tapiFactory.createInterRuleGroupForRdmNode("T0ML", nodeUuid, null,
170 nodeRuleGroupMap.entrySet().stream().map(e -> e.getKey()).collect(Collectors.toList()));
172 // Empty random creation of mandatory fields for avoiding errors....
173 CostCharacteristic costCharacteristic = new CostCharacteristicBuilder()
174 .setCostAlgorithm("Restricted Shortest Path - RSP")
175 .setCostName("HOP_COUNT")
176 .setCostValue(TapiStringConstants.COST_HOP_VALUE)
178 LatencyCharacteristic latencyCharacteristic = new LatencyCharacteristicBuilder()
179 .setFixedLatencyCharacteristic(TapiStringConstants.FIXED_LATENCY_VALUE)
180 .setQueuingLatencyCharacteristic(TapiStringConstants.QUEING_LATENCY_VALUE)
181 .setJitterCharacteristic(TapiStringConstants.JITTER_VALUE)
182 .setWanderCharacteristic(TapiStringConstants.WANDER_VALUE)
183 .setTrafficPropertyName("FIXED_LATENCY")
185 RiskCharacteristic riskCharacteristic = new RiskCharacteristicBuilder()
186 .setRiskCharacteristicName("risk characteristic")
187 .setRiskIdentifierList(Set.of("risk identifier1", "risk identifier2"))
189 RiskParameterPac riskParamPac = new RiskParameterPacBuilder()
190 .setRiskCharacteristic(Map.of(riskCharacteristic.key(), riskCharacteristic))
192 // build RDM infra node abstraction
193 org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node rdmNode = new NodeBuilder()
195 .setName(Map.of(nodeName.key(), nodeName, nodeName2.key(), nodeName2, nameNodeType.key(), nameNodeType))
196 .setLayerProtocolName(nodeLayerProtocols)
197 .setAdministrativeState(AdministrativeState.UNLOCKED)
198 .setOperationalState(OperationalState.ENABLED)
199 .setLifecycleState(LifecycleState.INSTALLED)
200 .setOwnedNodeEdgePoint(onepMap)
201 .setNodeRuleGroup(nodeRuleGroupMap)
202 .setInterRuleGroup(interRuleGroupMap)
203 .setCostCharacteristic(Map.of(costCharacteristic.key(), costCharacteristic))
204 .setLatencyCharacteristic(Map.of(latencyCharacteristic.key(), latencyCharacteristic))
205 .setRiskParameterPac(riskParamPac)
207 tapiNodes.put(rdmNode.key(), rdmNode);
208 // OTS link creation between photonic nodes and RDM infra abstraction node :
209 //onepMap is a list of nep which Uuid is formed from THE ROADM node name, "nep" and an integer (order of the nep)
210 // It has absolutely no relationship with the real ROADM infrastructure (SRG ports)
211 //rdmInfraNepUuisMap is a Map <ROADMnodeUuuid--NepUuid; ROADMnodeName--nepName> built from onepMap
212 //photonicNepUuisMap is a Map <TSPnodeUuuid--eNepUuid; TSPnodeName--nepName> built from TapiPhotonicNode
213 Map<String, String> rdmInfraNepUuisMap = convertListNodeWithListNepToMapForUuidAndName(List.of(rdmNode));
214 if (photonicNepUuisMap.size() != rdmInfraNepUuisMap.size()) {
215 LOG.warn("Unable to build OTS links between photonics nodes and RDM infrasctructure abstraction");
217 //Tapi OtsLinks are created between Neps corresponding to the eNEPs of transponders (existing network ports)
218 //and Generic NEPS with abstracted names created in the ROADM infrastructure corresponding to tps mirroring
219 //transponders NETWORK PORTs. There is a simplification here considering that any network port of
220 //transponders will have a mirroring SRG client port in the ROADM infrastructure.
221 // TODO: Do not understand that we build OTS link without checking that existing transponder ports
222 //are effectively connected. Need some consolidation
223 createTapiOtsLinks(photonicNepUuisMap, rdmInfraNepUuisMap);
227 private List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
228 pruneTapiPhotonicNodes() {
229 List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
230 prunedTapiPhotonicNodes = new ArrayList<>();
231 List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node> tapiPhotonicNodes
232 = this.tapiNodes.values().stream()
233 .filter(n -> n.getLayerProtocolName().contains(LayerProtocolName.PHOTONICMEDIA))
234 .collect(Collectors.toList());
235 for (org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node node
236 : tapiPhotonicNodes) {
237 Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepM = new HashMap<>();
238 for (Map.Entry<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> entry : node.getOwnedNodeEdgePoint().entrySet()) {
239 if (entry.getValue().getName().values().stream()
240 .filter(name -> name.getValueName().equals("eNodeEdgePoint")).count() > 0) {
241 onepM.put(entry.getKey(), entry.getValue());
244 org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node prunedNode
245 = new NodeBuilder(node).setOwnedNodeEdgePoint(onepM).build();
246 prunedTapiPhotonicNodes.add(prunedNode);
248 return prunedTapiPhotonicNodes;
251 private Map<String, String> convertListNodeWithListNepToMapForUuidAndName(
252 List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node> nodes) {
253 Map<String, String> uuidNameMap = new HashMap<>();
254 for (org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node node : nodes) {
255 for (OwnedNodeEdgePoint nep : node.nonnullOwnedNodeEdgePoint().values()) {
256 String nodeUuid = node.getUuid().getValue();
257 String nepUuid = nep.getUuid().getValue();
258 String nodeName = node.getName().get(new NameKey("otsi node name")).getValue();
259 String nepName = nep.getName().get(new NameKey(nep.getName().keySet().stream().findFirst()
262 uuidNameMap.put(String.join("--", nodeUuid, nepUuid), String.join("--", nodeName, nepName));
268 private Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> createNepForRdmNode(int nbNep) {
269 Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepMap = new HashMap<>();
270 for (int i = 1; i <= nbNep; i++) {
271 Uuid nepUuid = new Uuid(UUID.nameUUIDFromBytes((String.join("+", "roadm node", "nep", String.valueOf(i)))
272 .getBytes(Charset.forName("UTF-8"))).toString());
273 Name nepName = new NameBuilder()
274 .setValueName("NodeEdgePoint name")
275 .setValue(new StringBuilder("NodeEdgePoint_").append(i).toString())
277 List<SupportedCepLayerProtocolQualifierInstances> sclpqiList = new ArrayList<>();
278 sclpqiList.add(new SupportedCepLayerProtocolQualifierInstancesBuilder()
279 .setLayerProtocolQualifier(PHOTONICLAYERQUALIFIEROTS.VALUE)
280 .setNumberOfCepInstances(Uint64.valueOf(1))
282 OwnedNodeEdgePoint onep = new OwnedNodeEdgePointBuilder()
284 .setLayerProtocolName(LayerProtocolName.PHOTONICMEDIA)
285 .setName(Map.of(nepName.key(), nepName))
286 .setSupportedCepLayerProtocolQualifierInstances(sclpqiList)
287 .setDirection(Direction.BIDIRECTIONAL).setLinkPortRole(PortRole.SYMMETRIC)
288 .setAdministrativeState(AdministrativeState.UNLOCKED).setOperationalState(OperationalState.ENABLED)
289 .setLifecycleState(LifecycleState.INSTALLED)
291 onepMap.put(onep.key(), onep);
296 private void createTapiOtsLinks(Map<String, String> photonicNepUuisMap, Map<String, String> rdmInfraNepUuisMap) {
297 Iterator<Entry<String, String>> it1 = photonicNepUuisMap.entrySet().iterator();
298 Iterator<Entry<String, String>> it2 = rdmInfraNepUuisMap.entrySet().iterator();
299 while (it1.hasNext()) {
300 Map<NodeEdgePointKey, NodeEdgePoint> nepMap = new HashMap<>();
301 Map.Entry<String, String> photonicEntry = it1.next();
302 Map.Entry<String, String> rdmEntry = it2.next();
303 Uuid sourceUuidTp = new Uuid(photonicEntry.getKey().split("--")[1]);
304 Uuid sourceUuidNode = new Uuid(photonicEntry.getKey().split("--")[0]);
305 Uuid destUuidTp = new Uuid(rdmEntry.getKey().split("--")[1]);
306 Uuid destUuidNode = new Uuid(rdmEntry.getKey().split("--")[0]);
307 NodeEdgePoint sourceNep = new NodeEdgePointBuilder()
308 .setTopologyUuid(this.tapiTopoUuid)
309 .setNodeUuid(sourceUuidNode)
310 .setNodeEdgePointUuid(sourceUuidTp)
312 nepMap.put(sourceNep.key(), sourceNep);
313 NodeEdgePoint destNep = new NodeEdgePointBuilder()
314 .setTopologyUuid(this.tapiTopoUuid)
315 .setNodeUuid(destUuidNode)
316 .setNodeEdgePointUuid(destUuidTp)
318 nepMap.put(destNep.key(), destNep);
319 Name linkName = new NameBuilder().setValueName("OTS link name")
320 .setValue(String.join(" and ", photonicEntry.getValue(), rdmEntry.getValue()))
322 Link otsLink = new LinkBuilder()
324 UUID.nameUUIDFromBytes((String.join(" and ", photonicEntry.getValue(), rdmEntry.getValue()))
325 .getBytes(Charset.forName("UTF-8")))
327 .setName(Map.of(linkName.key(), linkName))
328 .setLayerProtocolName(Set.of(LayerProtocolName.PHOTONICMEDIA))
329 .setNodeEdgePoint(nepMap)
330 .setDirection(ForwardingDirection.BIDIRECTIONAL)
332 this.tapiLinks.put(otsLink.key(), otsLink);
336 public void setTapiNodes(Map<NodeKey,
337 org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node> nodeMap) {
338 this.tapiNodes.putAll(nodeMap);
341 public Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
346 public Map<LinkKey, Link> getTapiLinks() {
350 public Map<ServiceInterfacePointKey, ServiceInterfacePoint> getTapiSips() {
354 public void setTapiSips(Map<ServiceInterfacePointKey, ServiceInterfacePoint> tapiSip) {
355 this.tapiSips.putAll(tapiSip);