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;
15 import org.opendaylight.transportpce.common.StringConstants;
16 import org.opendaylight.transportpce.common.mapping.PortMapping;
17 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
18 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
19 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev170228.network.nodes.Mapping;
20 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.PowerDBm;
22 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceBuilder;
23 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceKey;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev161014.AdminStates;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.EthAttributes;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.Interface1;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.Interface1Builder;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.ethernet.container.EthernetBuilder;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.EthernetCsmacd;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.InterfaceType;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpenROADMOpticalMultiplex;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalChannel;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalTransport;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOdu;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOtu;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.OchAttributes;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.RateIdentity;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.och.container.OchBuilder;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.OtsAttributes;
41 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.ots.container.OtsBuilder;
42 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.ODU4;
43 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.OduAttributes;
44 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.odu.container.OduBuilder;
45 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.opu.OpuBuilder;
46 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OTU4;
47 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OtuAttributes;
48 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.otu.container.OtuBuilder;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
53 public class OpenRoadmInterface121 {
54 private final PortMapping portMapping;
55 private final OpenRoadmInterfaces openRoadmInterfaces;
56 private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterfaceFactory.class);
58 public OpenRoadmInterface121(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces) {
59 this.portMapping = portMapping;
60 this.openRoadmInterfaces = openRoadmInterfaces;
63 public String createOpenRoadmEthInterface(String nodeId, String logicalConnPoint)
64 throws OpenRoadmInterfaceException {
65 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
66 if (portMap == null) {
67 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
68 + " logical connection port %s", nodeId, logicalConnPoint));
71 // Ethernet interface specific data
72 EthernetBuilder ethIfBuilder = new EthernetBuilder();
73 ethIfBuilder.setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled);
74 ethIfBuilder.setDuplex(EthAttributes.Duplex.Full);
75 ethIfBuilder.setFec(EthAttributes.Fec.Off);
76 ethIfBuilder.setSpeed(100000L);
77 ethIfBuilder.setMtu(9000L);
79 InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
80 logicalConnPoint + "-ETHERNET");
82 // Create Interface1 type object required for adding as augmentation
83 Interface1Builder ethIf1Builder = new Interface1Builder();
84 ethInterfaceBldr.addAugmentation(Interface1.class, ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
86 // Post interface on the device
87 this.openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
89 // Post the equipment-state change on the device circuit-pack
90 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
92 return ethInterfaceBldr.getName();
95 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
97 InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
98 interfaceBuilder.setDescription(" TBD ");
99 interfaceBuilder.setCircuitId(" TBD ");
100 interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
101 interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
102 interfaceBuilder.setAdministrativeState(AdminStates.InService);
103 interfaceBuilder.setType(type);
104 interfaceBuilder.setName(key);
105 interfaceBuilder.withKey(new InterfaceKey(key));
106 return interfaceBuilder;
109 * This methods creates an OTU interface on the given termination point.
111 * @param nodeId node ID
112 * @param logicalConnPoint logical Connection Point
113 * @param supportOchInterface support OCH Interface
115 * @return Name of the interface if successful, otherwise return null.
116 * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
119 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
120 throws OpenRoadmInterfaceException {
121 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
122 if (portMap == null) {
123 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
124 + " logical connection port %s", nodeId, logicalConnPoint));
126 // Create generic interface
127 InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class, logicalConnPoint
129 otuInterfaceBldr.setSupportingInterface(supportOchInterface);
131 // OTU interface specific data
132 OtuBuilder otuIfBuilder = new OtuBuilder();
133 otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
134 otuIfBuilder.setRate(OTU4.class);
136 // Create Interface1 type object required for adding as augmentation
137 // TODO look at imports of different versions of class
138 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder otuIf1Builder =
139 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder();
140 otuInterfaceBldr.addAugmentation(
141 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1.class,
142 otuIf1Builder.setOtu(otuIfBuilder.build()).build());
144 // Post interface on the device
145 this.openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
146 return otuInterfaceBldr.getName();
150 * This methods creates an ODU interface on the given termination point.
152 * @param nodeId node ID
153 * @param logicalConnPoint logical Connection Point
154 * @param supportingOtuInterface supporting OTU Interface
156 * @return Name of the interface if successful, otherwise return null.
157 * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
160 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
161 throws OpenRoadmInterfaceException {
162 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
163 if (portMap == null) {
164 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
165 + " logical connection port %s", nodeId, logicalConnPoint));
167 InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class, logicalConnPoint
169 oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
171 // ODU interface specific data
172 OduBuilder oduIfBuilder = new OduBuilder();
173 oduIfBuilder.setRate(ODU4.class);
174 oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
176 // Set Opu attributes
177 OpuBuilder opuBldr = new OpuBuilder();
178 opuBldr.setPayloadType("07");
179 opuBldr.setExpPayloadType("07");
180 oduIfBuilder.setOpu(opuBldr.build());
182 // Create Interface1 type object required for adding as augmentation
183 // TODO look at imports of different versions of class
184 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder oduIf1Builder =
185 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder();
186 oduInterfaceBldr.addAugmentation(
187 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1.class,
188 oduIf1Builder.setOdu(oduIfBuilder.build()).build());
190 // Post interface on the device
191 this.openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
192 return oduInterfaceBldr.getName();
195 * This methods creates an OCH interface on the given termination point on
198 * @param waveNumber wavelength number of the OCH interface.
199 * @return Name of the interface if successful, otherwise return null.
202 public List<String> createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
203 throws OpenRoadmInterfaceException {
205 Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
206 if (portMap == null) {
207 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
208 + " logical connection port %s", nodeId, logicalConnPoint));
210 // Create generic interface
211 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
212 createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
214 // OCH interface specific data
215 OchBuilder ocIfBuilder = new OchBuilder();
216 ocIfBuilder.setWavelengthNumber(waveNumber);
218 // Add supporting OMS interface
219 if (portMap.getSupportingOms() != null) {
220 ochInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
222 // Create Interface1 type object required for adding as augmentation
223 // TODO look at imports of different versions of class
224 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1Builder
225 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces
226 .rev161014.Interface1Builder();
227 ochInterfaceBldr.addAugmentation(
228 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1.class,
229 ochIf1Builder.setOch(ocIfBuilder.build()).build());
231 List<String> interfacesCreated = new ArrayList<>();
232 // Post interface on the device
233 openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
234 interfacesCreated.add(ochInterfaceBldr.getName());
235 return interfacesCreated;
238 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber, Class<
239 ? extends RateIdentity> rate, OchAttributes.ModulationFormat format) throws OpenRoadmInterfaceException {
240 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
241 if (portMap == null) {
242 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
243 + " logical connection port %s", nodeId, logicalConnPoint));
246 // OCH interface specific data
247 OchBuilder ocIfBuilder = new OchBuilder();
248 ocIfBuilder.setWavelengthNumber(waveNumber);
249 ocIfBuilder.setModulationFormat(format);
250 ocIfBuilder.setRate(rate);
251 ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
253 // Create Interface1 type object required for adding as augmentation
254 // TODO look at imports of different versions of class
255 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
256 .Interface1Builder ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel
257 .interfaces.rev161014.Interface1Builder();
258 // Create generic interface
259 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
260 createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
261 ochInterfaceBldr.addAugmentation(
262 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1.class,
263 ochIf1Builder.setOch(ocIfBuilder.build()).build());
265 // Post interface on the device
266 this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
268 // Post the equipment-state change on the device circuit-pack if xpdr node
269 if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
270 this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
272 return ochInterfaceBldr.getName();
275 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
276 return logicalConnectionPoint + "-" + waveNumber;
279 public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
280 if (mapping.getSupportingOms() == null) {
281 // Create generic interface
282 InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
283 "OMS-" + mapping.getLogicalConnectionPoint());
284 if (mapping.getSupportingOts() != null) {
285 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
287 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
288 mapping.getLogicalConnectionPoint());
291 this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
292 this.portMapping.updateMapping(nodeId, mapping);
293 return omsInterfaceBldr.build().getName();
295 return mapping.getSupportingOms();
299 public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
300 if (mapping.getSupportingOts() == null) {
301 // Create generic interface
302 InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
303 + mapping.getLogicalConnectionPoint());
304 // OTS interface augmentation specific data
305 OtsBuilder otsIfBuilder = new OtsBuilder();
306 otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
308 // Create Interface1 type object required for adding as
310 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014
311 .Interface1Builder otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm
312 .optical.transport.interfaces.rev161014.Interface1Builder();
313 otsInterfaceBldr.addAugmentation(
314 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014
316 otsIf1Builder.setOts(otsIfBuilder.build()).build());
317 this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
318 this.portMapping.updateMapping(nodeId, mapping);
319 return otsInterfaceBldr.build().getName();
321 return mapping.getSupportingOts();