bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/AbstractMessageRegistry.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.bgp.parser.spi;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.primitives.UnsignedBytes;
  12
  13 import io.netty.buffer.ByteBuf;
  14
  15 import java.util.Arrays;
  16
  17 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
  18 import org.opendaylight.protocol.bgp.parser.BGPError;
  19 import org.opendaylight.protocol.bgp.parser.BGPParsingException;
  20 import org.opendaylight.protocol.util.ByteArray;
  21 import org.opendaylight.yangtools.yang.binding.Notification;
  22
  23 public abstract class AbstractMessageRegistry implements MessageRegistry {
  24
  25     private static final byte[] MARKER;
  26
  27     protected abstract Notification parseBody(final int type, final ByteBuf body, final int messageLength) throws BGPDocumentedException;
  28
  29     protected abstract void serializeMessageImpl(final Notification message, final ByteBuf buffer);
  30
  31     static {
  32         MARKER = new byte[MessageUtil.MARKER_LENGTH];
  33         Arrays.fill(MARKER, UnsignedBytes.MAX_VALUE);
  34     }
  35
  36     @Override
  37     public final Notification parseMessage(final ByteBuf buffer) throws BGPDocumentedException, BGPParsingException {
  38         Preconditions.checkArgument(buffer != null && buffer.isReadable(), "Array of bytes cannot be null or empty.");
  39         Preconditions.checkArgument(buffer.readableBytes() >= MessageUtil.COMMON_HEADER_LENGTH,
  40                 "Too few bytes in passed array. Passed: %s. Expected: >= %s.", buffer.readableBytes(), MessageUtil.COMMON_HEADER_LENGTH);
  41         final byte[] marker = ByteArray.readBytes(buffer, MessageUtil.MARKER_LENGTH);
  42
  43         if (!Arrays.equals(marker, MARKER)) {
  44             throw new BGPDocumentedException("Marker not set to ones.", BGPError.CONNECTION_NOT_SYNC);
  45         }
  46         final int messageLength = buffer.readUnsignedShort();
  47         // to be sent with Error message
  48         final byte typeBytes = buffer.readByte();
  49         final int messageType = UnsignedBytes.toInt(typeBytes);
  50
  51         final ByteBuf msgBody = buffer.slice(buffer.readerIndex(), messageLength - MessageUtil.COMMON_HEADER_LENGTH);
  52
  53         if (messageLength < MessageUtil.COMMON_HEADER_LENGTH) {
  54             throw BGPDocumentedException.badMessageLength("Message length field not within valid range.", messageLength);
  55         }
  56         if (msgBody.readableBytes() != messageLength - MessageUtil.COMMON_HEADER_LENGTH) {
  57             throw new BGPParsingException("Size doesn't match size specified in header. Passed: " + msgBody.readableBytes()
  58                     + "; Expected: " + (messageLength - MessageUtil.COMMON_HEADER_LENGTH) + ". ");
  59         }
  60         final Notification msg = parseBody(messageType, msgBody, messageLength);
  61         if (msg == null) {
  62             throw new BGPDocumentedException("Unhandled message type " + messageType, BGPError.BAD_MSG_TYPE, new byte[] { typeBytes });
  63         }
  64         buffer.skipBytes(messageLength - MessageUtil.COMMON_HEADER_LENGTH);
  65         return msg;
  66     }
  67
  68     @Override
  69     public final void serializeMessage(final Notification message, final ByteBuf buffer) {
  70         Preconditions.checkNotNull(message, "BGPMessage is mandatory.");
  71         serializeMessageImpl(message, buffer);
  72     }
  73 }