HoneyNode Java 11 support for 121 devices
[transportpce.git] / tests / honeynode / 1.2.1 / netconf-impl / src / main / java / org / opendaylight / netconf / impl / osgi / NetconfOperationRouterImpl.java
diff --git a/tests/honeynode/1.2.1/netconf-impl/src/main/java/org/opendaylight/netconf/impl/osgi/NetconfOperationRouterImpl.java b/tests/honeynode/1.2.1/netconf-impl/src/main/java/org/opendaylight/netconf/impl/osgi/NetconfOperationRouterImpl.java
new file mode 100644 (file)
index 0000000..449b0db
--- /dev/null
@@ -0,0 +1,198 @@
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.netconf.impl.osgi;
+
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Maps;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.NavigableMap;
+import java.util.Set;
+import java.util.TreeMap;
+import org.opendaylight.netconf.api.DocumentedException;
+import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
+import org.opendaylight.netconf.api.xml.XmlUtil;
+import org.opendaylight.netconf.impl.NetconfServerSession;
+import org.opendaylight.netconf.impl.mapping.operations.DefaultCloseSession;
+import org.opendaylight.netconf.impl.mapping.operations.DefaultNetconfOperation;
+import org.opendaylight.netconf.impl.mapping.operations.DefaultStartExi;
+import org.opendaylight.netconf.impl.mapping.operations.DefaultStopExi;
+import org.opendaylight.netconf.mapping.api.HandlingPriority;
+import org.opendaylight.netconf.mapping.api.NetconfOperation;
+import org.opendaylight.netconf.mapping.api.NetconfOperationChainedExecution;
+import org.opendaylight.netconf.mapping.api.NetconfOperationService;
+import org.opendaylight.netconf.mapping.api.SessionAwareNetconfOperation;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.w3c.dom.Document;
+
+public class NetconfOperationRouterImpl implements NetconfOperationRouter {
+
+    private static final Logger LOG = LoggerFactory.getLogger(NetconfOperationRouterImpl.class);
+    private final NetconfOperationService netconfOperationServiceSnapshot;
+    private final Collection<NetconfOperation> allNetconfOperations;
+
+    public NetconfOperationRouterImpl(final NetconfOperationService netconfOperationServiceSnapshot,
+                                      final NetconfMonitoringService netconfMonitoringService, final String sessionId) {
+        this.netconfOperationServiceSnapshot = Preconditions.checkNotNull(netconfOperationServiceSnapshot);
+
+        final Set<NetconfOperation> ops = new HashSet<>();
+        ops.add(new DefaultCloseSession(sessionId, this));
+        ops.add(new DefaultStartExi(sessionId));
+        ops.add(new DefaultStopExi(sessionId));
+
+        ops.addAll(netconfOperationServiceSnapshot.getNetconfOperations());
+
+        allNetconfOperations = ImmutableSet.copyOf(ops);
+    }
+
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    @Override
+    public Document onNetconfMessage(final Document message, final NetconfServerSession session) throws
+            DocumentedException {
+        Preconditions.checkNotNull(allNetconfOperations, "Operation router was not initialized properly");
+
+        final NetconfOperationExecution netconfOperationExecution;
+        try {
+            netconfOperationExecution = getNetconfOperationWithHighestPriority(message, session);
+        } catch (IllegalArgumentException | IllegalStateException e) {
+            final String messageAsString = XmlUtil.toString(message);
+            LOG.warn("Unable to handle rpc {} on session {}", messageAsString, session, e);
+
+            final DocumentedException.ErrorTag tag;
+            if (e instanceof IllegalArgumentException) {
+                tag = DocumentedException.ErrorTag.OPERATION_NOT_SUPPORTED;
+            } else {
+                tag = DocumentedException.ErrorTag.OPERATION_FAILED;
+            }
+
+            throw new DocumentedException(
+                    String.format("Unable to handle rpc %s on session %s", messageAsString, session),
+                    e, DocumentedException.ErrorType.APPLICATION,
+                    tag, DocumentedException.ErrorSeverity.ERROR,
+                    Collections.singletonMap(tag.toString(), e.getMessage()));
+        } catch (final RuntimeException e) {
+            throw handleUnexpectedEx("Unexpected exception during netconf operation sort", e);
+        }
+
+        try {
+            return executeOperationWithHighestPriority(message, netconfOperationExecution);
+        } catch (final RuntimeException e) {
+            throw handleUnexpectedEx("Unexpected exception during netconf operation execution", e);
+        }
+    }
+
+    @Override
+    public void close() {
+        netconfOperationServiceSnapshot.close();
+    }
+
+    private static DocumentedException handleUnexpectedEx(final String message, final Exception exception) {
+        LOG.error("{}", message, exception);
+        return new DocumentedException("Unexpected error",
+                DocumentedException.ErrorType.APPLICATION,
+                DocumentedException.ErrorTag.OPERATION_FAILED,
+                DocumentedException.ErrorSeverity.ERROR,
+                Collections.singletonMap(DocumentedException.ErrorSeverity.ERROR.toString(), exception.toString()));
+    }
+
+    private static Document executeOperationWithHighestPriority(final Document message,
+            final NetconfOperationExecution netconfOperationExecution) throws DocumentedException {
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("Forwarding netconf message {} to {}", XmlUtil.toString(message), netconfOperationExecution
+                    .netconfOperation);
+        }
+
+        return netconfOperationExecution.execute(message);
+    }
+
+    private NetconfOperationExecution getNetconfOperationWithHighestPriority(
+            final Document message, final NetconfServerSession session) throws DocumentedException {
+
+        final NavigableMap<HandlingPriority, NetconfOperation> sortedByPriority =
+                getSortedNetconfOperationsWithCanHandle(
+                message, session);
+
+        if (sortedByPriority.isEmpty()) {
+            throw new IllegalArgumentException(String.format("No %s available to handle message %s",
+                    NetconfOperation.class.getName(), XmlUtil.toString(message)));
+        }
+
+        return NetconfOperationExecution.createExecutionChain(sortedByPriority, sortedByPriority.lastKey());
+    }
+
+    private TreeMap<HandlingPriority, NetconfOperation> getSortedNetconfOperationsWithCanHandle(
+            final Document message, final NetconfServerSession session) throws DocumentedException {
+        final TreeMap<HandlingPriority, NetconfOperation> sortedPriority = Maps.newTreeMap();
+
+        for (final NetconfOperation netconfOperation : allNetconfOperations) {
+            final HandlingPriority handlingPriority = netconfOperation.canHandle(message);
+            if (netconfOperation instanceof DefaultNetconfOperation) {
+                ((DefaultNetconfOperation) netconfOperation).setNetconfSession(session);
+            }
+            if (netconfOperation instanceof SessionAwareNetconfOperation) {
+                ((SessionAwareNetconfOperation) netconfOperation).setSession(session);
+            }
+            if (!handlingPriority.equals(HandlingPriority.CANNOT_HANDLE)) {
+
+                Preconditions.checkState(!sortedPriority.containsKey(handlingPriority),
+                        "Multiple %s available to handle message %s with priority %s, %s and %s",
+                        NetconfOperation.class.getName(), message, handlingPriority, netconfOperation, sortedPriority
+                                .get(handlingPriority));
+                sortedPriority.put(handlingPriority, netconfOperation);
+            }
+        }
+        return sortedPriority;
+    }
+
+    private static final class NetconfOperationExecution implements NetconfOperationChainedExecution {
+        private final NetconfOperation netconfOperation;
+        private final NetconfOperationChainedExecution subsequentExecution;
+
+        private NetconfOperationExecution(final NetconfOperation netconfOperation,
+                                          final NetconfOperationChainedExecution subsequentExecution) {
+            this.netconfOperation = netconfOperation;
+            this.subsequentExecution = subsequentExecution;
+        }
+
+        @Override
+        public boolean isExecutionTermination() {
+            return false;
+        }
+
+        @Override
+        public Document execute(final Document message) throws DocumentedException {
+            return netconfOperation.handle(message, subsequentExecution);
+        }
+
+        public static NetconfOperationExecution createExecutionChain(
+                final NavigableMap<HandlingPriority, NetconfOperation> sortedByPriority,
+                final HandlingPriority handlingPriority) {
+            final NetconfOperation netconfOperation = sortedByPriority.get(handlingPriority);
+            final HandlingPriority subsequentHandlingPriority = sortedByPriority.lowerKey(handlingPriority);
+
+            NetconfOperationChainedExecution subsequentExecution = null;
+
+            if (subsequentHandlingPriority != null) {
+                subsequentExecution = createExecutionChain(sortedByPriority, subsequentHandlingPriority);
+            } else {
+                subsequentExecution = EXECUTION_TERMINATION_POINT;
+            }
+
+            return new NetconfOperationExecution(netconfOperation, subsequentExecution);
+        }
+    }
+
+    @Override
+    public String toString() {
+        return "NetconfOperationRouterImpl{" + "netconfOperationServiceSnapshot=" + netconfOperationServiceSnapshot
+                + '}';
+    }
+}