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;
13 import org.opendaylight.transportpce.common.mapping.PortMapping;
14 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
15 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
16 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.PowerDBm;
17 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceBuilder;
18 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceKey;
19 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev161014.AdminStates;
20 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.EthAttributes;
21 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.Interface1;
22 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.Interface1Builder;
23 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.ethernet.container.EthernetBuilder;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.EthernetCsmacd;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.InterfaceType;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalChannel;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOdu;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOtu;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.OchAttributes;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.RateIdentity;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.och.container.OchBuilder;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.ODU4;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.OduAttributes;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.odu.container.OduBuilder;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.opu.OpuBuilder;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OTU4;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OtuAttributes;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.otu.container.OtuBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.portmapping.rev170228.network.nodes.Mapping;
41 public class OpenRoadmInterfaceFactory {
43 private final PortMapping portMapping;
44 private final OpenRoadmInterfaces openRoadmInterfaces;
46 public OpenRoadmInterfaceFactory(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces) {
47 this.portMapping = portMapping;
48 this.openRoadmInterfaces = openRoadmInterfaces;
51 public String createOpenRoadmEthInterface(String nodeId,
52 String logicalConnPoint) throws OpenRoadmInterfaceException {
53 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
54 if (portMap == null) {
55 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
56 + " logical connection port %s", nodeId, logicalConnPoint));
59 // Ethernet interface specific data
60 EthernetBuilder ethIfBuilder = new EthernetBuilder();
61 ethIfBuilder.setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled);
62 ethIfBuilder.setDuplex(EthAttributes.Duplex.Full);
63 ethIfBuilder.setFec(EthAttributes.Fec.Off);
64 ethIfBuilder.setSpeed(100000L);
65 ethIfBuilder.setMtu(9000L);
67 InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
68 logicalConnPoint + "-ETHERNET");
70 // Create Interface1 type object required for adding as augmentation
71 Interface1Builder ethIf1Builder = new Interface1Builder();
72 ethInterfaceBldr.addAugmentation(Interface1.class, ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
74 // Post interface on the device
75 this.openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
76 return ethInterfaceBldr.getName();
80 * This methods creates an OCH interface on the given termination point on
84 * wavelength number of the OCH interface.
86 * @return Name of the interface if successful, otherwise return null.
89 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber) throws
90 OpenRoadmInterfaceException {
91 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
92 if (portMap == null) {
93 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
94 + " logical connection port %s", nodeId, logicalConnPoint));
96 // Create generic interface
97 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
98 createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
100 // OCH interface specific data
101 OchBuilder ocIfBuilder = new OchBuilder();
102 ocIfBuilder.setWavelengthNumber(waveNumber);
104 // Add supporting OMS interface
105 if (portMap.getSupportingOms() != null) {
106 ochInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
108 // Create Interface1 type object required for adding as augmentation
109 // TODO look at imports of different versions of class
110 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1Builder
111 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces
112 .rev161014.Interface1Builder();
113 ochInterfaceBldr.addAugmentation(
114 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1.class,
115 ochIf1Builder.setOch(ocIfBuilder.build()).build());
117 // Post interface on the device
118 this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
119 return ochInterfaceBldr.getName();
122 public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber,
123 Class<? extends RateIdentity> rate, OchAttributes.ModulationFormat format) throws OpenRoadmInterfaceException {
124 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
125 if (portMap == null) {
126 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node %s and"
127 + " logical connection port %s", nodeId, logicalConnPoint));
130 // OCH interface specific data
131 OchBuilder ocIfBuilder = new OchBuilder();
132 ocIfBuilder.setWavelengthNumber(waveNumber);
133 ocIfBuilder.setModulationFormat(format);
134 ocIfBuilder.setRate(rate);
135 ocIfBuilder.setTransmitPower(new PowerDBm(new BigDecimal("-5")));
137 // Create Interface1 type object required for adding as augmentation
138 // TODO look at imports of different versions of class
139 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1Builder
140 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces
141 .rev161014.Interface1Builder();
142 // Create generic interface
143 InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
144 createOpenRoadmOchInterfaceName(logicalConnPoint, waveNumber));
145 ochInterfaceBldr.addAugmentation(
146 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1.class,
147 ochIf1Builder.setOch(ocIfBuilder.build()).build());
149 // Post interface on the device
150 this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
151 return ochInterfaceBldr.getName();
154 public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
155 return logicalConnectionPoint + "-" + waveNumber;
159 * This methods creates an ODU interface on the given termination point.
162 * @return Name of the interface if successful, otherwise return null.
165 public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
166 throws OpenRoadmInterfaceException {
167 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
168 if (portMap == null) {
169 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
170 + " logical connection port %s", nodeId, logicalConnPoint));
172 InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class,
173 logicalConnPoint + "-ODU");
174 oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
176 // ODU interface specific data
177 OduBuilder oduIfBuilder = new OduBuilder();
178 oduIfBuilder.setRate(ODU4.class);
179 oduIfBuilder.setMonitoringMode(OduAttributes.MonitoringMode.Terminated);
182 OpuBuilder opuBldr = new OpuBuilder();
183 opuBldr.setPayloadType("07");
184 opuBldr.setExpPayloadType("07");
185 oduIfBuilder.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(
193 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1.class,
194 oduIf1Builder.setOdu(oduIfBuilder.build()).build());
196 // Post interface on the device
197 this.openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
198 return oduInterfaceBldr.getName();
202 * This methods creates an OTU interface on the given termination point.
205 * @return Name of the interface if successful, otherwise return null.
208 public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
209 throws OpenRoadmInterfaceException {
210 Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
211 if (portMap == null) {
212 throw new OpenRoadmInterfaceException(String.format("Unable to get mapping from PortMapping for node % and"
213 + " logical connection port %s", nodeId, logicalConnPoint));
215 // Create generic interface
216 InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class,
217 logicalConnPoint + "-OTU");
218 otuInterfaceBldr.setSupportingInterface(supportOchInterface);
220 // OTU interface specific data
221 OtuBuilder otuIfBuilder = new OtuBuilder();
222 otuIfBuilder.setFec(OtuAttributes.Fec.Scfec);
223 otuIfBuilder.setRate(OTU4.class);
225 // Create Interface1 type object required for adding as augmentation
226 // TODO look at imports of different versions of class
227 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder otuIf1Builder =
228 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder();
229 otuInterfaceBldr.addAugmentation(
230 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1.class,
231 otuIf1Builder.setOtu(otuIfBuilder.build()).build());
233 // Post interface on the device
234 this.openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
235 return otuInterfaceBldr.getName();
238 private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
240 InterfaceBuilder interfaceBuilder = new InterfaceBuilder();
241 interfaceBuilder.setDescription(" TBD ");
242 interfaceBuilder.setCircuitId(" TBD ");
243 interfaceBuilder.setSupportingCircuitPackName(portMap.getSupportingCircuitPackName());
244 interfaceBuilder.setSupportingPort(portMap.getSupportingPort());
245 interfaceBuilder.setAdministrativeState(AdminStates.InService);
246 interfaceBuilder.setType(type);
247 interfaceBuilder.setName(key);
248 interfaceBuilder.setKey(new InterfaceKey(key));
249 return interfaceBuilder;