Bug-2226: RFC5886 - Messages parsers/serializers
[bgpcep.git] / pcep / impl / src / main / java / org / opendaylight / protocol / pcep / impl / message / PCEPMonitoringReplyMessageParser.java
1 /*
2  * Copyright (c) 2014 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
9 package org.opendaylight.protocol.pcep.impl.message;
10
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import io.netty.buffer.ByteBuf;
14 import io.netty.buffer.Unpooled;
15
16 import java.util.ArrayList;
17 import java.util.List;
18 import org.opendaylight.protocol.pcep.spi.AbstractMessageParser;
19 import org.opendaylight.protocol.pcep.spi.MessageUtil;
20 import org.opendaylight.protocol.pcep.spi.ObjectRegistry;
21 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
22 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Pcmonrep;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcmonrepBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.metrics.MetricPce;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.metrics.MetricPceBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.object.Monitoring;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.response.monitoring.metrics.list.GeneralMetricsList;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.response.monitoring.metrics.list.GeneralMetricsListBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.response.monitoring.metrics.list.SpecificMetricsList;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.response.monitoring.metrics.list.SpecificMetricsListBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.response.monitoring.metrics.list.specific.metrics.list.SpecificMetrics;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.response.monitoring.metrics.list.specific.metrics.list.SpecificMetricsBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.overload.object.Overload;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcc.id.req.object.PccIdReq;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pce.id.object.PceId;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcmonrep.message.PcmonrepMessage;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcmonrep.message.PcmonrepMessageBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.proc.time.object.ProcTime;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
43
44 /**
45  * Parser for {@link Pcmonrep}
46  * @see https://tools.ietf.org/html/rfc5886#section-3.2
47  */
48 public class PCEPMonitoringReplyMessageParser extends AbstractMessageParser {
49
50     public static final int TYPE = 9;
51
52     public PCEPMonitoringReplyMessageParser(final ObjectRegistry registry) {
53         super(registry);
54     }
55
56     @Override
57     public void serializeMessage(final Message message, final ByteBuf buffer) {
58         Preconditions.checkArgument(message instanceof Pcmonrep, "Wrong instance of Message. Passed instance of %s. Need Pcmonrep.", message.getClass());
59         final PcmonrepMessage monRepMsg = ((Pcmonrep) message).getPcmonrepMessage();
60         Preconditions.checkArgument(monRepMsg.getMonitoring() != null, "MONITORING object is mandatory.");
61         final ByteBuf body = Unpooled.buffer();
62         serializeObject(monRepMsg.getMonitoring(), body);
63         serializeObject(monRepMsg.getPccIdReq(), body);
64         if (monRepMsg.getMonitoringMetricsList() instanceof GeneralMetricsList) {
65             final GeneralMetricsList gml = (GeneralMetricsList) monRepMsg.getMonitoringMetricsList();
66             if (gml.getMetricPce() != null) {
67                 for (final MetricPce metricPce : gml.getMetricPce()) {
68                     serializeMetricPce(metricPce, body);
69                 }
70             }
71         } else if (monRepMsg.getMonitoringMetricsList() instanceof SpecificMetricsList) {
72             final SpecificMetricsList sml = (SpecificMetricsList) monRepMsg.getMonitoringMetricsList();
73             if (sml.getSpecificMetrics() != null) {
74                 for (final SpecificMetrics specificMetrics : sml.getSpecificMetrics()) {
75                     serializeObject(specificMetrics.getRp(), body);
76                     if (specificMetrics.getMetricPce() != null) {
77                         for (final MetricPce metricPce : specificMetrics.getMetricPce()) {
78                             serializeMetricPce(metricPce, body);
79                         }
80                     }
81                 }
82             }
83         }
84
85         MessageUtil.formatMessage(TYPE, body, buffer);
86     }
87
88     private void serializeMetricPce(final MetricPce metricPce, final ByteBuf buffer) {
89         Preconditions.checkArgument(metricPce.getPceId() != null, "PCE-ID must be present.");
90         serializeObject(metricPce.getPceId(), buffer);
91         serializeObject(metricPce.getProcTime(), buffer);
92         serializeObject(metricPce.getOverload(), buffer);
93     }
94
95     @Override
96     protected Message validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException {
97         if (objects == null) {
98             throw new IllegalArgumentException("Passed list can't be null.");
99         }
100         if (objects.isEmpty()) {
101             throw new PCEPDeserializerException("Pcmonrep message cannot be empty.");
102         }
103         if (!(objects.get(0) instanceof Monitoring)) {
104             errors.add(createErrorMsg(PCEPErrors.MONITORING_OBJECT_MISSING, Optional.<Rp>absent()));
105             return null;
106         }
107         final PcmonrepMessageBuilder builder = new PcmonrepMessageBuilder();
108         builder.setMonitoring((Monitoring) objects.get(0));
109         objects.remove(0);
110         if (!objects.isEmpty() && objects.get(0) instanceof PccIdReq) {
111             builder.setPccIdReq((PccIdReq) objects.get(0));
112             objects.remove(0);
113         }
114         final List<SpecificMetrics> specificMetrics = new ArrayList<>();
115         while (!objects.isEmpty()) {
116             final SpecificMetricsBuilder smb = new SpecificMetricsBuilder();
117             final List<MetricPce> metricPceList = new ArrayList<>();
118             if (objects.get(0) instanceof Rp) {
119                 smb.setRp((Rp) objects.get(0));
120                 objects.remove(0);
121             }
122             while (!objects.isEmpty() && !(objects.get(0) instanceof Rp)) {
123                 metricPceList.add(validateMonitoringMetrics(objects));
124             }
125             if (smb.getRp() != null) {
126                 smb.setMetricPce(metricPceList);
127                 specificMetrics.add(smb.build());
128             } else if (!metricPceList.isEmpty()) {
129                 builder.setMonitoringMetricsList(new GeneralMetricsListBuilder().setMetricPce(metricPceList).build());
130             }
131         }
132         if (!specificMetrics.isEmpty()) {
133             builder.setMonitoringMetricsList(new SpecificMetricsListBuilder().setSpecificMetrics(specificMetrics).build());
134         }
135         if (!objects.isEmpty()) {
136             throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
137         }
138         return new PcmonrepBuilder().setPcmonrepMessage(builder.build()).build();
139     }
140
141     private MetricPce validateMonitoringMetrics(final List<Object> objects) throws PCEPDeserializerException {
142         final MetricPceBuilder metricPceBuilder = new MetricPceBuilder();
143         if (!(objects.get(0) instanceof PceId)) {
144             throw new PCEPDeserializerException("metric-pce-list must start with PCE-ID object.");
145         }
146         metricPceBuilder.setPceId((PceId) (objects.get(0)));
147         objects.remove(0);
148         State state = State.START;
149         while (!objects.isEmpty() && !state.equals(State.END)) {
150             final Object obj = objects.get(0);
151             switch(state) {
152             case START :
153                 state = State.PROC_TIME;
154                 if (obj instanceof ProcTime) {
155                     metricPceBuilder.setProcTime((ProcTime) obj);
156                     break;
157                 }
158             case PROC_TIME :
159                 state = State.OVERLOAD;
160                 if (obj instanceof Overload) {
161                     metricPceBuilder.setOverload((Overload) obj);
162                     break;
163                 }
164             case OVERLOAD :
165                 state = State.END;
166                 break;
167             case END :
168                 break;
169             }
170             if (!state.equals(State.END)) {
171                 objects.remove(0);
172             }
173         }
174         return metricPceBuilder.build();
175     }
176
177     private enum State {
178         START, PROC_TIME, OVERLOAD, END;
179     }
180
181 }