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.controller.config.util.capability.BasicCapability;
  27 import org.opendaylight.controller.config.util.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 = new Function<Capability, Uri>() {
  53         @Override
  54         public Uri apply(final Capability input) {
  55             return new Uri(input.getCapabilityUri());
  56         }
  57     };
  58
  59     private final NetconfOperationServiceFactory netconfOperationProvider;
  60     private final Map<Uri, Capability> capabilities = Maps.newHashMap();
  61     private final Map<String, Map<String, String>> mappedModulesToRevisionToSchema = Maps.newHashMap();
  62
  63
  64     private final Set<NetconfMonitoringService.CapabilitiesListener> listeners = Sets.newHashSet();
  65     private volatile BaseNotificationPublisherRegistration notificationPublisher;
  66
  67     NetconfCapabilityMonitoringService(final NetconfOperationServiceFactory netconfOperationProvider) {
  68         this.netconfOperationProvider = netconfOperationProvider;
  69         netconfOperationProvider.registerCapabilityListener(this);
  70     }
  71
  72     @SuppressWarnings("checkstyle:IllegalCatch")
  73     synchronized Schemas getSchemas() {
  74         try {
  75             return transformSchemas(netconfOperationProvider.getCapabilities());
  76         } catch (final RuntimeException e) {
  77             throw e;
  78         } catch (final Exception e) {
  79             throw new IllegalStateException("Exception while closing", e);
  80         }
  81     }
  82
  83     synchronized String getSchemaForModuleRevision(final String moduleName, final Optional<String> revision) {
  84
  85         Map<String, String> revisionMapRequest = mappedModulesToRevisionToSchema.get(moduleName);
  86         Preconditions.checkState(revisionMapRequest != null,
  87                 "Capability for module %s not present, available modules : %s",
  88                 moduleName, Collections2.transform(capabilities.values(), CAPABILITY_TO_URI));
  89
  90         if (revision.isPresent()) {
  91             String schema = revisionMapRequest.get(revision.get());
  92
  93             Preconditions.checkState(schema != null,
  94                     "Capability for module %s:%s not present, available revisions for module: %s", moduleName,
  95                     revision.get(), revisionMapRequest.keySet());
  96
  97             return schema;
  98         } else {
  99             Preconditions.checkState(revisionMapRequest.size() == 1,
 100                     "Expected 1 capability for module %s, available revisions : %s", moduleName,
 101                     revisionMapRequest.keySet());
 102             //Only one revision is present, so return it
 103             return revisionMapRequest.values().iterator().next();
 104         }
 105     }
 106
 107     private void updateCapabilityToSchemaMap(final Set<Capability> added, final Set<Capability> removed) {
 108         for (final Capability cap : added) {
 109             if (!isValidModuleCapability(cap)) {
 110                 continue;
 111             }
 112
 113             final String currentModuleName = cap.getModuleName().get();
 114             Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(currentModuleName);
 115             if (revisionMap == null) {
 116                 revisionMap = Maps.newHashMap();
 117                 mappedModulesToRevisionToSchema.put(currentModuleName, revisionMap);
 118             }
 119
 120             final String currentRevision = cap.getRevision().get();
 121             revisionMap.put(currentRevision, cap.getCapabilitySchema().get());
 122         }
 123         for (final Capability cap : removed) {
 124             if (!isValidModuleCapability(cap)) {
 125                 continue;
 126             }
 127             final Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(cap.getModuleName().get());
 128             if (revisionMap != null) {
 129                 revisionMap.remove(cap.getRevision().get());
 130                 if (revisionMap.isEmpty()) {
 131                     mappedModulesToRevisionToSchema.remove(cap.getModuleName().get());
 132                 }
 133             }
 134         }
 135     }
 136
 137     private static boolean isValidModuleCapability(Capability cap) {
 138         return cap.getModuleName().isPresent()
 139                 && cap.getRevision().isPresent()
 140                 && cap.getCapabilitySchema().isPresent();
 141     }
 142
 143
 144     synchronized Capabilities getCapabilities() {
 145         return new CapabilitiesBuilder().setCapability(Lists.newArrayList(capabilities.keySet())).build();
 146     }
 147
 148     synchronized AutoCloseable registerListener(final NetconfMonitoringService.CapabilitiesListener listener) {
 149         listeners.add(listener);
 150         listener.onCapabilitiesChanged(getCapabilities());
 151         listener.onSchemasChanged(getSchemas());
 152         return new AutoCloseable() {
 153             @Override
 154             public void close() throws Exception {
 155                 synchronized (NetconfCapabilityMonitoringService.this) {
 156                     listeners.remove(listener);
 157                 }
 158             }
 159         };
 160     }
 161
 162     private static Schemas transformSchemas(final Set<Capability> caps) {
 163         final List<Schema> schemas = new ArrayList<>(caps.size());
 164         for (final Capability cap : caps) {
 165             if (cap.getCapabilitySchema().isPresent()) {
 166                 final SchemaBuilder builder = new SchemaBuilder();
 167
 168                 Preconditions.checkState(isValidModuleCapability(cap));
 169
 170                 builder.setNamespace(new Uri(cap.getModuleNamespace().get()));
 171
 172                 final String version = cap.getRevision().get();
 173                 builder.setVersion(version);
 174
 175                 final String identifier = cap.getModuleName().get();
 176                 builder.setIdentifier(identifier);
 177
 178                 builder.setFormat(Yang.class);
 179
 180                 builder.setLocation(transformLocations(cap.getLocation()));
 181
 182                 builder.setKey(new SchemaKey(Yang.class, identifier, version));
 183
 184                 schemas.add(builder.build());
 185             }
 186         }
 187
 188         return new SchemasBuilder().setSchema(schemas).build();
 189     }
 190
 191     private static List<Schema.Location> transformLocations(final Collection<String> locations) {
 192         if (locations.isEmpty()) {
 193             return NETCONF_LOCATIONS;
 194         }
 195
 196         final Builder<Schema.Location> b = ImmutableList.builder();
 197         b.add(NETCONF_LOCATION);
 198
 199         for (final String location : locations) {
 200             b.add(new Schema.Location(new Uri(location)));
 201         }
 202
 203         return b.build();
 204     }
 205
 206     private static Set<Capability> setupCapabilities(final Set<Capability> caps) {
 207         Set<Capability> capabilities = new HashSet<>(caps);
 208         capabilities.add(CANDIDATE_CAPABILITY);
 209         // TODO rollback on error not supported EditConfigXmlParser:100
 210         // [RFC6241] 8.5.  Rollback-on-Error Capability
 211         // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
 212         return capabilities;
 213     }
 214
 215     @Override
 216     public synchronized void close() throws Exception {
 217         listeners.clear();
 218         capabilities.clear();
 219     }
 220
 221     @Override
 222     public synchronized void onCapabilitiesChanged(Set<Capability> added, Set<Capability> removed) {
 223         onCapabilitiesAdded(added);
 224         onCapabilitiesRemoved(removed);
 225         updateCapabilityToSchemaMap(added, removed);
 226         notifyCapabilityChanged(getCapabilities());
 227
 228         // publish notification to notification collector about changed capabilities
 229         if (notificationPublisher != null) {
 230             notificationPublisher.onCapabilityChanged(computeDiff(added, removed));
 231         }
 232     }
 233
 234     private void notifyCapabilityChanged(Capabilities capabilities) {
 235         for (NetconfMonitoringService.CapabilitiesListener listener : listeners) {
 236             listener.onCapabilitiesChanged(capabilities);
 237             listener.onSchemasChanged(getSchemas());
 238         }
 239     }
 240
 241
 242     private static NetconfCapabilityChange computeDiff(final Set<Capability> added, final Set<Capability> removed) {
 243         final NetconfCapabilityChangeBuilder netconfCapabilityChangeBuilder = new NetconfCapabilityChangeBuilder();
 244         netconfCapabilityChangeBuilder
 245                 .setChangedBy(new ChangedByBuilder().setServerOrUser(new ServerBuilder().setServer(true).build())
 246                         .build());
 247         netconfCapabilityChangeBuilder.setDeletedCapability(Lists.newArrayList(Collections2
 248                 .transform(removed, CAPABILITY_TO_URI)));
 249         netconfCapabilityChangeBuilder.setAddedCapability(Lists.newArrayList(Collections2
 250                 .transform(added, CAPABILITY_TO_URI)));
 251         // TODO modified should be computed ... but why ?
 252         netconfCapabilityChangeBuilder.setModifiedCapability(Collections.<Uri>emptyList());
 253         return netconfCapabilityChangeBuilder.build();
 254     }
 255
 256
 257     private void onCapabilitiesAdded(final Set<Capability> addedCaps) {
 258         this.capabilities.putAll(Maps.uniqueIndex(setupCapabilities(addedCaps), CAPABILITY_TO_URI));
 259     }
 260
 261     private void onCapabilitiesRemoved(final Set<Capability> removedCaps) {
 262         for (final Capability addedCap : removedCaps) {
 263             capabilities.remove(CAPABILITY_TO_URI.apply(addedCap));
 264         }
 265     }
 266
 267     void setNotificationPublisher(final BaseNotificationPublisherRegistration notificationPublisher) {
 268         this.notificationPublisher = notificationPublisher;
 269     }
 270 }