2 * Copyright © 2017 AT&T 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
9 package org.opendaylight.transportpce.renderer.provisiondevice;
11 import com.google.common.collect.Sets;
13 import java.util.ArrayList;
14 import java.util.LinkedList;
15 import java.util.List;
16 import java.util.Optional;
18 import java.util.concurrent.ConcurrentLinkedQueue;
19 import java.util.concurrent.ExecutionException;
20 import java.util.concurrent.ForkJoinPool;
21 import java.util.concurrent.ForkJoinTask;
22 import java.util.concurrent.Future;
23 import java.util.concurrent.TimeUnit;
24 import java.util.concurrent.TimeoutException;
25 import java.util.concurrent.atomic.AtomicBoolean;
27 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
28 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
29 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
31 import org.opendaylight.transportpce.common.Timeouts;
32 import org.opendaylight.transportpce.common.crossconnect.CrossConnect;
33 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
34 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
35 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
36 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfacesImpl;
37 import org.opendaylight.transportpce.renderer.openroadminterface.OpenRoadmInterfaceFactory;
38 import org.opendaylight.transportpce.renderer.provisiondevice.servicepath.ServiceListTopology;
39 import org.opendaylight.transportpce.renderer.provisiondevice.servicepath.ServicePathDirection;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.service.types.rev161014.service.Topology;
41 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.get.connection.port.trail.output.Ports;
42 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.OchAttributes.ModulationFormat;
43 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.R100G;
44 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev161014.ServiceList;
45 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev161014.service.list.Services;
46 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev161014.service.list.ServicesBuilder;
47 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev161014.service.list.ServicesKey;
48 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev170907.node.interfaces.NodeInterface;
49 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev170907.node.interfaces.NodeInterfaceBuilder;
50 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev170907.node.interfaces.NodeInterfaceKey;
51 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev170907.olm.renderer.input.Nodes;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.alarmsuppression.rev171102.ServiceNodelist;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.alarmsuppression.rev171102.service.nodelist.NodelistBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.alarmsuppression.rev171102.service.nodelist.NodelistKey;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.renderer.rev170228.RendererRollbackInput;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.renderer.rev170228.RendererRollbackOutput;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.renderer.rev170228.RendererRollbackOutputBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.renderer.rev170228.ServicePathInput;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.renderer.rev170228.ServicePathOutput;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.renderer.rev170228.ServicePathOutputBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.renderer.rev170228.renderer.rollback.output.FailedToRollback;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.renderer.rev170228.renderer.rollback.output.FailedToRollbackBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.renderer.rev170228.renderer.rollback.output.FailedToRollbackKey;
64 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
65 import org.slf4j.Logger;
66 import org.slf4j.LoggerFactory;
68 public class DeviceRendererServiceImpl implements DeviceRendererService {
70 private static final Logger LOG = LoggerFactory.getLogger(DeviceRendererServiceImpl.class);
72 private final DataBroker dataBroker;
73 private final DeviceTransactionManager deviceTransactionManager;
74 private final OpenRoadmInterfaceFactory openRoadmInterfaceFactory;
75 private final OpenRoadmInterfaces openRoadmInterfaces;
76 private final CrossConnect crossConnect;
78 public DeviceRendererServiceImpl(DataBroker dataBroker, DeviceTransactionManager deviceTransactionManager,
79 OpenRoadmInterfaceFactory openRoadmInterfaceFactory, OpenRoadmInterfaces openRoadmInterfaces,
80 CrossConnect crossConnect) {
81 this.dataBroker = dataBroker;
82 this.deviceTransactionManager = deviceTransactionManager;
83 this.openRoadmInterfaceFactory = openRoadmInterfaceFactory;
84 this.openRoadmInterfaces = openRoadmInterfaces;
85 this.crossConnect = crossConnect;
89 public ServicePathOutput setupServicePath(ServicePathInput input, ServicePathDirection direction) {
90 List<Nodes> nodes = input.getNodes();
91 // Register node for suppressing alarms
92 if (!alarmSuppressionNodeRegistration(input)) {
93 LOG.warn("Alarm suppresion node registraion failed!!!!");
96 ConcurrentLinkedQueue<String> results = new ConcurrentLinkedQueue<>();
97 Set<NodeInterface> nodeInterfaces = Sets.newConcurrentHashSet();
98 Set<String> nodesProvisioned = Sets.newConcurrentHashSet();
99 ServiceListTopology topology = new ServiceListTopology();
100 AtomicBoolean success = new AtomicBoolean(true);
102 ForkJoinPool forkJoinPool = new ForkJoinPool();
103 ForkJoinTask forkJoinTask = forkJoinPool.submit(() ->
104 nodes.parallelStream().forEach(node -> {
105 String nodeId = node.getNodeId();
106 LOG.info("Starting provisioning for node : {}", nodeId);
107 List<String> createdEthInterfaces = new ArrayList<>();
108 List<String> createdOtuInterfaces = new ArrayList<>();
109 List<String> createdOduInterfaces = new ArrayList<>();
110 List<String> createdOchInterfaces = new ArrayList<>();
111 List<String> createdConnections = new ArrayList<>();
112 int crossConnectFlag = 0;
115 // if the node is currently mounted then proceed
116 if (this.deviceTransactionManager.isDeviceMounted(nodeId)) {
117 String srcTp = node.getSrcTp();
118 String destTp = node.getDestTp();
120 Long waveNumber = input.getWaveNumber();
121 if ((destTp != null) && destTp.contains(OpenRoadmInterfacesImpl.NETWORK_TOKEN)) {
123 // create OpenRoadm Xponder Line Interfaces
124 String supportingOchInterface = this.openRoadmInterfaceFactory.createOpenRoadmOchInterface(
125 nodeId, destTp, waveNumber, R100G.class, ModulationFormat.DpQpsk);
126 createdOchInterfaces.add(supportingOchInterface);
128 String supportingOtuInterface = this.openRoadmInterfaceFactory.createOpenRoadmOtu4Interface(
129 nodeId, destTp, supportingOchInterface);
130 createdOtuInterfaces.add(supportingOtuInterface);
132 createdOduInterfaces.add(this.openRoadmInterfaceFactory.createOpenRoadmOdu4Interface(
133 nodeId, destTp,supportingOtuInterface));
135 if ((srcTp != null) && srcTp.contains(OpenRoadmInterfacesImpl.CLIENT_TOKEN)) {
137 // create OpenRoadm Xponder Client Interfaces
138 createdEthInterfaces.add(this.openRoadmInterfaceFactory.createOpenRoadmEthInterface(nodeId,
143 if ((srcTp != null) && srcTp.contains(OpenRoadmInterfacesImpl.NETWORK_TOKEN)) {
145 // create OpenRoadm Xponder Line Interfaces
146 String supportingOchInterface = this.openRoadmInterfaceFactory.createOpenRoadmOchInterface(
147 nodeId, srcTp, waveNumber, R100G.class, ModulationFormat.DpQpsk);
148 createdOchInterfaces.add(supportingOchInterface);
150 String supportingOtuInterface = this.openRoadmInterfaceFactory.createOpenRoadmOtu4Interface(
151 nodeId, srcTp, supportingOchInterface);
152 createdOtuInterfaces.add(supportingOtuInterface);
154 createdOduInterfaces.add(this.openRoadmInterfaceFactory.createOpenRoadmOdu4Interface(
155 nodeId, srcTp, supportingOtuInterface));
157 if ((destTp != null) && destTp.contains(OpenRoadmInterfacesImpl.CLIENT_TOKEN)) {
159 // create OpenRoadm Xponder Client Interfaces
160 createdEthInterfaces.add(this.openRoadmInterfaceFactory.createOpenRoadmEthInterface(nodeId,
165 if ((srcTp != null) && (srcTp.contains(OpenRoadmInterfacesImpl.TTP_TOKEN)
166 || srcTp.contains(OpenRoadmInterfacesImpl.PP_TOKEN))) {
167 createdOchInterfaces.add(this.openRoadmInterfaceFactory .createOpenRoadmOchInterface(nodeId,
170 if ((destTp != null) && (destTp.contains(OpenRoadmInterfacesImpl.TTP_TOKEN)
171 || destTp.contains(OpenRoadmInterfacesImpl.PP_TOKEN))) {
172 createdOchInterfaces.add(this.openRoadmInterfaceFactory.createOpenRoadmOchInterface(nodeId,
173 destTp, waveNumber));
175 if (crossConnectFlag < 1) {
176 LOG.info("Creating cross connect between source {} and destination {} for node {}",
177 srcTp, destTp, nodeId);
178 Optional<String> connectionNameOpt = this.crossConnect.postCrossConnect(nodeId, waveNumber,
180 if (connectionNameOpt.isPresent()) {
181 nodesProvisioned.add(nodeId);
182 List<Ports> ports = this.crossConnect.getConnectionPortTrail(nodeId, waveNumber, srcTp,
184 if (ServicePathDirection.A_TO_Z.equals(direction)) {
185 topology.updateAtoZTopologyList(ports, nodeId);
187 if (ServicePathDirection.Z_TO_A.equals(direction)) {
188 topology.updateZtoATopologyList(ports, nodeId);
191 createdConnections.add(connectionNameOpt.get());
193 processErrorMessage("Unable to post Roadm-connection for node " + nodeId, forkJoinPool,
199 processErrorMessage(nodeId + " is not mounted on the controller", forkJoinPool, results);
202 } catch (OpenRoadmInterfaceException ex) {
203 processErrorMessage("Setup service path failed! Exception:" + ex.toString(), forkJoinPool, results);
207 NodeInterfaceBuilder nodeInterfaceBuilder = new NodeInterfaceBuilder();
208 nodeInterfaceBuilder.setKey(new NodeInterfaceKey(nodeId));
209 nodeInterfaceBuilder.setNodeId(nodeId);
210 nodeInterfaceBuilder.setConnectionId(createdConnections);
211 nodeInterfaceBuilder.setEthInterfaceId(createdEthInterfaces);
212 nodeInterfaceBuilder.setOtuInterfaceId(createdOtuInterfaces);
213 nodeInterfaceBuilder.setOduInterfaceId(createdOduInterfaces);
214 nodeInterfaceBuilder.setOchInterfaceId(createdOchInterfaces);
215 nodeInterfaces.add(nodeInterfaceBuilder.build());
221 } catch (InterruptedException | ExecutionException e) {
222 LOG.error("Error while setting up service paths!", e);
225 forkJoinPool.shutdown();
228 results.add("Roadm-connection successfully created for nodes: " + String.join(", ", nodesProvisioned));
230 ServicePathOutputBuilder setServBldr = new ServicePathOutputBuilder();
231 setServBldr.setNodeInterface(new ArrayList<>(nodeInterfaces));
232 setServBldr.setSuccess(success.get());
233 setServBldr.setResult(String.join("\n", results));
235 //setting topology in the service list data store
237 setTopologyForService(input.getServiceName(), topology.getTopology());
238 } catch (InterruptedException | TimeoutException | ExecutionException e) {
239 LOG.warn("Failed to write topologies for service {}.", input.getServiceName(), e);
242 if (!alarmSuppressionNodeRemoval(input.getServiceName())) {
243 LOG.error("Alarm suppresion node removal failed!!!!");
246 return setServBldr.build();
249 private ConcurrentLinkedQueue<String> processErrorMessage(String message, ForkJoinPool forkJoinPool,
250 ConcurrentLinkedQueue<String> messages) {
252 messages.add(message);
253 forkJoinPool.shutdown();
258 public ServicePathOutput deleteServicePath(ServicePathInput input) {
259 List<Nodes> nodes = input.getNodes();
260 ServicePathOutputBuilder delServBldr = new ServicePathOutputBuilder();
262 ConcurrentLinkedQueue<String> results = new ConcurrentLinkedQueue<>();
263 if (!alarmSuppressionNodeRegistration(input)) {
264 LOG.warn("Alarm suppresion node registraion failed!!!!");
266 ForkJoinPool forkJoinPool = new ForkJoinPool();
267 ForkJoinTask forkJoinTask = forkJoinPool.submit(() ->
268 nodes.parallelStream().forEach(node -> {
269 List<String> interfacesToDelete = new LinkedList<>();
270 String nodeId = node.getNodeId();
271 LOG.info("Deleting service setup on node {}", nodeId);
272 String srcTp = node.getSrcTp();
273 String destTp = node.getDestTp();
274 Long waveNumber = input.getWaveNumber();
276 if ((srcTp == null) || (destTp == null)) {
277 LOG.error("Source ({}) or destination ({}) termination point is null.", srcTp, destTp);
281 // if the node is currently mounted then proceed.
282 if (this.deviceTransactionManager.isDeviceMounted(nodeId)) {
283 if (destTp.contains(OpenRoadmInterfacesImpl.NETWORK_TOKEN)
284 || srcTp.contains(OpenRoadmInterfacesImpl.CLIENT_TOKEN)) {
285 if (destTp.contains(OpenRoadmInterfacesImpl.NETWORK_TOKEN)) {
286 interfacesToDelete.add(destTp + "-ODU");
287 interfacesToDelete.add(destTp + "-OTU");
288 interfacesToDelete.add(
289 this.openRoadmInterfaceFactory.createOpenRoadmOchInterfaceName(destTp, waveNumber));
291 if (srcTp.contains(OpenRoadmInterfacesImpl.CLIENT_TOKEN)) {
292 interfacesToDelete.add(srcTp + "-ETHERNET");
295 String connectionNumber = srcTp + "-" + destTp + "-" + waveNumber;
296 if (!this.crossConnect.deleteCrossConnect(nodeId, connectionNumber)) {
297 LOG.error("Failed to delete cross connect {}", srcTp + "-" + destTp + "-" + waveNumber);
299 interfacesToDelete.add(
300 this.openRoadmInterfaceFactory.createOpenRoadmOchInterfaceName(srcTp, waveNumber));
301 interfacesToDelete.add(
302 this.openRoadmInterfaceFactory.createOpenRoadmOchInterfaceName(destTp, waveNumber));
305 String result = nodeId + " is not mounted on the controller";
308 forkJoinPool.shutdown();
309 return; // TODO should deletion end here?
312 for (String interfaceId : interfacesToDelete) {
314 this.openRoadmInterfaces.deleteInterface(nodeId, interfaceId);
315 } catch (OpenRoadmInterfaceException e) {
316 String result = String.format("Failed to delete interface %s on node %s!", interfaceId, nodeId);
317 LOG.error(result, e);
326 } catch (InterruptedException | ExecutionException e) {
327 LOG.error("Error while deleting service paths!", e);
330 forkJoinPool.shutdown();
331 if (!alarmSuppressionNodeRemoval(input.getServiceName())) {
332 LOG.error("Alarm suppresion node removal failed!!!!");
334 if (results.isEmpty()) {
335 return delServBldr.setResult("Request processed").build();
337 return delServBldr.setResult(String.join("\n", results)).build();
342 public RendererRollbackOutput rendererRollback(RendererRollbackInput input) {
343 boolean success = true;
344 List<FailedToRollback> failedToRollbackList = new ArrayList<>();
345 for (NodeInterface nodeInterfaces : input.getNodeInterface()) {
346 List<String> failedInterfaces = new ArrayList<>();
347 String nodeId = nodeInterfaces.getNodeId();
348 for (String connectionId : nodeInterfaces.getConnectionId()) {
349 if (this.crossConnect.deleteCrossConnect(nodeId, connectionId)) {
350 LOG.info("Cross connect {} on node {} successfully deleted.", connectionId, nodeId);
352 LOG.error("Failed to delete cross connect {} on node {}!", connectionId, nodeId);
354 failedInterfaces.add(connectionId);
357 // Interfaces needs to be in specific order to delete. Order is:
362 LinkedList<String> interfacesToDelete = new LinkedList<>();
363 if (nodeInterfaces.getOduInterfaceId() != null) {
364 interfacesToDelete.addAll(nodeInterfaces.getOduInterfaceId());
366 if (nodeInterfaces.getOtuInterfaceId() != null) {
367 interfacesToDelete.addAll(nodeInterfaces.getOtuInterfaceId());
369 if (nodeInterfaces.getOchInterfaceId() != null) {
370 interfacesToDelete.addAll(nodeInterfaces.getOchInterfaceId());
372 if (nodeInterfaces.getEthInterfaceId() != null) {
373 interfacesToDelete.addAll(nodeInterfaces.getEthInterfaceId());
376 LOG.info("Going to execute rollback on node {}. Interfaces to rollback: {}", nodeId,
377 String.join(", ", interfacesToDelete));
379 for (String interfaceId : interfacesToDelete) {
381 this.openRoadmInterfaces.deleteInterface(nodeId, interfaceId);
382 LOG.info("Interface {} on node {} successfully deleted.", interfaceId, nodeId);
383 } catch (OpenRoadmInterfaceException e) {
384 LOG.error("Failed to delete interface {} on node {}!", interfaceId, nodeId);
386 failedInterfaces.add(interfaceId);
389 failedToRollbackList.add(new FailedToRollbackBuilder()
390 .setKey(new FailedToRollbackKey(nodeId))
392 .setInterface(failedInterfaces)
396 return new RendererRollbackOutputBuilder()
398 .setFailedToRollback(failedToRollbackList)
402 private boolean alarmSuppressionNodeRegistration(ServicePathInput input) {
403 NodelistBuilder nodeListBuilder = new NodelistBuilder();
404 nodeListBuilder.setKey(new NodelistKey(input.getServiceName()));
405 nodeListBuilder.setServiceName(input.getServiceName());
406 List<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.alarmsuppression.rev171102.service
407 .nodelist.nodelist.Nodes> nodeList = new ArrayList<>();
408 for (Nodes node: input.getNodes()) {
409 nodeList.add(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns
410 .yang.alarmsuppression.rev171102.service.nodelist.nodelist.NodesBuilder()
411 .setNodeId(node.getNodeId()).build());
413 nodeListBuilder.setNodes(nodeList);
414 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params
415 .xml.ns.yang.alarmsuppression.rev171102.service.nodelist.Nodelist> nodeListIID =
416 InstanceIdentifier.create(ServiceNodelist.class).child(org.opendaylight.yang.gen.v1.urn
417 .opendaylight.params.xml.ns.yang.alarmsuppression.rev171102.service.nodelist.Nodelist.class,
418 new NodelistKey(input.getServiceName()));
419 final WriteTransaction writeTransaction = this.dataBroker.newWriteOnlyTransaction();
420 writeTransaction.merge(LogicalDatastoreType.CONFIGURATION, nodeListIID, nodeListBuilder.build());
421 Future<Void> submit = writeTransaction.submit();
423 submit.get(Timeouts.DATASTORE_WRITE, TimeUnit.MILLISECONDS);
424 LOG.info("Nodes are register for alarm suppression for service: {}",
425 input.getServiceName());
428 } catch (ExecutionException | InterruptedException | TimeoutException e) {
429 LOG.warn("Failed to alarm suppresslist for service: {}", input.getServiceName(), e);
434 private boolean alarmSuppressionNodeRemoval(String serviceName) {
435 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params
436 .xml.ns.yang.alarmsuppression.rev171102.service.nodelist.Nodelist> nodeListIID =
437 InstanceIdentifier.create(ServiceNodelist.class).child(org.opendaylight.yang.gen.v1.urn
438 .opendaylight.params.xml.ns.yang.alarmsuppression.rev171102.service.nodelist.Nodelist.class,
439 new NodelistKey(serviceName));
440 final WriteTransaction writeTransaction = this.dataBroker.newWriteOnlyTransaction();
441 writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, nodeListIID);
442 Future<Void> submit = writeTransaction.submit();
444 submit.get(Timeouts.DATASTORE_DELETE, TimeUnit.MILLISECONDS);
445 LOG.info("Nodes are unregister for alarm suppression for service: {}", serviceName);
448 } catch (InterruptedException | TimeoutException | ExecutionException e) {
449 LOG.warn("Failed to alarm suppresslist for service: {}", serviceName, e);
454 private void setTopologyForService(String serviceName, Topology topo)
455 throws InterruptedException, ExecutionException, TimeoutException {
457 ServicesBuilder servicesBuilder;
458 //Get the service from the service list inventory
460 ServicesKey serviceKey = new ServicesKey(serviceName);
461 InstanceIdentifier<Services> iid =
462 InstanceIdentifier.create(ServiceList.class).child(Services.class, serviceKey);
463 Optional<Services> services;
464 try (ReadOnlyTransaction readTx = this.dataBroker.newReadOnlyTransaction()) {
465 Future<com.google.common.base.Optional<Services>> future = readTx.read(LogicalDatastoreType.OPERATIONAL,
467 services = future.get(Timeouts.DATASTORE_READ, TimeUnit.MILLISECONDS).toJavaUtil();
468 } catch (InterruptedException | ExecutionException | TimeoutException e) {
472 if (services.isPresent()) {
473 servicesBuilder = new ServicesBuilder(services.get());
475 servicesBuilder = new ServicesBuilder();
476 servicesBuilder.setKey(serviceKey);
478 servicesBuilder.setTopology(topo);
480 WriteTransaction writeTx = this.dataBroker.newWriteOnlyTransaction();
481 writeTx.merge(LogicalDatastoreType.OPERATIONAL, iid, servicesBuilder.build());
482 writeTx.submit().get(Timeouts.DATASTORE_WRITE, TimeUnit.MILLISECONDS);