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