BUG-4568: Introduce BGP Extended Community registry

[bgpcep.git] / bgp / parser-spi / src / main / java / org / opendaylight / protocol / bgp / parser / spi / pojo / SimpleExtendedCommunityRegistry.java

diff --git a/bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/pojo/SimpleExtendedCommunityRegistry.java b/bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/pojo/SimpleExtendedCommunityRegistry.java
new file mode 100644 (file)
index 0000000..7b144f9
--- /dev/null
+++ b/bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/pojo/SimpleExtendedCommunityRegistry.java
@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.protocol.bgp.parser.spi.pojo;
+
+import static org.opendaylight.protocol.bgp.parser.spi.extended.community.ExtendedCommunityUtil.isTransitive;
+import static org.opendaylight.protocol.util.Values.UNSIGNED_BYTE_MAX_VALUE;
+
+import com.google.common.base.Preconditions;
+import com.google.common.primitives.Shorts;
+import io.netty.buffer.ByteBuf;
+import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
+import org.opendaylight.protocol.bgp.parser.BGPParsingException;
+import org.opendaylight.protocol.bgp.parser.spi.extended.community.ExtendedCommunityParser;
+import org.opendaylight.protocol.bgp.parser.spi.extended.community.ExtendedCommunityRegistry;
+import org.opendaylight.protocol.bgp.parser.spi.extended.community.ExtendedCommunitySerializer;
+import org.opendaylight.protocol.concepts.HandlerRegistry;
+import org.opendaylight.protocol.util.ByteBufWriteUtil;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.ExtendedCommunities;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.ExtendedCommunitiesBuilder;
+import org.opendaylight.yangtools.yang.binding.DataContainer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+final class SimpleExtendedCommunityRegistry implements ExtendedCommunityRegistry {
+
+    private static final Logger LOG = LoggerFactory.getLogger(SimpleExtendedCommunityRegistry.class);
+
+    private static final int EXTENDED_COMMUNITY_LENGTH = 6;
+
+    private final HandlerRegistry<DataContainer, ExtendedCommunityParser, ExtendedCommunitySerializer> handlers = new HandlerRegistry<>();
+
+    private static int createKey(final int type, final int subtype) {
+        return (type << UNSIGNED_BYTE_MAX_VALUE) | subtype;
+    }
+
+    @Override
+    public ExtendedCommunities parseExtendedCommunity(final ByteBuf buffer)
+            throws BGPDocumentedException, BGPParsingException {
+        final short type = buffer.readUnsignedByte();
+        final short subtype = buffer.readUnsignedByte();
+        final ExtendedCommunityParser parser = this.handlers.getParser(createKey(type, subtype));
+        if (parser == null) {
+            buffer.skipBytes(EXTENDED_COMMUNITY_LENGTH);
+            LOG.info("Skipping unknown extended-community type/sub-type {}/{}.", type, subtype);
+            return null;
+        }
+        return new ExtendedCommunitiesBuilder()
+            .setTransitive(isTransitive(type))
+            .setExtendedCommunity(parser.parseExtendedCommunity(buffer))
+            .build();
+    }
+
+    @Override
+    public void serializeExtendedCommunity(final ExtendedCommunities extendedCommunity, final ByteBuf byteAggregator) {
+        final ExtendedCommunitySerializer serializer = this.handlers.getSerializer(extendedCommunity.getExtendedCommunity().getImplementedInterface());
+        if (serializer == null) {
+            return;
+        }
+        ByteBufWriteUtil.writeUnsignedByte(Shorts.checkedCast(serializer.getType(extendedCommunity.isTransitive())), byteAggregator);
+        ByteBufWriteUtil.writeUnsignedByte(Shorts.checkedCast(serializer.getSubType()), byteAggregator);
+        serializer.serializeExtendedCommunity(extendedCommunity.getExtendedCommunity(), byteAggregator);
+    }
+
+    synchronized AutoCloseable registerExtendedCommunitySerializer(
+            final Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.ExtendedCommunity> extendedCommunityClass,
+            final ExtendedCommunitySerializer serializer) {
+        return handlers.registerSerializer(extendedCommunityClass, serializer);
+    }
+
+    synchronized AutoCloseable registerExtendedCommunityParser(final int type, final int subtype, final ExtendedCommunityParser parser) {
+        checkTypes(type, subtype);
+        return handlers.registerParser(createKey(type, subtype), parser);
+    }
+
+    private static void checkTypes(final int type, final int subtype) {
+        Preconditions.checkArgument(type >= 0 && type <= UNSIGNED_BYTE_MAX_VALUE, "Illegal extended-community type %s",
+                type);
+        Preconditions.checkArgument(subtype >= 0 && subtype <= UNSIGNED_BYTE_MAX_VALUE, "Illegal extended-community sub-type %s", subtype);
+    }
+
+}