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