2 * Copyright © 2017 AT&T, Inc. 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
8 package org.opendaylight.transportpce.pce;
10 import com.google.common.collect.ImmutableList;
11 import java.util.HashMap;
12 import java.util.List;
14 import org.opendaylight.transportpce.common.ResponseCodes;
15 import org.opendaylight.transportpce.common.StringConstants;
16 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
17 import org.opendaylight.transportpce.pce.networkanalyzer.PceLink;
18 import org.opendaylight.transportpce.pce.networkanalyzer.PceResult;
19 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.optical.channel.types.rev200529.FrequencyTHz;
20 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
21 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.ModulationFormat;
22 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.AToZDirectionBuilder;
23 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.ZToADirectionBuilder;
24 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.atoz.direction.AToZ;
25 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.atoz.direction.AToZBuilder;
26 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.atoz.direction.AToZKey;
27 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.ztoa.direction.ZToA;
28 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.ztoa.direction.ZToABuilder;
29 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.path.description.ztoa.direction.ZToAKey;
30 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.Resource;
31 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.ResourceBuilder;
32 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.resource.resource.LinkBuilder;
33 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.resource.resource.NodeBuilder;
34 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.resource.resource.TerminationPoint;
35 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce.resource.resource.resource.TerminationPointBuilder;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
37 import org.opendaylight.yangtools.yang.common.Uint16;
38 import org.opendaylight.yangtools.yang.common.Uint32;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
42 public class PcePathDescription {
44 private static final Logger LOG = LoggerFactory.getLogger(PcePathDescription.class);
46 private List<PceLink> pathAtoZ = null;
48 private Map<LinkId, PceLink> allPceLinks = null;
50 public PcePathDescription(List<PceLink> pathAtoZ, Map<LinkId, PceLink> allPceLinks, PceResult rc) {
52 this.allPceLinks = allPceLinks;
53 this.pathAtoZ = pathAtoZ;
57 public PceResult buildDescriptions() {
58 LOG.info("In buildDescriptions: AtoZ = {}", pathAtoZ);
59 Map<AToZKey,AToZ> atozMap = new HashMap<>();
60 if (pathAtoZ == null) {
61 rc.setRC(ResponseCodes.RESPONSE_FAILED);
62 LOG.error("In buildDescriptions: there is empty AtoZ path");
66 buildAtoZ(atozMap, pathAtoZ);
67 rc.setAtoZDirection(buildAtoZDirection(atozMap).build());
68 List<PceLink> pathZtoA = ImmutableList.copyOf(pathAtoZ).reverse();
69 LOG.info("In buildDescriptions: ZtoA {}", pathZtoA);
71 Map<ZToAKey,ZToA> ztoaMap = new HashMap<>();
72 if (pathZtoA == null) {
73 rc.setRC(ResponseCodes.RESPONSE_FAILED);
74 LOG.error("In buildDescriptions: there is empty ZtoA path");
77 buildZtoA(ztoaMap, pathZtoA);
78 rc.setZtoADirection(buildZtoADirection(ztoaMap).build());
84 * Create a builder for AtoZDirection object.
85 * @param atozMap Map of AToZ object
86 * @return a builder for AtoZDirection object
88 private AToZDirectionBuilder buildAtoZDirection(Map<AToZKey, AToZ> atozMap) {
89 AToZDirectionBuilder atoZDirectionBldr = new AToZDirectionBuilder()
90 .setRate(Uint32.valueOf(rc.getRate()))
91 .setModulationFormat(GridConstant.RATE_MODULATION_FORMAT_MAP
92 .getOrDefault(Uint32.valueOf(rc.getRate()), ModulationFormat.DpQpsk).getName())
94 switch (rc.getServiceType()) {
95 case StringConstants.SERVICE_TYPE_400GE:
96 case StringConstants.SERVICE_TYPE_OTUC4:
97 case StringConstants.SERVICE_TYPE_100GE_T:
98 case StringConstants.SERVICE_TYPE_OTU4:
99 atoZDirectionBldr.setAToZMaxFrequency(new FrequencyTHz(rc.getMaxFreq()));
100 atoZDirectionBldr.setAToZMinFrequency(new FrequencyTHz(rc.getMinFreq()));
101 atoZDirectionBldr.setAToZWavelengthNumber(Uint32.valueOf(rc.getResultWavelength()));
103 case StringConstants.SERVICE_TYPE_100GE_M:
104 case StringConstants.SERVICE_TYPE_10GE:
105 case StringConstants.SERVICE_TYPE_1GE:
106 case StringConstants.SERVICE_TYPE_ODU4:
107 case StringConstants.SERVICE_TYPE_ODUC4:
108 if (rc.getResultTribSlot() != null && rc.getResultTribPort() != null) {
109 @SuppressWarnings("unchecked")
110 List<Uint16> tribSlotList = (List<Uint16>) rc.getResultTribSlot().values().toArray()[0];
111 atoZDirectionBldr.setAToZWavelengthNumber(Uint32.valueOf(0))
112 .setTribPortNumber(Uint16.valueOf(rc.getResultTribPort().values().toArray()[0].toString()))
113 .setTribSlotNumber(tribSlotList.get(0));
115 LOG.error("Trib port and trib slot number should be present");
116 atoZDirectionBldr.setTribSlotNumber(Uint16.valueOf(0)).setTribPortNumber(Uint16.valueOf(0));
120 LOG.warn("unknown service type : unable to set Min/Max frequencies");
123 return atoZDirectionBldr;
127 * Create a builder for ZtoADirection object.
128 * @param ztoaMap Map of ZToA object
129 * @return a builder for ZtoADirection object
131 private ZToADirectionBuilder buildZtoADirection(Map<ZToAKey, ZToA> ztoaMap) {
132 ZToADirectionBuilder ztoADirectionBldr = new ZToADirectionBuilder().setRate(Uint32.valueOf(rc.getRate()))
133 .setModulationFormat(GridConstant.RATE_MODULATION_FORMAT_MAP
134 .getOrDefault(Uint32.valueOf(rc.getRate()), ModulationFormat.DpQpsk).getName())
136 switch (rc.getServiceType()) {
137 case StringConstants.SERVICE_TYPE_400GE:
138 case StringConstants.SERVICE_TYPE_OTUC4:
139 case StringConstants.SERVICE_TYPE_100GE_T:
140 case StringConstants.SERVICE_TYPE_OTU4:
141 ztoADirectionBldr.setZToAMaxFrequency(new FrequencyTHz(rc.getMaxFreq()));
142 ztoADirectionBldr.setZToAMinFrequency(new FrequencyTHz(rc.getMinFreq()));
143 ztoADirectionBldr.setZToAWavelengthNumber(Uint32.valueOf(rc.getResultWavelength()));
145 case StringConstants.SERVICE_TYPE_100GE_M:
146 case StringConstants.SERVICE_TYPE_10GE:
147 case StringConstants.SERVICE_TYPE_1GE:
148 case StringConstants.SERVICE_TYPE_ODU4:
149 if (rc.getResultTribSlot() != null && rc.getResultTribPort() != null) {
150 @SuppressWarnings("unchecked")
151 List<Uint16> tribSlotList = (List<Uint16>) rc.getResultTribSlot().values().toArray()[0];
152 ztoADirectionBldr.setZToAWavelengthNumber(Uint32.valueOf(0))
153 .setTribPortNumber(Uint16.valueOf(rc.getResultTribPort().values().toArray()[0].toString()))
154 .setTribSlotNumber(tribSlotList.get(0));
156 LOG.error("Trib port and trib slot number should be present");
157 ztoADirectionBldr.setTribSlotNumber(Uint16.valueOf(0)).setTribPortNumber(Uint16.valueOf(0));
161 LOG.warn("unknown service type : unable to set Min/Max frequencies");
164 return ztoADirectionBldr;
167 @SuppressWarnings("java:S138")
168 //sonar issue This method has 77 lines, which is greater than the 75 lines authorized. Split it into smaller
169 //ignore as it's not relevant to split it from functional point
170 private void buildAtoZ(Map<AToZKey, AToZ> atozMap, List<PceLink> path) {
172 PceLink lastLink = null;
173 AToZ lastResource = null;
175 // build A side Client TP
176 String tpName = path.get(0).getClient();
177 String xname = path.get(0).getSourceId().getValue();
178 TerminationPoint stp = new TerminationPointBuilder()
179 .setTpId(tpName).setTpNodeId(xname)
182 AToZKey clientKey = new AToZKey(index.toString());
183 Resource clientResource = new ResourceBuilder().setResource(stp).setState(State.InService).build();
184 AToZ firstResource = new AToZBuilder().setId(tpName).withKey(clientKey).setResource(clientResource).build();
185 atozMap.put(firstResource.key(),firstResource);
187 for (PceLink pcelink : path) {
188 String srcName = pcelink.getSourceId().getValue();
190 org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
191 .resource.resource.resource.Node sourceNode = new NodeBuilder()
196 AToZKey sourceKey = new AToZKey(index.toString());
197 Resource nodeResource1 = new ResourceBuilder().setResource(sourceNode).setState(State.InService).build();
198 AToZ srcResource = new AToZBuilder().setId(srcName).withKey(sourceKey).setResource(nodeResource1).build();
200 atozMap.put(srcResource.key(),srcResource);
203 tpName = pcelink.getSourceTP().toString();
204 stp = new TerminationPointBuilder()
205 .setTpNodeId(srcName).setTpId(tpName)
209 AToZKey srcTPKey = new AToZKey(index.toString());
210 Resource tpResource1 = new ResourceBuilder().setResource(stp).setState(State.InService).build();
211 AToZ stpResource = new AToZBuilder().setId(tpName).withKey(srcTPKey).setResource(tpResource1).build();
213 atozMap.put(stpResource.key(),stpResource);
215 String linkName = pcelink.getLinkId().getValue();
217 org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
218 .resource.resource.resource.Link atozLink = new LinkBuilder()
223 AToZKey linkKey = new AToZKey(index.toString());
224 Resource nodeResource2 = new ResourceBuilder().setResource(atozLink).setState(pcelink.getState()).build();
225 AToZ linkResource = new AToZBuilder().setId(linkName).withKey(linkKey).setResource(nodeResource2).build();
227 atozMap.put(linkResource.key(),linkResource);
229 String destName = pcelink.getDestId().getValue();
231 tpName = pcelink.getDestTP().toString();
232 TerminationPoint dtp = new TerminationPointBuilder()
233 .setTpNodeId(destName).setTpId(tpName)
237 AToZKey destTPKey = new AToZKey(index.toString());
238 Resource tpResource2 = new ResourceBuilder().setResource(dtp).setState(State.InService).build();
239 AToZ ttpResource = new AToZBuilder().setId(tpName).withKey(destTPKey).setResource(tpResource2).build();
241 atozMap.put(ttpResource.key(),ttpResource);
243 org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
244 .resource.resource.resource.Node targetNode = new NodeBuilder()
249 AToZKey targetKey = new AToZKey(index.toString());
250 Resource nodeResource3 = new ResourceBuilder().setResource(targetNode).setState(State.InService).build();
251 lastResource = new AToZBuilder().setId(destName).withKey(targetKey).setResource(nodeResource3).build();
256 if (lastResource != null) {
257 atozMap.put(lastResource.key(),lastResource);
260 // build Z side Client TP
261 tpName = lastLink.getClient();
262 xname = lastLink.getDestId().getValue();
263 stp = new TerminationPointBuilder()
264 .setTpNodeId(xname).setTpId(tpName)
268 clientKey = new AToZKey(index.toString());
269 clientResource = new ResourceBuilder().setResource(stp).setState(State.InService).build();
270 lastResource = new AToZBuilder().setId(tpName).withKey(clientKey).setResource(clientResource).build();
271 atozMap.put(lastResource.key(),lastResource);
275 private void buildZtoA(Map<ZToAKey, ZToA> ztoaList, List<PceLink> path) {
277 PceLink lastLink = null;
278 ZToA lastResource = null;
280 // build Z size Client TP
281 PceLink pcelink = this.allPceLinks.get(path.get(0).getOppositeLink());
282 String tpName = pcelink.getClient();
283 String xname = pcelink.getSourceId().getValue();
284 TerminationPoint stp = new TerminationPointBuilder()
285 .setTpNodeId(xname).setTpId(tpName)
288 ZToAKey clientKey = new ZToAKey(index.toString());
289 Resource clientResource = new ResourceBuilder().setResource(stp).setState(State.InService).build();
290 ZToA firstResource = new ZToABuilder().setId(tpName).withKey(clientKey).setResource(clientResource).build();
291 ztoaList.put(firstResource.key(),firstResource);
294 for (PceLink pcelinkAtoZ : path) {
296 pcelink = this.allPceLinks.get(pcelinkAtoZ.getOppositeLink());
297 LOG.debug("link to oppsite: {} to {}", pcelinkAtoZ, pcelink);
299 String srcName = pcelink.getSourceId().getValue();
303 org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
304 .resource.resource.resource.Node sourceNode = new NodeBuilder()
305 .setNodeId(srcName).build();
309 ZToAKey sourceKey = new ZToAKey(index.toString());
310 Resource nodeResource1 = new ResourceBuilder().setResource(sourceNode).setState(State.InService).build();
311 ZToA srcResource = new ZToABuilder().setId(srcName).withKey(sourceKey).setResource(nodeResource1).build();
313 ztoaList.put(srcResource.key(),srcResource);
316 tpName = pcelink.getSourceTP().toString();
317 stp = new TerminationPointBuilder()
318 .setTpNodeId(srcName).setTpId(tpName)
322 ZToAKey srcTPKey = new ZToAKey(index.toString());
323 Resource tpResource1 = new ResourceBuilder().setResource(stp).setState(State.InService).build();
324 ZToA stpResource = new ZToABuilder().setId(tpName).withKey(srcTPKey).setResource(tpResource1).build();
326 ztoaList.put(stpResource.key(),stpResource);
328 String linkName = pcelink.getLinkId().getValue();
330 org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
331 .resource.resource.resource.Link ztoaLink = new LinkBuilder()
332 .setLinkId(linkName).build();
335 ZToAKey linkKey = new ZToAKey(index.toString());
336 Resource nodeResource2 = new ResourceBuilder().setResource(ztoaLink).setState(State.InService).build();
337 ZToA linkResource = new ZToABuilder().setId(linkName).withKey(linkKey).setResource(nodeResource2).build();
339 ztoaList.put(linkResource.key(),linkResource);
341 String destName = pcelink.getDestId().getValue();
343 tpName = pcelink.getDestTP().toString();
344 TerminationPoint ttp = new TerminationPointBuilder()
345 .setTpNodeId(destName).setTpId(tpName).build();
348 ZToAKey destTPKey = new ZToAKey(index.toString());
349 Resource tpResource2 = new ResourceBuilder().setResource(ttp).setState(State.InService).build();
350 ZToA ttpResource = new ZToABuilder().setId(tpName).withKey(destTPKey).setResource(tpResource2).build();
352 ztoaList.put(ttpResource.key(),ttpResource);
355 org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev201210.pce
356 .resource.resource.resource.Node targetNode = new NodeBuilder()
357 .setNodeId(destName).build();
359 ZToAKey targetKey = new ZToAKey(index.toString());
360 Resource nodeResource3 = new ResourceBuilder().setResource(targetNode).setState(State.InService).build();
361 lastResource = new ZToABuilder().setId(destName).withKey(targetKey).setResource(nodeResource3).build();
365 if (lastResource != null) {
366 ztoaList.put(lastResource.key(),lastResource);
369 // build Z side Client TP
370 tpName = lastLink.getClient();
371 xname = lastLink.getDestId().getValue();
372 stp = new TerminationPointBuilder()
373 .setTpNodeId(xname).setTpId(tpName).build();
376 clientKey = new ZToAKey(index.toString());
377 clientResource = new ResourceBuilder().setResource(stp).setState(State.InService).build();
378 lastResource = new ZToABuilder().setId(tpName).withKey(clientKey).setResource(clientResource).build();
379 ztoaList.put(lastResource.key(),lastResource);
382 public PceResult getReturnStructure() {