netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/NetconfDevice.java

   1 /*
   2  * Copyright (c) 2014 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.sal.connect.netconf;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.base.Predicates;
  14 import com.google.common.collect.Collections2;
  15 import com.google.common.collect.Lists;
  16 import com.google.common.collect.Sets;
  17 import com.google.common.util.concurrent.FluentFuture;
  18 import com.google.common.util.concurrent.FutureCallback;
  19 import com.google.common.util.concurrent.Futures;
  20 import com.google.common.util.concurrent.ListenableFuture;
  21 import com.google.common.util.concurrent.ListeningExecutorService;
  22 import com.google.common.util.concurrent.MoreExecutors;
  23 import io.netty.util.concurrent.EventExecutor;
  24 import java.util.ArrayList;
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.LinkedList;
  28 import java.util.List;
  29 import java.util.Optional;
  30 import java.util.Set;
  31 import java.util.concurrent.Callable;
  32 import java.util.concurrent.ExecutionException;
  33 import java.util.concurrent.TimeUnit;
  34 import java.util.stream.Collectors;
  35 import javax.annotation.Nonnull;
  36 import javax.annotation.concurrent.GuardedBy;
  37 import org.opendaylight.mdsal.dom.api.DOMNotification;
  38 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  39 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  40 import org.opendaylight.netconf.api.NetconfMessage;
  41 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
  42 import org.opendaylight.netconf.sal.connect.api.MessageTransformer;
  43 import org.opendaylight.netconf.sal.connect.api.NetconfDeviceSchemas;
  44 import org.opendaylight.netconf.sal.connect.api.NetconfDeviceSchemasResolver;
  45 import org.opendaylight.netconf.sal.connect.api.RemoteDevice;
  46 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceCommunicator;
  47 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  48 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  49 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  50 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  51 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceRpc;
  52 import org.opendaylight.netconf.sal.connect.netconf.schema.NetconfRemoteSchemaYangSourceProvider;
  53 import org.opendaylight.netconf.sal.connect.netconf.schema.YangLibrarySchemaYangSourceProvider;
  54 import org.opendaylight.netconf.sal.connect.netconf.schema.mapping.BaseSchema;
  55 import org.opendaylight.netconf.sal.connect.netconf.schema.mapping.NetconfMessageTransformer;
  56 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  57 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.optional.rev190614.NetconfNodeAugmentedOptional;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapabilityBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability;
  63 import org.opendaylight.yangtools.yang.common.QName;
  64 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  65 import org.opendaylight.yangtools.yang.model.repo.api.MissingSchemaSourceException;
  66 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  67 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactory;
  68 import org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository;
  69 import org.opendaylight.yangtools.yang.model.repo.api.SchemaResolutionException;
  70 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
  71 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  72 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  73 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
  74 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  75 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration;
  76 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry;
  77 import org.slf4j.Logger;
  78 import org.slf4j.LoggerFactory;
  79
  80 /**
  81  *  This is a mediator between NetconfDeviceCommunicator and NetconfDeviceSalFacade.
  82  */
  83 public class NetconfDevice
  84         implements RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> {
  85
  86     private static final Logger LOG = LoggerFactory.getLogger(NetconfDevice.class);
  87
  88     protected final RemoteDeviceId id;
  89     protected final SchemaContextFactory schemaContextFactory;
  90     protected final SchemaSourceRegistry schemaRegistry;
  91     protected final SchemaRepository schemaRepository;
  92
  93     protected final List<SchemaSourceRegistration<? extends SchemaSourceRepresentation>> sourceRegistrations =
  94             new ArrayList<>();
  95
  96     private final RemoteDeviceHandler<NetconfSessionPreferences> salFacade;
  97     private final ListeningExecutorService processingExecutor;
  98     private final DeviceActionFactory deviceActionFactory;
  99     private final NetconfDeviceSchemasResolver stateSchemasResolver;
 100     private final NotificationHandler notificationHandler;
 101     private final boolean reconnectOnSchemasChange;
 102     private final NetconfNode node;
 103     private final EventExecutor eventExecutor;
 104     private final NetconfNodeAugmentedOptional nodeOptional;
 105
 106     @GuardedBy("this")
 107     private boolean connected = false;
 108
 109     // Message transformer is constructed once the schemas are available
 110     private MessageTransformer<NetconfMessage> messageTransformer;
 111
 112     /**
 113      * Create rpc implementation capable of handling RPC for monitoring and notifications
 114      * even before the schemas of remote device are downloaded.
 115      */
 116     static NetconfDeviceRpc getRpcForInitialization(final NetconfDeviceCommunicator listener,
 117                                                     final boolean notificationSupport) {
 118         final BaseSchema baseSchema = notificationSupport
 119                 ? BaseSchema.BASE_NETCONF_CTX_WITH_NOTIFICATIONS
 120                 : BaseSchema.BASE_NETCONF_CTX;
 121
 122         return new NetconfDeviceRpc(baseSchema.getSchemaContext(), listener,
 123                 new NetconfMessageTransformer(baseSchema.getSchemaContext(), false, baseSchema));
 124     }
 125
 126     public NetconfDevice(final SchemaResourcesDTO schemaResourcesDTO, final RemoteDeviceId id,
 127                          final RemoteDeviceHandler<NetconfSessionPreferences> salFacade,
 128                          final ListeningExecutorService globalProcessingExecutor,
 129                          final boolean reconnectOnSchemasChange) {
 130         this(schemaResourcesDTO, id, salFacade, globalProcessingExecutor, reconnectOnSchemasChange, null, null, null,
 131                 null);
 132     }
 133
 134     public NetconfDevice(final SchemaResourcesDTO schemaResourcesDTO, final RemoteDeviceId id,
 135             final RemoteDeviceHandler<NetconfSessionPreferences> salFacade,
 136             final ListeningExecutorService globalProcessingExecutor, final boolean reconnectOnSchemasChange,
 137             final DeviceActionFactory deviceActionFactory, final NetconfNode node, final EventExecutor eventExecutor,
 138             final NetconfNodeAugmentedOptional nodeOptional) {
 139         this.id = id;
 140         this.reconnectOnSchemasChange = reconnectOnSchemasChange;
 141         this.deviceActionFactory = deviceActionFactory;
 142         this.node = node;
 143         this.eventExecutor = eventExecutor;
 144         this.nodeOptional = nodeOptional;
 145         this.schemaRegistry = schemaResourcesDTO.getSchemaRegistry();
 146         this.schemaRepository = schemaResourcesDTO.getSchemaRepository();
 147         this.schemaContextFactory = schemaResourcesDTO.getSchemaContextFactory();
 148         this.salFacade = salFacade;
 149         this.stateSchemasResolver = schemaResourcesDTO.getStateSchemasResolver();
 150         this.processingExecutor = requireNonNull(globalProcessingExecutor);
 151         this.notificationHandler = new NotificationHandler(salFacade, id);
 152     }
 153
 154     @Override
 155     public void onRemoteSessionUp(final NetconfSessionPreferences remoteSessionCapabilities,
 156                                   final NetconfDeviceCommunicator listener) {
 157         // SchemaContext setup has to be performed in a dedicated thread since
 158         // we are in a netty thread in this method
 159         // Yang models are being downloaded in this method and it would cause a
 160         // deadlock if we used the netty thread
 161         // http://netty.io/wiki/thread-model.html
 162         setConnected(true);
 163         LOG.debug("{}: Session to remote device established with {}", id, remoteSessionCapabilities);
 164
 165         final NetconfDeviceRpc initRpc =
 166                 getRpcForInitialization(listener, remoteSessionCapabilities.isNotificationsSupported());
 167         final DeviceSourcesResolver task =
 168                 new DeviceSourcesResolver(remoteSessionCapabilities, id, stateSchemasResolver, initRpc);
 169         final ListenableFuture<DeviceSources> sourceResolverFuture = processingExecutor.submit(task);
 170
 171         if (shouldListenOnSchemaChange(remoteSessionCapabilities)) {
 172             registerToBaseNetconfStream(initRpc, listener);
 173         }
 174
 175         final FutureCallback<DeviceSources> resolvedSourceCallback = new FutureCallback<DeviceSources>() {
 176             @Override
 177             public void onSuccess(@Nonnull final DeviceSources result) {
 178                 addProvidedSourcesToSchemaRegistry(result);
 179                 setUpSchema(result);
 180             }
 181
 182             private void setUpSchema(final DeviceSources result) {
 183                 processingExecutor.submit(new SchemaSetup(result, remoteSessionCapabilities, listener));
 184             }
 185
 186             @Override
 187             public void onFailure(final Throwable throwable) {
 188                 LOG.warn("{}: Unexpected error resolving device sources", id, throwable);
 189                 handleSalInitializationFailure(throwable, listener);
 190             }
 191         };
 192
 193         Futures.addCallback(sourceResolverFuture, resolvedSourceCallback, MoreExecutors.directExecutor());
 194     }
 195
 196     private void registerToBaseNetconfStream(final NetconfDeviceRpc deviceRpc,
 197                                              final NetconfDeviceCommunicator listener) {
 198         // TODO check whether the model describing create subscription is present in schema
 199         // Perhaps add a default schema context to support create-subscription if the model was not provided
 200         // (same as what we do for base netconf operations in transformer)
 201         final FluentFuture<DOMRpcResult> rpcResultListenableFuture = deviceRpc.invokeRpc(
 202                 NetconfMessageTransformUtil.toPath(NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME),
 203                 NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_CONTENT);
 204
 205         final NotificationHandler.NotificationFilter filter = new NotificationHandler.NotificationFilter() {
 206             @Override
 207             public Optional<DOMNotification> filterNotification(final DOMNotification notification) {
 208                 if (isCapabilityChanged(notification)) {
 209                     LOG.info("{}: Schemas change detected, reconnecting", id);
 210                     // Only disconnect is enough,
 211                     // the reconnecting nature of the connector will take care of reconnecting
 212                     listener.disconnect();
 213                     return Optional.empty();
 214                 }
 215                 return Optional.of(notification);
 216             }
 217
 218             private boolean isCapabilityChanged(final DOMNotification notification) {
 219                 return notification.getBody().getNodeType().equals(NetconfCapabilityChange.QNAME);
 220             }
 221         };
 222
 223         Futures.addCallback(rpcResultListenableFuture, new FutureCallback<DOMRpcResult>() {
 224             @Override
 225             public void onSuccess(final DOMRpcResult domRpcResult) {
 226                 notificationHandler.addNotificationFilter(filter);
 227             }
 228
 229             @Override
 230             public void onFailure(final Throwable throwable) {
 231                 LOG.warn("Unable to subscribe to base notification stream. Schemas will not be reloaded on the fly",
 232                         throwable);
 233             }
 234         }, MoreExecutors.directExecutor());
 235     }
 236
 237     private boolean shouldListenOnSchemaChange(final NetconfSessionPreferences remoteSessionCapabilities) {
 238         return remoteSessionCapabilities.isNotificationsSupported() && reconnectOnSchemasChange;
 239     }
 240
 241     private synchronized void handleSalInitializationSuccess(final SchemaContext result,
 242                                         final NetconfSessionPreferences remoteSessionCapabilities,
 243                                         final DOMRpcService deviceRpc,
 244                                         final RemoteDeviceCommunicator<NetconfMessage> listener) {
 245         //NetconfDevice.SchemaSetup can complete after NetconfDeviceCommunicator was closed. In that case do nothing,
 246         //since salFacade.onDeviceDisconnected was already called.
 247         if (connected) {
 248             final BaseSchema baseSchema =
 249                 remoteSessionCapabilities.isNotificationsSupported()
 250                         ? BaseSchema.BASE_NETCONF_CTX_WITH_NOTIFICATIONS : BaseSchema.BASE_NETCONF_CTX;
 251             this.messageTransformer = new NetconfMessageTransformer(result, true, baseSchema);
 252
 253             updateTransformer(this.messageTransformer);
 254             // salFacade.onDeviceConnected has to be called before the notification handler is initialized
 255             this.salFacade.onDeviceConnected(result, remoteSessionCapabilities, deviceRpc,
 256                     this.deviceActionFactory == null ? null : this.deviceActionFactory.createDeviceAction(
 257                             this.messageTransformer, listener, result));
 258             this.notificationHandler.onRemoteSchemaUp(this.messageTransformer);
 259
 260             LOG.info("{}: Netconf connector initialized successfully", id);
 261         } else {
 262             LOG.warn("{}: Device communicator was closed before schema setup finished.", id);
 263         }
 264     }
 265
 266     private void handleSalInitializationFailure(final Throwable throwable,
 267                                                 final RemoteDeviceCommunicator<NetconfMessage> listener) {
 268         LOG.error("{}: Initialization in sal failed, disconnecting from device", id, throwable);
 269         listener.close();
 270         onRemoteSessionDown();
 271         resetMessageTransformer();
 272     }
 273
 274     /**
 275      * Set the transformer to null as is in initial state.
 276      */
 277     private void resetMessageTransformer() {
 278         updateTransformer(null);
 279     }
 280
 281     private synchronized void updateTransformer(final MessageTransformer<NetconfMessage> transformer) {
 282         messageTransformer = transformer;
 283     }
 284
 285     private synchronized void setConnected(final boolean connected) {
 286         this.connected = connected;
 287     }
 288
 289     private void addProvidedSourcesToSchemaRegistry(final DeviceSources deviceSources) {
 290         final SchemaSourceProvider<YangTextSchemaSource> yangProvider = deviceSources.getSourceProvider();
 291         for (final SourceIdentifier sourceId : deviceSources.getProvidedSources()) {
 292             sourceRegistrations.add(schemaRegistry.registerSchemaSource(yangProvider,
 293                     PotentialSchemaSource.create(
 294                             sourceId, YangTextSchemaSource.class, PotentialSchemaSource.Costs.REMOTE_IO.getValue())));
 295         }
 296     }
 297
 298     @Override
 299     public void onRemoteSessionDown() {
 300         setConnected(false);
 301         notificationHandler.onRemoteSchemaDown();
 302
 303         salFacade.onDeviceDisconnected();
 304         for (final SchemaSourceRegistration<? extends SchemaSourceRepresentation> sourceRegistration
 305                 : sourceRegistrations) {
 306             sourceRegistration.close();
 307         }
 308         resetMessageTransformer();
 309     }
 310
 311     @Override
 312     public void onRemoteSessionFailed(final Throwable throwable) {
 313         setConnected(false);
 314         salFacade.onDeviceFailed(throwable);
 315     }
 316
 317     @Override
 318     public void onNotification(final NetconfMessage notification) {
 319         notificationHandler.handleNotification(notification);
 320     }
 321
 322     /**
 323      * Just a transfer object containing schema related dependencies. Injected in constructor.
 324      */
 325     public static class SchemaResourcesDTO {
 326         private final SchemaSourceRegistry schemaRegistry;
 327         private final SchemaRepository schemaRepository;
 328         private final SchemaContextFactory schemaContextFactory;
 329         private final NetconfDeviceSchemasResolver stateSchemasResolver;
 330
 331         public SchemaResourcesDTO(final SchemaSourceRegistry schemaRegistry,
 332                                   final SchemaRepository schemaRepository,
 333                                   final SchemaContextFactory schemaContextFactory,
 334                                   final NetconfDeviceSchemasResolver deviceSchemasResolver) {
 335             this.schemaRegistry = Preconditions.checkNotNull(schemaRegistry);
 336             this.schemaRepository = Preconditions.checkNotNull(schemaRepository);
 337             this.schemaContextFactory = Preconditions.checkNotNull(schemaContextFactory);
 338             this.stateSchemasResolver = Preconditions.checkNotNull(deviceSchemasResolver);
 339         }
 340
 341         public SchemaSourceRegistry getSchemaRegistry() {
 342             return schemaRegistry;
 343         }
 344
 345         public SchemaRepository getSchemaRepository() {
 346             return schemaRepository;
 347         }
 348
 349         public SchemaContextFactory getSchemaContextFactory() {
 350             return schemaContextFactory;
 351         }
 352
 353         public NetconfDeviceSchemasResolver getStateSchemasResolver() {
 354             return stateSchemasResolver;
 355         }
 356     }
 357
 358     /**
 359      * Schema building callable.
 360      */
 361     private static class DeviceSourcesResolver implements Callable<DeviceSources> {
 362
 363         private final NetconfDeviceRpc deviceRpc;
 364         private final NetconfSessionPreferences remoteSessionCapabilities;
 365         private final RemoteDeviceId id;
 366         private final NetconfDeviceSchemasResolver stateSchemasResolver;
 367
 368         DeviceSourcesResolver(final NetconfDeviceRpc deviceRpc,
 369                               final NetconfSessionPreferences remoteSessionCapabilities,
 370                               final RemoteDeviceId id, final NetconfDeviceSchemasResolver stateSchemasResolver) {
 371             this.deviceRpc = deviceRpc;
 372             this.remoteSessionCapabilities = remoteSessionCapabilities;
 373             this.id = id;
 374             this.stateSchemasResolver = stateSchemasResolver;
 375         }
 376
 377         DeviceSourcesResolver(final NetconfSessionPreferences remoteSessionCapabilities, final RemoteDeviceId id,
 378                                      final NetconfDeviceSchemasResolver stateSchemasResolver,
 379                                      final NetconfDeviceRpc rpcForMonitoring) {
 380             this(rpcForMonitoring, remoteSessionCapabilities, id, stateSchemasResolver);
 381         }
 382
 383         @Override
 384         public DeviceSources call() {
 385             final NetconfDeviceSchemas availableSchemas =
 386                     stateSchemasResolver.resolve(deviceRpc, remoteSessionCapabilities, id);
 387             LOG.debug("{}: Schemas exposed by ietf-netconf-monitoring: {}", id,
 388                     availableSchemas.getAvailableYangSchemasQNames());
 389
 390             final Set<QName> requiredSources = Sets.newHashSet(remoteSessionCapabilities.getModuleBasedCaps());
 391             final Set<QName> providedSources = availableSchemas.getAvailableYangSchemasQNames();
 392
 393             final Set<QName> requiredSourcesNotProvided = Sets.difference(requiredSources, providedSources);
 394             if (!requiredSourcesNotProvided.isEmpty()) {
 395                 LOG.warn("{}: Netconf device does not provide all yang models reported in hello message capabilities,"
 396                         + " required but not provided: {}", id, requiredSourcesNotProvided);
 397                 LOG.warn("{}: Attempting to build schema context from required sources", id);
 398             }
 399
 400             // Here all the sources reported in netconf monitoring are merged with those reported in hello.
 401             // It is necessary to perform this since submodules are not mentioned in hello but still required.
 402             // This clashes with the option of a user to specify supported yang models manually in configuration
 403             // for netconf-connector and as a result one is not able to fully override yang models of a device.
 404             // It is only possible to add additional models.
 405             final Set<QName> providedSourcesNotRequired = Sets.difference(providedSources, requiredSources);
 406             if (!providedSourcesNotRequired.isEmpty()) {
 407                 LOG.warn("{}: Netconf device provides additional yang models not reported in "
 408                         + "hello message capabilities: {}", id, providedSourcesNotRequired);
 409                 LOG.warn("{}: Adding provided but not required sources as required to prevent failures", id);
 410                 LOG.debug("{}: Netconf device reported in hello: {}", id, requiredSources);
 411                 requiredSources.addAll(providedSourcesNotRequired);
 412             }
 413
 414             final SchemaSourceProvider<YangTextSchemaSource> sourceProvider;
 415             if (availableSchemas instanceof LibraryModulesSchemas) {
 416                 sourceProvider = new YangLibrarySchemaYangSourceProvider(id,
 417                         ((LibraryModulesSchemas) availableSchemas).getAvailableModels());
 418             } else {
 419                 sourceProvider = new NetconfRemoteSchemaYangSourceProvider(id, deviceRpc);
 420             }
 421
 422             return new DeviceSources(requiredSources, providedSources, sourceProvider);
 423         }
 424     }
 425
 426     /**
 427      * Contains RequiredSources - sources from capabilities.
 428      */
 429     private static final class DeviceSources {
 430         private final Set<QName> requiredSources;
 431         private final Set<QName> providedSources;
 432         private final SchemaSourceProvider<YangTextSchemaSource> sourceProvider;
 433
 434         DeviceSources(final Set<QName> requiredSources, final Set<QName> providedSources,
 435                              final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
 436             this.requiredSources = requiredSources;
 437             this.providedSources = providedSources;
 438             this.sourceProvider = sourceProvider;
 439         }
 440
 441         public Set<QName> getRequiredSourcesQName() {
 442             return requiredSources;
 443         }
 444
 445         public Set<QName> getProvidedSourcesQName() {
 446             return providedSources;
 447         }
 448
 449         public Collection<SourceIdentifier> getRequiredSources() {
 450             return Collections2.transform(requiredSources, DeviceSources::toSourceId);
 451         }
 452
 453         public Collection<SourceIdentifier> getProvidedSources() {
 454             return Collections2.transform(providedSources, DeviceSources::toSourceId);
 455         }
 456
 457         public SchemaSourceProvider<YangTextSchemaSource> getSourceProvider() {
 458             return sourceProvider;
 459         }
 460
 461         private static SourceIdentifier toSourceId(final QName input) {
 462             return RevisionSourceIdentifier.create(input.getLocalName(), input.getRevision());
 463         }
 464     }
 465
 466     /**
 467      * Schema builder that tries to build schema context from provided sources or biggest subset of it.
 468      */
 469     private final class SchemaSetup implements Runnable {
 470         private final DeviceSources deviceSources;
 471         private final NetconfSessionPreferences remoteSessionCapabilities;
 472         private final RemoteDeviceCommunicator<NetconfMessage> listener;
 473         private final NetconfDeviceCapabilities capabilities;
 474
 475         SchemaSetup(final DeviceSources deviceSources, final NetconfSessionPreferences remoteSessionCapabilities,
 476                            final RemoteDeviceCommunicator<NetconfMessage> listener) {
 477             this.deviceSources = deviceSources;
 478             this.remoteSessionCapabilities = remoteSessionCapabilities;
 479             this.listener = listener;
 480             this.capabilities = remoteSessionCapabilities.getNetconfDeviceCapabilities();
 481         }
 482
 483         @Override
 484         public void run() {
 485
 486             final Collection<SourceIdentifier> requiredSources = deviceSources.getRequiredSources();
 487             final Collection<SourceIdentifier> missingSources = filterMissingSources(requiredSources);
 488
 489             capabilities.addUnresolvedCapabilities(getQNameFromSourceIdentifiers(missingSources),
 490                     UnavailableCapability.FailureReason.MissingSource);
 491
 492             requiredSources.removeAll(missingSources);
 493             setUpSchema(requiredSources);
 494         }
 495
 496         private Collection<SourceIdentifier> filterMissingSources(final Collection<SourceIdentifier> requiredSources) {
 497             return requiredSources.parallelStream().filter(sourceIdentifier -> {
 498                 try {
 499                     schemaRepository.getSchemaSource(sourceIdentifier, YangTextSchemaSource.class).get();
 500                     return false;
 501                 } catch (InterruptedException | ExecutionException e) {
 502                     return true;
 503                 }
 504             }).collect(Collectors.toList());
 505         }
 506
 507         /**
 508          * Build schema context, in case of success or final failure notify device.
 509          *
 510          * @param requiredSources required sources
 511          */
 512         @SuppressWarnings("checkstyle:IllegalCatch")
 513         private void setUpSchema(Collection<SourceIdentifier> requiredSources) {
 514             while (!requiredSources.isEmpty()) {
 515                 LOG.trace("{}: Trying to build schema context from {}", id, requiredSources);
 516                 try {
 517                     final ListenableFuture<SchemaContext> schemaBuilderFuture = schemaContextFactory
 518                             .createSchemaContext(requiredSources);
 519                     final SchemaContext result = schemaBuilderFuture.get();
 520                     LOG.debug("{}: Schema context built successfully from {}", id, requiredSources);
 521                     final Collection<QName> filteredQNames = Sets.difference(deviceSources.getRequiredSourcesQName(),
 522                             capabilities.getUnresolvedCapabilites().keySet());
 523                     capabilities.addCapabilities(filteredQNames.stream().map(entry -> new AvailableCapabilityBuilder()
 524                             .setCapability(entry.toString()).setCapabilityOrigin(
 525                                     remoteSessionCapabilities.getModuleBasedCapsOrigin().get(entry)).build())
 526                             .collect(Collectors.toList()));
 527
 528                     capabilities.addNonModuleBasedCapabilities(remoteSessionCapabilities
 529                             .getNonModuleCaps().stream().map(entry -> new AvailableCapabilityBuilder()
 530                                     .setCapability(entry).setCapabilityOrigin(
 531                                             remoteSessionCapabilities.getNonModuleBasedCapsOrigin().get(entry)).build())
 532                             .collect(Collectors.toList()));
 533
 534                     handleSalInitializationSuccess(result, remoteSessionCapabilities, getDeviceSpecificRpc(result),
 535                             listener);
 536                     return;
 537                 } catch (final ExecutionException e) {
 538                     // schemaBuilderFuture.checkedGet() throws only SchemaResolutionException
 539                     // that might be wrapping a MissingSchemaSourceException so we need to look
 540                     // at the cause of the exception to make sure we don't misinterpret it.
 541                     final Throwable cause = e.getCause();
 542
 543                     if (cause instanceof MissingSchemaSourceException) {
 544                         requiredSources = handleMissingSchemaSourceException(
 545                                 requiredSources, (MissingSchemaSourceException) cause);
 546                         continue;
 547                     }
 548                     if (cause instanceof SchemaResolutionException) {
 549                         requiredSources = handleSchemaResolutionException(requiredSources,
 550                             (SchemaResolutionException) cause);
 551                     } else {
 552                         handleSalInitializationFailure(e, listener);
 553                         return;
 554                     }
 555                 } catch (final Exception e) {
 556                     // unknown error, fail
 557                     handleSalInitializationFailure(e, listener);
 558                     return;
 559                 }
 560             }
 561             // No more sources, fail or try to reconnect
 562             if (nodeOptional != null && nodeOptional.getIgnoreMissingSchemaSources().isAllowed()) {
 563                 eventExecutor.schedule(() -> {
 564                     LOG.warn("Reconnection is allowed! This can lead to unexpected errors at runtime.");
 565                     LOG.warn("{} : No more sources for schema context.", id);
 566                     LOG.info("{} : Try to remount device.", id);
 567                     onRemoteSessionDown();
 568                     salFacade.onDeviceReconnected(remoteSessionCapabilities, node);
 569                 }, nodeOptional.getIgnoreMissingSchemaSources().getReconnectTime(), TimeUnit.MILLISECONDS);
 570             } else {
 571                 final IllegalStateException cause =
 572                         new IllegalStateException(id + ": No more sources for schema context");
 573                 handleSalInitializationFailure(cause, listener);
 574                 salFacade.onDeviceFailed(cause);
 575             }
 576         }
 577
 578         private Collection<SourceIdentifier> handleMissingSchemaSourceException(
 579                 final Collection<SourceIdentifier> requiredSources, final MissingSchemaSourceException exception) {
 580             // In case source missing, try without it
 581             final SourceIdentifier missingSource = exception.getSourceId();
 582             LOG.warn("{}: Unable to build schema context, missing source {}, will reattempt without it",
 583                 id, missingSource);
 584             LOG.debug("{}: Unable to build schema context, missing source {}, will reattempt without it",
 585                 id, missingSource, exception);
 586             final Collection<QName> qNameOfMissingSource =
 587                 getQNameFromSourceIdentifiers(Sets.newHashSet(missingSource));
 588             if (!qNameOfMissingSource.isEmpty()) {
 589                 capabilities.addUnresolvedCapabilities(
 590                         qNameOfMissingSource, UnavailableCapability.FailureReason.MissingSource);
 591             }
 592             return stripUnavailableSource(requiredSources, missingSource);
 593         }
 594
 595         private Collection<SourceIdentifier> handleSchemaResolutionException(
 596             final Collection<SourceIdentifier> requiredSources, final SchemaResolutionException resolutionException) {
 597             // In case resolution error, try only with resolved sources
 598             // There are two options why schema resolution exception occurred : unsatisfied imports or flawed model
 599             // FIXME Do we really have assurance that these two cases cannot happen at once?
 600             if (resolutionException.getFailedSource() != null) {
 601                 // flawed model - exclude it
 602                 final SourceIdentifier failedSourceId = resolutionException.getFailedSource();
 603                 LOG.warn("{}: Unable to build schema context, failed to resolve source {}, will reattempt without it",
 604                     id, failedSourceId);
 605                 LOG.warn("{}: Unable to build schema context, failed to resolve source {}, will reattempt without it",
 606                     id, failedSourceId, resolutionException);
 607                 capabilities.addUnresolvedCapabilities(
 608                         getQNameFromSourceIdentifiers(Collections.singleton(failedSourceId)),
 609                         UnavailableCapability.FailureReason.UnableToResolve);
 610                 return stripUnavailableSource(requiredSources, resolutionException.getFailedSource());
 611             }
 612             // unsatisfied imports
 613             final Set<SourceIdentifier> unresolvedSources = resolutionException.getUnsatisfiedImports().keySet();
 614             capabilities.addUnresolvedCapabilities(getQNameFromSourceIdentifiers(unresolvedSources),
 615                 UnavailableCapability.FailureReason.UnableToResolve);
 616             LOG.warn("{}: Unable to build schema context, unsatisfied imports {}, will reattempt with resolved only",
 617                 id, resolutionException.getUnsatisfiedImports());
 618             LOG.debug("{}: Unable to build schema context, unsatisfied imports {}, will reattempt with resolved only",
 619                 id, resolutionException.getUnsatisfiedImports(), resolutionException);
 620             return resolutionException.getResolvedSources();
 621         }
 622
 623         protected NetconfDeviceRpc getDeviceSpecificRpc(final SchemaContext result) {
 624             return new NetconfDeviceRpc(result, listener, new NetconfMessageTransformer(result, true));
 625         }
 626
 627         private Collection<SourceIdentifier> stripUnavailableSource(final Collection<SourceIdentifier> requiredSources,
 628                                                                     final SourceIdentifier sourceIdToRemove) {
 629             final LinkedList<SourceIdentifier> sourceIdentifiers = Lists.newLinkedList(requiredSources);
 630             final boolean removed = sourceIdentifiers.remove(sourceIdToRemove);
 631             Preconditions.checkState(
 632                     removed, "{}: Trying to remove {} from {} failed", id, sourceIdToRemove, requiredSources);
 633             return sourceIdentifiers;
 634         }
 635
 636         private Collection<QName> getQNameFromSourceIdentifiers(final Collection<SourceIdentifier> identifiers) {
 637             final Collection<QName> qNames = Collections2.transform(identifiers, this::getQNameFromSourceIdentifier);
 638
 639             if (qNames.isEmpty()) {
 640                 LOG.debug("{}: Unable to map any source identifiers to a capability reported by device : {}", id,
 641                         identifiers);
 642             }
 643             return Collections2.filter(qNames, Predicates.notNull());
 644         }
 645
 646         private QName getQNameFromSourceIdentifier(final SourceIdentifier identifier) {
 647             // Required sources are all required and provided merged in DeviceSourcesResolver
 648             for (final QName qname : deviceSources.getRequiredSourcesQName()) {
 649                 if (!qname.getLocalName().equals(identifier.getName())) {
 650                     continue;
 651                 }
 652
 653                 if (identifier.getRevision().equals(qname.getRevision())) {
 654                     return qname;
 655                 }
 656             }
 657             LOG.warn("Unable to map identifier to a devices reported capability: {} Available: {}",identifier,
 658                     deviceSources.getRequiredSourcesQName());
 659             // return null since we cannot find the QName,
 660             // this capability will be removed from required sources and not reported as unresolved-capability
 661             return null;
 662         }
 663     }
 664 }