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.math.BigDecimal;
12 import java.util.ArrayList;
13 import java.util.List;
14 import java.util.Optional;
15 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
16 import org.opendaylight.transportpce.common.StringConstants;
17 import org.opendaylight.transportpce.common.Timeouts;
18 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
19 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
20 import org.opendaylight.transportpce.common.fixedflex.SpectrumInformation;
21 import org.opendaylight.transportpce.common.mapping.PortMapping;
22 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
23 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220114.mapping.Mapping;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.PowerDBm;
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.R100G;
44 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.och.container.OchBuilder;
45 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.OtsAttributes;
46 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.ots.container.OtsBuilder;
47 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.ODU4;
48 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.OduAttributes;
49 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.odu.container.OduBuilder;
50 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.opu.OpuBuilder;
51 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OTU4;
52 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OtuAttributes;
53 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.otu.container.OtuBuilder;
54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
55 import org.opendaylight.yangtools.yang.common.Uint32;
56 import org.slf4j.Logger;
57 import org.slf4j.LoggerFactory;
60 public class OpenRoadmInterface121 {
61 private static final String MAPPING_MSG_ERROR =
62 "Unable to get mapping from PortMapping for node % and logical connection port %s";
63 private final PortMapping portMapping;
64 private final OpenRoadmInterfaces openRoadmInterfaces;
65 private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterface121.class);
67 public OpenRoadmInterface121(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces) {
68 this.portMapping = portMapping;
69 this.openRoadmInterfaces = openRoadmInterfaces;
72 public String createOpenRoadmEthInterface(String nodeId, String logicalConnPoint)
73 throws OpenRoadmInterfaceException {
74 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
75 if (portMap == null) {
76 throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
79 // Ethernet interface specific data
80 EthernetBuilder ethIfBuilder = new EthernetBuilder()
81 .setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled)
82 .setDuplex(EthAttributes.Duplex.Full)
83 .setFec(EthAttributes.Fec.Off)
84 .setSpeed(Uint32.valueOf(100000))
85 .setMtu(Uint32.valueOf(9000));
87 InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
88 logicalConnPoint + "-ETHERNET");
90 // Create Interface1 type object required for adding as augmentation
91 Interface1Builder ethIf1Builder = new Interface1Builder();
92 ethInterfaceBldr.addAugmentation(ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
94 // Post interface on the device
95 this.openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
97 // Post the equipment-state change on the device circuit-pack
98 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
100 return ethInterfaceBldr.getName();
103 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
105 return new InterfaceBuilder()
106 .setDescription(" TBD ")
107 .setCircuitId(" TBD ")
108 .setSupportingCircuitPackName(portMap.getSupportingCircuitPackName())
109 .setSupportingPort(portMap.getSupportingPort())
110 .setAdministrativeState(AdminStates.InService)
113 .withKey(new InterfaceKey(key));
116 * This methods creates an OTU interface on the given termination point.
118 * @param nodeId node ID
119 * @param logicalConnPoint logical Connection Point
120 * @param supportOchInterface support OCH Interface
122 * @return Name of the interface if successful, otherwise return null.
123 * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
126 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
127 throws OpenRoadmInterfaceException {
128 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
129 if (portMap == null) {
130 throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
132 // Create generic interface
133 InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class, logicalConnPoint
135 otuInterfaceBldr.setSupportingInterface(supportOchInterface);
137 // OTU interface specific data
138 OtuBuilder otuIfBuilder = new OtuBuilder()
139 .setFec(OtuAttributes.Fec.Scfec)
140 .setRate(OTU4.class);
142 // Create Interface1 type object required for adding as augmentation
143 // TODO look at imports of different versions of class
144 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder otuIf1Builder =
145 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder();
146 otuInterfaceBldr.addAugmentation(otuIf1Builder.setOtu(otuIfBuilder.build()).build());
148 // Post interface on the device
149 this.openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
150 this.portMapping.updateMapping(nodeId, portMap);
151 return otuInterfaceBldr.getName();
155 * This methods creates an ODU interface on the given termination point.
157 * @param nodeId node ID
158 * @param logicalConnPoint logical Connection Point
160 * @return Name of the interface if successful, otherwise return null.
161 * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
164 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint)
165 throws OpenRoadmInterfaceException {
166 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
167 if (portMap == null) {
168 throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
170 InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class, logicalConnPoint
172 if (portMap.getSupportingOtu4() != null) {
173 oduInterfaceBldr.setSupportingInterface(portMap.getSupportingOtu4());
176 // ODU interface specific data
177 // Set Opu attributes
178 OpuBuilder opuBldr = new OpuBuilder()
179 .setPayloadType("07")
180 .setExpPayloadType("07");
181 OduBuilder oduIfBuilder = new OduBuilder()
183 .setMonitoringMode(OduAttributes.MonitoringMode.Terminated)
184 .setOpu(opuBldr.build());
186 // Create Interface1 type object required for adding as augmentation
187 // TODO look at imports of different versions of class
188 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder oduIf1Builder =
189 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder();
190 oduInterfaceBldr.addAugmentation(oduIf1Builder.setOdu(oduIfBuilder.build()).build());
192 // Post interface on the device
193 this.openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
194 return oduInterfaceBldr.getName();
197 * This methods creates a list of OCH interface on the given termination point on
200 * @param nodeId node ID
201 * @param logicalConnPoint logical connection point
202 * @param spectrumInformation SpectrumInformation
203 * @return List containing name of the interface if successful, otherwise return empty list.
205 * @throws OpenRoadmInterfaceException OpenRoadm interface exception
208 public List<String> createOpenRoadmOchInterfaces(String nodeId, String logicalConnPoint,
209 SpectrumInformation spectrumInformation)
210 throws OpenRoadmInterfaceException {
211 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
212 if (portMap == null) {
213 throw new OpenRoadmInterfaceException(String.format(
214 "Unable to get mapping from PortMapping for node %s and logical connection port %s",
215 nodeId, logicalConnPoint));
217 // Create generic interface
218 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
219 spectrumInformation.getIdentifierFromParams(logicalConnPoint));
221 // OCH interface specific data
222 OchBuilder ocIfBuilder = new OchBuilder().setWavelengthNumber(spectrumInformation.getWaveLength());
224 // Add supporting OMS interface
225 if (portMap.getSupportingOms() != null) {
226 ochInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
228 // Create Interface1 type object required for adding as augmentation
229 // TODO look at imports of different versions of class
230 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1Builder
231 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces
232 .rev161014.Interface1Builder();
233 ochInterfaceBldr.addAugmentation(ochIf1Builder.setOch(ocIfBuilder.build()).build());
235 List<String> interfacesCreated = new ArrayList<>();
236 // Post interface on the device
237 openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
238 interfacesCreated.add(ochInterfaceBldr.getName());
239 return interfacesCreated;
242 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint,
243 SpectrumInformation spectrumInformation) throws OpenRoadmInterfaceException {
244 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
245 if (portMap == null) {
246 throw new OpenRoadmInterfaceException(String.format(
247 "Unable to get mapping from PortMapping for node %s and logical connection port %s",
248 nodeId, logicalConnPoint));
250 OchAttributes.ModulationFormat modulationFormat = OchAttributes.ModulationFormat.DpQpsk;
251 Optional<OchAttributes.ModulationFormat> optionalModulationFormat = OchAttributes.ModulationFormat
252 .forName(spectrumInformation.getModulationFormat());
253 if (optionalModulationFormat.isPresent()) {
254 modulationFormat = optionalModulationFormat.get();
256 // OCH interface specific data
257 OchBuilder ocIfBuilder = new OchBuilder()
258 .setWavelengthNumber(spectrumInformation.getWaveLength())
259 .setModulationFormat(modulationFormat)
260 .setRate(R100G.class)
261 .setTransmitPower(new PowerDBm(new BigDecimal("-5")));
263 // Create Interface1 type object required for adding as augmentation
264 // TODO look at imports of different versions of class
265 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
266 .Interface1Builder ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel
267 .interfaces.rev161014.Interface1Builder();
268 // Create generic interface
269 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
270 spectrumInformation.getIdentifierFromParams(logicalConnPoint));
271 ochInterfaceBldr.addAugmentation(ochIf1Builder.setOch(ocIfBuilder.build()).build());
273 // Post interface on the device
274 this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
276 // Post the equipment-state change on the device circuit-pack if xpdr node
277 if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
278 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
280 return ochInterfaceBldr.getName();
283 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, String spectralSlotName) {
284 return String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,logicalConnectionPoint, spectralSlotName);
287 public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
288 if (mapping.getSupportingOms() == null) {
289 // Create generic interface
290 InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
291 "OMS-" + mapping.getLogicalConnectionPoint());
292 if (mapping.getSupportingOts() != null) {
293 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
295 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
296 mapping.getLogicalConnectionPoint());
299 this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
300 this.portMapping.updateMapping(nodeId, mapping);
301 return omsInterfaceBldr.build().getName();
303 return mapping.getSupportingOms();
307 public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
308 if (mapping.getSupportingOts() == null) {
309 // Create generic interface
310 InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
311 + mapping.getLogicalConnectionPoint());
312 // OTS interface augmentation specific data
313 OtsBuilder otsIfBuilder = new OtsBuilder();
314 otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
316 // Create Interface1 type object required for adding as
318 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014
319 .Interface1Builder otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm
320 .optical.transport.interfaces.rev161014.Interface1Builder();
321 otsInterfaceBldr.addAugmentation(otsIf1Builder.setOts(otsIfBuilder.build()).build());
322 this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
323 this.portMapping.updateMapping(nodeId, mapping);
324 return otsInterfaceBldr.build().getName();
326 return mapping.getSupportingOts();
330 public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
331 DeviceTransactionManager deviceTransactionManager) {
332 InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
333 .child(RoadmConnections.class, new RoadmConnectionsKey(xc));
334 LOG.info("reading xc {} in node {}", xc, nodeId);
335 Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
336 LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
337 if (crossconnection.isPresent()) {
338 RoadmConnections rc = crossconnection.get();
339 LOG.info("xd {} found", xc);
340 if (rc.getSource().getSrcIf().equals(interfaceName)
341 || rc.getDestination().getDstIf().equals(interfaceName)) {
345 LOG.info("xd {} not found !", xc);