pcep/ietf-stateful/src/main/java/org/opendaylight/protocol/pcep/ietf/stateful/StatefulErrorMessageParser.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.stateful;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import io.netty.buffer.ByteBuf;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15 import java.util.Optional;
  16 import java.util.Queue;
  17 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
  18 import org.opendaylight.protocol.pcep.parser.message.PCEPErrorMessageParser;
  19 import org.opendaylight.protocol.pcep.spi.ObjectRegistry;
  20 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
  21 import org.opendaylight.protocol.pcep.spi.UnknownObject;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.pcerr.pcerr.message.error.type.StatefulCase;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.pcerr.pcerr.message.error.type.StatefulCaseBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.pcerr.pcerr.message.error.type.stateful._case.StatefulBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.pcerr.pcerr.message.error.type.stateful._case.stateful.Srps;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.pcerr.pcerr.message.error.type.stateful._case.stateful.SrpsBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.srp.object.Srp;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.PcerrBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Message;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.PcerrMessage;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.object.Open;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcep.error.object.ErrorObject;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.PcerrMessageBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.Errors;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.ErrorsBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.RequestCase;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.RequestCaseBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.SessionCaseBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.request._case.RequestBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.request._case.request.Rps;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.request._case.request.RpsBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.session._case.SessionBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.Rp;
  45
  46 /**
  47  * Parser for {@link PcerrMessage}.
  48  */
  49 public final class StatefulErrorMessageParser extends PCEPErrorMessageParser {
  50     public StatefulErrorMessageParser(final ObjectRegistry registry) {
  51         super(registry);
  52     }
  53
  54     @Override
  55     protected void serializeCases(final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types
  56             .rev181109.pcerr.message.PcerrMessage err, final ByteBuf buffer) {
  57         if (err.getErrorType() instanceof RequestCase request) {
  58             for (final Rps r : request.getRequest().nonnullRps()) {
  59                 serializeObject(r.getRp(), buffer);
  60             }
  61         }
  62         if (err.getErrorType() instanceof StatefulCase stateful) {
  63             for (final Srps s : stateful.getStateful().nonnullSrps()) {
  64                 serializeObject(s.getSrp(), buffer);
  65             }
  66         }
  67     }
  68
  69     @Override
  70     protected PcerrMessage validate(final Queue<Object> objects, final List<Message> errors)
  71             throws PCEPDeserializerException {
  72         checkArgument(objects != null, "Passed list can't be null.");
  73
  74         final Object first = objects.peek();
  75         if (first == null) {
  76             throw new PCEPDeserializerException("Error message is empty.");
  77         }
  78         final var requestParameters = new ArrayList<Rps>();
  79         final var srps = new ArrayList<Srps>();
  80         final var errorObjects = new ArrayList<Errors>();
  81         final PcerrMessageBuilder b = new PcerrMessageBuilder();
  82         State state = State.INIT;
  83         if (first instanceof ErrorObject) {
  84             errorObjects.add(new ErrorsBuilder().setErrorObject((ErrorObject) first).build());
  85             state = State.ERROR_IN;
  86         } else if (first instanceof Rp rp) {
  87             if (rp.getProcessingRule()) {
  88                 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.empty()));
  89                 return null;
  90             }
  91             requestParameters.add(new RpsBuilder().setRp(rp).build());
  92             state = State.RP_IN;
  93         } else if (first instanceof Srp) {
  94             srps.add(new SrpsBuilder().setSrp((Srp) first).build());
  95             state = State.SRP_IN;
  96         }
  97         if (state != State.INIT) {
  98             objects.remove();
  99         }
 100
 101         for (Object obj = objects.peek(); obj != null; obj = objects.peek()) {
 102             if (obj instanceof UnknownObject) {
 103                 return new PcerrBuilder()
 104                     .setPcerrMessage(b.setErrors(((UnknownObject) obj).getErrors()).build())
 105                     .build();
 106             }
 107             state = insertObject(state, obj, errorObjects, requestParameters, srps, b);
 108             if (state == State.END) {
 109                 break;
 110             }
 111
 112             objects.remove();
 113         }
 114         if (errorObjects.isEmpty()) {
 115             throw new PCEPDeserializerException("At least one PCEPErrorObject is mandatory.");
 116         }
 117         if (!objects.isEmpty()) {
 118             throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
 119         }
 120         if (!requestParameters.isEmpty()) {
 121             b.setErrorType(new RequestCaseBuilder().setRequest(new RequestBuilder().setRps(requestParameters).build())
 122                 .build());
 123         }
 124         if (!srps.isEmpty()) {
 125             b.setErrorType(new StatefulCaseBuilder().setStateful(new StatefulBuilder().setSrps(srps).build()).build());
 126         }
 127         return new PcerrBuilder().setPcerrMessage(b.setErrors(errorObjects).build()).build();
 128     }
 129
 130     private static State insertObject(final State state, final Object obj, final List<Errors> errorObjects,
 131             final List<Rps> requestParameters, final List<Srps> srps, final PcerrMessageBuilder builder) {
 132         switch (state) {
 133             case ERROR_IN:
 134                 if (obj instanceof ErrorObject o) {
 135                     errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 136                     return State.ERROR_IN;
 137                 }
 138                 // fall through
 139             case RP_IN:
 140                 if (obj instanceof Rp o) {
 141                     requestParameters.add(new RpsBuilder().setRp(o).build());
 142                     return State.RP_IN;
 143                 }
 144                 // fall through
 145             case SRP_IN:
 146                 if (obj instanceof Srp o) {
 147                     srps.add(new SrpsBuilder().setSrp(o).build());
 148                     return State.SRP_IN;
 149                 }
 150                 // fall through
 151             case OPEN:
 152                 if (obj instanceof Open) {
 153                     builder.setErrorType(
 154                         new SessionCaseBuilder().setSession(new SessionBuilder().setOpen((Open) obj).build()).build());
 155                     return State.OPEN_IN;
 156                 }
 157                 // fall through
 158             case ERROR:
 159                 if (obj instanceof ErrorObject o) {
 160                     errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 161                     return State.ERROR;
 162                 }
 163                 // fall through
 164             case OPEN_IN:
 165             case END:
 166                 return State.END;
 167             default:
 168                 return state;
 169         }
 170     }
 171
 172     private enum State {
 173         INIT, ERROR_IN, RP_IN, SRP_IN, OPEN, ERROR, OPEN_IN, END
 174     }
 175 }