Remove no-schema reconnect
[netconf.git] / netconf / sal-netconf-connector / src / main / java / org / opendaylight / netconf / sal / connect / netconf / NetconfDevice.java
index 20fe41c34849a9bfdd6a52ddd8c972ba203d26ea..89ce12533b035867ee049ff00f8ec407577a9ee7 100644 (file)
@@ -20,18 +20,14 @@ import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.ListeningExecutorService;
 import com.google.common.util.concurrent.MoreExecutors;
 import com.google.common.util.concurrent.SettableFuture;
-import io.netty.util.concurrent.EventExecutor;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
-import java.util.LinkedList;
 import java.util.List;
 import java.util.Objects;
-import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.ExecutionException;
-import java.util.concurrent.TimeUnit;
 import java.util.stream.Collectors;
 import org.checkerframework.checker.lock.qual.GuardedBy;
 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
@@ -54,10 +50,9 @@ import org.opendaylight.netconf.sal.connect.netconf.schema.mapping.NetconfMessag
 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.optional.rev190614.NetconfNodeAugmentedOptional;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapabilityBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability;
+import org.opendaylight.yangtools.concepts.Registration;
 import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
 import org.opendaylight.yangtools.rfc8528.data.util.EmptyMountPointContext;
 import org.opendaylight.yangtools.rfc8528.model.api.SchemaMountConstants;
@@ -75,9 +70,6 @@ import org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository;
 import org.opendaylight.yangtools.yang.model.repo.api.SchemaResolutionException;
 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
-import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
-import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
-import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration;
 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -85,7 +77,7 @@ import org.slf4j.LoggerFactory;
 /**
  *  This is a mediator between NetconfDeviceCommunicator and NetconfDeviceSalFacade.
  */
-public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, NetconfDeviceCommunicator> {
+public class NetconfDevice implements RemoteDevice<NetconfDeviceCommunicator> {
     private static final Logger LOG = LoggerFactory.getLogger(NetconfDevice.class);
 
     private static final QName RFC8528_SCHEMA_MOUNTS_QNAME = QName.create(
@@ -98,18 +90,15 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
     protected final SchemaSourceRegistry schemaRegistry;
     protected final SchemaRepository schemaRepository;
 
-    protected final List<SchemaSourceRegistration<?>> sourceRegistrations = new ArrayList<>();
+    protected final List<Registration> sourceRegistrations = new ArrayList<>();
 
-    private final RemoteDeviceHandler<NetconfSessionPreferences> salFacade;
+    private final RemoteDeviceHandler salFacade;
     private final ListeningExecutorService processingExecutor;
     private final DeviceActionFactory deviceActionFactory;
     private final NetconfDeviceSchemasResolver stateSchemasResolver;
     private final NotificationHandler notificationHandler;
     private final boolean reconnectOnSchemasChange;
     private final BaseNetconfSchemas baseSchemas;
-    private final NetconfNode node;
-    private final EventExecutor eventExecutor;
-    private final NetconfNodeAugmentedOptional nodeOptional;
 
     @GuardedBy("this")
     private boolean connected = false;
@@ -118,24 +107,19 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
     private MessageTransformer messageTransformer;
 
     public NetconfDevice(final SchemaResourcesDTO schemaResourcesDTO, final BaseNetconfSchemas baseSchemas,
-            final RemoteDeviceId id, final RemoteDeviceHandler<NetconfSessionPreferences> salFacade,
+            final RemoteDeviceId id, final RemoteDeviceHandler salFacade,
             final ListeningExecutorService globalProcessingExecutor, final boolean reconnectOnSchemasChange) {
-        this(schemaResourcesDTO, baseSchemas, id, salFacade, globalProcessingExecutor, reconnectOnSchemasChange, null,
-            null, null, null);
+        this(schemaResourcesDTO, baseSchemas, id, salFacade, globalProcessingExecutor, reconnectOnSchemasChange, null);
     }
 
     public NetconfDevice(final SchemaResourcesDTO schemaResourcesDTO, final BaseNetconfSchemas baseSchemas,
-            final RemoteDeviceId id, final RemoteDeviceHandler<NetconfSessionPreferences> salFacade,
+            final RemoteDeviceId id, final RemoteDeviceHandler salFacade,
             final ListeningExecutorService globalProcessingExecutor, final boolean reconnectOnSchemasChange,
-            final DeviceActionFactory deviceActionFactory, final NetconfNode node, final EventExecutor eventExecutor,
-            final NetconfNodeAugmentedOptional nodeOptional) {
+            final DeviceActionFactory deviceActionFactory) {
         this.baseSchemas = requireNonNull(baseSchemas);
         this.id = id;
         this.reconnectOnSchemasChange = reconnectOnSchemasChange;
         this.deviceActionFactory = deviceActionFactory;
-        this.node = node;
-        this.eventExecutor = eventExecutor;
-        this.nodeOptional = nodeOptional;
         schemaRegistry = schemaResourcesDTO.getSchemaRegistry();
         schemaRepository = schemaResourcesDTO.getSchemaRepository();
         schemaContextFactory = schemaResourcesDTO.getSchemaContextFactory();
@@ -184,22 +168,8 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
             @Override
             public void onFailure(final Throwable cause) {
                 LOG.warn("{}: Unexpected error resolving device sources", id, cause);
-
-                // No more sources, fail or try to reconnect
-                if (cause instanceof EmptySchemaContextException) {
-                    if (nodeOptional != null && nodeOptional.getIgnoreMissingSchemaSources().getAllowed()) {
-                        eventExecutor.schedule(() -> {
-                            LOG.warn("Reconnection is allowed! This can lead to unexpected errors at runtime.");
-                            LOG.warn("{} : No more sources for schema context.", id);
-                            LOG.info("{} : Try to remount device.", id);
-                            onRemoteSessionDown();
-                            salFacade.onDeviceReconnected(remoteSessionCapabilities, node);
-                        }, nodeOptional.getIgnoreMissingSchemaSources().getReconnectTime().toJava(),
-                            TimeUnit.MILLISECONDS);
-                        return;
-                    }
-                }
-
+                // FIXME: this causes salFacade to see onDeviceDisconnected() and then onDeviceFailed(), which is quite
+                //        weird
                 handleSalInitializationFailure(cause, listener);
                 salFacade.onDeviceFailed(cause);
             }
@@ -224,9 +194,9 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
                         // Only disconnect is enough,
                         // the reconnecting nature of the connector will take care of reconnecting
                         listener.disconnect();
-                        return Optional.empty();
+                        return false;
                     }
-                    return Optional.of(notification);
+                    return true;
                 });
             }
 
@@ -288,12 +258,8 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
     private ListenableFuture<EffectiveModelContext> assembleSchemaContext(final DeviceSources deviceSources,
             final NetconfSessionPreferences remoteSessionCapabilities) {
         LOG.debug("{}: Resolved device sources to {}", id, deviceSources);
-        final SchemaSourceProvider<YangTextSchemaSource> yangProvider = deviceSources.getSourceProvider();
-        for (final SourceIdentifier sourceId : deviceSources.getProvidedSources()) {
-            sourceRegistrations.add(schemaRegistry.registerSchemaSource(yangProvider,
-                PotentialSchemaSource.create(sourceId, YangTextSchemaSource.class,
-                    PotentialSchemaSource.Costs.REMOTE_IO.getValue())));
-        }
+
+        sourceRegistrations.addAll(deviceSources.register(schemaRegistry));
 
         return new SchemaSetup(deviceSources, remoteSessionCapabilities).startResolution();
     }
@@ -340,7 +306,7 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
         notificationHandler.onRemoteSchemaDown();
 
         salFacade.onDeviceDisconnected();
-        sourceRegistrations.forEach(SchemaSourceRegistration::close);
+        sourceRegistrations.forEach(Registration::close);
         sourceRegistrations.clear();
         resetMessageTransformer();
     }
@@ -403,14 +369,12 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
     }
 
     /**
-     * A dedicated exception to indicate when we fail to setup a SchemaContext.
-     *
-     * @author Robert Varga
+     * A dedicated exception to indicate when we fail to setup an {@link EffectiveModelContext}.
      */
-    private static final class EmptySchemaContextException extends Exception {
+    public static final class EmptySchemaContextException extends Exception {
         private static final long serialVersionUID = 1L;
 
-        EmptySchemaContextException(final String message) {
+        public EmptySchemaContextException(final String message) {
             super(message);
         }
     }
@@ -509,7 +473,7 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
             }
         }
 
-        private Collection<SourceIdentifier> filterMissingSources(final Collection<SourceIdentifier> origSources) {
+        private List<SourceIdentifier> filterMissingSources(final Collection<SourceIdentifier> origSources) {
             return origSources.parallelStream().filter(sourceIdentifier -> {
                 try {
                     schemaRepository.getSchemaSource(sourceIdentifier, YangTextSchemaSource.class).get();
@@ -520,7 +484,7 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
             }).collect(Collectors.toList());
         }
 
-        private Collection<SourceIdentifier> handleMissingSchemaSourceException(
+        private List<SourceIdentifier> handleMissingSchemaSourceException(
                 final MissingSchemaSourceException exception) {
             // In case source missing, try without it
             final SourceIdentifier missingSource = exception.getSourceId();
@@ -565,11 +529,11 @@ public class NetconfDevice implements RemoteDevice<NetconfSessionPreferences, Ne
             return resolutionException.getResolvedSources();
         }
 
-        private Collection<SourceIdentifier> stripUnavailableSource(final SourceIdentifier sourceIdToRemove) {
-            final LinkedList<SourceIdentifier> sourceIdentifiers = new LinkedList<>(requiredSources);
-            checkState(sourceIdentifiers.remove(sourceIdToRemove),
-                    "%s: Trying to remove %s from %s failed", id, sourceIdToRemove, requiredSources);
-            return sourceIdentifiers;
+        private List<SourceIdentifier> stripUnavailableSource(final SourceIdentifier sourceIdToRemove) {
+            final var tmp = new ArrayList<>(requiredSources);
+            checkState(tmp.remove(sourceIdToRemove), "%s: Trying to remove %s from %s failed", id, sourceIdToRemove,
+                requiredSources);
+            return tmp;
         }
 
         private Collection<QName> getQNameFromSourceIdentifiers(final Collection<SourceIdentifier> identifiers) {