netconf/netconf-impl/src/main/java/org/opendaylight/netconf/impl/osgi/NetconfCapabilityMonitoringService.java

   1 /*
   2  * Copyright (c) 2016 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.impl.osgi;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static org.opendaylight.netconf.api.xml.XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_CANDIDATE_1_0;
  12 import static org.opendaylight.netconf.api.xml.XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_URL_1_0;
  13
  14 import com.google.common.base.Function;
  15 import com.google.common.collect.Collections2;
  16 import com.google.common.collect.ImmutableSet;
  17 import com.google.common.collect.Maps;
  18 import java.util.Collection;
  19 import java.util.HashMap;
  20 import java.util.HashSet;
  21 import java.util.Map;
  22 import java.util.Optional;
  23 import java.util.Set;
  24 import org.opendaylight.netconf.api.capability.BasicCapability;
  25 import org.opendaylight.netconf.api.capability.Capability;
  26 import org.opendaylight.netconf.api.monitoring.CapabilityListener;
  27 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
  28 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
  29 import org.opendaylight.netconf.notifications.BaseNotificationPublisherRegistration;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.CapabilitiesBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SchemasBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaKey;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChangeBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.ChangedByBuilder;
  42 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;
  43 import org.opendaylight.yangtools.yang.common.Empty;
  44
  45 final class NetconfCapabilityMonitoringService implements CapabilityListener, AutoCloseable {
  46     private static final Schema.Location NETCONF_LOCATION = new Schema.Location(Schema.Location.Enumeration.NETCONF);
  47     private static final Set<Schema.Location> NETCONF_LOCATIONS = Set.of(NETCONF_LOCATION);
  48     private static final BasicCapability CANDIDATE_CAPABILITY =
  49             new BasicCapability(URN_IETF_PARAMS_NETCONF_CAPABILITY_CANDIDATE_1_0);
  50     private static final BasicCapability URL_CAPABILITY =
  51             new BasicCapability(URN_IETF_PARAMS_NETCONF_CAPABILITY_URL_1_0);
  52     private static final Function<Capability, Uri> CAPABILITY_TO_URI = input -> new Uri(input.getCapabilityUri());
  53
  54     private final NetconfOperationServiceFactory netconfOperationProvider;
  55     private final Map<Uri, Capability> capabilities = new HashMap<>();
  56     private final Map<String, Map<String, String>> mappedModulesToRevisionToSchema = new HashMap<>();
  57
  58     private final Set<NetconfMonitoringService.CapabilitiesListener> listeners = new HashSet<>();
  59     private volatile BaseNotificationPublisherRegistration notificationPublisher;
  60
  61     NetconfCapabilityMonitoringService(final NetconfOperationServiceFactory netconfOperationProvider) {
  62         this.netconfOperationProvider = netconfOperationProvider;
  63         netconfOperationProvider.registerCapabilityListener(this);
  64     }
  65
  66     @SuppressWarnings("checkstyle:IllegalCatch")
  67     synchronized Schemas getSchemas() {
  68         try {
  69             return transformSchemas(netconfOperationProvider.getCapabilities());
  70         } catch (final RuntimeException e) {
  71             throw e;
  72         } catch (final Exception e) {
  73             throw new IllegalStateException("Exception while closing", e);
  74         }
  75     }
  76
  77     synchronized String getSchemaForModuleRevision(final String moduleName, final Optional<String> revision) {
  78         final Map<String, String> revisionMapRequest = mappedModulesToRevisionToSchema.get(moduleName);
  79         checkState(revisionMapRequest != null,
  80                 "Capability for module %s not present, available modules : %s",
  81                 moduleName, Collections2.transform(capabilities.values(), CAPABILITY_TO_URI));
  82
  83         final String revToLookup = revision.orElse("");
  84         final String schema = revisionMapRequest.get(revToLookup);
  85         if (schema != null) {
  86             // Exact match found
  87             return schema;
  88         }
  89
  90         // We can recover only if the revision was not specified
  91         checkState(revision.isEmpty(),
  92             "Capability for module %s:%s not present, available revisions for module: %s", moduleName,
  93             revToLookup, revisionMapRequest.keySet());
  94
  95         checkState(revisionMapRequest.size() == 1,
  96                 "Expected 1 capability for module %s, available revisions : %s", moduleName,
  97                 revisionMapRequest.keySet());
  98         // Only one revision is present, so return it
  99         return revisionMapRequest.values().iterator().next();
 100     }
 101
 102     private void updateCapabilityToSchemaMap(final Set<Capability> added, final Set<Capability> removed) {
 103         for (final Capability cap : added) {
 104             if (isValidModuleCapability(cap)) {
 105                 mappedModulesToRevisionToSchema.computeIfAbsent(cap.getModuleName().get(), k -> new HashMap<>())
 106                     .put(cap.getRevision().orElse(""), cap.getCapabilitySchema().get());
 107             }
 108         }
 109         for (final Capability cap : removed) {
 110             if (isValidModuleCapability(cap)) {
 111                 final Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(cap.getModuleName().get());
 112                 if (revisionMap != null) {
 113                     revisionMap.remove(cap.getRevision().get());
 114                     if (revisionMap.isEmpty()) {
 115                         mappedModulesToRevisionToSchema.remove(cap.getModuleName().get());
 116                     }
 117                 }
 118             }
 119         }
 120     }
 121
 122     private static boolean isValidModuleCapability(final Capability cap) {
 123         return cap.getModuleName().isPresent() && cap.getCapabilitySchema().isPresent();
 124     }
 125
 126     synchronized Capabilities getCapabilities() {
 127         return new CapabilitiesBuilder().setCapability(Set.copyOf(capabilities.keySet())).build();
 128     }
 129
 130     synchronized AutoCloseable registerListener(final NetconfMonitoringService.CapabilitiesListener listener) {
 131         listeners.add(listener);
 132         listener.onCapabilitiesChanged(getCapabilities());
 133         listener.onSchemasChanged(getSchemas());
 134         return () -> {
 135             synchronized (NetconfCapabilityMonitoringService.this) {
 136                 listeners.remove(listener);
 137             }
 138         };
 139     }
 140
 141     private static Schemas transformSchemas(final Set<Capability> caps) {
 142         final Map<SchemaKey, Schema> schemas = Maps.newHashMapWithExpectedSize(caps.size());
 143         for (final Capability cap : caps) {
 144             if (isValidModuleCapability(cap)) {
 145                 final SchemaKey key = new SchemaKey(Yang.class, cap.getModuleName().get(),
 146                     cap.getRevision().orElse(""));
 147                 schemas.put(key, new SchemaBuilder()
 148                     .withKey(key)
 149                     .setNamespace(new Uri(cap.getModuleNamespace().get()))
 150                     .setLocation(transformLocations(cap.getLocation()))
 151                     .build());
 152             }
 153         }
 154
 155         return new SchemasBuilder().setSchema(schemas).build();
 156     }
 157
 158     private static Set<Schema.Location> transformLocations(final Collection<String> locations) {
 159         if (locations.isEmpty()) {
 160             return NETCONF_LOCATIONS;
 161         }
 162
 163         final var b = ImmutableSet.<Schema.Location>builder();
 164         b.add(NETCONF_LOCATION);
 165
 166         for (final String location : locations) {
 167             b.add(new Schema.Location(new Uri(location)));
 168         }
 169
 170         return b.build();
 171     }
 172
 173     private static Set<Capability> setupCapabilities(final Set<Capability> caps) {
 174         Set<Capability> capabilities = new HashSet<>(caps);
 175         capabilities.add(CANDIDATE_CAPABILITY);
 176         capabilities.add(URL_CAPABILITY);
 177         // TODO rollback on error not supported EditConfigXmlParser:100
 178         // [RFC6241] 8.5.  Rollback-on-Error Capability
 179         // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
 180         return capabilities;
 181     }
 182
 183     @Override
 184     public synchronized void close() {
 185         listeners.clear();
 186         capabilities.clear();
 187     }
 188
 189     @Override
 190     public synchronized void onCapabilitiesChanged(final Set<Capability> added, final Set<Capability> removed) {
 191         onCapabilitiesAdded(added);
 192         onCapabilitiesRemoved(removed);
 193         updateCapabilityToSchemaMap(added, removed);
 194         notifyCapabilityChanged(getCapabilities());
 195
 196         // publish notification to notification collector about changed capabilities
 197         if (notificationPublisher != null) {
 198             notificationPublisher.onCapabilityChanged(computeDiff(added, removed));
 199         }
 200     }
 201
 202     private void notifyCapabilityChanged(final Capabilities newCapabilities) {
 203         for (NetconfMonitoringService.CapabilitiesListener listener : listeners) {
 204             listener.onCapabilitiesChanged(newCapabilities);
 205             listener.onSchemasChanged(getSchemas());
 206         }
 207     }
 208
 209
 210     private static NetconfCapabilityChange computeDiff(final Set<Capability> added, final Set<Capability> removed) {
 211         return new NetconfCapabilityChangeBuilder()
 212             .setChangedBy(new ChangedByBuilder()
 213                 .setServerOrUser(new ServerBuilder().setServer(Empty.value()).build())
 214                 .build())
 215             .setDeletedCapability(Set.copyOf(Collections2.transform(removed, CAPABILITY_TO_URI)))
 216             .setAddedCapability(Set.copyOf(Collections2.transform(added, CAPABILITY_TO_URI)))
 217             // TODO modified should be computed ... but why ?
 218             .setModifiedCapability(Set.of())
 219             .build();
 220     }
 221
 222
 223     private void onCapabilitiesAdded(final Set<Capability> addedCaps) {
 224         capabilities.putAll(Maps.uniqueIndex(setupCapabilities(addedCaps), CAPABILITY_TO_URI));
 225     }
 226
 227     private void onCapabilitiesRemoved(final Set<Capability> removedCaps) {
 228         for (final Capability addedCap : removedCaps) {
 229             capabilities.remove(new Uri(addedCap.getCapabilityUri()));
 230         }
 231     }
 232
 233     void setNotificationPublisher(final BaseNotificationPublisherRegistration notificationPublisher) {
 234         this.notificationPublisher = notificationPublisher;
 235     }
 236 }