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