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