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