/* * 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.controller.netconf.impl.osgi; import java.util.Collections; import java.util.HashSet; import java.util.Iterator; import java.util.LinkedList; import java.util.Map; import java.util.Set; import java.util.TreeMap; import java.util.TreeSet; import org.opendaylight.controller.netconf.api.NetconfDocumentedException; import org.opendaylight.controller.netconf.api.NetconfOperationRouter; import org.opendaylight.controller.netconf.api.NetconfSession; import org.opendaylight.controller.netconf.impl.DefaultCommitNotificationProducer; import org.opendaylight.controller.netconf.impl.mapping.CapabilityProvider; import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCloseSession; import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCommit; import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultGetSchema; import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultStartExi; import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultStopExi; import org.opendaylight.controller.netconf.mapping.api.DefaultNetconfOperation; import org.opendaylight.controller.netconf.mapping.api.HandlingPriority; import org.opendaylight.controller.netconf.mapping.api.NetconfOperation; import org.opendaylight.controller.netconf.mapping.api.NetconfOperationFilter; import org.opendaylight.controller.netconf.mapping.api.NetconfOperationFilterChain; import org.opendaylight.controller.netconf.mapping.api.NetconfOperationService; import org.opendaylight.controller.netconf.util.xml.XmlUtil; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import com.google.common.base.Preconditions; import com.google.common.collect.Maps; import com.google.common.collect.Sets; public class NetconfOperationRouterImpl implements NetconfOperationRouter { private static final Logger logger = LoggerFactory.getLogger(NetconfOperationRouterImpl.class); private final NetconfOperationServiceSnapshot netconfOperationServiceSnapshot; private final Set allNetconfOperations; private final TreeSet allSortedFilters; private final CapabilityProvider capabilityProvider; public NetconfOperationRouterImpl(NetconfOperationServiceSnapshot netconfOperationServiceSnapshot, CapabilityProvider capabilityProvider, DefaultCommitNotificationProducer commitNotifier) { this.netconfOperationServiceSnapshot = Preconditions.checkNotNull(netconfOperationServiceSnapshot); this.capabilityProvider = Preconditions.checkNotNull(capabilityProvider); final String sessionId = netconfOperationServiceSnapshot.getNetconfSessionIdForReporting(); final Set defaultNetconfOperations = Sets.newHashSet(); defaultNetconfOperations.add(new DefaultGetSchema(capabilityProvider, sessionId)); defaultNetconfOperations.add(new DefaultCloseSession(sessionId)); defaultNetconfOperations.add(new DefaultStartExi(sessionId)); defaultNetconfOperations.add(new DefaultStopExi(sessionId)); allNetconfOperations = getAllNetconfOperations(defaultNetconfOperations, netconfOperationServiceSnapshot); DefaultCommit defaultCommit = new DefaultCommit(commitNotifier, capabilityProvider, sessionId); Set defaultFilters = Sets. newHashSet(defaultCommit); allSortedFilters = getAllNetconfFilters(defaultFilters, netconfOperationServiceSnapshot); } private static Set getAllNetconfOperations(Set defaultNetconfOperations, NetconfOperationServiceSnapshot netconfOperationServiceSnapshot) { Set result = new HashSet<>(); result.addAll(defaultNetconfOperations); for (NetconfOperationService netconfOperationService : netconfOperationServiceSnapshot.getServices()) { final Set netOpsFromService = netconfOperationService.getNetconfOperations(); for (NetconfOperation netconfOperation : netOpsFromService) { Preconditions.checkState(result.contains(netconfOperation) == false, "Netconf operation %s already present", netconfOperation); result.add(netconfOperation); } } return Collections.unmodifiableSet(result); } private static TreeSet getAllNetconfFilters(Set defaultFilters, NetconfOperationServiceSnapshot netconfOperationServiceSnapshot) { TreeSet result = new TreeSet<>(defaultFilters); for (NetconfOperationService netconfOperationService : netconfOperationServiceSnapshot.getServices()) { final Set filtersFromService = netconfOperationService.getFilters(); for (NetconfOperationFilter filter : filtersFromService) { Preconditions.checkState(result.contains(filter) == false, "Filter %s already present, all filters so far: %s", filter, result); result.add(filter); } } return result; } public CapabilityProvider getCapabilityProvider() { return capabilityProvider; } @Override public synchronized Document onNetconfMessage(Document message, NetconfSession session) throws NetconfDocumentedException { NetconfOperationExecution netconfOperationExecution; String messageAsString = XmlUtil.toString(message); try { netconfOperationExecution = getNetconfOperationWithHighestPriority(message, session); } catch (IllegalArgumentException | IllegalStateException e) { logger.warn("Unable to handle rpc {} on session {}", messageAsString, session, e); String errorMessage = String.format("Unable to handle rpc %s on session %s", messageAsString, session); Map errorInfo = Maps.newHashMap(); NetconfDocumentedException.ErrorTag tag = null; if (e instanceof IllegalArgumentException) { errorInfo.put(NetconfDocumentedException.ErrorTag.operation_not_supported.toString(), e.getMessage()); tag = NetconfDocumentedException.ErrorTag.operation_not_supported; } else if (e instanceof IllegalStateException) { errorInfo.put(NetconfDocumentedException.ErrorTag.operation_failed.toString(), e.getMessage()); tag = NetconfDocumentedException.ErrorTag.operation_failed; } throw new NetconfDocumentedException(errorMessage, e, NetconfDocumentedException.ErrorType.application, tag, NetconfDocumentedException.ErrorSeverity.error, errorInfo); } catch (RuntimeException e) { throw handleUnexpectedEx("Unexpected exception during netconf operation sort", e); } try { return executeOperationWithHighestPriority(message, netconfOperationExecution, messageAsString); } catch (RuntimeException e) { throw handleUnexpectedEx("Unexpected exception during netconf operation execution", e); } } private NetconfDocumentedException handleUnexpectedEx(String s, Exception e) throws NetconfDocumentedException { logger.error(s, e); Map info = Maps.newHashMap(); info.put(NetconfDocumentedException.ErrorSeverity.error.toString(), e.toString()); return new NetconfDocumentedException("Unexpected error", NetconfDocumentedException.ErrorType.application, NetconfDocumentedException.ErrorTag.operation_failed, NetconfDocumentedException.ErrorSeverity.error, info); } private Document executeOperationWithHighestPriority(Document message, NetconfOperationExecution netconfOperationExecution, String messageAsString) throws NetconfDocumentedException { logger.debug("Forwarding netconf message {} to {}", messageAsString, netconfOperationExecution.operationWithHighestPriority); final LinkedList chain = new LinkedList<>(); chain.push(netconfOperationExecution); for (Iterator it = allSortedFilters.descendingIterator(); it.hasNext();) { final NetconfOperationFilter filter = it.next(); final NetconfOperationFilterChain prevItem = chain.getFirst(); NetconfOperationFilterChain currentItem = new NetconfOperationFilterChain() { @Override public Document execute(Document message, NetconfOperationRouter operationRouter) throws NetconfDocumentedException { logger.trace("Entering {}", filter); return filter.doFilter(message, operationRouter, prevItem); } }; chain.push(currentItem); } return chain.getFirst().execute(message, this); } private NetconfOperationExecution getNetconfOperationWithHighestPriority( Document message, NetconfSession session) { TreeMap> sortedPriority = getSortedNetconfOperationsWithCanHandle( message, session); Preconditions.checkArgument(sortedPriority.isEmpty() == false, "No %s available to handle message %s", NetconfOperation.class.getName(), XmlUtil.toString(message)); HandlingPriority highestFoundPriority = sortedPriority.lastKey(); int netconfOperationsWithHighestPriority = sortedPriority.get(highestFoundPriority).size(); Preconditions.checkState(netconfOperationsWithHighestPriority == 1, "Multiple %s available to handle message %s", NetconfOperation.class.getName(), message); return new NetconfOperationExecution(sortedPriority, highestFoundPriority); } private TreeMap> getSortedNetconfOperationsWithCanHandle( Document message, NetconfSession session) { TreeMap> sortedPriority = Maps.newTreeMap(); for (NetconfOperation netconfOperation : allNetconfOperations) { final HandlingPriority handlingPriority = netconfOperation.canHandle(message); if (netconfOperation instanceof DefaultNetconfOperation) { ((DefaultNetconfOperation) netconfOperation) .setNetconfSession(session); } if (handlingPriority.equals(HandlingPriority.CANNOT_HANDLE) == false) { Set netconfOperations = sortedPriority.get(handlingPriority); netconfOperations = checkIfNoOperationsOnPriority(sortedPriority, handlingPriority, netconfOperations); netconfOperations.add(netconfOperation); } } return sortedPriority; } private Set checkIfNoOperationsOnPriority( TreeMap> sortedPriority, HandlingPriority handlingPriority, Set netconfOperations) { if (netconfOperations == null) { netconfOperations = Sets.newHashSet(); sortedPriority.put(handlingPriority, netconfOperations); } return netconfOperations; } @Override public void close() { netconfOperationServiceSnapshot.close(); } private class NetconfOperationExecution implements NetconfOperationFilterChain { private final NetconfOperation operationWithHighestPriority; private NetconfOperationExecution(NetconfOperation operationWithHighestPriority) { this.operationWithHighestPriority = operationWithHighestPriority; } public NetconfOperationExecution(TreeMap> sortedPriority, HandlingPriority highestFoundPriority) { operationWithHighestPriority = sortedPriority.get(highestFoundPriority).iterator().next(); sortedPriority.remove(highestFoundPriority); } @Override public Document execute(Document message, NetconfOperationRouter router) throws NetconfDocumentedException { return operationWithHighestPriority.handle(message, router); } } @Override public String toString() { return "NetconfOperationRouterImpl{" + "netconfOperationServiceSnapshot=" + netconfOperationServiceSnapshot + '}'; } }