bgp/rib-impl/src/main/java/org/opendaylight/controller/config/yang/bgp/rib/impl/BGPApplicationPeerModule.java

   1 /*
   2  * Copyright (c) 2014 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.controller.config.yang.bgp.rib.impl;
   9
  10 import com.google.common.base.Optional;
  11 import java.util.Collections;
  12 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  13 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  14 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
  15 import org.opendaylight.protocol.bgp.openconfig.spi.BGPConfigModuleTracker;
  16 import org.opendaylight.protocol.bgp.openconfig.spi.BGPOpenConfigProvider;
  17 import org.opendaylight.protocol.bgp.openconfig.spi.BGPOpenconfigMapper;
  18 import org.opendaylight.protocol.bgp.openconfig.spi.InstanceConfigurationIdentifier;
  19 import org.opendaylight.protocol.bgp.openconfig.spi.pojo.BGPAppPeerInstanceConfiguration;
  20 import org.opendaylight.protocol.bgp.rib.impl.ApplicationPeer;
  21 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
  22 import org.opendaylight.protocol.bgp.rib.impl.RIBImpl;
  23 import org.opendaylight.protocol.bgp.rib.impl.StrictBGPPeerRegistry;
  24 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
  25 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
  26 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRib;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.SimpleRoutingPolicy;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  32 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  33 import org.opendaylight.yangtools.yang.common.QName;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  35
  36 /**
  37  * Application peer handler which handles translation from custom RIB into local RIB
  38  */
  39 public class BGPApplicationPeerModule extends org.opendaylight.controller.config.yang.bgp.rib.impl.AbstractBGPApplicationPeerModule {
  40
  41     private static final QName APP_ID_QNAME = QName.create(ApplicationRib.QNAME, "id").intern();
  42
  43     public BGPApplicationPeerModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier, final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver) {
  44         super(identifier, dependencyResolver);
  45     }
  46
  47     public BGPApplicationPeerModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier, final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver, final org.opendaylight.controller.config.yang.bgp.rib.impl.BGPApplicationPeerModule oldModule, final java.lang.AutoCloseable oldInstance) {
  48         super(identifier, dependencyResolver, oldModule, oldInstance);
  49     }
  50
  51     @Override
  52     public void customValidation() {
  53         // add custom validation form module attributes here.
  54     }
  55
  56     @Override
  57     public java.lang.AutoCloseable createInstance() {
  58         // add to peer-registry to catch any conflicting peer addresses
  59         addToPeerRegistry();
  60
  61         final YangInstanceIdentifier id = YangInstanceIdentifier.builder().node(ApplicationRib.QNAME).nodeWithKey(ApplicationRib.QNAME, APP_ID_QNAME, getApplicationRibId().getValue()).node(Tables.QNAME).node(Tables.QNAME).build();
  62         final DOMDataTreeChangeService service = (DOMDataTreeChangeService) getDataBrokerDependency().getSupportedExtensions().get(DOMDataTreeChangeService.class);
  63         final AppPeerModuleTracker appPeerMT = new AppPeerModuleTracker(getTargetRibDependency().getOpenConfigProvider());
  64         final ApplicationPeer appPeer = new ApplicationPeer(getApplicationRibId(), getBgpPeerId(), (RIBImpl) getTargetRibDependency(), appPeerMT);
  65         final ListenerRegistration<ApplicationPeer> listenerRegistration = service.registerDataTreeChangeListener(
  66                 new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, id), appPeer);
  67
  68         return () -> {
  69             listenerRegistration.close();
  70             appPeer.close();
  71             removeFromPeerRegistry();
  72         };
  73     }
  74
  75     private interface CloseableNoEx extends AutoCloseable {
  76         @Override
  77         void close();
  78     }
  79
  80     private void addToPeerRegistry() {
  81         final RIB r = getTargetRibDependency();
  82
  83         final IpAddress bgpPeerId = new IpAddress(getBgpPeerId());
  84         final BGPPeer bgpClientPeer = new BGPPeer(bgpPeerId.getIpv4Address().getValue(), r, PeerRole.Internal, SimpleRoutingPolicy.AnnounceNone, null);
  85
  86         final BGPSessionPreferences prefs = new BGPSessionPreferences(r.getLocalAs(), 0, r.getBgpIdentifier(),
  87                 r.getLocalAs(), Collections.emptyList(), Optional.absent());
  88
  89         final BGPPeerRegistry peerRegistry = getPeerRegistryBackwards();
  90         peerRegistry.addPeer(bgpPeerId, bgpClientPeer, prefs);
  91     }
  92
  93     private void removeFromPeerRegistry() {
  94         final IpAddress bgpPeerId = new IpAddress(getBgpPeerId());
  95         final BGPPeerRegistry peerRegistry = getPeerRegistryBackwards();
  96         peerRegistry.removePeer(bgpPeerId);
  97     }
  98
  99     private BGPPeerRegistry getPeerRegistryBackwards() {
 100         return getBgpPeerRegistryDependency() == null ? StrictBGPPeerRegistry.GLOBAL : getBgpPeerRegistryDependency();
 101     }
 102
 103     private final class AppPeerModuleTracker implements BGPConfigModuleTracker {
 104
 105         private final BGPOpenconfigMapper<BGPAppPeerInstanceConfiguration> appProvider;
 106         private final BGPAppPeerInstanceConfiguration bgpAppPeerInstanceConfiguration;
 107
 108         AppPeerModuleTracker(final Optional<BGPOpenConfigProvider> openConfigProvider) {
 109             if (openConfigProvider.isPresent()) {
 110                 this.appProvider = openConfigProvider.get().getOpenConfigMapper(BGPAppPeerInstanceConfiguration.class);
 111             } else {
 112                 this.appProvider = null;
 113             }
 114             final InstanceConfigurationIdentifier identifier = new InstanceConfigurationIdentifier(getIdentifier().getInstanceName());
 115             this.bgpAppPeerInstanceConfiguration = new BGPAppPeerInstanceConfiguration(identifier, getApplicationRibId().getValue(),
 116                     getBgpPeerId());
 117         }
 118
 119         @Override
 120         public void onInstanceCreate() {
 121             if (this.appProvider != null) {
 122                 this.appProvider.writeConfiguration(this.bgpAppPeerInstanceConfiguration);
 123             }
 124         }
 125
 126         @Override
 127         public void onInstanceClose() {
 128             if (this.appProvider != null) {
 129                 this.appProvider.removeConfiguration(this.bgpAppPeerInstanceConfiguration);
 130             }
 131         }
 132
 133     }
 134 }