protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/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.server.osgi;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11
  12 import com.google.common.base.Function;
  13 import com.google.common.base.Throwables;
  14 import com.google.common.collect.Collections2;
  15 import com.google.common.collect.ImmutableSet;
  16 import com.google.common.collect.Maps;
  17 import java.util.Collection;
  18 import java.util.HashMap;
  19 import java.util.HashSet;
  20 import java.util.Map;
  21 import java.util.Optional;
  22 import java.util.Set;
  23 import org.opendaylight.netconf.api.CapabilityURN;
  24 import org.opendaylight.netconf.server.api.monitoring.BasicCapability;
  25 import org.opendaylight.netconf.server.api.monitoring.Capability;
  26 import org.opendaylight.netconf.server.api.monitoring.CapabilityListener;
  27 import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
  28 import org.opendaylight.netconf.server.api.notifications.BaseNotificationPublisherRegistration;
  29 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
  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.concepts.AbstractRegistration;
  44 import org.opendaylight.yangtools.concepts.Registration;
  45 import org.opendaylight.yangtools.yang.common.Empty;
  46
  47 final class NetconfCapabilityMonitoringService implements CapabilityListener, AutoCloseable {
  48     private static final Schema.Location NETCONF_LOCATION = new Schema.Location(Schema.Location.Enumeration.NETCONF);
  49     private static final Set<Schema.Location> NETCONF_LOCATIONS = Set.of(NETCONF_LOCATION);
  50     private static final BasicCapability CANDIDATE_CAPABILITY = new BasicCapability(CapabilityURN.CANDIDATE);
  51     // FIXME: hard-coded scheme here
  52     private static final BasicCapability URL_CAPABILITY = new BasicCapability(CapabilityURN.URL + "?scheme=file");
  53     private static final Function<Capability, Uri> CAPABILITY_TO_URI = input -> new Uri(input.getCapabilityUri());
  54
  55     private final NetconfOperationServiceFactory netconfOperationProvider;
  56     private final Map<Uri, Capability> capabilities = new HashMap<>();
  57     private final Map<String, Map<String, String>> mappedModulesToRevisionToSchema = new HashMap<>();
  58
  59     private final Set<NetconfMonitoringService.CapabilitiesListener> listeners = new HashSet<>();
  60     private volatile BaseNotificationPublisherRegistration notificationPublisher;
  61
  62     NetconfCapabilityMonitoringService(final NetconfOperationServiceFactory netconfOperationProvider) {
  63         this.netconfOperationProvider = netconfOperationProvider;
  64         netconfOperationProvider.registerCapabilityListener(this);
  65     }
  66
  67     @SuppressWarnings("checkstyle:IllegalCatch")
  68     synchronized Schemas getSchemas() {
  69         try {
  70             return transformSchemas(netconfOperationProvider.getCapabilities());
  71         } catch (final Exception e) {
  72             Throwables.throwIfUnchecked(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().orElseThrow(), k -> new HashMap<>())
 106                     .put(cap.getRevision().orElse(""), cap.getCapabilitySchema().orElseThrow());
 107             }
 108         }
 109         for (final Capability cap : removed) {
 110             if (isValidModuleCapability(cap)) {
 111                 final Map<String, String> revisionMap =
 112                     mappedModulesToRevisionToSchema.get(cap.getModuleName().orElseThrow());
 113                 if (revisionMap != null) {
 114                     revisionMap.remove(cap.getRevision().orElseThrow());
 115                     if (revisionMap.isEmpty()) {
 116                         mappedModulesToRevisionToSchema.remove(cap.getModuleName().orElseThrow());
 117                     }
 118                 }
 119             }
 120         }
 121     }
 122
 123     private static boolean isValidModuleCapability(final Capability cap) {
 124         return cap.getModuleName().isPresent() && cap.getCapabilitySchema().isPresent();
 125     }
 126
 127     synchronized Capabilities getCapabilities() {
 128         return new CapabilitiesBuilder().setCapability(Set.copyOf(capabilities.keySet())).build();
 129     }
 130
 131     synchronized Registration registerListener(final NetconfMonitoringService.CapabilitiesListener listener) {
 132         listeners.add(listener);
 133         listener.onCapabilitiesChanged(getCapabilities());
 134         listener.onSchemasChanged(getSchemas());
 135         return new AbstractRegistration() {
 136             @Override
 137             protected void removeRegistration() {
 138                 synchronized (NetconfCapabilityMonitoringService.this) {
 139                     listeners.remove(listener);
 140                 }
 141             }
 142         };
 143     }
 144
 145     private static Schemas transformSchemas(final Set<Capability> caps) {
 146         final Map<SchemaKey, Schema> schemas = Maps.newHashMapWithExpectedSize(caps.size());
 147         for (final Capability cap : caps) {
 148             if (isValidModuleCapability(cap)) {
 149                 final SchemaKey key = new SchemaKey(Yang.VALUE, cap.getModuleName().orElseThrow(),
 150                     cap.getRevision().orElse(""));
 151                 schemas.put(key, new SchemaBuilder()
 152                     .withKey(key)
 153                     .setNamespace(new Uri(cap.getModuleNamespace().orElseThrow()))
 154                     .setLocation(transformLocations(cap.getLocation()))
 155                     .build());
 156             }
 157         }
 158
 159         return new SchemasBuilder().setSchema(schemas).build();
 160     }
 161
 162     private static Set<Schema.Location> transformLocations(final Collection<String> locations) {
 163         if (locations.isEmpty()) {
 164             return NETCONF_LOCATIONS;
 165         }
 166
 167         final var b = ImmutableSet.<Schema.Location>builder();
 168         b.add(NETCONF_LOCATION);
 169
 170         for (final String location : locations) {
 171             b.add(new Schema.Location(new Uri(location)));
 172         }
 173
 174         return b.build();
 175     }
 176
 177     private static Set<Capability> setupCapabilities(final Set<Capability> caps) {
 178         Set<Capability> capabilities = new HashSet<>(caps);
 179         capabilities.add(CANDIDATE_CAPABILITY);
 180         capabilities.add(URL_CAPABILITY);
 181         // FIXME: rollback on error not supported EditConfigXmlParser:100
 182         // [RFC6241] 8.5.  Rollback-on-Error Capability
 183         // capabilities.add(new BasicCapability(CapabilityURN.ROLLBACK_ON_ERROR));
 184         return capabilities;
 185     }
 186
 187     @Override
 188     public synchronized void close() {
 189         listeners.clear();
 190         capabilities.clear();
 191     }
 192
 193     @Override
 194     public synchronized void onCapabilitiesChanged(final Set<Capability> added, final Set<Capability> removed) {
 195         onCapabilitiesAdded(added);
 196         onCapabilitiesRemoved(removed);
 197         updateCapabilityToSchemaMap(added, removed);
 198         notifyCapabilityChanged(getCapabilities());
 199
 200         // publish notification to notification collector about changed capabilities
 201         if (notificationPublisher != null) {
 202             notificationPublisher.onCapabilityChanged(computeDiff(added, removed));
 203         }
 204     }
 205
 206     private void notifyCapabilityChanged(final Capabilities newCapabilities) {
 207         for (NetconfMonitoringService.CapabilitiesListener listener : listeners) {
 208             listener.onCapabilitiesChanged(newCapabilities);
 209             listener.onSchemasChanged(getSchemas());
 210         }
 211     }
 212
 213
 214     private static NetconfCapabilityChange computeDiff(final Set<Capability> added, final Set<Capability> removed) {
 215         return new NetconfCapabilityChangeBuilder()
 216             .setChangedBy(new ChangedByBuilder()
 217                 .setServerOrUser(new ServerBuilder().setServer(Empty.value()).build())
 218                 .build())
 219             .setDeletedCapability(Set.copyOf(Collections2.transform(removed, CAPABILITY_TO_URI)))
 220             .setAddedCapability(Set.copyOf(Collections2.transform(added, CAPABILITY_TO_URI)))
 221             // TODO modified should be computed ... but why ?
 222             .setModifiedCapability(Set.of())
 223             .build();
 224     }
 225
 226
 227     private void onCapabilitiesAdded(final Set<Capability> addedCaps) {
 228         capabilities.putAll(Maps.uniqueIndex(setupCapabilities(addedCaps), CAPABILITY_TO_URI));
 229     }
 230
 231     private void onCapabilitiesRemoved(final Set<Capability> removedCaps) {
 232         for (final Capability addedCap : removedCaps) {
 233             capabilities.remove(new Uri(addedCap.getCapabilityUri()));
 234         }
 235     }
 236
 237     void setNotificationPublisher(final BaseNotificationPublisherRegistration notificationPublisher) {
 238         this.notificationPublisher = notificationPublisher;
 239     }
 240 }