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,
  55                 "Wrong instance of Message. Passed instance of %s. Need PcerrMessage.", message.getClass());
  56         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message
  57             .PcerrMessage err = ((PcerrMessage) message).getPcerrMessage();
  58         Preconditions.checkArgument(err.getErrors() != null && !err.getErrors().isEmpty(),
  59                 "Errors should not be empty.");
  60         final ByteBuf buffer = Unpooled.buffer();
  61         serializeCases(err, buffer);
  62         for (final Errors e : err.getErrors()) {
  63             serializeObject(e.getErrorObject(), buffer);
  64         }
  65
  66         if (err.getErrorType() instanceof SessionCase) {
  67             serializeObject(((SessionCase) err.getErrorType()).getSession().getOpen(), buffer);
  68         }
  69         MessageUtil.formatMessage(TYPE, buffer, out);
  70     }
  71
  72     /**
  73      * If needed, subclasses can override this method.
  74      */
  75     protected void serializeCases(
  76             final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message
  77                 .PcerrMessage err, final ByteBuf buffer) {
  78         if (err.getErrorType() instanceof RequestCase) {
  79             final List<Rps> rps = ((RequestCase) err.getErrorType()).getRequest().getRps();
  80             for (final Rps r : rps) {
  81                 serializeObject(r.getRp(), buffer);
  82             }
  83         }
  84     }
  85
  86     @Override
  87     protected PcerrMessage validate(final List<Object> objects, final List<Message> errors)
  88             throws PCEPDeserializerException {
  89         Preconditions.checkArgument(objects != null, "Passed list can't be null.");
  90         if (objects.isEmpty()) {
  91             throw new PCEPDeserializerException("Error message is empty.");
  92         }
  93         final List<Rps> requestParameters = new ArrayList<>();
  94         final List<Errors> errorObjects = new ArrayList<>();
  95         final PcerrMessageBuilder msgBuilder = new PcerrMessageBuilder();
  96
  97         Object obj = objects.get(0);
  98         State state = State.INIT;
  99
 100         if (obj instanceof ErrorObject) {
 101             final ErrorObject o = (ErrorObject) obj;
 102             errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 103             state = State.ERROR_IN;
 104         } else if (obj instanceof Rp) {
 105             final Rp o = (Rp) obj;
 106             if (o.isProcessingRule()) {
 107                 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.empty()));
 108                 return null;
 109             }
 110             requestParameters.add(new RpsBuilder().setRp(o).build());
 111             state = State.RP_IN;
 112         }
 113         if (state.equals(State.INIT)) {
 114             throw new PCEPDeserializerException("At least one PCEPErrorObject is mandatory.");
 115         }
 116         objects.remove(0);
 117         while (!objects.isEmpty() && !state.equals(State.END)) {
 118             obj = objects.get(0);
 119             if (obj instanceof UnknownObject) {
 120                 return new PcerrBuilder()
 121                         .setPcerrMessage(msgBuilder.setErrors(((UnknownObject) obj).getErrors()).build()).build();
 122             }
 123             state = insertObject(state, errorObjects, obj, requestParameters, msgBuilder);
 124             if (!state.equals(State.END)) {
 125                 objects.remove(0);
 126             }
 127         }
 128         if (errorObjects.isEmpty()) {
 129             throw new PCEPDeserializerException("At least one PCEPErrorObject is mandatory.");
 130         }
 131         if (!objects.isEmpty()) {
 132             throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
 133         }
 134         if (!requestParameters.isEmpty()) {
 135             msgBuilder.setErrorType(new RequestCaseBuilder()
 136                     .setRequest(new RequestBuilder().setRps(requestParameters).build()).build());
 137         }
 138         return new PcerrBuilder().setPcerrMessage(msgBuilder.setErrors(errorObjects).build()).build();
 139     }
 140
 141     private static State insertObject(final State state, final List<Errors> errorObjects, final Object obj,
 142             final List<Rps> requestParameters, final PcerrMessageBuilder msgBuilder) {
 143         switch (state) {
 144             case RP_IN:
 145                 if (obj instanceof Rp) {
 146                     final Rp o = (Rp) obj;
 147                     requestParameters.add(new RpsBuilder().setRp(o).build());
 148                     return State.RP_IN;
 149                 }
 150                 // fallthrough
 151             case ERROR_IN:
 152                 if (obj instanceof ErrorObject) {
 153                     final ErrorObject o = (ErrorObject) obj;
 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) {
 167                     final ErrorObject o = (ErrorObject) obj;
 168                     errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 169                     return State.ERROR;
 170                 }
 171                 // fallthrough
 172             case OPEN_IN:
 173             case END:
 174                 return State.END;
 175             default:
 176                 return state;
 177         }
 178     }
 179
 180     private enum State {
 181         INIT, ERROR_IN, RP_IN, OPEN, ERROR, OPEN_IN, END
 182     }
 183 }