infra/northbound/bgp/src/main/java/io/fd/honeycomb/infra/bgp/neighbors/BgpPeerWriterFactory.java

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.infra.bgp.neighbors;
  18
  19 import com.google.common.collect.Sets;
  20 import com.google.inject.Inject;
  21 import io.fd.honeycomb.infra.bgp.BgpConfiguration;
  22 import io.fd.honeycomb.translate.impl.write.GenericListWriter;
  23 import io.fd.honeycomb.translate.write.WriterFactory;
  24 import io.fd.honeycomb.translate.write.registry.ModifiableWriterRegistryBuilder;
  25 import javax.annotation.Nonnull;
  26 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
  27 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
  28 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  29 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
  30 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafis;
  31 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Config;
  32 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Timers;
  33 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Transport;
  34 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
  35 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
  36 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Neighbors;
  37 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.NetworkInstances;
  38 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstance;
  39 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.Protocols;
  40 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.Protocol;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.AfiSafi1;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.Config1;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.Config2;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.Protocol1;
  45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  46
  47 /**
  48  * Initializes writer for Bgp Neighbors ({@link Neighbor} node) and all its parents required by HC infra.
  49  */
  50 public final class BgpPeerWriterFactory implements WriterFactory {
  51     private static final InstanceIdentifier<NetworkInstance> NETWORK_INSTANCE_ID =
  52         InstanceIdentifier.create(NetworkInstances.class)
  53             .child(NetworkInstance.class);
  54
  55     private static final InstanceIdentifier<Protocol> PROTOCOL_ID =
  56         NETWORK_INSTANCE_ID.child(Protocols.class).child(Protocol.class);
  57
  58     private static final InstanceIdentifier<Neighbor> NEIGHBOR_ID =
  59         PROTOCOL_ID.augmentation(Protocol1.class).child(Bgp.class).child(Neighbors.class).child(Neighbor.class);
  60
  61     @Inject
  62     private BgpConfiguration configuration;
  63     @Inject
  64     private RIB globalRib;
  65     @Inject
  66     private BGPTableTypeRegistryConsumer tableTypeRegistry;
  67     @Inject
  68     private BGPPeerRegistry peerRegistry;
  69
  70     @Override
  71     public void init(@Nonnull final ModifiableWriterRegistryBuilder registry) {
  72         // NetworkInstances
  73         //  NetworkInstance =
  74         registry.add(new GenericListWriter<>(NETWORK_INSTANCE_ID,
  75             new NetworkInstanceCustomizer(configuration.bgpNetworkInstanceName)));
  76
  77         //   Protocols
  78         //    Protocol =
  79         registry.add(
  80             new GenericListWriter<>(PROTOCOL_ID, new ProtocolCustomizer(configuration.bgpProtocolInstanceName.get())));
  81
  82         //     Protocol1 augmentation (from bgp-openconfig-extensions)
  83         //      Bgp
  84         //       Neighbors
  85         //        Neighbor=
  86         final InstanceIdentifier<Neighbor> neighbor = InstanceIdentifier.create(Neighbor.class);
  87         registry.subtreeAdd(
  88             // TODO (HONEYCOMB-359): there might be more subnodes that needs to be handled
  89             Sets.newHashSet(
  90                 neighbor.child(Config.class),
  91                 neighbor.child(Config.class).augmentation(Config2.class),
  92                 neighbor.child(AfiSafis.class),
  93                 neighbor.child(AfiSafis.class).child(AfiSafi.class),
  94                 neighbor.child(AfiSafis.class).child(AfiSafi.class).augmentation(AfiSafi1.class),
  95                 neighbor.child(Timers.class),
  96                 neighbor.child(Timers.class).child(
  97                     org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.timers.Config.class),
  98                 neighbor.child(Transport.class),
  99                 neighbor.child(Transport.class).child(
 100                     org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.transport.Config.class),
 101                 neighbor.child(Transport.class).child(
 102                     org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.transport.Config.class)
 103                     .augmentation(Config1.class)
 104             ),
 105             new GenericListWriter<>(
 106                 NEIGHBOR_ID,
 107                 new NeighborCustomizer(globalRib, peerRegistry, tableTypeRegistry)));
 108     }
 109 }
 110