pcep/base-parser/src/main/java/org/opendaylight/protocol/pcep/parser/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 package org.opendaylight.protocol.pcep.parser.message;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import io.netty.buffer.ByteBuf;
  13 import io.netty.buffer.Unpooled;
  14 import java.util.ArrayList;
  15 import java.util.List;
  16 import java.util.Optional;
  17 import java.util.Queue;
  18 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
  19 import org.opendaylight.protocol.pcep.parser.util.Util;
  20 import org.opendaylight.protocol.pcep.spi.AbstractMessageParser;
  21 import org.opendaylight.protocol.pcep.spi.MessageUtil;
  22 import org.opendaylight.protocol.pcep.spi.ObjectRegistry;
  23 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.Pcmonrep;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.PcmonrepBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Message;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.metrics.MetricPce;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.object.Monitoring;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.GeneralMetricsList;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.GeneralMetricsListBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.SpecificMetricsList;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.SpecificMetricsListBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.specific.metrics.list.SpecificMetrics;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.specific.metrics.list.SpecificMetricsBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcc.id.req.object.PccIdReq;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcmonrep.message.PcmonrepMessage;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcmonrep.message.PcmonrepMessageBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.Rp;
  40
  41
  42 /**
  43  * Parser for {@link Pcmonrep}.
  44  * @see <a href="https://tools.ietf.org/html/rfc5886#section-3.2">Path Monitoring Replay Message</a>
  45  */
  46 public class PCEPMonitoringReplyMessageParser extends AbstractMessageParser {
  47
  48     public static final int TYPE = 9;
  49
  50     public PCEPMonitoringReplyMessageParser(final ObjectRegistry registry) {
  51         super(registry);
  52     }
  53
  54     @Override
  55     public void serializeMessage(final Message message, final ByteBuf buffer) {
  56         checkArgument(message instanceof Pcmonrep,
  57                 "Wrong instance of Message. Passed instance of %s. Need Pcmonrep.", message.getClass());
  58         final PcmonrepMessage monRepMsg = ((Pcmonrep) message).getPcmonrepMessage();
  59         checkArgument(monRepMsg.getMonitoring() != null, "MONITORING object is mandatory.");
  60         final ByteBuf body = Unpooled.buffer();
  61         serializeObject(monRepMsg.getMonitoring(), body);
  62         serializeObject(monRepMsg.getPccIdReq(), body);
  63         if (monRepMsg.getMonitoringMetricsList() instanceof GeneralMetricsList) {
  64             final GeneralMetricsList gml = (GeneralMetricsList) monRepMsg.getMonitoringMetricsList();
  65             for (final MetricPce metricPce : gml.nonnullMetricPce()) {
  66                 serializeMetricPce(metricPce, body);
  67             }
  68         } else if (monRepMsg.getMonitoringMetricsList() instanceof SpecificMetricsList) {
  69             final SpecificMetricsList sml = (SpecificMetricsList) monRepMsg.getMonitoringMetricsList();
  70             for (final SpecificMetrics specificMetrics : sml.nonnullSpecificMetrics()) {
  71                 serializeObject(specificMetrics.getRp(), body);
  72                 for (final MetricPce metricPce : specificMetrics.nonnullMetricPce()) {
  73                     serializeMetricPce(metricPce, body);
  74                 }
  75             }
  76         }
  77
  78         MessageUtil.formatMessage(TYPE, body, buffer);
  79     }
  80
  81     private void serializeMetricPce(final MetricPce metricPce, final ByteBuf buffer) {
  82         checkArgument(metricPce.getPceId() != null, "PCE-ID must be present.");
  83         serializeObject(metricPce.getPceId(), buffer);
  84         serializeObject(metricPce.getProcTime(), buffer);
  85         serializeObject(metricPce.getOverload(), buffer);
  86     }
  87
  88     @Override
  89     protected Message validate(final Queue<Object> objects, final List<Message> errors)
  90             throws PCEPDeserializerException {
  91         checkArgument(objects != null, "Passed list can't be null.");
  92
  93         final Object monitoring = objects.poll();
  94         if (monitoring == null) {
  95             throw new PCEPDeserializerException("Pcmonrep message cannot be empty.");
  96         }
  97         if (!(monitoring instanceof Monitoring)) {
  98             errors.add(createErrorMsg(PCEPErrors.MONITORING_OBJECT_MISSING, Optional.empty()));
  99             return null;
 100         }
 101
 102         final PcmonrepMessageBuilder builder = new PcmonrepMessageBuilder().setMonitoring((Monitoring) monitoring);
 103
 104         final Object obj = objects.peek();
 105         if (obj instanceof PccIdReq) {
 106             builder.setPccIdReq((PccIdReq)obj);
 107             objects.remove();
 108         }
 109
 110         validateSpecificMetrics(objects, builder);
 111         if (!objects.isEmpty()) {
 112             throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
 113         }
 114         return new PcmonrepBuilder().setPcmonrepMessage(builder.build()).build();
 115     }
 116
 117     private static void validateSpecificMetrics(final Queue<Object> objects, final PcmonrepMessageBuilder builder)
 118             throws PCEPDeserializerException {
 119         final List<SpecificMetrics> specificMetrics = new ArrayList<>();
 120
 121         for (Object obj = objects.peek(); obj != null; obj = objects.peek()) {
 122             final SpecificMetricsBuilder smb = new SpecificMetricsBuilder();
 123             if (obj instanceof Rp) {
 124                 smb.setRp((Rp) obj);
 125                 objects.remove();
 126             }
 127
 128             final List<MetricPce> metricPceList = new ArrayList<>();
 129             for (obj = objects.peek(); obj != null && !(obj instanceof Rp); obj = objects.peek()) {
 130                 metricPceList.add(Util.validateMonitoringMetrics(objects));
 131             }
 132
 133             if (smb.getRp() != null) {
 134                 specificMetrics.add(smb.setMetricPce(metricPceList).build());
 135             } else if (!metricPceList.isEmpty()) {
 136                 builder.setMonitoringMetricsList(new GeneralMetricsListBuilder().setMetricPce(metricPceList).build());
 137             }
 138         }
 139
 140         if (!specificMetrics.isEmpty()) {
 141             builder.setMonitoringMetricsList(
 142                     new SpecificMetricsListBuilder().setSpecificMetrics(specificMetrics).build());
 143         }
 144     }
 145 }