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 com.google.common.util.concurrent.FluentFuture;
11 import com.google.common.util.concurrent.ListenableFuture;
12 import java.nio.charset.Charset;
13 import java.util.ArrayList;
14 import java.util.HashMap;
15 import java.util.List;
17 import java.util.NoSuchElementException;
18 import java.util.Optional;
19 import java.util.UUID;
20 import java.util.concurrent.ExecutionException;
21 import java.util.stream.Collectors;
22 import org.eclipse.jdt.annotation.NonNull;
23 import org.eclipse.jdt.annotation.Nullable;
24 import org.opendaylight.mdsal.binding.api.DataBroker;
25 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
26 import org.opendaylight.transportpce.common.InstanceIdentifiers;
27 import org.opendaylight.transportpce.common.NetworkUtils;
28 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.network.Nodes;
29 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.network.NodesKey;
30 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.network.nodes.Mapping;
31 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.network.nodes.MappingKey;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.Link1;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.TerminationPoint1;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmLinkType;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmNodeType;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmTpType;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
43 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.AdministrativeState;
44 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.LayerProtocolName;
45 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.LifecycleState;
46 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.OperationalState;
47 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.PortDirection;
48 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.PortRole;
49 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.TerminationDirection;
50 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.TerminationState;
51 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.Uuid;
52 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.Name;
53 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.NameBuilder;
54 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.NameKey;
55 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetLinkDetailsInput;
56 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetLinkDetailsOutput;
57 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetNodeDetailsInput;
58 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetNodeDetailsOutput;
59 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetNodeEdgePointDetailsInput;
60 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetNodeEdgePointDetailsOutput;
61 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyDetailsInput;
62 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyDetailsOutput;
63 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyDetailsOutputBuilder;
64 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyListInput;
65 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyListOutput;
66 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.TapiTopologyService;
67 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.get.topology.details.output.Topology;
68 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.get.topology.details.output.TopologyBuilder;
69 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePoint;
70 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePointBuilder;
71 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePointKey;
72 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.edge.point.MappedServiceInterfacePoint;
73 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.edge.point.MappedServiceInterfacePointBuilder;
74 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.edge.point.MappedServiceInterfacePointKey;
75 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.LinkKey;
76 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.NodeBuilder;
77 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.NodeKey;
78 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
79 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
80 import org.opendaylight.yangtools.yang.common.RpcResult;
81 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
82 import org.slf4j.Logger;
83 import org.slf4j.LoggerFactory;
85 public class TapiTopologyImpl implements TapiTopologyService {
87 private static final Logger LOG = LoggerFactory.getLogger(TapiTopologyImpl.class);
88 private static final String ETH_TOPO = "Ethernet Topology";
89 private static final String T0_MULTI_LAYER_TOPO = "T0 - Multi-layer topology";
90 private final DataBroker dataBroker;
92 public TapiTopologyImpl(DataBroker dataBroker) {
93 this.dataBroker = dataBroker;
97 public ListenableFuture<RpcResult<GetNodeDetailsOutput>> getNodeDetails(GetNodeDetailsInput input) {
98 // TODO Auto-generated method stub
103 public ListenableFuture<RpcResult<GetTopologyDetailsOutput>> getTopologyDetails(GetTopologyDetailsInput input) {
104 LOG.info("Building TAPI Topology abstraction from {}", input.getTopologyIdOrName());
105 Topology topology = null;
106 switch (input.getTopologyIdOrName()) {
107 case NetworkUtils.OVERLAY_NETWORK_ID:
108 topology = createAbstractedOpenroadmTopology();
110 case NetworkUtils.OTN_NETWORK_ID:
111 topology = createAbstractedOtnTopology();
114 LOG.error("{} unknown - can not be abstracted", input.getTopologyIdOrName());
117 if (topology != null) {
118 return RpcResultBuilder.success(new GetTopologyDetailsOutputBuilder().setTopology(topology).build())
121 return RpcResultBuilder.success(new GetTopologyDetailsOutputBuilder().build()).buildFuture();
125 private Topology createAbstractedOpenroadmTopology() {
126 // read openroadm-topology
128 FluentFuture<Optional<Network>> openroadmTopoOpt = dataBroker.newReadOnlyTransaction()
129 .read(LogicalDatastoreType.CONFIGURATION, InstanceIdentifiers.OVERLAY_NETWORK_II);
130 if (!openroadmTopoOpt.isDone()) {
131 LOG.warn("Cannot get openroadm topology, returning null");
134 Optional<Network> optionalOpenroadmTop = null;
136 optionalOpenroadmTop = openroadmTopoOpt.get();
137 } catch (InterruptedException e) {
138 //sonar : "InterruptedException" should not be ignored (java:S2142)
139 //https://www.ibm.com/developerworks/java/library/j-jtp05236/index.html?ca=drs-#2.1
140 Thread.currentThread().interrupt();
142 } catch (ExecutionException | NoSuchElementException e) {
143 LOG.error("Impossible to retrieve openroadm-topology from mdsal", e);
147 if (!optionalOpenroadmTop.isPresent()) {
148 LOG.warn("Openroadm topology is not present, returning null");
151 Network openroadmTopo = optionalOpenroadmTop.get();
152 List<Node> nodeList = new ArrayList<>(openroadmTopo.getNode().values());
153 List<Link> linkList = null;
154 if (openroadmTopo.augmentation(Network1.class) != null) {
155 linkList = new ArrayList<>(openroadmTopo.augmentation(Network1.class).getLink().values());
157 linkList = new ArrayList<>();
159 List<Link> xponderOutLinkList = linkList.stream()
160 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDEROUTPUT))
161 .collect(Collectors.toList());
162 List<Link> xponderInLinkList = linkList.stream()
163 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDERINPUT))
164 .collect(Collectors.toList());
166 List<Node> xpdrNodeList = nodeList
169 .augmentation(org.opendaylight.yang.gen.v1
170 .http.org.openroadm.common.network.rev181130.Node1.class)
171 .getNodeType().equals(OpenroadmNodeType.XPONDER)).collect(Collectors.toList());
172 Map<String, List<String>> clientPortMap = new HashMap<>();
173 for (Node node : xpdrNodeList) {
174 String nodeId = node.getSupportingNode().values().stream()
175 .filter(sn -> sn.getNetworkRef().getValue().equals(NetworkUtils.UNDERLAY_NETWORK_ID))
177 .get().getNodeRef().getValue();
178 List<String> clientPortList = new ArrayList<>();
179 for (TerminationPoint tp : node.augmentation(Node1.class).getTerminationPoint().values()) {
180 if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERCLIENT)
181 && checkTp(node.getNodeId().getValue(), nodeId, tp, xponderOutLinkList, xponderInLinkList)) {
182 clientPortList.add(tp.getTpId().getValue());
185 if (!clientPortList.isEmpty()) {
186 clientPortMap.put(nodeId, clientPortList);
189 List<String> goodTpList = extractGoodTpList(clientPortMap);
190 // tapi topology creation
191 Map<NameKey, Name> names = new HashMap<>();
192 Name name = new NameBuilder().setValue(ETH_TOPO).setValueName("Topo Name").build();
193 names.put(name.key(), name);
194 Uuid uuid = new Uuid(UUID.nameUUIDFromBytes(ETH_TOPO.getBytes(Charset.forName("UTF-8"))).toString());
195 Map<NodeKey ,org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node>
196 tapiNodeList = new HashMap<>();
197 org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node node
198 = createTapiNode(goodTpList);
199 tapiNodeList.put(node.key(), node);
200 return new TopologyBuilder().setName(names).setUuid(uuid).setNode(tapiNodeList).build();
204 private List<String> extractGoodTpList(Map<String, List<String>> clientPortMap) {
205 List<String> goodTpList = new ArrayList<>();
206 for (Map.Entry<String, List<String>> entry : clientPortMap.entrySet()) {
207 String key = entry.getKey();
208 List<String> value = entry.getValue();
209 for (String tpid : value) {
210 goodTpList.add(key + "--" + tpid);
216 private Topology createAbstractedOtnTopology() {
219 FluentFuture<Optional<Network>> otnTopoOpt = dataBroker.newReadOnlyTransaction().read(
220 LogicalDatastoreType.CONFIGURATION, InstanceIdentifiers.OTN_NETWORK_II);
221 if (otnTopoOpt.isDone()) {
222 Network otnTopo = null;
224 otnTopo = otnTopoOpt.get().get();
225 } catch (InterruptedException | ExecutionException | NoSuchElementException e) {
226 LOG.error("Impossible to retreive otn-topology from mdsal",e);
229 List<Node> nodeList = new ArrayList<>(otnTopo.getNode().values());
230 List<Node> otnNodeList = nodeList.stream().filter(nt -> nt.augmentation(
231 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.Node1.class)
232 .getNodeType().equals(OpenroadmNodeType.SWITCH) || nt.augmentation(
233 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.Node1.class)
234 .getNodeType().equals(OpenroadmNodeType.MUXPDR)).collect(Collectors.toList());
235 Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node>
236 tapiNodeList = new HashMap<>();
237 Map<LinkKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Link>
238 tapiLinkList = new HashMap<>();
239 Uuid topoUuid = new Uuid(UUID.nameUUIDFromBytes(T0_MULTI_LAYER_TOPO.getBytes(Charset.forName("UTF-8")))
241 for (Node node : otnNodeList) {
242 ConvertORTopoObjectToTapiTopoObject tapiFactory =
243 new ConvertORTopoObjectToTapiTopoObject(node, null, topoUuid);
244 tapiFactory.convertNode();
245 tapiNodeList.putAll(tapiFactory.getTapiNodes());
246 tapiLinkList.putAll(tapiFactory.getTapiLinks());
248 Name name = new NameBuilder().setValue(T0_MULTI_LAYER_TOPO).setValueName("TAPI Topology Name").build();
249 return new TopologyBuilder()
250 .setName(Map.of(name.key(), name))
252 .setNode(tapiNodeList)
253 .setLink(tapiLinkList).build();
260 public ListenableFuture<RpcResult<GetNodeEdgePointDetailsOutput>> getNodeEdgePointDetails(
261 GetNodeEdgePointDetailsInput input) {
262 // TODO Auto-generated method stub
267 public ListenableFuture<RpcResult<GetLinkDetailsOutput>> getLinkDetails(GetLinkDetailsInput input) {
268 // TODO Auto-generated method stub
273 public ListenableFuture<RpcResult<GetTopologyListOutput>> getTopologyList(GetTopologyListInput input) {
274 // TODO Auto-generated method stub
278 private org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node createTapiNode(List<
280 Name name = new NameBuilder().setValueName("node name").setValue("TAPI Ethernet Node").build();
281 List<LayerProtocolName> layerProtocols = new ArrayList<>();
282 layerProtocols.add(LayerProtocolName.ETH);
283 Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepl = new HashMap<>();
284 for (int i = 0; i < tpList.size(); i++) {
285 Name onedName = new NameBuilder().setValueName("OwnedNodeEdgePoint " + i).setValue(tpList.get(i)).build();
286 OwnedNodeEdgePoint onep = new OwnedNodeEdgePointBuilder()
287 .setUuid(new Uuid(UUID.nameUUIDFromBytes(("OwnedNodeEdgePoint " + i).getBytes(Charset.forName("UTF-8")))
289 .setLayerProtocolName(LayerProtocolName.ETH).setMappedServiceInterfacePoint(createSIP(1))
290 .setLinkPortDirection(PortDirection.BIDIRECTIONAL).setLinkPortRole(PortRole.SYMMETRIC)
291 .setAdministrativeState(AdministrativeState.UNLOCKED).setOperationalState(OperationalState.ENABLED)
292 .setLifecycleState(LifecycleState.INSTALLED).setName(Map.of(onedName.key(), onedName))
293 .setTerminationDirection(
294 TerminationDirection.BIDIRECTIONAL).setTerminationState(TerminationState.TERMINATEDBIDIRECTIONAL)
296 onepl.put(onep.key(), onep);
299 return new NodeBuilder()
300 .setUuid(new Uuid(UUID.nameUUIDFromBytes(name.getValue().getBytes(Charset.forName("UTF-8")))
302 .setName(Map.of(name.key(), name)).setLayerProtocolName(layerProtocols)
303 .setAdministrativeState(AdministrativeState.UNLOCKED)
304 .setOperationalState(OperationalState.ENABLED)
305 .setLifecycleState(LifecycleState.INSTALLED)
306 .setOwnedNodeEdgePoint(onepl)
310 private Map<MappedServiceInterfacePointKey, MappedServiceInterfacePoint> createSIP(int nb) {
311 Map<MappedServiceInterfacePointKey, MappedServiceInterfacePoint> msipl = new HashMap<>();
312 for (int i = 0; i < nb; i++) {
313 MappedServiceInterfacePoint msip = new MappedServiceInterfacePointBuilder().setServiceInterfacePointUuid(
314 new Uuid(UUID.randomUUID().toString())).build();
315 msipl.put(msip.key(), msip);
320 private boolean checkTp(String nodeIdTopo, String nodeIdPortMap, TerminationPoint tp, List<Link> xpdOut, List<
323 String networkLcp = tp.augmentation(
324 org.opendaylight.yang.gen.v1.http.transportpce.topology.rev200129.TerminationPoint1.class)
325 .getAssociatedConnectionMapPort();
327 KeyedInstanceIdentifier<Mapping, MappingKey> pmIID = InstanceIdentifier.create(
328 org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.Network.class)
329 .child(Nodes.class, new NodesKey(nodeIdPortMap)).child(Mapping.class, new MappingKey(networkLcp));
331 FluentFuture<Optional<Mapping>> mappingOpt = dataBroker.newReadOnlyTransaction().read(
332 LogicalDatastoreType.CONFIGURATION, pmIID);
333 Mapping mapping = null;
334 if (mappingOpt.isDone()) {
336 mapping = mappingOpt.get().get();
337 } catch (InterruptedException | ExecutionException e) {
338 LOG.error("Error getting mapping for {}", networkLcp,e);
342 LOG.error("Impossible to get mapping of associated network port {} of tp {}", networkLcp, tp.getTpId()
346 String networkPortDirection = mapping.getPortDirection();
348 switch (networkPortDirection) {
349 case "bidirectional":
350 count += xpdOut.stream().filter(lk -> lk.getSource().getSourceNode().getValue().equals(nodeIdTopo) && lk
351 .getSource().getSourceTp().equals(networkLcp)).count();
352 count += xpdIn.stream().filter(lk -> lk.getDestination().getDestNode().getValue().equals(nodeIdTopo)
353 && lk.getDestination().getDestTp().equals(networkLcp)).count();
358 String partnerLcp = mapping.getPartnerLcp();
359 if (mapping.getPortQual().equals("tx")) {
360 count += xpdOut.stream().filter(lk -> lk.getSource().getSourceNode().getValue().equals(nodeIdTopo)
361 && lk.getSource().getSourceTp().equals(networkLcp)).count();
362 count += xpdIn.stream().filter(lk -> lk.getDestination().getDestNode().getValue().equals(nodeIdTopo)
363 && lk.getDestination().getDestTp().equals(partnerLcp)).count();
365 if (mapping.getPortQual().equals("rx")) {
366 count += xpdIn.stream().filter(lk -> lk.getDestination().getDestNode().getValue().equals(nodeIdTopo)
367 && lk.getDestination().getDestTp().equals(networkLcp)).count();
368 count += xpdOut.stream().filter(lk -> lk.getSource().getSourceNode().getValue().equals(nodeIdTopo)
369 && lk.getSource().getSourceTp().equals(partnerLcp)).count();
373 LOG.error("Invalid port direction for {}", networkLcp);