netconf/netconf-impl/src/main/java/org/opendaylight/netconf/impl/osgi/NetconfMonitoringServiceImpl.java

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