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