2 * Copyright (c) 2013 Cisco Systems, 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.protocol.pcep.parser.message;
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import io.netty.buffer.ByteBuf;
13 import io.netty.buffer.Unpooled;
14 import java.util.ArrayList;
15 import java.util.List;
16 import org.opendaylight.protocol.pcep.spi.AbstractMessageParser;
17 import org.opendaylight.protocol.pcep.spi.MessageUtil;
18 import org.opendaylight.protocol.pcep.spi.ObjectRegistry;
19 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
20 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Pcreq;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcreqBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.Bandwidth;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.classtype.object.ClassType;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.object.EndpointsObj;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.exclude.route.object.Xro;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.gc.object.Gc;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.include.route.object.Iro;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.load.balancing.object.LoadBalancing;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.Metrics;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.MetricsBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lspa.object.Lspa;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.metric.object.Metric;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.object.Monitoring;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.of.object.Of;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.path.key.object.PathKey;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcc.id.req.object.PccIdReq;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pce.id.object.PceId;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.PcreqMessage;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.PcreqMessageBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.MonitoringRequest;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.MonitoringRequestBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Requests;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.RequestsBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Svec;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.SvecBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.monitoring.request.PceIdList;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.monitoring.request.PceIdListBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.PathKeyExpansionBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputation;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputationBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.P2p;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.P2pBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRoute;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRouteBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reported.route.object.Rro;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.vendor.information.objects.VendorInformationObject;
63 * Parser for {@link Pcreq}
65 public class PCEPRequestMessageParser extends AbstractMessageParser {
67 public static final int TYPE = 3;
69 public PCEPRequestMessageParser(final ObjectRegistry registry) {
74 public void serializeMessage(final Message message, final ByteBuf out) {
75 Preconditions.checkArgument(message instanceof Pcreq, "Wrong instance of Message. Passed instance of %s. Need Pcreq.", message.getClass());
76 final PcreqMessage msg = ((Pcreq) message).getPcreqMessage();
77 Preconditions.checkArgument(msg.getRequests() != null && !msg.getRequests().isEmpty(), "Requests cannot be null or empty.");
78 final ByteBuf buffer = Unpooled.buffer();
79 if (msg.getMonitoringRequest() != null) {
80 serializeMonitoringRequest(msg.getMonitoringRequest(), buffer);
82 if (msg.getSvec() != null) {
83 serializeSvec(msg, buffer);
85 serializeRequest(msg, buffer);
86 MessageUtil.formatMessage(TYPE, buffer, out);
89 protected void serializeRequest(final PcreqMessage msg, final ByteBuf buffer) {
90 for (final Requests req : msg.getRequests()) {
91 serializeObject(req.getRp(), buffer);
92 serializeVendorInformationObjects(req.getVendorInformationObject(), buffer);
93 if (req.getPathKeyExpansion() != null) {
94 serializeObject(req.getPathKeyExpansion().getPathKey(), buffer);
96 if (req.getSegmentComputation() != null) {
97 final SegmentComputation sc = req.getSegmentComputation();
98 if (sc.getP2p() != null) {
99 serializeP2P(buffer, sc.getP2p());
105 protected void serializeSvec(final PcreqMessage msg, final ByteBuf buffer) {
106 for (final Svec s : msg.getSvec()) {
107 serializeObject(s.getSvec(), buffer);
108 serializeObject(s.getOf(), buffer);
109 serializeObject(s.getGc(), buffer);
110 serializeObject(s.getXro(), buffer);
111 if (s.getMetric() != null) {
112 for (final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.svec.Metric m : s.getMetric()) {
113 serializeObject(m.getMetric(), buffer);
116 serializeVendorInformationObjects(s.getVendorInformationObject(), buffer);
120 protected void serializeP2P(final ByteBuf buffer, final P2p p2p) {
121 serializeObject(p2p.getEndpointsObj(), buffer);
122 serializeVendorInformationObjects(p2p.getVendorInformationObject(), buffer);
123 if (p2p.getReportedRoute() != null) {
124 final ReportedRoute rr = p2p.getReportedRoute();
126 serializeObject(rr.getRro(), buffer);
127 serializeObject(rr.getReoptimizationBandwidth(), buffer);
130 serializeObject(p2p.getLoadBalancing(), buffer);
131 serializeObject(p2p.getLspa(), buffer);
132 serializeObject(p2p.getBandwidth(), buffer);
133 if (p2p.getMetrics() != null) {
134 for (final Metrics m : p2p.getMetrics()) {
135 serializeObject(m.getMetric(), buffer);
138 serializeObject(p2p.getIro(), buffer);
139 serializeObject(p2p.getRro(), buffer);
140 serializeObject(p2p.getXro(), buffer);
141 serializeObject(p2p.getOf(), buffer);
142 serializeObject(p2p.getClassType(), buffer);
145 protected void serializeMonitoringRequest(final MonitoringRequest monReq, final ByteBuf out) {
146 serializeObject(monReq.getMonitoring(), out);
147 serializeObject(monReq.getPccIdReq(), out);
148 if (monReq.getPceIdList() != null) {
149 for (final PceIdList pceId : monReq.getPceIdList()) {
150 serializeObject(pceId.getPceId(), out);
156 protected Message validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException {
157 Preconditions.checkArgument(objects != null, "Passed list can't be null.");
158 if (objects.isEmpty()) {
159 throw new PCEPDeserializerException("Pcrep message cannot be empty.");
161 final PcreqMessageBuilder mBuilder = new PcreqMessageBuilder();
162 mBuilder.setMonitoringRequest(getMonitoring(objects));
163 final List<Svec> svecs = getSvecs(objects);
164 if (!svecs.isEmpty()) {
165 mBuilder.setSvec(svecs);
167 final List<Requests> requests = getRequests(objects, errors);
168 if (requests != null) {
169 mBuilder.setRequests(requests);
171 errors.add(createErrorMsg(PCEPErrors.RP_MISSING, Optional.<Rp>absent()));
173 if (!objects.isEmpty()) {
174 throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
176 return new PcreqBuilder().setPcreqMessage(mBuilder.build()).build();
179 protected List<Svec> getSvecs(final List<Object> objects) {
180 final List<Svec> svecList = new ArrayList<>();
181 while (!objects.isEmpty()) {
182 final SvecBuilder sBuilder = new SvecBuilder();
183 final Svec svecComp = getValidSvec(sBuilder, objects);
184 if (svecComp == null) {
187 svecList.add(svecComp);
192 protected List<Requests> getRequests(final List<Object> objects, final List<Message> errors) {
193 final List<Requests> requests = new ArrayList<>();
194 while (!objects.isEmpty()) {
195 final RequestsBuilder rBuilder = new RequestsBuilder();
197 if (!(objects.get(0) instanceof Rp)) {
198 // if RP obj is missing return error only
199 errors.add(createErrorMsg(PCEPErrors.RP_MISSING, Optional.<Rp>absent()));
202 rpObj = (Rp) objects.get(0);
204 if (!rpObj.isProcessingRule()) {
205 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.<Rp>absent()));
207 rBuilder.setRp(rpObj);
209 final List<VendorInformationObject> vendorInfo = addVendorInformationObjects(objects);
210 if (!vendorInfo.isEmpty()) {
211 rBuilder.setVendorInformationObject(vendorInfo);
214 if (rpObj.isPathKey() && objects.get(0) instanceof PathKey) {
215 rBuilder.setPathKeyExpansion(new PathKeyExpansionBuilder().setPathKey((PathKey) objects.get(0)).build());
218 final P2pBuilder p2pBuilder = new P2pBuilder();
220 if (!objects.isEmpty() && objects.get(0) instanceof EndpointsObj) {
221 final EndpointsObj ep = (EndpointsObj) objects.get(0);
223 if (!ep.isProcessingRule()) {
224 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.of(rpObj)));
226 p2pBuilder.setEndpointsObj(ep);
229 errors.add(createErrorMsg(PCEPErrors.END_POINTS_MISSING, Optional.of(rpObj)));
233 if (!rpObj.isP2mp()) {
234 final SegmentComputation segm = getSegmentComputation(p2pBuilder, objects, errors, rpObj);
236 rBuilder.setSegmentComputation(segm);
239 requests.add(rBuilder.build());
244 protected SegmentComputation getSegmentComputation(final P2pBuilder builder, final List<Object> objects, final List<Message> errors,
246 final List<Metrics> metrics = new ArrayList<>();
247 final List<VendorInformationObject> viObjects = new ArrayList<>();
249 State state = State.INIT;
250 while (!objects.isEmpty() && state != State.END) {
251 state = insertObject(state, objects, viObjects, builder, metrics, errors, rp);
252 if (!state.equals(State.END)) {
256 if (!metrics.isEmpty()) {
257 builder.setMetrics(metrics);
259 if (!viObjects.isEmpty()) {
260 builder.setVendorInformationObject(viObjects);
263 if (rp.isReoptimization()
264 && builder.getBandwidth() != null
265 && !builder.getReportedRoute().getReoptimizationBandwidth().getBandwidth().equals(
266 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth(new byte[] { 0 }))
267 && builder.getReportedRoute().getRro() == null) {
268 errors.add(createErrorMsg(PCEPErrors.RRO_MISSING, Optional.of(rp)));
271 return new SegmentComputationBuilder().setP2p(builder.build()).build();
274 private State insertObject(final State state, final List<Object> objects, final List<VendorInformationObject> viObjects, final P2pBuilder builder, final List<Metrics> metrics, final List<Message> errors, final Rp rp) {
275 final Object obj = objects.get(0);
278 if (obj instanceof Rro) {
279 final ReportedRouteBuilder rrBuilder = new ReportedRouteBuilder();
280 rrBuilder.setRro((Rro) obj);
282 final Object nextObj = objects.get(0);
283 if (nextObj instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reoptimization.bandwidth.object.ReoptimizationBandwidth) {
284 rrBuilder.setReoptimizationBandwidth((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reoptimization.bandwidth.object.ReoptimizationBandwidth) nextObj);
286 return State.REPORTED_IN;
289 if (obj instanceof VendorInformationObject) {
290 viObjects.add((VendorInformationObject) obj);
291 return State.REPORTED_IN;
293 case VENDOR_INFO_LIST:
294 if (obj instanceof LoadBalancing) {
295 builder.setLoadBalancing((LoadBalancing) obj);
296 return State.LOAD_BIN;
299 if (obj instanceof Lspa) {
300 builder.setLspa((Lspa) obj);
301 return State.LSPA_IN;
304 if (obj instanceof Bandwidth) {
305 builder.setBandwidth((Bandwidth) obj);
306 return State.BANDWIDTH_IN;
309 if (obj instanceof Metric) {
310 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
311 return State.BANDWIDTH_IN;
314 if (obj instanceof Iro) {
315 builder.setIro((Iro) obj);
319 if (obj instanceof Rro) {
320 builder.setRro((Rro) obj);
324 if (obj instanceof Xro) {
325 builder.setXro((Xro) obj);
329 if (obj instanceof Of) {
330 builder.setOf((Of) obj);
334 if (obj instanceof ClassType) {
335 final ClassType classType = (ClassType) obj;
336 if (!classType.isProcessingRule()) {
337 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.of(rp)));
339 builder.setClassType(classType);
352 INIT, REPORTED_IN, VENDOR_INFO_LIST, LOAD_BIN, LSPA_IN, BANDWIDTH_IN, METRIC_IN, IRO_IN, RRO_IN, XRO_IN, OF_IN, CT_IN, END
355 private Svec getValidSvec(final SvecBuilder builder, final List<Object> objects) {
356 Preconditions.checkArgument(objects != null && !objects.isEmpty(), "Passed list can't be null or empty.");
358 if (objects.get(0) instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) {
359 builder.setSvec((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) objects.get(0));
365 final List<Metrics> metrics = new ArrayList<>();
366 final List<VendorInformationObject> viObjects = new ArrayList<>();
369 SvecState state = SvecState.INIT;
370 while (!objects.isEmpty() && !state.equals(SvecState.END)) {
371 obj = objects.get(0);
372 state = insertObject(state, obj, builder, metrics, viObjects);
373 if (!state.equals(SvecState.END)) {
377 if (!viObjects.isEmpty()) {
378 builder.setVendorInformationObject(viObjects);
380 return builder.build();
383 private SvecState insertObject(final SvecState state, final Object obj, final SvecBuilder builder, final List<Metrics> metrics, final List<VendorInformationObject> viObjects) {
386 if (obj instanceof Of) {
387 builder.setOf((Of) obj);
388 return SvecState.OF_IN;
391 if (obj instanceof Gc) {
392 builder.setGc((Gc) obj);
393 return SvecState.GC_IN;
396 if (obj instanceof Xro) {
397 builder.setXro((Xro) obj);
398 return SvecState.XRO_IN;
401 if (obj instanceof Metric) {
402 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
403 return SvecState.XRO_IN;
406 if (obj instanceof VendorInformationObject) {
407 viObjects.add((VendorInformationObject) obj);
408 return SvecState.METRIC_IN;
412 return SvecState.END;
418 private enum SvecState {
419 INIT, OF_IN, GC_IN, XRO_IN, METRIC_IN, VENDOR_INFO, END
422 protected MonitoringRequest getMonitoring(final List<Object> objects) {
423 final MonitoringRequestBuilder builder = new MonitoringRequestBuilder();
424 if (!objects.isEmpty() && objects.get(0) instanceof Monitoring) {
425 builder.setMonitoring((Monitoring) objects.get(0));
430 if (!objects.isEmpty() && objects.get(0) instanceof PccIdReq) {
431 builder.setPccIdReq((PccIdReq) objects.get(0));
434 final List<PceIdList> pceIdList = new ArrayList<>();
435 while(!objects.isEmpty() && objects.get(0) instanceof PceId) {
436 pceIdList.add(new PceIdListBuilder().setPceId((PceId) objects.get(0)).build());
439 if (!pceIdList.isEmpty()) {
440 builder.setPceIdList(pceIdList);
442 return builder.build();