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