Merge "BUG-612 : defensive parser for LSPA"
[bgpcep.git] / pcep / ietf-stateful07 / src / main / java / org / opendaylight / protocol / pcep / ietf / stateful07 / Stateful07PCReportMessageParser.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.protocol.pcep.ietf.stateful07;
9
10 import com.google.common.base.Preconditions;
11 import com.google.common.collect.Lists;
12 import io.netty.buffer.ByteBuf;
13 import io.netty.buffer.Unpooled;
14 import java.util.List;
15 import org.opendaylight.protocol.pcep.spi.AbstractMessageParser;
16 import org.opendaylight.protocol.pcep.spi.MessageUtil;
17 import org.opendaylight.protocol.pcep.spi.ObjectRegistry;
18 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
19 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Pcrpt;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PcrptBuilder;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.Lsp;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.PcrptMessageBuilder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.pcrpt.message.Reports;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.pcrpt.message.ReportsBuilder;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.pcrpt.message.reports.Path;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.pcrpt.message.reports.PathBuilder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.Srp;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.Bandwidth;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.Ero;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.include.route.object.Iro;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.Metrics;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.MetricsBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lspa.object.Lspa;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.metric.object.Metric;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reported.route.object.Rro;
39
40 /**
41  * Parser for {@link Pcrpt}
42  */
43 public class Stateful07PCReportMessageParser extends AbstractMessageParser {
44
45     public static final int TYPE = 10;
46
47     public Stateful07PCReportMessageParser(final ObjectRegistry registry) {
48         super(registry);
49     }
50
51     @Override
52     public void serializeMessage(final Message message, final ByteBuf out) {
53         Preconditions.checkArgument(message instanceof Pcrpt, "Wrong instance of Message. Passed instance of %s. Need Pcrpt.", message.getClass());
54         final Pcrpt msg = (Pcrpt) message;
55         final List<Reports> reports = msg.getPcrptMessage().getReports();
56         ByteBuf buffer = Unpooled.buffer();
57         for (final Reports report : reports) {
58             serializeReport(report, buffer);
59         }
60         MessageUtil.formatMessage(TYPE, buffer, out);
61     }
62
63     protected void serializeReport(final Reports report, final ByteBuf buffer) {
64         if (report.getSrp() != null) {
65             serializeObject(report.getSrp(), buffer);
66         }
67         serializeObject(report.getLsp(), buffer);
68         final Path p = report.getPath();
69         if (p != null) {
70             serializeObject(p.getEro(), buffer);
71             if (p.getLspa() != null) {
72                 serializeObject(p.getLspa(), buffer);
73             }
74             if (p.getBandwidth() != null) {
75                 serializeObject(p.getBandwidth(), buffer);
76             }
77             if (p.getMetrics() != null && !p.getMetrics().isEmpty()) {
78                 for (final Metrics m : p.getMetrics()) {
79                     serializeObject(m.getMetric(), buffer);
80                 }
81             }
82             if (p.getIro() != null) {
83                 serializeObject(p.getIro(), buffer);
84             }
85             if (p.getRro() != null) {
86                 serializeObject(p.getRro(), buffer);
87             }
88         }
89     }
90
91     @Override
92     public Message validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException {
93         if (objects == null) {
94             throw new IllegalArgumentException("Passed list can't be null.");
95         }
96         if (objects.isEmpty()) {
97             throw new PCEPDeserializerException("Pcrpt message cannot be empty.");
98         }
99
100         final List<Reports> reports = Lists.newArrayList();
101
102         while (!objects.isEmpty()) {
103             final Reports report = getValidReports(objects, errors);
104             if (report != null) {
105                 reports.add(report);
106             }
107         }
108         return new PcrptBuilder().setPcrptMessage(new PcrptMessageBuilder().setReports(reports).build()).build();
109     }
110
111     protected Reports getValidReports(final List<Object> objects, final List<Message> errors) {
112         boolean isValid = true;
113         final ReportsBuilder builder = new ReportsBuilder();
114         if (objects.get(0) instanceof Srp) {
115             builder.setSrp((Srp) objects.get(0));
116             objects.remove(0);
117         }
118         if (objects.get(0) instanceof Lsp) {
119             builder.setLsp((Lsp) objects.get(0));
120             objects.remove(0);
121         } else {
122             errors.add(createErrorMsg(PCEPErrors.LSP_MISSING));
123             isValid = false;
124         }
125         if (!objects.isEmpty()) {
126             final PathBuilder pBuilder = new PathBuilder();
127             if (objects.get(0) instanceof Ero) {
128                 pBuilder.setEro((Ero) objects.get(0));
129                 objects.remove(0);
130             } else {
131                 errors.add(createErrorMsg(PCEPErrors.ERO_MISSING));
132                 isValid = false;
133             }
134             parsePath(objects, pBuilder);
135             builder.setPath(pBuilder.build());
136         }
137         if(isValid) {
138             return builder.build();
139         }
140         return null;
141     }
142
143     private void parsePath(final List<Object> objects, final PathBuilder builder) {
144         final List<Metrics> pathMetrics = Lists.newArrayList();
145         Object obj;
146         State state = State.Init;
147         while (!objects.isEmpty() && !state.equals(State.End)) {
148             obj = objects.get(0);
149             switch (state) {
150             case Init:
151                 state = State.LspaIn;
152                 if (obj instanceof Lspa) {
153                     builder.setLspa((Lspa) obj);
154                     break;
155                 }
156             case LspaIn:
157                 state = State.BandwidthIn;
158                 if (obj instanceof Bandwidth) {
159                     builder.setBandwidth((Bandwidth) obj);
160                     break;
161                 }
162             case BandwidthIn:
163                 state = State.MetricIn;
164                 if (obj instanceof Metric) {
165                     pathMetrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
166                     state = State.BandwidthIn;
167                     break;
168                 }
169             case MetricIn:
170                 state = State.IroIn;
171                 if (obj instanceof Iro) {
172                     builder.setIro((Iro) obj);
173                     break;
174                 }
175             case IroIn:
176                 state = State.RroIn;
177                 if (obj instanceof Rro) {
178                     builder.setRro((Rro) obj);
179                     break;
180                 }
181             case RroIn:
182                 state = State.End;
183                 break;
184             case End:
185                 break;
186             }
187             if (!state.equals(State.End)) {
188                 objects.remove(0);
189             }
190         }
191         if (!pathMetrics.isEmpty()) {
192             builder.setMetrics(pathMetrics);
193         }
194     }
195
196     private enum State {
197         Init, LspaIn, BandwidthIn, MetricIn, IroIn, RroIn, End
198     }
199 }