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.nonnullErrors().isEmpty(),
  59                 "Errors should not be empty.");
  60         final ByteBuf buffer = Unpooled.buffer();
  61         serializeCases(err, buffer);
  62         for (final Errors e : err.nonnullErrors()) {
  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             for (final Rps r : ((RequestCase) err.getErrorType()).getRequest().nonnullRps()) {
  80                 serializeObject(r.getRp(), buffer);
  81             }
  82         }
  83     }
  84
  85     @Override
  86     protected PcerrMessage validate(final List<Object> objects, final List<Message> errors)
  87             throws PCEPDeserializerException {
  88         Preconditions.checkArgument(objects != null, "Passed list can't be null.");
  89         if (objects.isEmpty()) {
  90             throw new PCEPDeserializerException("Error message is empty.");
  91         }
  92         final List<Rps> requestParameters = new ArrayList<>();
  93         final List<Errors> errorObjects = new ArrayList<>();
  94         final PcerrMessageBuilder msgBuilder = new PcerrMessageBuilder();
  95
  96         Object obj = objects.get(0);
  97         State state = State.INIT;
  98
  99         if (obj instanceof ErrorObject) {
 100             final ErrorObject o = (ErrorObject) obj;
 101             errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 102             state = State.ERROR_IN;
 103         } else if (obj instanceof Rp) {
 104             final Rp o = (Rp) obj;
 105             if (o.getProcessingRule()) {
 106                 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.empty()));
 107                 return null;
 108             }
 109             requestParameters.add(new RpsBuilder().setRp(o).build());
 110             state = State.RP_IN;
 111         }
 112         if (state.equals(State.INIT)) {
 113             throw new PCEPDeserializerException("At least one PCEPErrorObject is mandatory.");
 114         }
 115         objects.remove(0);
 116         while (!objects.isEmpty() && !state.equals(State.END)) {
 117             obj = objects.get(0);
 118             if (obj instanceof UnknownObject) {
 119                 return new PcerrBuilder()
 120                         .setPcerrMessage(msgBuilder.setErrors(((UnknownObject) obj).getErrors()).build()).build();
 121             }
 122             state = insertObject(state, errorObjects, obj, requestParameters, msgBuilder);
 123             if (!state.equals(State.END)) {
 124                 objects.remove(0);
 125             }
 126         }
 127         if (errorObjects.isEmpty()) {
 128             throw new PCEPDeserializerException("At least one PCEPErrorObject is mandatory.");
 129         }
 130         if (!objects.isEmpty()) {
 131             throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
 132         }
 133         if (!requestParameters.isEmpty()) {
 134             msgBuilder.setErrorType(new RequestCaseBuilder()
 135                     .setRequest(new RequestBuilder().setRps(requestParameters).build()).build());
 136         }
 137         return new PcerrBuilder().setPcerrMessage(msgBuilder.setErrors(errorObjects).build()).build();
 138     }
 139
 140     private static State insertObject(final State state, final List<Errors> errorObjects, final Object obj,
 141             final List<Rps> requestParameters, final PcerrMessageBuilder msgBuilder) {
 142         switch (state) {
 143             case RP_IN:
 144                 if (obj instanceof Rp) {
 145                     final Rp o = (Rp) obj;
 146                     requestParameters.add(new RpsBuilder().setRp(o).build());
 147                     return State.RP_IN;
 148                 }
 149                 // fallthrough
 150             case ERROR_IN:
 151                 if (obj instanceof ErrorObject) {
 152                     final ErrorObject o = (ErrorObject) obj;
 153                     errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 154                     return State.ERROR_IN;
 155                 }
 156                 // fallthrough
 157             case OPEN:
 158                 if (obj instanceof Open) {
 159                     msgBuilder.setErrorType(
 160                         new SessionCaseBuilder().setSession(new SessionBuilder().setOpen((Open) obj).build()).build());
 161                     return State.OPEN_IN;
 162                 }
 163                 // fallthrough
 164             case ERROR:
 165                 if (obj instanceof ErrorObject) {
 166                     final ErrorObject o = (ErrorObject) obj;
 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 }