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