Rework parser infrastructure to support partial message processing
[bgpcep.git] / pcep / impl / src / main / java / org / opendaylight / protocol / pcep / impl / message / PCEPErrorMessageParser.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.PCEPDeserializerException;
15 import org.opendaylight.protocol.pcep.PCEPDocumentedException;
16 import org.opendaylight.protocol.pcep.PCEPErrors;
17 import org.opendaylight.protocol.pcep.UnknownObject;
18 import org.opendaylight.protocol.pcep.spi.ObjectHandlerRegistry;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcerrBuilder;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.PcerrMessage;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.Open;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcep.error.object.ErrorObject;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.PcerrMessageBuilder;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.Errors;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.ErrorsBuilder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.Request;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.RequestBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.Session;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.SessionBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.request.Rps;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.request.RpsBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
35
36 import com.google.common.collect.Lists;
37
38 /**
39  * Parser for {@link PcerrMessage}
40  */
41 public class PCEPErrorMessageParser extends AbstractMessageParser {
42
43         public static final int TYPE = 6;
44
45         public PCEPErrorMessageParser(final ObjectHandlerRegistry registry) {
46                 super(registry);
47         }
48
49         @Override
50         public void serializeMessage(final Message message, final ByteBuf buffer) {
51                 if (!(message instanceof PcerrMessage)) {
52                         throw new IllegalArgumentException("Wrong instance of Message. Passed instance " + message.getClass()
53                                         + ". Nedded ErrorMessage.");
54                 }
55                 final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.PcerrMessage err = ((PcerrMessage) message).getPcerrMessage();
56
57                 if (err.getErrors() == null || err.getErrors().isEmpty()) {
58                         throw new IllegalArgumentException("Errors should not be empty.");
59                 }
60
61                 if (err.getErrorType() instanceof Request) {
62                         final List<Rps> rps = ((Request) err.getErrorType()).getRps();
63                         for (final Rps r : rps) {
64                                 buffer.writeBytes(serializeObject(r.getRp()));
65                         }
66                 }
67
68                 for (final Errors e : err.getErrors()) {
69                         buffer.writeBytes(serializeObject(e.getErrorObject()));
70                 }
71
72                 if (err.getErrorType() instanceof Session) {
73                         buffer.writeBytes(serializeObject(((Session) err.getErrorType()).getOpen()));
74                 }
75         }
76
77         @Override
78         protected PcerrMessage validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException, PCEPDocumentedException {
79                 if (objects == null) {
80                         throw new IllegalArgumentException("Passed list can't be null.");
81                 }
82
83                 if (objects.isEmpty()) {
84                         throw new PCEPDeserializerException("Error message is empty.");
85                 }
86
87                 final List<Rps> requestParameters = Lists.newArrayList();
88                 final List<Errors> errorObjects = Lists.newArrayList();
89                 final PcerrMessageBuilder b = new PcerrMessageBuilder();
90
91                 Object obj;
92                 State state = State.Init;
93                 obj = objects.get(0);
94
95                 if (obj instanceof ErrorObject) {
96                         final ErrorObject o = (ErrorObject) obj;
97                         errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
98                         state = State.ErrorIn;
99                         objects.remove(0);
100                 } else if (obj instanceof Rp) {
101                         final Rp o = ((Rp) obj);
102                         if (o.isProcessingRule()) {
103                                 throw new PCEPDocumentedException("Invalid setting of P flag.", PCEPErrors.P_FLAG_NOT_SET);
104                         }
105                         requestParameters.add(new RpsBuilder().setRp(o).build());
106                         state = State.RpIn;
107                         objects.remove(0);
108                 }
109
110                 while (!objects.isEmpty()) {
111                         obj = objects.get(0);
112
113                         if (obj instanceof UnknownObject) {
114                                 return new PcerrBuilder().setPcerrMessage(b.setErrors(((UnknownObject) obj).getErrors()).build()).build();
115                         }
116
117                         switch (state) {
118                         case ErrorIn:
119                                 state = State.Open;
120                                 if (obj instanceof ErrorObject) {
121                                         final ErrorObject o = (ErrorObject) obj;
122                                         errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
123                                         state = State.ErrorIn;
124                                         break;
125                                 }
126                         case RpIn:
127                                 state = State.Error;
128                                 if (obj instanceof Rp) {
129                                         final Rp o = ((Rp) obj);
130                                         if (o.isProcessingRule()) {
131                                                 throw new PCEPDocumentedException("Invalid setting of P flag.", PCEPErrors.P_FLAG_NOT_SET);
132                                         }
133                                         requestParameters.add(new RpsBuilder().setRp(o).build());
134                                         state = State.RpIn;
135                                         break;
136                                 }
137                         case Open:
138                                 state = State.OpenIn;
139                                 if (obj instanceof Open) {
140                                         b.setErrorType(new SessionBuilder().setOpen((Open) obj).build());
141                                         break;
142                                 }
143                         case Error:
144                                 state = State.OpenIn;
145                                 if (obj instanceof ErrorObject) {
146                                         final ErrorObject o = (ErrorObject) obj;
147                                         errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
148                                         state = State.Error;
149                                         break;
150                                 }
151                         case OpenIn:
152                                 state = State.End;
153                                 break;
154                         case End:
155                                 break;
156                         default:
157                                 break;
158                         }
159                         if (!state.equals(State.End)) {
160                                 objects.remove(0);
161                         }
162                 }
163
164                 if (errorObjects.isEmpty() && errorObjects.isEmpty()) {
165                         throw new PCEPDeserializerException("At least one PCEPErrorObject is mandatory.");
166                 }
167
168                 if (!objects.isEmpty()) {
169                         throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
170                 }
171                 if (requestParameters != null && !requestParameters.isEmpty()) {
172                         b.setErrorType(new RequestBuilder().setRps(requestParameters).build());
173                 }
174
175                 return new PcerrBuilder().setPcerrMessage(b.setErrors(errorObjects).build()).build();
176         }
177
178         private enum State {
179                 Init, ErrorIn, RpIn, Open, Error, OpenIn, End
180         }
181
182         @Override
183         public int getMessageType() {
184                 return TYPE;
185         }
186 }