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.protocol.pcep.spi.VendorInformationObjectRegistry;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Pcreq;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcreqBuilder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.Bandwidth;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.classtype.object.ClassType;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.object.EndpointsObj;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.exclude.route.object.Xro;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.gc.object.Gc;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.include.route.object.Iro;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.load.balancing.object.LoadBalancing;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.Metrics;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.MetricsBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lspa.object.Lspa;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.metric.object.Metric;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.object.Monitoring;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.of.object.Of;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.path.key.object.PathKey;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcc.id.req.object.PccIdReq;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pce.id.object.PceId;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.PcreqMessage;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.PcreqMessageBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.MonitoringRequest;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.MonitoringRequestBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Requests;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.RequestsBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Svec;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.SvecBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.monitoring.request.PceIdList;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.monitoring.request.PceIdListBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.PathKeyExpansionBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputation;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputationBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.P2p;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.P2pBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRoute;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRouteBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reported.route.object.Rro;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.vendor.information.objects.VendorInformationObject;
64 * Parser for {@link Pcreq}
66 public class PCEPRequestMessageParser extends AbstractMessageParser {
68 public static final int TYPE = 3;
70 public PCEPRequestMessageParser(final ObjectRegistry registry, final VendorInformationObjectRegistry viRegistry) {
71 super(registry, viRegistry);
75 public void serializeMessage(final Message message, final ByteBuf out) {
76 Preconditions.checkArgument(message instanceof Pcreq, "Wrong instance of Message. Passed instance of %s. Need Pcreq.", message.getClass());
77 final PcreqMessage msg = ((Pcreq) message).getPcreqMessage();
78 Preconditions.checkArgument(msg.getRequests() != null && !msg.getRequests().isEmpty(), "Requests cannot be null or empty.");
79 final ByteBuf buffer = Unpooled.buffer();
80 if (msg.getMonitoringRequest() != null) {
81 serializeMonitoringRequest(msg.getMonitoringRequest(), buffer);
83 if (msg.getSvec() != null) {
84 serializeSvec(msg, buffer);
86 serializeRequest(msg, buffer);
87 MessageUtil.formatMessage(TYPE, buffer, out);
90 protected void serializeRequest(final PcreqMessage msg, final ByteBuf buffer) {
91 for (final Requests req : msg.getRequests()) {
92 serializeObject(req.getRp(), buffer);
93 serializeVendorInformationObjects(req.getVendorInformationObject(), buffer);
94 if (req.getPathKeyExpansion() != null) {
95 serializeObject(req.getPathKeyExpansion().getPathKey(), buffer);
97 if (req.getSegmentComputation() != null) {
98 final SegmentComputation sc = req.getSegmentComputation();
99 if (sc.getP2p() != null) {
100 serializeP2P(buffer, sc.getP2p());
106 protected void serializeSvec(final PcreqMessage msg, final ByteBuf buffer) {
107 for (final Svec s : msg.getSvec()) {
108 serializeObject(s.getSvec(), buffer);
109 serializeObject(s.getOf(), buffer);
110 serializeObject(s.getGc(), buffer);
111 serializeObject(s.getXro(), buffer);
112 if (s.getMetric() != null) {
113 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()) {
114 serializeObject(m.getMetric(), buffer);
117 serializeVendorInformationObjects(s.getVendorInformationObject(), buffer);
121 protected void serializeP2P(final ByteBuf buffer, final P2p p2p) {
122 serializeObject(p2p.getEndpointsObj(), buffer);
123 serializeVendorInformationObjects(p2p.getVendorInformationObject(), buffer);
124 if (p2p.getReportedRoute() != null) {
125 final ReportedRoute rr = p2p.getReportedRoute();
127 serializeObject(rr.getRro(), buffer);
128 serializeObject(rr.getBandwidth(), buffer);
131 serializeObject(p2p.getLoadBalancing(), buffer);
132 serializeObject(p2p.getLspa(), buffer);
133 serializeObject(p2p.getBandwidth(), buffer);
134 if (p2p.getMetrics() != null) {
135 for (final Metrics m : p2p.getMetrics()) {
136 serializeObject(m.getMetric(), buffer);
139 serializeObject(p2p.getIro(), buffer);
140 serializeObject(p2p.getRro(), buffer);
141 serializeObject(p2p.getXro(), buffer);
142 serializeObject(p2p.getOf(), buffer);
143 serializeObject(p2p.getClassType(), buffer);
146 protected void serializeMonitoringRequest(final MonitoringRequest monReq, final ByteBuf out) {
147 serializeObject(monReq.getMonitoring(), out);
148 serializeObject(monReq.getPccIdReq(), out);
149 if (monReq.getPceIdList() != null) {
150 for (final PceIdList pceId : monReq.getPceIdList()) {
151 serializeObject(pceId.getPceId(), out);
157 protected Message validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException {
158 Preconditions.checkArgument(objects != null, "Passed list can't be null.");
159 if (objects.isEmpty()) {
160 throw new PCEPDeserializerException("Pcrep message cannot be empty.");
162 final PcreqMessageBuilder mBuilder = new PcreqMessageBuilder();
163 mBuilder.setMonitoringRequest(getMonitoring(objects));
164 final List<Svec> svecs = getSvecs(objects, errors);
165 if (!svecs.isEmpty()) {
166 mBuilder.setSvec(svecs);
168 final List<Requests> requests = getRequests(objects, errors);
169 if (requests != null) {
170 mBuilder.setRequests(requests);
172 errors.add(createErrorMsg(PCEPErrors.RP_MISSING, Optional.<Rp>absent()));
174 if (!objects.isEmpty()) {
175 throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
177 return new PcreqBuilder().setPcreqMessage(mBuilder.build()).build();
180 protected List<Svec> getSvecs(final List<Object> objects, final List<Message> errors) {
181 final List<Svec> svecList = new ArrayList<>();
182 while (!objects.isEmpty()) {
183 final SvecBuilder sBuilder = new SvecBuilder();
184 final Svec svecComp = getValidSvec(sBuilder, objects);
185 if (svecComp == null) {
188 svecList.add(svecComp);
193 protected List<Requests> getRequests(final List<Object> objects, final List<Message> errors) {
194 final List<Requests> requests = new ArrayList<>();
195 while (!objects.isEmpty()) {
196 final RequestsBuilder rBuilder = new RequestsBuilder();
198 if (!(objects.get(0) instanceof Rp)) {
199 // if RP obj is missing return error only
200 errors.add(createErrorMsg(PCEPErrors.RP_MISSING, Optional.<Rp>absent()));
203 rpObj = (Rp) objects.get(0);
205 if (!rpObj.isProcessingRule()) {
206 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.<Rp>absent()));
208 rBuilder.setRp(rpObj);
210 final List<VendorInformationObject> vendorInfo = addVendorInformationObjects(objects);
211 if (!vendorInfo.isEmpty()) {
212 rBuilder.setVendorInformationObject(vendorInfo);
215 if (rpObj.isPathKey() && objects.get(0) instanceof PathKey) {
216 rBuilder.setPathKeyExpansion(new PathKeyExpansionBuilder().setPathKey((PathKey) objects.get(0)).build());
219 final P2pBuilder p2pBuilder = new P2pBuilder();
221 if (!objects.isEmpty() && objects.get(0) instanceof EndpointsObj) {
222 final EndpointsObj ep = (EndpointsObj) objects.get(0);
224 if (!ep.isProcessingRule()) {
225 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.of(rpObj)));
227 p2pBuilder.setEndpointsObj(ep);
230 errors.add(createErrorMsg(PCEPErrors.END_POINTS_MISSING, Optional.of(rpObj)));
234 if (!rpObj.isP2mp()) {
235 final SegmentComputation segm = getSegmentComputation(p2pBuilder, objects, errors, rpObj);
237 rBuilder.setSegmentComputation(segm);
240 requests.add(rBuilder.build());
245 protected SegmentComputation getSegmentComputation(final P2pBuilder builder, final List<Object> objects, final List<Message> errors,
247 final List<Metrics> metrics = new ArrayList<>();
248 final List<VendorInformationObject> viObjects = new ArrayList<>();
250 State state = State.INIT;
251 while (!objects.isEmpty() && state != State.END) {
252 state = insertObject(state, objects, viObjects, builder, metrics, errors, rp);
253 if (!state.equals(State.END)) {
257 if (!metrics.isEmpty()) {
258 builder.setMetrics(metrics);
260 if (!viObjects.isEmpty()) {
261 builder.setVendorInformationObject(viObjects);
264 if (rp.isReoptimization()
265 && builder.getBandwidth() != null
266 && !builder.getReportedRoute().getBandwidth().getBandwidth().equals(
267 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth(new byte[] { 0 }))
268 && builder.getReportedRoute().getRro() == null) {
269 errors.add(createErrorMsg(PCEPErrors.RRO_MISSING, Optional.of(rp)));
272 return new SegmentComputationBuilder().setP2p(builder.build()).build();
275 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) {
276 final Object obj = objects.get(0);
279 if (obj instanceof Rro) {
280 final ReportedRouteBuilder rrBuilder = new ReportedRouteBuilder();
281 rrBuilder.setRro((Rro) obj);
283 final Object nextObj = objects.get(0);
284 if (nextObj instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reoptimization.bandwidth.object.Bandwidth) {
285 rrBuilder.setBandwidth((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reoptimization.bandwidth.object.Bandwidth) nextObj);
287 return State.REPORTED_IN;
290 if (obj instanceof VendorInformationObject) {
291 viObjects.add((VendorInformationObject) obj);
292 return State.REPORTED_IN;
294 case VENDOR_INFO_LIST:
295 if (obj instanceof LoadBalancing) {
296 builder.setLoadBalancing((LoadBalancing) obj);
297 return State.LOAD_BIN;
300 if (obj instanceof Lspa) {
301 builder.setLspa((Lspa) obj);
302 return State.LSPA_IN;
305 if (obj instanceof Bandwidth) {
306 builder.setBandwidth((Bandwidth) obj);
307 return State.BANDWIDTH_IN;
310 if (obj instanceof Metric) {
311 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
312 return State.BANDWIDTH_IN;
315 if (obj instanceof Iro) {
316 builder.setIro((Iro) obj);
320 if (obj instanceof Rro) {
321 builder.setRro((Rro) obj);
325 if (obj instanceof Xro) {
326 builder.setXro((Xro) obj);
330 if (obj instanceof Of) {
331 builder.setOf((Of) obj);
335 if (obj instanceof ClassType) {
336 final ClassType classType = (ClassType) obj;
337 if (!classType.isProcessingRule()) {
338 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.of(rp)));
340 builder.setClassType(classType);
353 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
356 private Svec getValidSvec(final SvecBuilder builder, final List<Object> objects) {
357 Preconditions.checkArgument(objects != null && !objects.isEmpty(), "Passed list can't be null or empty.");
359 if (objects.get(0) instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) {
360 builder.setSvec((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) objects.get(0));
366 final List<Metrics> metrics = new ArrayList<>();
367 final List<VendorInformationObject> viObjects = new ArrayList<>();
370 SvecState state = SvecState.INIT;
371 while (!objects.isEmpty() && !state.equals(SvecState.END)) {
372 obj = objects.get(0);
373 state = insertObject(state, obj, builder, metrics, viObjects);
374 if (!state.equals(SvecState.END)) {
378 if (!viObjects.isEmpty()) {
379 builder.setVendorInformationObject(viObjects);
381 return builder.build();
384 private SvecState insertObject(final SvecState state, final Object obj, final SvecBuilder builder, final List<Metrics> metrics, final List<VendorInformationObject> viObjects) {
387 if (obj instanceof Of) {
388 builder.setOf((Of) obj);
389 return SvecState.OF_IN;
392 if (obj instanceof Gc) {
393 builder.setGc((Gc) obj);
394 return SvecState.GC_IN;
397 if (obj instanceof Xro) {
398 builder.setXro((Xro) obj);
399 return SvecState.XRO_IN;
402 if (obj instanceof Metric) {
403 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
404 return SvecState.XRO_IN;
407 if (obj instanceof VendorInformationObject) {
408 viObjects.add((VendorInformationObject) obj);
409 return SvecState.METRIC_IN;
413 return SvecState.END;
419 private enum SvecState {
420 INIT, OF_IN, GC_IN, XRO_IN, METRIC_IN, VENDOR_INFO, END
423 protected MonitoringRequest getMonitoring(final List<Object> objects) {
424 final MonitoringRequestBuilder builder = new MonitoringRequestBuilder();
425 if (!objects.isEmpty() && objects.get(0) instanceof Monitoring) {
426 builder.setMonitoring((Monitoring) objects.get(0));
431 if (!objects.isEmpty() && objects.get(0) instanceof PccIdReq) {
432 builder.setPccIdReq((PccIdReq) objects.get(0));
435 final List<PceIdList> pceIdList = new ArrayList<>();
436 while(!objects.isEmpty() && objects.get(0) instanceof PceId) {
437 pceIdList.add(new PceIdListBuilder().setPceId((PceId) objects.get(0)).build());
440 if (!pceIdList.isEmpty()) {
441 builder.setPceIdList(pceIdList);
443 return builder.build();