BUG-50 : added parser for Pcreq message.
[bgpcep.git] / pcep / impl / src / main / java / org / opendaylight / protocol / pcep / impl / message / PCEPRequestMessageParser.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.impl.message;
9
10 import io.netty.buffer.ByteBuf;
11
12 import java.util.List;
13
14 import org.opendaylight.protocol.pcep.spi.ObjectHandlerRegistry;
15 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
16 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Pcreq;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcreqBuilder;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.Bandwidth;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.BandwidthBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.classtype.object.ClassType;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.object.EndpointsObj;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.exclude.route.object.Xro;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.gc.object.Gc;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.include.route.object.Iro;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.load.balancing.object.LoadBalancing;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.Metrics;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.MetricsBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.object.Lsp;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lspa.object.Lspa;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.metric.object.Metric;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.of.object.Of;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.path.key.object.PathKey;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.PcreqMessageBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Requests;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.RequestsBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Svec;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.SvecBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.PathKeyExpansionBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputation;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputationBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.P2pBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRouteBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reported.route.object.Rro;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
48
49 import com.google.common.collect.Lists;
50
51 /**
52  * Parser for {@link Pcreq}
53  */
54 public class PCEPRequestMessageParser extends AbstractMessageParser {
55
56         public static final int TYPE = 3;
57
58         public PCEPRequestMessageParser(final ObjectHandlerRegistry registry) {
59                 super(registry);
60         }
61
62         @Override
63         public void serializeMessage(final Message message, final ByteBuf buffer) {
64                 if (!(message instanceof Pcreq)) {
65                         throw new IllegalArgumentException("Wrong instance of PCEPMessage. Passed instance of " + message.getClass()
66                                         + ". Needed PcrepMessage.");
67                 }
68
69         }
70
71         @Override
72         protected Message validate(
73                         final List<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object> objects,
74                         final List<Message> errors) throws PCEPDeserializerException {
75                 if (objects == null) {
76                         throw new IllegalArgumentException("Passed list can't be null.");
77                 }
78
79                 final List<Requests> requests = Lists.newArrayList();
80                 final List<Svec> svecList = Lists.newArrayList();
81                 while (!objects.isEmpty()) {
82                         final RequestsBuilder rBuilder = new RequestsBuilder();
83                         Rp rpObj = null;
84                         if (objects.get(0) instanceof Rp) {
85                                 rpObj = (Rp) objects.get(0);
86                                 objects.remove(0);
87                                 if (!rpObj.isProcessingRule()) {
88                                         errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET));
89                                 } else {
90                                         rBuilder.setRp(rpObj);
91                                 }
92                         } else {
93                                 // if RP obj is missing return error only;
94                                 errors.add(createErrorMsg(PCEPErrors.RP_MISSING));
95                                 return null;
96                         }
97
98                         // expansion
99                         if (rpObj.isPathKey()) {
100                                 if (objects.get(0) instanceof PathKey) {
101                                         rBuilder.setPathKeyExpansion(new PathKeyExpansionBuilder().setPathKey((PathKey) objects.get(0)).build());
102                                 }
103                                 continue;
104                         }
105
106                         final P2pBuilder p2pBuilder = new P2pBuilder();
107
108                         if (objects.get(0) instanceof EndpointsObj) {
109                                 final EndpointsObj ep = (EndpointsObj) objects.get(0);
110                                 objects.remove(0);
111                                 if (!ep.isProcessingRule()) {
112                                         errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, rpObj));
113                                 } else {
114                                         p2pBuilder.setEndpointsObj(ep);
115                                 }
116                         } else {
117                                 errors.add(createErrorMsg(PCEPErrors.END_POINTS_MISSING, rpObj));
118                                 return null;
119                         }
120                         // p2p
121                         if (!rpObj.isP2mp()) {
122                                 final SegmentComputation segm = getSegmentComputation(p2pBuilder, objects, errors, rpObj);
123                                 if (segm != null) {
124                                         rBuilder.setSegmentComputation(segm);
125                                 }
126                         }
127                         while (!objects.isEmpty()) {
128                                 final SvecBuilder sBuilder = new SvecBuilder();
129                                 final Svec svecComp = getValidSvec(sBuilder, objects);
130                                 if (svecComp == null) {
131                                         break;
132                                 }
133                                 svecList.add(svecComp);
134                         }
135                 }
136
137                 final PcreqMessageBuilder mBuilder = new PcreqMessageBuilder();
138                 mBuilder.setRequests(requests);
139                 if (!svecList.isEmpty()) {
140                         mBuilder.setSvec(svecList);
141                 }
142                 return new PcreqBuilder().setPcreqMessage(mBuilder.build()).build();
143         }
144
145         private SegmentComputation getSegmentComputation(final P2pBuilder builder, final List<Object> objects, final List<Message> errors,
146                         final Rp rp) {
147                 final List<Metrics> metrics = Lists.newArrayList();
148
149                 State state = State.Init;
150                 while (!objects.isEmpty() && state != State.End) {
151                         Object obj = objects.get(0);
152
153                         switch (state) {
154                         case Init:
155                                 state = State.ReportedIn;
156                                 if (obj instanceof Rro) {
157                                         final ReportedRouteBuilder rrBuilder = new ReportedRouteBuilder();
158                                         rrBuilder.setRro((Rro) obj);
159                                         objects.remove(0);
160                                         obj = objects.get(0);
161                                         if (obj instanceof Bandwidth) {
162                                                 rrBuilder.setBandwidth((Bandwidth) obj);
163                                         }
164                                         break;
165                                 }
166                         case ReportedIn:
167                                 state = State.LoadBIn;
168                                 if (obj instanceof LoadBalancing) {
169                                         builder.setLoadBalancing((LoadBalancing) obj);
170                                         break;
171                                 }
172                         case LoadBIn:
173                                 state = State.LspaIn;
174                                 if (obj instanceof Lspa) {
175                                         builder.setLspa((Lspa) obj);
176                                         break;
177                                 }
178                         case LspaIn:
179                                 state = State.BandwidthIn;
180                                 if (obj instanceof Bandwidth) {
181                                         builder.setBandwidth((Bandwidth) obj);
182                                         break;
183                                 }
184                         case BandwidthIn:
185                                 state = State.MetricIn;
186                                 if (obj instanceof Metric) {
187                                         metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
188                                         state = State.BandwidthIn;
189                                         break;
190                                 }
191                         case MetricIn:
192                                 state = State.IroIn;
193                                 if (obj instanceof Iro) {
194                                         builder.setIro((Iro) obj);
195                                         break;
196                                 }
197                         case IroIn:
198                                 state = State.RroIn;
199                                 if (obj instanceof Rro) {
200                                         builder.setRro((Rro) obj);
201                                         break;
202                                 }
203                         case RroIn:
204                                 state = State.XroIn;
205                                 if (obj instanceof Xro) {
206                                         builder.setXro((Xro) obj);
207                                         break;
208                                 }
209                         case XroIn:
210                                 state = State.OfIn;
211                                 if (obj instanceof Of) {
212                                         builder.setOf((Of) obj);
213                                         break;
214                                 }
215                         case OfIn:
216                                 state = State.CtIn;
217                                 if (obj instanceof ClassType) {
218                                         final ClassType classType = (ClassType) obj;
219                                         if (!classType.isProcessingRule()) {
220                                                 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, rp));
221                                         } else {
222                                                 builder.setClassType(classType);
223                                         }
224                                         break;
225                                 }
226                         case CtIn:
227                                 state = State.LspIn;
228                                 if (obj instanceof Lsp) {
229                                         builder.setLsp((Lsp) obj);
230                                         break;
231                                 }
232                         case LspIn:
233                                 state = State.End;
234                                 break;
235                         case End:
236                                 break;
237                         }
238                         if (!state.equals(State.End)) {
239                                 objects.remove(0);
240                         }
241                 }
242                 if (!metrics.isEmpty()) {
243                         builder.setMetrics(metrics);
244                 }
245
246                 if (rp.isReoptimization()
247                                 && builder.getBandwidth() != null
248                                 && builder.getReportedRoute().getBandwidth().getBandwidth() != new BandwidthBuilder().setBandwidth(
249                                                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.nps.concepts.rev130930.Bandwidth(new byte[] { 0 })).build()
250                                 && builder.getReportedRoute().getRro() == null) {
251                         errors.add(createErrorMsg(PCEPErrors.RRO_MISSING, rp));
252                         return null;
253                 }
254                 return new SegmentComputationBuilder().setP2p(builder.build()).build();
255         }
256
257         private enum State {
258                 Init, ReportedIn, LoadBIn, LspaIn, BandwidthIn, MetricIn, IroIn, RroIn, XroIn, OfIn, CtIn, LspIn, End
259         }
260
261         private Svec getValidSvec(final SvecBuilder builder, final List<Object> objects) {
262                 if (objects == null || objects.isEmpty()) {
263                         throw new IllegalArgumentException("List cannot be null or empty.");
264                 }
265
266                 if (objects.get(0) instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) {
267                         builder.setSvec((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) objects.get(0));
268                         objects.remove(0);
269                 } else {
270                         return null;
271                 }
272
273                 final List<Metrics> metrics = Lists.newArrayList();
274
275                 Object obj = null;
276                 SvecState state = SvecState.Init;
277                 while (!objects.isEmpty() && !state.equals(SvecState.End)) {
278                         obj = objects.get(0);
279
280                         switch (state) {
281                         case Init:
282                                 state = SvecState.OfIn;
283                                 if (obj instanceof Of) {
284                                         builder.setOf((Of) obj);
285                                         break;
286                                 }
287                         case OfIn:
288                                 state = SvecState.GcIn;
289                                 if (obj instanceof Gc) {
290                                         builder.setGc((Gc) obj);
291                                         break;
292                                 }
293                         case GcIn:
294                                 state = SvecState.XroIn;
295                                 if (obj instanceof Xro) {
296                                         builder.setXro((Xro) obj);
297                                         break;
298                                 }
299                         case XroIn:
300                                 state = SvecState.MetricIn;
301                                 if (obj instanceof Metric) {
302                                         metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
303                                         state = SvecState.XroIn;
304
305                                         break;
306                                 }
307                         case MetricIn:
308                                 state = SvecState.End;
309                                 break;
310                         case End:
311                                 break;
312                         }
313                         if (!state.equals(SvecState.End)) {
314                                 objects.remove(0);
315                         }
316                 }
317                 return builder.build();
318         }
319
320         private enum SvecState {
321                 Init, OfIn, GcIn, XroIn, MetricIn, End
322         }
323
324         @Override
325         public int getMessageType() {
326                 return TYPE;
327         }
328 }