pcep/impl/src/main/java/org/opendaylight/protocol/pcep/impl/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.impl.message;
   9
  10 import io.netty.buffer.ByteBuf;
  11
  12 import java.util.Arrays;
  13 import java.util.List;
  14
  15 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
  16 import org.opendaylight.protocol.pcep.PCEPDocumentedException;
  17 import org.opendaylight.protocol.pcep.PCEPErrorMapping;
  18 import org.opendaylight.protocol.pcep.PCEPErrors;
  19 import org.opendaylight.protocol.pcep.UnknownObject;
  20 import org.opendaylight.protocol.pcep.spi.ObjectHandlerRegistry;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcerrBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.PcerrMessage;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.Open;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcep.error.object.ErrorObject;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcep.error.object.ErrorObjectBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.PcerrMessageBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.Errors;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.ErrorsBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.Request;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.RequestBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.Session;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.SessionBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.request.Rps;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.request.RpsBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
  38
  39 import com.google.common.collect.Lists;
  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 ObjectHandlerRegistry registry) {
  49                 super(registry);
  50         }
  51
  52         @Override
  53         public void serializeMessage(final Message message, final ByteBuf buffer) {
  54                 if (!(message instanceof PcerrMessage)) {
  55                         throw new IllegalArgumentException("Wrong instance of Message. Passed instance " + message.getClass()
  56                                         + ". Nedded ErrorMessage.");
  57                 }
  58                 final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.PcerrMessage err = ((PcerrMessage) message).getPcerrMessage();
  59
  60                 if (err.getErrors() == null || err.getErrors().isEmpty()) {
  61                         throw new IllegalArgumentException("Errors should not be empty.");
  62                 }
  63
  64                 if (err.getErrorType() instanceof Request) {
  65                         final List<Rps> rps = ((Request) err.getErrorType()).getRps();
  66                         for (final Rps r : rps) {
  67                                 buffer.writeBytes(serializeObject(r.getRp()));
  68                         }
  69                 }
  70
  71                 for (final Errors e : err.getErrors()) {
  72                         buffer.writeBytes(serializeObject(e.getErrorObject()));
  73                 }
  74
  75                 if (err.getErrorType() instanceof Session) {
  76                         buffer.writeBytes(serializeObject(((Session) err.getErrorType()).getOpen()));
  77                 }
  78         }
  79
  80         @Override
  81         public Message parseMessage(final byte[] buffer) throws PCEPDeserializerException, PCEPDocumentedException {
  82                 if (buffer == null || buffer.length == 0) {
  83                         throw new PCEPDeserializerException("Error message is empty.");
  84                 }
  85                 final List<Object> objs = parseObjects(buffer);
  86                 PcerrMessage m = null;
  87                 try {
  88                         m = validate(objs);
  89                 } catch (final PCEPDocumentedException e) {
  90                         final PCEPErrorMapping maping = PCEPErrorMapping.getInstance();
  91                         return new PcerrBuilder().setPcerrMessage(
  92                                         new PcerrMessageBuilder().setErrors(
  93                                                         Arrays.asList(new ErrorsBuilder().setErrorObject(
  94                                                                         new ErrorObjectBuilder().setType(maping.getFromErrorsEnum(e.getError()).type).setValue(
  95                                                                                         maping.getFromErrorsEnum(e.getError()).value).build()).build())).build()).build();
  96                 }
  97                 return m;
  98         }
  99
 100         private PcerrMessage validate(final List<Object> objects) throws PCEPDeserializerException, PCEPDocumentedException {
 101                 if (objects == null) {
 102                         throw new IllegalArgumentException("Passed list can't be null.");
 103                 }
 104
 105                 final List<Rps> requestParameters = Lists.newArrayList();
 106                 final List<Errors> errorObjects = Lists.newArrayList();
 107                 final PcerrMessageBuilder b = new PcerrMessageBuilder();
 108
 109                 Object obj;
 110                 State state = State.Init;
 111                 obj = objects.get(0);
 112
 113                 if (obj instanceof ErrorObject) {
 114                         final ErrorObject o = (ErrorObject) obj;
 115                         errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 116                         state = State.ErrorIn;
 117                         objects.remove(0);
 118                 } else if (obj instanceof Rp) {
 119                         final Rp o = ((Rp) obj);
 120                         if (o.isProcessingRule()) {
 121                                 throw new PCEPDocumentedException("Invalid setting of P flag.", PCEPErrors.P_FLAG_NOT_SET);
 122                         }
 123                         requestParameters.add(new RpsBuilder().setRp(o).build());
 124                         state = State.RpIn;
 125                         objects.remove(0);
 126                 }
 127
 128                 while (!objects.isEmpty()) {
 129                         obj = objects.get(0);
 130
 131                         if (obj instanceof UnknownObject) {
 132                                 return new PcerrBuilder().setPcerrMessage(b.setErrors(((UnknownObject) obj).getErrors()).build()).build();
 133                         }
 134
 135                         switch (state) {
 136                         case ErrorIn:
 137                                 state = State.Open;
 138                                 if (obj instanceof ErrorObject) {
 139                                         final ErrorObject o = (ErrorObject) obj;
 140                                         errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 141                                         state = State.ErrorIn;
 142                                         break;
 143                                 }
 144                         case RpIn:
 145                                 state = State.Error;
 146                                 if (obj instanceof Rp) {
 147                                         final Rp o = ((Rp) obj);
 148                                         if (o.isProcessingRule()) {
 149                                                 throw new PCEPDocumentedException("Invalid setting of P flag.", PCEPErrors.P_FLAG_NOT_SET);
 150                                         }
 151                                         requestParameters.add(new RpsBuilder().setRp(o).build());
 152                                         state = State.RpIn;
 153                                         break;
 154                                 }
 155                         case Open:
 156                                 state = State.OpenIn;
 157                                 if (obj instanceof Open) {
 158                                         b.setErrorType(new SessionBuilder().setOpen((Open) obj).build());
 159                                         break;
 160                                 }
 161                         case Error:
 162                                 state = State.OpenIn;
 163                                 if (obj instanceof ErrorObject) {
 164                                         final ErrorObject o = (ErrorObject) obj;
 165                                         errorObjects.add(new ErrorsBuilder().setErrorObject(o).build());
 166                                         state = State.Error;
 167                                         break;
 168                                 }
 169                         case OpenIn:
 170                                 state = State.End;
 171                                 break;
 172                         case End:
 173                                 break;
 174                         default:
 175                                 break;
 176                         }
 177                         if (!state.equals(State.End)) {
 178                                 objects.remove(0);
 179                         }
 180                 }
 181
 182                 if (errorObjects.isEmpty() && errorObjects.isEmpty()) {
 183                         throw new PCEPDeserializerException("At least one PCEPErrorObject is mandatory.");
 184                 }
 185
 186                 if (!objects.isEmpty()) {
 187                         throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
 188                 }
 189                 if (requestParameters != null && !requestParameters.isEmpty()) {
 190                         b.setErrorType(new RequestBuilder().setRps(requestParameters).build());
 191                 }
 192
 193                 return new PcerrBuilder().setPcerrMessage(b.setErrors(errorObjects).build()).build();
 194         }
 195
 196         private enum State {
 197                 Init, ErrorIn, RpIn, Open, Error, OpenIn, End
 198         }
 199
 200         @Override
 201         public int getMessageType() {
 202                 return TYPE;
 203         }
 204 }