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