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 com.google.common.base.Function;
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.Collections2;
  14 import com.google.common.collect.ImmutableList;
  15 import com.google.common.collect.ImmutableList.Builder;
  16 import com.google.common.collect.Lists;
  17 import com.google.common.collect.Maps;
  18 import com.google.common.collect.Sets;
  19 import java.util.ArrayList;
  20 import java.util.Collection;
  21 import java.util.Collections;
  22 import java.util.HashSet;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Set;
  26 import org.opendaylight.netconf.api.capability.BasicCapability;
  27 import org.opendaylight.netconf.api.capability.Capability;
  28 import org.opendaylight.netconf.api.monitoring.CapabilityListener;
  29 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
  30 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
  31 import org.opendaylight.netconf.notifications.BaseNotificationPublisherRegistration;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.CapabilitiesBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SchemasBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaKey;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChangeBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.ChangedByBuilder;
  44 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;
  45
  46 class NetconfCapabilityMonitoringService implements CapabilityListener, AutoCloseable {
  47
  48     private static final Schema.Location NETCONF_LOCATION = new Schema.Location(Schema.Location.Enumeration.NETCONF);
  49     private static final List<Schema.Location> NETCONF_LOCATIONS = ImmutableList.of(NETCONF_LOCATION);
  50     private static final BasicCapability CANDIDATE_CAPABILITY =
  51             new BasicCapability("urn:ietf:params:netconf:capability:candidate: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 = Maps.newHashMap();
  56     private final Map<String, Map<String, String>> mappedModulesToRevisionToSchema = Maps.newHashMap();
  57
  58
  59     private final Set<NetconfMonitoringService.CapabilitiesListener> listeners = Sets.newHashSet();
  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 RuntimeException e) {
  72             throw e;
  73         } catch (final Exception e) {
  74             throw new IllegalStateException("Exception while closing", e);
  75         }
  76     }
  77
  78     synchronized String getSchemaForModuleRevision(final String moduleName, final Optional<String> revision) {
  79
  80         Map<String, String> revisionMapRequest = mappedModulesToRevisionToSchema.get(moduleName);
  81         Preconditions.checkState(revisionMapRequest != null,
  82                 "Capability for module %s not present, available modules : %s",
  83                 moduleName, Collections2.transform(capabilities.values(), CAPABILITY_TO_URI));
  84
  85         if (revision.isPresent()) {
  86             String schema = revisionMapRequest.get(revision.get());
  87
  88             Preconditions.checkState(schema != null,
  89                     "Capability for module %s:%s not present, available revisions for module: %s", moduleName,
  90                     revision.get(), revisionMapRequest.keySet());
  91
  92             return schema;
  93         }
  94
  95         Preconditions.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                 continue;
 106             }
 107
 108             final String currentModuleName = cap.getModuleName().get();
 109             Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(currentModuleName);
 110             if (revisionMap == null) {
 111                 revisionMap = Maps.newHashMap();
 112                 mappedModulesToRevisionToSchema.put(currentModuleName, revisionMap);
 113             }
 114
 115             final String currentRevision = cap.getRevision().get();
 116             revisionMap.put(currentRevision, cap.getCapabilitySchema().get());
 117         }
 118         for (final Capability cap : removed) {
 119             if (!isValidModuleCapability(cap)) {
 120                 continue;
 121             }
 122             final Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(cap.getModuleName().get());
 123             if (revisionMap != null) {
 124                 revisionMap.remove(cap.getRevision().get());
 125                 if (revisionMap.isEmpty()) {
 126                     mappedModulesToRevisionToSchema.remove(cap.getModuleName().get());
 127                 }
 128             }
 129         }
 130     }
 131
 132     private static boolean isValidModuleCapability(final Capability cap) {
 133         return cap.getModuleName().isPresent()
 134                 && cap.getRevision().isPresent()
 135                 && cap.getCapabilitySchema().isPresent();
 136     }
 137
 138
 139     synchronized Capabilities getCapabilities() {
 140         return new CapabilitiesBuilder().setCapability(Lists.newArrayList(capabilities.keySet())).build();
 141     }
 142
 143     synchronized AutoCloseable registerListener(final NetconfMonitoringService.CapabilitiesListener listener) {
 144         listeners.add(listener);
 145         listener.onCapabilitiesChanged(getCapabilities());
 146         listener.onSchemasChanged(getSchemas());
 147         return () -> {
 148             synchronized (NetconfCapabilityMonitoringService.this) {
 149                 listeners.remove(listener);
 150             }
 151         };
 152     }
 153
 154     private static Schemas transformSchemas(final Set<Capability> caps) {
 155         final List<Schema> schemas = new ArrayList<>(caps.size());
 156         for (final Capability cap : caps) {
 157             if (cap.getCapabilitySchema().isPresent()) {
 158                 final SchemaBuilder builder = new SchemaBuilder();
 159
 160                 Preconditions.checkState(isValidModuleCapability(cap));
 161
 162                 builder.setNamespace(new Uri(cap.getModuleNamespace().get()));
 163
 164                 final String version = cap.getRevision().get();
 165                 builder.setVersion(version);
 166
 167                 final String identifier = cap.getModuleName().get();
 168                 builder.setIdentifier(identifier);
 169
 170                 builder.setFormat(Yang.class);
 171
 172                 builder.setLocation(transformLocations(cap.getLocation()));
 173
 174                 builder.withKey(new SchemaKey(Yang.class, identifier, version));
 175
 176                 schemas.add(builder.build());
 177             }
 178         }
 179
 180         return new SchemasBuilder().setSchema(schemas).build();
 181     }
 182
 183     private static List<Schema.Location> transformLocations(final Collection<String> locations) {
 184         if (locations.isEmpty()) {
 185             return NETCONF_LOCATIONS;
 186         }
 187
 188         final Builder<Schema.Location> b = ImmutableList.builder();
 189         b.add(NETCONF_LOCATION);
 190
 191         for (final String location : locations) {
 192             b.add(new Schema.Location(new Uri(location)));
 193         }
 194
 195         return b.build();
 196     }
 197
 198     private static Set<Capability> setupCapabilities(final Set<Capability> caps) {
 199         Set<Capability> capabilities = new HashSet<>(caps);
 200         capabilities.add(CANDIDATE_CAPABILITY);
 201         // TODO rollback on error not supported EditConfigXmlParser:100
 202         // [RFC6241] 8.5.  Rollback-on-Error Capability
 203         // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
 204         return capabilities;
 205     }
 206
 207     @Override
 208     public synchronized void close() throws Exception {
 209         listeners.clear();
 210         capabilities.clear();
 211     }
 212
 213     @Override
 214     public synchronized void onCapabilitiesChanged(final Set<Capability> added, final Set<Capability> removed) {
 215         onCapabilitiesAdded(added);
 216         onCapabilitiesRemoved(removed);
 217         updateCapabilityToSchemaMap(added, removed);
 218         notifyCapabilityChanged(getCapabilities());
 219
 220         // publish notification to notification collector about changed capabilities
 221         if (notificationPublisher != null) {
 222             notificationPublisher.onCapabilityChanged(computeDiff(added, removed));
 223         }
 224     }
 225
 226     private void notifyCapabilityChanged(final Capabilities newCapabilities) {
 227         for (NetconfMonitoringService.CapabilitiesListener listener : listeners) {
 228             listener.onCapabilitiesChanged(newCapabilities);
 229             listener.onSchemasChanged(getSchemas());
 230         }
 231     }
 232
 233
 234     private static NetconfCapabilityChange computeDiff(final Set<Capability> added, final Set<Capability> removed) {
 235         final NetconfCapabilityChangeBuilder netconfCapabilityChangeBuilder = new NetconfCapabilityChangeBuilder();
 236         netconfCapabilityChangeBuilder
 237                 .setChangedBy(new ChangedByBuilder().setServerOrUser(
 238                     new ServerBuilder().setServer(Boolean.TRUE).build()).build());
 239         netconfCapabilityChangeBuilder.setDeletedCapability(Lists.newArrayList(Collections2
 240                 .transform(removed, CAPABILITY_TO_URI)));
 241         netconfCapabilityChangeBuilder.setAddedCapability(Lists.newArrayList(Collections2
 242                 .transform(added, CAPABILITY_TO_URI)));
 243         // TODO modified should be computed ... but why ?
 244         netconfCapabilityChangeBuilder.setModifiedCapability(Collections.<Uri>emptyList());
 245         return netconfCapabilityChangeBuilder.build();
 246     }
 247
 248
 249     private void onCapabilitiesAdded(final Set<Capability> addedCaps) {
 250         this.capabilities.putAll(Maps.uniqueIndex(setupCapabilities(addedCaps), CAPABILITY_TO_URI));
 251     }
 252
 253     private void onCapabilitiesRemoved(final Set<Capability> removedCaps) {
 254         for (final Capability addedCap : removedCaps) {
 255             capabilities.remove(new Uri(addedCap.getCapabilityUri()));
 256         }
 257     }
 258
 259     void setNotificationPublisher(final BaseNotificationPublisherRegistration notificationPublisher) {
 260         this.notificationPublisher = notificationPublisher;
 261     }
 262 }