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.openroadminterface;
11 import java.util.ArrayList;
12 import java.util.List;
13 import java.util.Optional;
14 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
15 import org.opendaylight.transportpce.common.StringConstants;
16 import org.opendaylight.transportpce.common.Timeouts;
17 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
18 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
19 import org.opendaylight.transportpce.common.fixedflex.SpectrumInformation;
20 import org.opendaylight.transportpce.common.mapping.PortMapping;
21 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
22 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.Mapping;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.PowerDBm;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.OrgOpenroadmDeviceData;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceBuilder;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceKey;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.OrgOpenroadmDevice;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.RoadmConnections;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsKey;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev161014.AdminStates;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.EthAttributes;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.Interface1Builder;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.ethernet.container.EthernetBuilder;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.EthernetCsmacd;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.InterfaceType;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpenROADMOpticalMultiplex;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalChannel;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalTransport;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOdu;
41 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOtu;
42 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.OchAttributes;
43 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.OchAttributes.ModulationFormat;
44 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.R100G;
45 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.och.container.OchBuilder;
46 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.OtsAttributes;
47 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.ots.container.OtsBuilder;
48 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.ODU4;
49 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.OduAttributes;
50 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.odu.container.OduBuilder;
51 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.opu.OpuBuilder;
52 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OTU4;
53 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OtuAttributes;
54 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.otu.container.OtuBuilder;
55 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
56 import org.opendaylight.yangtools.yang.common.Decimal64;
57 import org.opendaylight.yangtools.yang.common.Uint32;
58 import org.slf4j.Logger;
59 import org.slf4j.LoggerFactory;
62 public class OpenRoadmInterface121 {
63 private static final String MAPPING_MSG_ERROR =
64 "Unable to get mapping from PortMapping for node % and logical connection port %s";
65 private final PortMapping portMapping;
66 private final OpenRoadmInterfaces openRoadmInterfaces;
67 private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterface121.class);
69 public OpenRoadmInterface121(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces) {
70 this.portMapping = portMapping;
71 this.openRoadmInterfaces = openRoadmInterfaces;
74 public String createOpenRoadmEthInterface(String nodeId, String logicalConnPoint)
75 throws OpenRoadmInterfaceException {
76 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
77 if (portMap == null) {
78 throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
81 // Ethernet interface specific data
82 EthernetBuilder ethIfBuilder = new EthernetBuilder()
83 .setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled)
84 .setDuplex(EthAttributes.Duplex.Full)
85 .setFec(EthAttributes.Fec.Off)
86 .setSpeed(Uint32.valueOf(100000))
87 .setMtu(Uint32.valueOf(9000));
89 InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.VALUE,
90 logicalConnPoint + "-ETHERNET");
92 // Create Interface1 type object required for adding as augmentation
93 Interface1Builder ethIf1Builder = new Interface1Builder();
94 ethInterfaceBldr.addAugmentation(ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
96 // Post interface on the device
97 this.openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
99 // Post the equipment-state change on the device circuit-pack
100 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
102 return ethInterfaceBldr.getName();
105 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, InterfaceType type,
107 return new InterfaceBuilder()
108 .setDescription(" TBD ")
109 .setCircuitId(" TBD ")
110 .setSupportingCircuitPackName(portMap.getSupportingCircuitPackName())
111 .setSupportingPort(portMap.getSupportingPort())
112 .setAdministrativeState(AdminStates.InService)
115 .withKey(new InterfaceKey(key));
118 * This methods creates an OTU interface on the given termination point.
120 * @param nodeId node ID
121 * @param logicalConnPoint logical Connection Point
122 * @param supportOchInterface support OCH Interface
124 * @return Name of the interface if successful, otherwise return null.
125 * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
128 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
129 throws OpenRoadmInterfaceException {
130 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
131 if (portMap == null) {
132 throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
134 // Create generic interface
135 InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.VALUE, logicalConnPoint
137 otuInterfaceBldr.setSupportingInterface(supportOchInterface);
139 // OTU interface specific data
140 OtuBuilder otuIfBuilder = new OtuBuilder()
141 .setFec(OtuAttributes.Fec.Scfec)
142 .setRate(OTU4.VALUE);
144 // Create Interface1 type object required for adding as augmentation
145 // TODO look at imports of different versions of class
146 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder otuIf1Builder =
147 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder();
148 otuInterfaceBldr.addAugmentation(otuIf1Builder.setOtu(otuIfBuilder.build()).build());
150 // Post interface on the device
151 this.openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
152 this.portMapping.updateMapping(nodeId, portMap);
153 return otuInterfaceBldr.getName();
157 * This methods creates an ODU interface on the given termination point.
159 * @param nodeId node ID
160 * @param logicalConnPoint logical Connection Point
162 * @return Name of the interface if successful, otherwise return null.
163 * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
166 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint)
167 throws OpenRoadmInterfaceException {
168 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
169 if (portMap == null) {
170 throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
172 InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.VALUE, logicalConnPoint
174 if (portMap.getSupportingOtu4() != null) {
175 oduInterfaceBldr.setSupportingInterface(portMap.getSupportingOtu4());
178 // ODU interface specific data
179 // Set Opu attributes
180 OpuBuilder opuBldr = new OpuBuilder()
181 .setPayloadType("07")
182 .setExpPayloadType("07");
183 OduBuilder oduIfBuilder = new OduBuilder()
185 .setMonitoringMode(OduAttributes.MonitoringMode.Terminated)
186 .setOpu(opuBldr.build());
188 // Create Interface1 type object required for adding as augmentation
189 // TODO look at imports of different versions of class
190 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder oduIf1Builder =
191 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder();
192 oduInterfaceBldr.addAugmentation(oduIf1Builder.setOdu(oduIfBuilder.build()).build());
194 // Post interface on the device
195 this.openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
196 return oduInterfaceBldr.getName();
199 * This methods creates a list of OCH interface on the given termination point on
202 * @param nodeId node ID
203 * @param logicalConnPoint logical connection point
204 * @param spectrumInformation SpectrumInformation
205 * @return List containing name of the interface if successful, otherwise return empty list.
207 * @throws OpenRoadmInterfaceException OpenRoadm interface exception
210 public List<String> createOpenRoadmOchInterfaces(String nodeId, String logicalConnPoint,
211 SpectrumInformation spectrumInformation)
212 throws OpenRoadmInterfaceException {
213 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
214 if (portMap == null) {
215 throw new OpenRoadmInterfaceException(String.format(
216 "Unable to get mapping from PortMapping for node %s and logical connection port %s",
217 nodeId, logicalConnPoint));
219 // Create generic interface
220 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.VALUE,
221 spectrumInformation.getIdentifierFromParams(logicalConnPoint));
223 // OCH interface specific data
224 OchBuilder ocIfBuilder = new OchBuilder().setWavelengthNumber(spectrumInformation.getWaveLength());
226 // Add supporting OMS interface
227 if (portMap.getSupportingOms() != null) {
228 ochInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
230 // Create Interface1 type object required for adding as augmentation
231 // TODO look at imports of different versions of class
232 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1Builder
233 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces
234 .rev161014.Interface1Builder();
235 ochInterfaceBldr.addAugmentation(ochIf1Builder.setOch(ocIfBuilder.build()).build());
237 List<String> interfacesCreated = new ArrayList<>();
238 // Post interface on the device
239 openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
240 interfacesCreated.add(ochInterfaceBldr.getName());
241 return interfacesCreated;
244 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint,
245 SpectrumInformation spectrumInformation) throws OpenRoadmInterfaceException {
246 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
247 if (portMap == null) {
248 throw new OpenRoadmInterfaceException(String.format(
249 "Unable to get mapping from PortMapping for node %s and logical connection port %s",
250 nodeId, logicalConnPoint));
252 ModulationFormat modulationFormat = OchAttributes.ModulationFormat
253 .forName(spectrumInformation.getModulationFormat());
254 if (modulationFormat == null) {
255 modulationFormat = OchAttributes.ModulationFormat.DpQpsk;
257 // OCH interface specific data
258 OchBuilder ocIfBuilder = new OchBuilder()
259 .setWavelengthNumber(spectrumInformation.getWaveLength())
260 .setModulationFormat(modulationFormat)
261 .setRate(R100G.VALUE)
262 .setTransmitPower(new PowerDBm(Decimal64.valueOf("-5")));
264 // Create Interface1 type object required for adding as augmentation
265 // TODO look at imports of different versions of class
266 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
267 .Interface1Builder ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel
268 .interfaces.rev161014.Interface1Builder();
269 // Create generic interface
270 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.VALUE,
271 spectrumInformation.getIdentifierFromParams(logicalConnPoint));
272 ochInterfaceBldr.addAugmentation(ochIf1Builder.setOch(ocIfBuilder.build()).build());
274 // Post interface on the device
275 this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
277 // Post the equipment-state change on the device circuit-pack if xpdr node
278 if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
279 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
281 return ochInterfaceBldr.getName();
284 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, String spectralSlotName) {
285 return String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,logicalConnectionPoint, spectralSlotName);
288 public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
289 if (mapping.getSupportingOms() == null) {
290 // Create generic interface
291 InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.VALUE,
292 "OMS-" + mapping.getLogicalConnectionPoint());
293 if (mapping.getSupportingOts() != null) {
294 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
296 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
297 mapping.getLogicalConnectionPoint());
300 this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
301 this.portMapping.updateMapping(nodeId, mapping);
302 return omsInterfaceBldr.build().getName();
304 return mapping.getSupportingOms();
308 public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
309 if (mapping.getSupportingOts() == null) {
310 // Create generic interface
311 InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.VALUE, "OTS-"
312 + mapping.getLogicalConnectionPoint());
313 // OTS interface augmentation specific data
314 OtsBuilder otsIfBuilder = new OtsBuilder();
315 otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
317 // Create Interface1 type object required for adding as
319 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014
320 .Interface1Builder otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm
321 .optical.transport.interfaces.rev161014.Interface1Builder();
322 otsInterfaceBldr.addAugmentation(otsIf1Builder.setOts(otsIfBuilder.build()).build());
323 this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
324 this.portMapping.updateMapping(nodeId, mapping);
325 return otsInterfaceBldr.build().getName();
327 return mapping.getSupportingOts();
331 public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
332 DeviceTransactionManager deviceTransactionManager) {
333 InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier
334 .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
335 .child(RoadmConnections.class, new RoadmConnectionsKey(xc))
337 LOG.info("reading xc {} in node {}", xc, nodeId);
338 Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
339 LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
340 if (crossconnection.isPresent()) {
341 RoadmConnections rc = crossconnection.get();
342 LOG.info("xd {} found", xc);
343 if (rc.getSource().getSrcIf().equals(interfaceName)
344 || rc.getDestination().getDstIf().equals(interfaceName)) {
348 LOG.info("xd {} not found !", xc);