BUG-5785 Support for dissemination of L3VPN flow spec II
[bgpcep.git] / bgp / flowspec / src / main / java / org / opendaylight / protocol / bgp / flowspec / l3vpn / AbstractFlowspecL3vpnNlriParser.java
1 /*
2  * Copyright (c) 2016 Brocade Communications 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.flowspec.l3vpn;
9
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import io.netty.buffer.ByteBuf;
13 import java.util.List;
14 import javax.annotation.Nonnull;
15 import org.opendaylight.bgp.concepts.RouteDistinguisherUtil;
16 import org.opendaylight.protocol.bgp.flowspec.AbstractFlowspecNlriParser;
17 import org.opendaylight.protocol.bgp.flowspec.SimpleFlowspecTypeRegistry;
18 import org.opendaylight.protocol.bgp.parser.BGPParsingException;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev150807.flowspec.destination.Flowspec;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.RouteDistinguisher;
21 import org.opendaylight.yangtools.yang.common.QName;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
24 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
25 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
26 import org.slf4j.Logger;
27 import org.slf4j.LoggerFactory;
28
29 /**
30  * @author Kevin Wang
31  */
32 public abstract class AbstractFlowspecL3vpnNlriParser extends AbstractFlowspecNlriParser {
33     private static final Logger LOG = LoggerFactory.getLogger(AbstractFlowspecL3vpnNlriParser.class);
34
35     private static final NodeIdentifier RD_NID = new NodeIdentifier(QName.create(Flowspec.QNAME.getNamespace(), Flowspec.QNAME.getRevision(), "route-distinguisher"));
36
37     protected AbstractFlowspecL3vpnNlriParser(SimpleFlowspecTypeRegistry flowspecTypeRegistry) {
38         super(flowspecTypeRegistry);
39     }
40
41     @Override
42     public String stringNlri(final DataContainerNode<?> flowspec) {
43         final StringBuilder buffer = new StringBuilder();
44         final RouteDistinguisher rd = extractRouteDistinguisher(flowspec);
45         if (rd != null) {
46             buffer.append("[l3vpn with route-distinguisher ").append(rd.getValue()).append("] ");
47         }
48         buffer.append(super.stringNlri(flowspec));
49         return buffer.toString();
50     }
51
52     public static final RouteDistinguisher extractRouteDistinguisher(final DataContainerNode<?> route) {
53         final Optional<DataContainerChild<? extends PathArgument, ?>> rdNode = route.getChild(RD_NID);
54         if (rdNode.isPresent()) {
55             return RouteDistinguisherUtil.parseRouteDistinguisher(rdNode.get().getValue());
56         }
57         return null;
58     }
59
60     /**
61      * For flowspec-l3vpn, there is a route distinguisher field at the beginning of NLRI (8 bytes)
62      *
63      * @param nlri
64      * @return
65      */
66     private static final RouteDistinguisher readRouteDistinguisher(final ByteBuf nlri) {
67         final RouteDistinguisher rd = RouteDistinguisherUtil.parseRouteDistinguisher(nlri);
68         LOG.trace("Route Distinguisher read from NLRI: {}", rd);
69         return rd;
70     }
71
72     @Override
73     protected void serializeNlri(@Nonnull final Object[] nlriFields, @Nonnull final ByteBuf buffer) {
74         final RouteDistinguisher rd = Preconditions.checkNotNull((RouteDistinguisher) nlriFields[0]);
75         RouteDistinguisherUtil.serializeRouteDistinquisher(rd, buffer);
76         final List<Flowspec> flowspecList = (List<Flowspec>) nlriFields[1];
77         serializeNlri(flowspecList, buffer);
78     }
79
80     @Override
81     @Nonnull
82     protected Object[] parseNlri(@Nonnull final ByteBuf nlri) throws BGPParsingException {
83         return new Object[] {
84             Preconditions.checkNotNull(readRouteDistinguisher(nlri)),
85             parseNlriFlowspecList(nlri)
86         };
87     }
88 }
89