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