pcep/base-parser/src/main/java/org/opendaylight/protocol/pcep/parser/message/PCEPErrorMessageParser.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.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.spi.AbstractMessageParser;
  20 import org.opendaylight.protocol.pcep.spi.MessageUtil;
  21 import org.opendaylight.protocol.pcep.spi.ObjectRegistry;
  22 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
  23 import org.opendaylight.protocol.pcep.spi.UnknownObject;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.PcerrBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Message;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.PcerrMessage;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.object.Open;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcep.error.object.ErrorObject;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.PcerrMessageBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.Errors;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.ErrorsBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.RequestCase;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.RequestCaseBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.SessionCase;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.SessionCaseBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.request._case.RequestBuilder;
  38 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;
  39 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;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.error.type.session._case.SessionBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.Rp;
  42
  43 /**
  44  * Parser for {@link PcerrMessage}.
  45  */
  46 public class PCEPErrorMessageParser extends AbstractMessageParser {
  47
  48     public static final int TYPE = 6;
  49
  50     public PCEPErrorMessageParser(final ObjectRegistry registry) {
  51         super(registry);
  52     }
  53
  54     @Override
  55     public void serializeMessage(final Message message, final ByteBuf out) {
  56         checkArgument(message instanceof PcerrMessage,
  57                 "Wrong instance of Message. Passed instance of %s. Need PcerrMessage.", message.getClass());
  58         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message
  59             .PcerrMessage err = ((PcerrMessage) message).getPcerrMessage();
  60         checkArgument(err.getErrors() != null && !err.nonnullErrors().isEmpty(),
  61                 "Errors should not be empty.");
  62         final ByteBuf buffer = Unpooled.buffer();
  63         serializeCases(err, buffer);
  64         for (final Errors e : err.nonnullErrors()) {
  65             serializeObject(e.getErrorObject(), buffer);
  66         }
  67
  68         if (err.getErrorType() instanceof SessionCase) {
  69             serializeObject(((SessionCase) err.getErrorType()).getSession().getOpen(), buffer);
  70         }
  71         MessageUtil.formatMessage(TYPE, buffer, out);
  72     }
  73
  74     /**
  75      * If needed, subclasses can override this method.
  76      */
  77     protected void serializeCases(
  78             final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message
  79                 .PcerrMessage err, final ByteBuf buffer) {
  80         if (err.getErrorType() instanceof RequestCase) {
  81             for (final Rps r : ((RequestCase) err.getErrorType()).getRequest().nonnullRps()) {
  82                 serializeObject(r.getRp(), buffer);
  83             }
  84         }
  85     }
  86
  87     @Override
  88     protected PcerrMessage validate(final Queue<Object> objects, final List<Message> errors)
  89             throws PCEPDeserializerException {
  90         checkArgument(objects != null, "Passed list can't be null.");
  91
  92         final List<Rps> requestParameters = new ArrayList<>();
  93         final List<Errors> errorObjects = new ArrayList<>();
  94
  95         final State initialState;
  96         final Object first = objects.poll();
  97         if (first instanceof ErrorObject) {
  98             errorObjects.add(new ErrorsBuilder().setErrorObject((ErrorObject) first).build());
  99             initialState = State.ERROR_IN;
 100         } else if (first instanceof Rp rp) {
 101             if (rp.getProcessingRule()) {
 102                 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.empty()));
 103                 return null;
 104             }
 105             requestParameters.add(new RpsBuilder().setRp(rp).build());
 106             initialState = State.RP_IN;
 107         } else if (first == null) {
 108             throw new PCEPDeserializerException("Error message is empty.");
 109         } else {
 110             throw new PCEPDeserializerException("At least one PCEPErrorObject is mandatory.");
 111         }
 112
 113         final PcerrMessageBuilder msgBuilder = new PcerrMessageBuilder();
 114         State state = initialState;
 115         for (Object obj = objects.peek(); obj != null; obj = objects.peek()) {
 116             if (obj instanceof UnknownObject) {
 117                 return new PcerrBuilder()
 118                         .setPcerrMessage(msgBuilder.setErrors(((UnknownObject) obj).getErrors()).build())
 119                         .build();
 120             }
 121
 122             state = insertObject(state, errorObjects, obj, requestParameters, msgBuilder);
 123             if (state == State.END) {
 124                 break;
 125             }
 126
 127             objects.remove();
 128         }
 129
 130         if (errorObjects.isEmpty()) {
 131             throw new PCEPDeserializerException("At least one PCEPErrorObject is mandatory.");
 132         }
 133         if (!objects.isEmpty()) {
 134             throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
 135         }
 136         if (!requestParameters.isEmpty()) {
 137             msgBuilder.setErrorType(new RequestCaseBuilder()
 138                     .setRequest(new RequestBuilder().setRps(requestParameters).build()).build());
 139         }
 140         return new PcerrBuilder().setPcerrMessage(msgBuilder.setErrors(errorObjects).build()).build();
 141     }
 142
 143     private static State insertObject(final State state, final List<Errors> errorObjects, final Object obj,
 144             final List<Rps> requestParameters, final PcerrMessageBuilder msgBuilder) {
 145         switch (state) {
 146             case RP_IN:
 147                 if (obj instanceof Rp o) {
 148                     requestParameters.add(new RpsBuilder().setRp(o).build());
 149                     return State.RP_IN;
 150                 }
 151                 // fallthrough
 152             case ERROR_IN:
 153                 if (obj instanceof ErrorObject o) {
 154                     errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 155                     return State.ERROR_IN;
 156                 }
 157                 // fallthrough
 158             case OPEN:
 159                 if (obj instanceof Open) {
 160                     msgBuilder.setErrorType(
 161                         new SessionCaseBuilder().setSession(new SessionBuilder().setOpen((Open) obj).build()).build());
 162                     return State.OPEN_IN;
 163                 }
 164                 // fallthrough
 165             case ERROR:
 166                 if (obj instanceof ErrorObject o) {
 167                     errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 168                     return State.ERROR;
 169                 }
 170                 // fallthrough
 171             case OPEN_IN:
 172             case END:
 173                 return State.END;
 174             default:
 175                 return state;
 176         }
 177     }
 178
 179     private enum State {
 180         INIT, ERROR_IN, RP_IN, OPEN, ERROR, OPEN_IN, END
 181     }
 182 }