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 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(
77 OpenRoadmInterfaceException.mapping_msg_err(nodeId, logicalConnPoint));
79 InterfaceBuilder ethInterfaceBldr =
80 createGenericInterfaceBuilder(portMap, EthernetCsmacd.VALUE, logicalConnPoint + "-ETHERNET")
82 // Create Interface1 type object required for adding as augmentation
83 new Interface1Builder()
85 // Ethernet interface specific data
87 .setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled)
88 .setDuplex(EthAttributes.Duplex.Full)
89 .setFec(EthAttributes.Fec.Off)
90 .setSpeed(Uint32.valueOf(100000))
91 .setMtu(Uint32.valueOf(9000))
94 // Post interface on the device
95 this.openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
96 // Post the equipment-state change on the device circuit-pack
97 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
98 return ethInterfaceBldr.getName();
101 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, InterfaceType type,
103 return new InterfaceBuilder()
104 .setDescription(" TBD ")
105 .setCircuitId(" TBD ")
106 .setSupportingCircuitPackName(portMap.getSupportingCircuitPackName())
107 .setSupportingPort(portMap.getSupportingPort())
108 .setAdministrativeState(AdminStates.InService)
111 .withKey(new InterfaceKey(key));
114 * This methods creates an OTU interface on the given termination point.
116 * @param nodeId node ID
117 * @param logicalConnPoint logical Connection Point
118 * @param supportOchInterface support OCH Interface
120 * @return Name of the interface if successful, otherwise return null.
121 * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
124 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
125 throws OpenRoadmInterfaceException {
126 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
127 if (portMap == null) {
128 throw new OpenRoadmInterfaceException(
129 OpenRoadmInterfaceException.mapping_msg_err(nodeId, logicalConnPoint));
131 // Create generic interface
132 InterfaceBuilder otuInterfaceBldr =
133 createGenericInterfaceBuilder(portMap, OtnOtu.VALUE, logicalConnPoint + "-OTU")
134 .setSupportingInterface(supportOchInterface)
136 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder()
138 // OTU interface specific data
140 .setFec(OtuAttributes.Fec.Scfec)
144 // Post interface on the device
145 this.openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
146 this.portMapping.updateMapping(nodeId, portMap);
147 return otuInterfaceBldr.getName();
151 * This methods creates an ODU interface on the given termination point.
153 * @param nodeId node ID
154 * @param logicalConnPoint logical Connection Point
156 * @return Name of the interface if successful, otherwise return null.
157 * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
160 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint)
161 throws OpenRoadmInterfaceException {
162 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
163 if (portMap == null) {
164 throw new OpenRoadmInterfaceException(
165 OpenRoadmInterfaceException.mapping_msg_err(nodeId, logicalConnPoint));
167 InterfaceBuilder oduInterfaceBldr =
168 createGenericInterfaceBuilder(portMap, OtnOdu.VALUE, logicalConnPoint + "-ODU");
169 if (portMap.getSupportingOtu4() != null) {
170 oduInterfaceBldr.setSupportingInterface(portMap.getSupportingOtu4());
172 oduInterfaceBldr.addAugmentation(
173 // Create Interface1 type object required for adding as augmentation
174 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder()
176 // ODU interface specific data
179 .setMonitoringMode(OduAttributes.MonitoringMode.Terminated)
181 // Set Opu attributes
183 .setPayloadType("07")
184 .setExpPayloadType("07")
188 // Post interface on the device
189 this.openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
190 return oduInterfaceBldr.getName();
193 * This methods creates a list of OCH interface on the given termination point on
196 * @param nodeId node ID
197 * @param logicalConnPoint logical connection point
198 * @param spectrumInformation SpectrumInformation
199 * @return List containing name of the interface if successful, otherwise return empty list.
201 * @throws OpenRoadmInterfaceException OpenRoadm interface exception
204 public List<String> createOpenRoadmOchInterfaces(String nodeId, String logicalConnPoint,
205 SpectrumInformation spectrumInformation)
206 throws OpenRoadmInterfaceException {
207 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
208 if (portMap == null) {
209 throw new OpenRoadmInterfaceException(
210 OpenRoadmInterfaceException.mapping_msg_err(nodeId, logicalConnPoint));
212 // Create generic interface
213 InterfaceBuilder ochInterfaceBldr =
214 createGenericInterfaceBuilder(
215 portMap, OpticalChannel.VALUE,
216 spectrumInformation.getIdentifierFromParams(logicalConnPoint));
217 // Add supporting OMS interface
218 if (portMap.getSupportingOms() != null) {
219 ochInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
221 ochInterfaceBldr.addAugmentation(
222 // Create Interface1 type object required for adding as augmentation
223 new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1Builder()
225 // OCH interface specific data
226 new OchBuilder().setWavelengthNumber(spectrumInformation.getWaveLength()).build())
228 // Post interface on the device
229 openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
230 return new ArrayList<String>(List.of(ochInterfaceBldr.getName()));
233 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint,
234 SpectrumInformation spectrumInformation) throws OpenRoadmInterfaceException {
235 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
236 if (portMap == null) {
237 throw new OpenRoadmInterfaceException(
238 OpenRoadmInterfaceException.mapping_msg_err(nodeId, logicalConnPoint));
240 ModulationFormat modulationFormat =
241 OchAttributes.ModulationFormat.forName(spectrumInformation.getModulationFormat());
242 if (modulationFormat == null) {
243 modulationFormat = OchAttributes.ModulationFormat.DpQpsk;
245 // Create generic interface
246 InterfaceBuilder ochInterfaceBldr =
247 createGenericInterfaceBuilder(
248 portMap, OpticalChannel.VALUE,
249 spectrumInformation.getIdentifierFromParams(logicalConnPoint))
251 // Create Interface1 type object required for adding as augmentation
252 new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
255 // OCH interface specific data
257 .setWavelengthNumber(spectrumInformation.getWaveLength())
258 .setModulationFormat(modulationFormat)
259 .setRate(R100G.VALUE)
260 .setTransmitPower(new PowerDBm(Decimal64.valueOf("-5")))
263 // Post interface on the device
264 this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
265 // Post the equipment-state change on the device circuit-pack if xpdr node
266 if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
267 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
269 return ochInterfaceBldr.getName();
272 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, String spectralSlotName) {
273 return String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,logicalConnectionPoint, spectralSlotName);
276 public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
277 if (mapping.getSupportingOms() != null) {
278 return mapping.getSupportingOms();
280 if (mapping.getSupportingOts() == null) {
281 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId, mapping.getLogicalConnectionPoint());
284 // Create generic interface
285 InterfaceBuilder omsInterfaceBldr =
286 createGenericInterfaceBuilder(
287 mapping, OpenROADMOpticalMultiplex.VALUE,
288 "OMS-" + mapping.getLogicalConnectionPoint())
289 .setSupportingInterface(mapping.getSupportingOts());
290 this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
291 this.portMapping.updateMapping(nodeId, mapping);
292 return omsInterfaceBldr.build().getName();
295 public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
296 if (mapping.getSupportingOts() != null) {
297 return mapping.getSupportingOts();
299 // Create generic interface
300 InterfaceBuilder otsInterfaceBldr =
301 createGenericInterfaceBuilder(mapping, OpticalTransport.VALUE, "OTS-" + mapping.getLogicalConnectionPoint())
303 // Create Interface1 type object required for adding as
305 new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014
308 // OTS interface augmentation specific data
309 new OtsBuilder().setFiberType(OtsAttributes.FiberType.Smf).build())
311 this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
312 this.portMapping.updateMapping(nodeId, mapping);
313 return otsInterfaceBldr.build().getName();
316 public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
317 DeviceTransactionManager deviceTransactionManager) {
318 LOG.info("reading xc {} in node {}", xc, nodeId);
319 Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(
321 LogicalDatastoreType.CONFIGURATION,
323 .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
324 .child(RoadmConnections.class, new RoadmConnectionsKey(xc))
326 Timeouts.DEVICE_READ_TIMEOUT,
327 Timeouts.DEVICE_READ_TIMEOUT_UNIT);
328 if (crossconnection.isEmpty()) {
329 LOG.info("xd {} not found !", xc);
332 RoadmConnections rc = crossconnection.get();
333 LOG.info("xd {} found", xc);
334 if (rc.getSource().getSrcIf().equals(interfaceName)
335 || rc.getDestination().getDstIf().equals(interfaceName)) {