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 java.util.Optional;
  16 import org.opendaylight.protocol.pcep.spi.AbstractMessageParser;
  17 import org.opendaylight.protocol.pcep.spi.MessageUtil;
  18 import org.opendaylight.protocol.pcep.spi.ObjectRegistry;
  19 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
  20 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
  21 import org.opendaylight.protocol.pcep.spi.PSTUtil;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.Pcrpt;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.PcrptBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.Lsp;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcrpt.message.PcrptMessageBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcrpt.message.pcrpt.message.Reports;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcrpt.message.pcrpt.message.ReportsBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcrpt.message.pcrpt.message.reports.Path;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcrpt.message.pcrpt.message.reports.PathBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.srp.object.Srp;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.srp.object.srp.Tlvs;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Message;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.bandwidth.object.Bandwidth;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.explicit.route.object.Ero;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.include.route.object.Iro;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.lsp.attributes.Metrics;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.lsp.attributes.MetricsBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.lspa.object.Lspa;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.metric.object.Metric;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.reported.route.object.Rro;
  42
  43 /**
  44  * Parser for {@link Pcrpt}
  45  */
  46 public class Stateful07PCReportMessageParser extends AbstractMessageParser {
  47
  48     public static final int TYPE = 10;
  49
  50     public Stateful07PCReportMessageParser(final ObjectRegistry registry) {
  51         super(registry);
  52     }
  53
  54     @Override
  55     public void serializeMessage(final Message message, final ByteBuf out) {
  56         Preconditions.checkArgument(message instanceof Pcrpt, "Wrong instance of Message. Passed instance of %s. Need Pcrpt.", message.getClass());
  57         final Pcrpt msg = (Pcrpt) message;
  58         final List<Reports> reports = msg.getPcrptMessage().getReports();
  59         final ByteBuf buffer = Unpooled.buffer();
  60         for (final Reports report : reports) {
  61             serializeReport(report, buffer);
  62         }
  63         MessageUtil.formatMessage(TYPE, buffer, out);
  64     }
  65
  66     private void serializeReport(final Reports report, final ByteBuf buffer) {
  67         if (report.getSrp() != null) {
  68             serializeObject(report.getSrp(), buffer);
  69         }
  70         serializeObject(report.getLsp(), buffer);
  71         final Path p = report.getPath();
  72         if (p != null) {
  73             serializeObject(p.getEro(), buffer);
  74             serializeObject(p.getLspa(), buffer);
  75             serializeObject(p.getBandwidth(), buffer);
  76             serializeObject(p.getReoptimizationBandwidth(), buffer);
  77             if (p.getMetrics() != null) {
  78                 for (final Metrics m : p.getMetrics()) {
  79                     serializeObject(m.getMetric(), buffer);
  80                 }
  81             }
  82             serializeObject(p.getIro(), buffer);
  83             serializeObject(p.getRro(), buffer);
  84         }
  85     }
  86
  87     @Override
  88     public Message validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException {
  89         Preconditions.checkArgument(objects != null, "Passed list can't be null.");
  90         if (objects.isEmpty()) {
  91             throw new PCEPDeserializerException("Pcrpt message cannot be empty.");
  92         }
  93
  94         final List<Reports> reports = Lists.newArrayList();
  95
  96         while (!objects.isEmpty()) {
  97             final Reports report = getValidReports(objects, errors);
  98             if (report != null) {
  99                 reports.add(report);
 100             }
 101         }
 102         return new PcrptBuilder().setPcrptMessage(new PcrptMessageBuilder().setReports(reports).build()).build();
 103     }
 104
 105     protected Reports getValidReports(final List<Object> objects, final List<Message> errors) {
 106         final ReportsBuilder builder = new ReportsBuilder();
 107
 108         boolean lspViaSR = false;
 109         Object object = objects.remove(0);
 110         if (object instanceof Srp) {
 111             final Srp srp = (Srp) object;
 112             final Tlvs tlvs = srp.getTlvs();
 113             if (tlvs != null) {
 114                 lspViaSR = PSTUtil.isDefaultPST(tlvs.getPathSetupType());
 115             }
 116             builder.setSrp(srp);
 117             if (objects.isEmpty()) {
 118                 object = null;
 119             } else {
 120                 object = objects.remove(0);
 121             }
 122         }
 123
 124         if (validateLsp(object, lspViaSR, errors, builder)) {
 125             if (!objects.isEmpty()) {
 126                 if (!validatePath(objects, errors, builder)) {
 127                     return null;
 128                 }
 129             }
 130
 131             return builder.build();
 132         }
 133         return null;
 134     }
 135
 136     private static boolean validateLsp(final Object object, final boolean lspViaSR, final List<Message> errors,
 137             final ReportsBuilder builder) {
 138         if (object instanceof Lsp) {
 139             final Lsp lsp = (Lsp) object;
 140             final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.lsp.Tlvs tlvs = lsp.getTlvs();
 141             if (!lspViaSR && lsp.getPlspId().getValue() != 0 && (tlvs == null || tlvs.getLspIdentifiers() == null)) {
 142                 final Message errorMsg = createErrorMsg(PCEPErrors.LSP_IDENTIFIERS_TLV_MISSING, Optional.empty());
 143                 errors.add(errorMsg);
 144                 return false;
 145             }
 146
 147             builder.setLsp(lsp);
 148             return true;
 149         }
 150
 151         errors.add(createErrorMsg(PCEPErrors.LSP_MISSING, Optional.empty()));
 152         return false;
 153     }
 154
 155     private static boolean validatePath(final List<Object> objects, final List<Message> errors,
 156             final ReportsBuilder builder) {
 157         final PathBuilder pBuilder = new PathBuilder();
 158         Object object = objects.remove(0);
 159         if (object instanceof Ero) {
 160             pBuilder.setEro((Ero) object);
 161         } else {
 162             errors.add(createErrorMsg(PCEPErrors.ERO_MISSING, Optional.empty()));
 163             return false;
 164         }
 165         parsePath(objects, pBuilder);
 166         builder.setPath(pBuilder.build());
 167         return true;
 168     }
 169
 170     private static void parsePath(final List<Object> objects, final PathBuilder builder) {
 171         final List<Metrics> pathMetrics = Lists.newArrayList();
 172         Object obj;
 173         State state = State.INIT;
 174         while (!objects.isEmpty() && !state.equals(State.END)) {
 175             obj = objects.get(0);
 176             state = insertObject(state, obj, builder, pathMetrics);
 177             if (!state.equals(State.END)) {
 178                 objects.remove(0);
 179             }
 180         }
 181         if (!pathMetrics.isEmpty()) {
 182             builder.setMetrics(pathMetrics);
 183         }
 184     }
 185
 186     private static State insertObject(final State state, final Object obj, final PathBuilder builder,
 187             final List<Metrics> pathMetrics) {
 188         switch (state) {
 189         case INIT:
 190             if (obj instanceof Lspa) {
 191                 builder.setLspa((Lspa) obj);
 192                 return State.LSPA_IN;
 193             }
 194         case LSPA_IN:
 195             if (obj instanceof Bandwidth) {
 196                 builder.setBandwidth((Bandwidth) obj);
 197                 return State.LSPA_IN;
 198             }
 199             if (obj instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.reoptimization.bandwidth.object.ReoptimizationBandwidth) {
 200                 builder.setReoptimizationBandwidth((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.reoptimization.bandwidth.object.ReoptimizationBandwidth) obj);
 201                 return State.LSPA_IN;
 202             }
 203         case BANDWIDTH_IN:
 204             if (obj instanceof Metric) {
 205                 pathMetrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
 206                 return State.BANDWIDTH_IN;
 207             }
 208         case METRIC_IN:
 209             if (obj instanceof Iro) {
 210                 builder.setIro((Iro) obj);
 211                 return State.IRO_IN;
 212             }
 213         case IRO_IN:
 214             if (obj instanceof Rro) {
 215                 builder.setRro((Rro) obj);
 216                 return State.RRO_IN;
 217             }
 218         case RRO_IN:
 219         case END:
 220             return State.END;
 221         default:
 222             return state;
 223         }
 224     }
 225
 226     private enum State {
 227         INIT, LSPA_IN, BANDWIDTH_IN, METRIC_IN, IRO_IN, RRO_IN, END
 228     }
 229 }