netconf/mdsal-netconf-notification/src/main/java/org/opendaylight/controller/config/yang/netconf/mdsal/notification/CapabilityChangeNotificationProducer.java

   1 /*
   2  * Copyright (c) 2015 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
   9 package org.opendaylight.controller.config.yang.netconf.mdsal.notification;
  10
  11 import com.google.common.collect.ImmutableList;
  12 import com.google.common.collect.ImmutableSet;
  13 import com.google.common.collect.Sets;
  14 import java.util.Collection;
  15 import java.util.Collections;
  16 import java.util.Set;
  17 import javax.annotation.Nonnull;
  18 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  19 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  20 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  21 import org.opendaylight.netconf.notifications.BaseNotificationPublisherRegistration;
  22 import org.opendaylight.netconf.notifications.NetconfNotificationCollector;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChangeBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.ChangedByBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.changed.by.server.or.user.ServerBuilder;
  29 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  30 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34
  35 /**
  36  * Listens on capabilities changes in data store and publishes them to base
  37  * netconf notification stream listener.
  38  */
  39 public final class CapabilityChangeNotificationProducer extends OperationalDatastoreListener<Capabilities>
  40     implements AutoCloseable {
  41
  42     private static final InstanceIdentifier<Capabilities> CAPABILITIES_INSTANCE_IDENTIFIER =
  43             InstanceIdentifier.create(NetconfState.class).child(Capabilities.class);
  44     private static final Logger LOG = LoggerFactory.getLogger(CapabilityChangeNotificationProducer.class);
  45
  46     private final BaseNotificationPublisherRegistration baseNotificationPublisherRegistration;
  47     private final ListenerRegistration capabilityChangeListenerRegistration;
  48
  49     public CapabilityChangeNotificationProducer(final NetconfNotificationCollector netconfNotificationCollector,
  50                                                 final DataBroker dataBroker) {
  51         super(CAPABILITIES_INSTANCE_IDENTIFIER);
  52         this.baseNotificationPublisherRegistration = netconfNotificationCollector.registerBaseNotificationPublisher();
  53         this.capabilityChangeListenerRegistration = registerOnChanges(dataBroker);
  54     }
  55
  56     @Override
  57     public void onDataTreeChanged(@Nonnull Collection<DataTreeModification<Capabilities>> changes) {
  58         for (DataTreeModification<Capabilities> change : changes) {
  59             final DataObjectModification<Capabilities> rootNode = change.getRootNode();
  60             final DataObjectModification.ModificationType modificationType = rootNode.getModificationType();
  61             switch (modificationType) {
  62                 case WRITE: {
  63                     final Capabilities dataAfter = rootNode.getDataAfter();
  64                     final Capabilities dataBefore = rootNode.getDataBefore();
  65                     final Set<Uri> before = dataBefore != null ? ImmutableSet.copyOf(dataBefore.getCapability()) :
  66                             Collections.emptySet();
  67                     final Set<Uri> after = dataAfter != null ? ImmutableSet.copyOf(dataAfter.getCapability()) :
  68                             Collections.emptySet();
  69                     final Set<Uri> added = Sets.difference(after, before);
  70                     final Set<Uri> removed = Sets.difference(before, after);
  71                     publishNotification(added, removed);
  72                     break;
  73                 }
  74                 case DELETE: {
  75                     final Capabilities dataBeforeDelete = rootNode.getDataBefore();
  76                     if (dataBeforeDelete != null) {
  77                         final Set<Uri> removed = ImmutableSet.copyOf(dataBeforeDelete.getCapability());
  78                         publishNotification(Collections.emptySet(), removed);
  79                     }
  80                     break;
  81                 }
  82                 default:
  83                     LOG.debug("Received intentionally unhandled type: {}.", modificationType);
  84             }
  85         }
  86
  87     }
  88
  89     private void publishNotification(Set<Uri> added, Set<Uri> removed) {
  90         final NetconfCapabilityChangeBuilder netconfCapabilityChangeBuilder = new NetconfCapabilityChangeBuilder();
  91         netconfCapabilityChangeBuilder.setChangedBy(new ChangedByBuilder().setServerOrUser(new ServerBuilder()
  92                 .setServer(true).build()).build());
  93         netconfCapabilityChangeBuilder.setAddedCapability(ImmutableList.copyOf(added));
  94         netconfCapabilityChangeBuilder.setDeletedCapability(ImmutableList.copyOf(removed));
  95         // TODO modified should be computed ... but why ?
  96         netconfCapabilityChangeBuilder.setModifiedCapability(Collections.emptyList());
  97         baseNotificationPublisherRegistration.onCapabilityChanged(netconfCapabilityChangeBuilder.build());
  98     }
  99
 100     /**
 101      * Invoked by blueprint.
 102      */
 103     public void close() {
 104         if (baseNotificationPublisherRegistration != null) {
 105             baseNotificationPublisherRegistration.close();
 106         }
 107         if (capabilityChangeListenerRegistration != null) {
 108             capabilityChangeListenerRegistration.close();
 109         }
 110     }
 111 }