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