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.impl.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 if (msg.getRequests() == null || msg.getRequests().isEmpty()) {
79 throw new IllegalArgumentException("Requests cannot be null or empty.");
81 final ByteBuf buffer = Unpooled.buffer();
82 if (msg.getMonitoringRequest() != null) {
83 serializeMonitoringRequest(msg.getMonitoringRequest(), buffer);
85 if (msg.getSvec() != null) {
86 serializeSvec(msg, buffer);
88 serializeRequest(msg, buffer);
89 MessageUtil.formatMessage(TYPE, buffer, out);
92 protected void serializeRequest(final PcreqMessage msg, final ByteBuf buffer) {
93 for (final Requests req : msg.getRequests()) {
94 serializeObject(req.getRp(), buffer);
95 serializeVendorInformationObjects(req.getVendorInformationObject(), buffer);
96 if (req.getPathKeyExpansion() != null) {
97 serializeObject(req.getPathKeyExpansion().getPathKey(), buffer);
99 if (req.getSegmentComputation() != null) {
100 final SegmentComputation sc = req.getSegmentComputation();
101 if (sc.getP2p() != null) {
102 serializeP2P(buffer, sc.getP2p());
108 protected void serializeSvec(final PcreqMessage msg, final ByteBuf buffer) {
109 for (final Svec s : msg.getSvec()) {
110 serializeObject(s.getSvec(), buffer);
111 serializeObject(s.getOf(), buffer);
112 serializeObject(s.getGc(), buffer);
113 serializeObject(s.getXro(), buffer);
114 if (s.getMetric() != null) {
115 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()) {
116 serializeObject(m.getMetric(), buffer);
119 serializeVendorInformationObjects(s.getVendorInformationObject(), buffer);
123 protected void serializeP2P(final ByteBuf buffer, final P2p p2p) {
124 serializeObject(p2p.getEndpointsObj(), buffer);
125 serializeVendorInformationObjects(p2p.getVendorInformationObject(), buffer);
126 if (p2p.getReportedRoute() != null) {
127 final ReportedRoute rr = p2p.getReportedRoute();
129 serializeObject(rr.getRro(), buffer);
130 serializeObject(rr.getBandwidth(), buffer);
133 serializeObject(p2p.getLoadBalancing(), buffer);
134 serializeObject(p2p.getLspa(), buffer);
135 serializeObject(p2p.getBandwidth(), buffer);
136 if (p2p.getMetrics() != null) {
137 for (final Metrics m : p2p.getMetrics()) {
138 serializeObject(m.getMetric(), buffer);
141 serializeObject(p2p.getIro(), buffer);
142 serializeObject(p2p.getRro(), buffer);
143 serializeObject(p2p.getXro(), buffer);
144 serializeObject(p2p.getOf(), buffer);
145 serializeObject(p2p.getClassType(), buffer);
148 protected void serializeMonitoringRequest(final MonitoringRequest monReq, final ByteBuf out) {
149 serializeObject(monReq.getMonitoring(), out);
150 serializeObject(monReq.getPccIdReq(), out);
151 if (monReq.getPceIdList() != null) {
152 for (final PceIdList pceId : monReq.getPceIdList()) {
153 serializeObject(pceId.getPceId(), out);
159 protected Message validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException {
160 if (objects == null) {
161 throw new IllegalArgumentException("Passed list can't be null.");
163 if (objects.isEmpty()) {
164 throw new PCEPDeserializerException("Pcrep message cannot be empty.");
166 final PcreqMessageBuilder mBuilder = new PcreqMessageBuilder();
167 mBuilder.setMonitoringRequest(getMonitoring(objects));
168 final List<Svec> svecs = getSvecs(objects, errors);
169 if (!svecs.isEmpty()) {
170 mBuilder.setSvec(svecs);
172 final List<Requests> requests = getRequests(objects, errors);
173 if (requests != null) {
174 mBuilder.setRequests(requests);
176 errors.add(createErrorMsg(PCEPErrors.RP_MISSING, Optional.<Rp>absent()));
178 if (!objects.isEmpty()) {
179 throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
181 return new PcreqBuilder().setPcreqMessage(mBuilder.build()).build();
184 protected List<Svec> getSvecs(final List<Object> objects, final List<Message> errors) {
185 final List<Svec> svecList = new ArrayList<>();
186 while (!objects.isEmpty()) {
187 final SvecBuilder sBuilder = new SvecBuilder();
188 final Svec svecComp = getValidSvec(sBuilder, objects);
189 if (svecComp == null) {
192 svecList.add(svecComp);
197 protected List<Requests> getRequests(final List<Object> objects, final List<Message> errors) {
198 final List<Requests> requests = new ArrayList<>();
199 while (!objects.isEmpty()) {
200 final RequestsBuilder rBuilder = new RequestsBuilder();
202 if (!(objects.get(0) instanceof Rp)) {
203 // if RP obj is missing return error only
204 errors.add(createErrorMsg(PCEPErrors.RP_MISSING, Optional.<Rp>absent()));
207 rpObj = (Rp) objects.get(0);
209 if (!rpObj.isProcessingRule()) {
210 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.<Rp>absent()));
212 rBuilder.setRp(rpObj);
214 final List<VendorInformationObject> vendorInfo = addVendorInformationObjects(objects);
215 if (!vendorInfo.isEmpty()) {
216 rBuilder.setVendorInformationObject(vendorInfo);
219 if (rpObj.isPathKey() && objects.get(0) instanceof PathKey) {
220 rBuilder.setPathKeyExpansion(new PathKeyExpansionBuilder().setPathKey((PathKey) objects.get(0)).build());
223 final P2pBuilder p2pBuilder = new P2pBuilder();
225 if (!objects.isEmpty() && objects.get(0) instanceof EndpointsObj) {
226 final EndpointsObj ep = (EndpointsObj) objects.get(0);
228 if (!ep.isProcessingRule()) {
229 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.of(rpObj)));
231 p2pBuilder.setEndpointsObj(ep);
234 errors.add(createErrorMsg(PCEPErrors.END_POINTS_MISSING, Optional.of(rpObj)));
238 if (!rpObj.isP2mp()) {
239 final SegmentComputation segm = getSegmentComputation(p2pBuilder, objects, errors, rpObj);
241 rBuilder.setSegmentComputation(segm);
244 requests.add(rBuilder.build());
249 protected SegmentComputation getSegmentComputation(final P2pBuilder builder, final List<Object> objects, final List<Message> errors,
251 final List<Metrics> metrics = new ArrayList<>();
252 final List<VendorInformationObject> viObjects = new ArrayList<>();
254 State state = State.INIT;
255 while (!objects.isEmpty() && state != State.END) {
256 final Object obj = objects.get(0);
257 state = insertObject(state, obj, objects, viObjects, builder, metrics, errors, rp);
258 if (!state.equals(State.END)) {
262 if (!metrics.isEmpty()) {
263 builder.setMetrics(metrics);
265 if (!viObjects.isEmpty()) {
266 builder.setVendorInformationObject(viObjects);
269 if (rp.isReoptimization()
270 && builder.getBandwidth() != null
271 && !builder.getReportedRoute().getBandwidth().getBandwidth().equals(
272 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth(new byte[] { 0 }))
273 && builder.getReportedRoute().getRro() == null) {
274 errors.add(createErrorMsg(PCEPErrors.RRO_MISSING, Optional.of(rp)));
277 return new SegmentComputationBuilder().setP2p(builder.build()).build();
280 private State insertObject(final State state, Object obj, final List<Object> objects, final List<VendorInformationObject> viObjects, final P2pBuilder builder, final List<Metrics> metrics, final List<Message> errors, final Rp rp) {
283 if (obj instanceof Rro) {
284 final ReportedRouteBuilder rrBuilder = new ReportedRouteBuilder();
285 rrBuilder.setRro((Rro) obj);
287 obj = objects.get(0);
288 if (obj instanceof Bandwidth) {
289 rrBuilder.setBandwidth((Bandwidth) obj);
291 return State.REPORTED_IN;
294 if (obj instanceof VendorInformationObject) {
295 viObjects.add((VendorInformationObject) obj);
296 return State.REPORTED_IN;
298 case VENDOR_INFO_LIST:
299 if (obj instanceof LoadBalancing) {
300 builder.setLoadBalancing((LoadBalancing) obj);
301 return State.LOAD_BIN;
304 if (obj instanceof Lspa) {
305 builder.setLspa((Lspa) obj);
306 return State.LSPA_IN;
309 if (obj instanceof Bandwidth) {
310 builder.setBandwidth((Bandwidth) obj);
311 return State.BANDWIDTH_IN;
314 if (obj instanceof Metric) {
315 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
316 return State.BANDWIDTH_IN;
319 if (obj instanceof Iro) {
320 builder.setIro((Iro) obj);
324 if (obj instanceof Rro) {
325 builder.setRro((Rro) obj);
329 if (obj instanceof Xro) {
330 builder.setXro((Xro) obj);
334 if (obj instanceof Of) {
335 builder.setOf((Of) obj);
339 if (obj instanceof ClassType) {
340 final ClassType classType = (ClassType) obj;
341 if (!classType.isProcessingRule()) {
342 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.of(rp)));
344 builder.setClassType(classType);
357 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
360 private Svec getValidSvec(final SvecBuilder builder, final List<Object> objects) {
361 if (objects == null || objects.isEmpty()) {
362 throw new IllegalArgumentException("List cannot be null or empty.");
365 if (objects.get(0) instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) {
366 builder.setSvec((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) objects.get(0));
372 final List<Metrics> metrics = new ArrayList<>();
373 final List<VendorInformationObject> viObjects = new ArrayList<>();
376 SvecState state = SvecState.INIT;
377 while (!objects.isEmpty() && !state.equals(SvecState.END)) {
378 obj = objects.get(0);
379 state = insertObject(state, obj, builder, metrics, viObjects);
380 if (!state.equals(SvecState.END)) {
384 if (!viObjects.isEmpty()) {
385 builder.setVendorInformationObject(viObjects);
387 return builder.build();
390 private SvecState insertObject(final SvecState state, final Object obj, final SvecBuilder builder, final List<Metrics> metrics, final List<VendorInformationObject> viObjects) {
393 if (obj instanceof Of) {
394 builder.setOf((Of) obj);
395 return SvecState.OF_IN;
398 if (obj instanceof Gc) {
399 builder.setGc((Gc) obj);
400 return SvecState.GC_IN;
403 if (obj instanceof Xro) {
404 builder.setXro((Xro) obj);
405 return SvecState.XRO_IN;
408 if (obj instanceof Metric) {
409 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
410 return SvecState.XRO_IN;
413 if (obj instanceof VendorInformationObject) {
414 viObjects.add((VendorInformationObject) obj);
415 return SvecState.METRIC_IN;
419 return SvecState.END;
425 private enum SvecState {
426 INIT, OF_IN, GC_IN, XRO_IN, METRIC_IN, VENDOR_INFO, END
429 protected MonitoringRequest getMonitoring(final List<Object> objects) {
430 final MonitoringRequestBuilder builder = new MonitoringRequestBuilder();
431 if (!objects.isEmpty() && objects.get(0) instanceof Monitoring) {
432 builder.setMonitoring((Monitoring) objects.get(0));
437 if (!objects.isEmpty() && objects.get(0) instanceof PccIdReq) {
438 builder.setPccIdReq((PccIdReq) objects.get(0));
441 final List<PceIdList> pceIdList = new ArrayList<>();
442 while(!objects.isEmpty() && objects.get(0) instanceof PceId) {
443 pceIdList.add(new PceIdListBuilder().setPceId((PceId) objects.get(0)).build());
446 if (!pceIdList.isEmpty()) {
447 builder.setPceIdList(pceIdList);
449 return builder.build();