2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.netconf.impl.osgi;
10 import com.google.common.base.Preconditions;
11 import com.google.common.collect.Maps;
12 import com.google.common.collect.Sets;
13 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
14 import org.opendaylight.controller.netconf.impl.DefaultCommitNotificationProducer;
15 import org.opendaylight.controller.netconf.impl.NetconfServerSession;
16 import org.opendaylight.controller.netconf.impl.mapping.CapabilityProvider;
17 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCloseSession;
18 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCommit;
19 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultGetSchema;
20 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultNetconfOperation;
21 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultStartExi;
22 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultStopExi;
23 import org.opendaylight.controller.netconf.mapping.api.HandlingPriority;
24 import org.opendaylight.controller.netconf.mapping.api.NetconfOperation;
25 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationChainedExecution;
26 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationService;
27 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationServiceSnapshot;
28 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
31 import org.w3c.dom.Document;
33 import java.util.Collections;
34 import java.util.HashSet;
36 import java.util.NavigableMap;
38 import java.util.TreeMap;
40 public class NetconfOperationRouterImpl implements NetconfOperationRouter {
42 private static final Logger logger = LoggerFactory.getLogger(NetconfOperationRouterImpl.class);
44 private final NetconfOperationServiceSnapshot netconfOperationServiceSnapshot;
45 private Set<NetconfOperation> allNetconfOperations;
47 private NetconfOperationRouterImpl(NetconfOperationServiceSnapshot netconfOperationServiceSnapshot) {
48 this.netconfOperationServiceSnapshot = netconfOperationServiceSnapshot;
51 private void initNetconfOperations(Set<NetconfOperation> allOperations) {
52 allNetconfOperations = allOperations;
56 * Factory method to produce instance of NetconfOperationRouter
58 public static NetconfOperationRouter createOperationRouter(NetconfOperationServiceSnapshot netconfOperationServiceSnapshot,
59 CapabilityProvider capabilityProvider, DefaultCommitNotificationProducer commitNotifier) {
60 NetconfOperationRouterImpl router = new NetconfOperationRouterImpl(netconfOperationServiceSnapshot);
62 Preconditions.checkNotNull(netconfOperationServiceSnapshot);
63 Preconditions.checkNotNull(capabilityProvider);
65 final String sessionId = netconfOperationServiceSnapshot.getNetconfSessionIdForReporting();
67 final Set<NetconfOperation> defaultNetconfOperations = Sets.newHashSet();
68 defaultNetconfOperations.add(new DefaultGetSchema(capabilityProvider, sessionId));
69 defaultNetconfOperations.add(new DefaultCloseSession(sessionId, router));
70 defaultNetconfOperations.add(new DefaultStartExi(sessionId));
71 defaultNetconfOperations.add(new DefaultStopExi(sessionId));
72 defaultNetconfOperations.add(new DefaultCommit(commitNotifier, capabilityProvider, sessionId, router));
74 router.initNetconfOperations(getAllNetconfOperations(defaultNetconfOperations, netconfOperationServiceSnapshot));
79 private static Set<NetconfOperation> getAllNetconfOperations(Set<NetconfOperation> defaultNetconfOperations,
80 NetconfOperationServiceSnapshot netconfOperationServiceSnapshot) {
81 Set<NetconfOperation> result = new HashSet<>();
82 result.addAll(defaultNetconfOperations);
84 for (NetconfOperationService netconfOperationService : netconfOperationServiceSnapshot.getServices()) {
85 final Set<NetconfOperation> netOpsFromService = netconfOperationService.getNetconfOperations();
86 for (NetconfOperation netconfOperation : netOpsFromService) {
87 Preconditions.checkState(!result.contains(netconfOperation),
88 "Netconf operation %s already present", netconfOperation);
89 result.add(netconfOperation);
92 return Collections.unmodifiableSet(result);
96 public synchronized Document onNetconfMessage(Document message,
97 NetconfServerSession session) throws NetconfDocumentedException {
98 Preconditions.checkNotNull(allNetconfOperations, "Operation router was not initialized properly");
100 NetconfOperationExecution netconfOperationExecution;
102 String messageAsString = "";
104 messageAsString = XmlUtil.toString(message);
105 netconfOperationExecution = getNetconfOperationWithHighestPriority(message, session);
106 } catch (IllegalArgumentException | IllegalStateException e) {
107 logger.warn("Unable to handle rpc {} on session {}", messageAsString, session, e);
109 String errorMessage = String.format("Unable to handle rpc %s on session %s", messageAsString, session);
110 Map<String, String> errorInfo = Maps.newHashMap();
112 NetconfDocumentedException.ErrorTag tag;
113 if (e instanceof IllegalArgumentException) {
114 errorInfo.put(NetconfDocumentedException.ErrorTag.operation_not_supported.toString(), e.getMessage());
115 tag = NetconfDocumentedException.ErrorTag.operation_not_supported;
117 errorInfo.put(NetconfDocumentedException.ErrorTag.operation_failed.toString(), e.getMessage());
118 tag = NetconfDocumentedException.ErrorTag.operation_failed;
121 throw new NetconfDocumentedException(errorMessage, e, NetconfDocumentedException.ErrorType.application,
122 tag, NetconfDocumentedException.ErrorSeverity.error, errorInfo);
123 } catch (RuntimeException e) {
124 throw handleUnexpectedEx("Unexpected exception during netconf operation sort", e);
128 return executeOperationWithHighestPriority(message, netconfOperationExecution, messageAsString);
129 } catch (RuntimeException e) {
130 throw handleUnexpectedEx("Unexpected exception during netconf operation execution", e);
135 public void close() throws Exception {
136 netconfOperationServiceSnapshot.close();
139 private NetconfDocumentedException handleUnexpectedEx(String s, Exception e) throws NetconfDocumentedException {
142 Map<String, String> info = Maps.newHashMap();
143 info.put(NetconfDocumentedException.ErrorSeverity.error.toString(), e.toString());
144 return new NetconfDocumentedException("Unexpected error",
145 NetconfDocumentedException.ErrorType.application,
146 NetconfDocumentedException.ErrorTag.operation_failed,
147 NetconfDocumentedException.ErrorSeverity.error, info);
150 private Document executeOperationWithHighestPriority(Document message,
151 NetconfOperationExecution netconfOperationExecution, String messageAsString)
152 throws NetconfDocumentedException {
153 logger.debug("Forwarding netconf message {} to {}", messageAsString, netconfOperationExecution.netconfOperation);
154 return netconfOperationExecution.execute(message);
157 private NetconfOperationExecution getNetconfOperationWithHighestPriority(
158 Document message, NetconfServerSession session) throws NetconfDocumentedException {
160 NavigableMap<HandlingPriority, NetconfOperation> sortedByPriority = getSortedNetconfOperationsWithCanHandle(
163 Preconditions.checkArgument(sortedByPriority.isEmpty() == false,
164 "No %s available to handle message %s", NetconfOperation.class.getName(),
165 XmlUtil.toString(message));
167 return NetconfOperationExecution.createExecutionChain(sortedByPriority, sortedByPriority.lastKey());
170 private TreeMap<HandlingPriority, NetconfOperation> getSortedNetconfOperationsWithCanHandle(Document message,
171 NetconfServerSession session) throws NetconfDocumentedException {
172 TreeMap<HandlingPriority, NetconfOperation> sortedPriority = Maps.newTreeMap();
174 for (NetconfOperation netconfOperation : allNetconfOperations) {
175 final HandlingPriority handlingPriority = netconfOperation.canHandle(message);
176 if (netconfOperation instanceof DefaultNetconfOperation) {
177 ((DefaultNetconfOperation) netconfOperation).setNetconfSession(session);
179 if (!handlingPriority.equals(HandlingPriority.CANNOT_HANDLE)) {
181 Preconditions.checkState(!sortedPriority.containsKey(handlingPriority),
182 "Multiple %s available to handle message %s with priority %s",
183 NetconfOperation.class.getName(), message, handlingPriority);
184 sortedPriority.put(handlingPriority, netconfOperation);
187 return sortedPriority;
190 public static final NetconfOperationChainedExecution EXECUTION_TERMINATION_POINT = new NetconfOperationChainedExecution() {
192 public boolean isExecutionTermination() {
197 public Document execute(Document requestMessage) throws NetconfDocumentedException {
198 throw new NetconfDocumentedException("This execution represents the termination point in operation execution and cannot be executed itself",
199 NetconfDocumentedException.ErrorType.application,
200 NetconfDocumentedException.ErrorTag.operation_failed,
201 NetconfDocumentedException.ErrorSeverity.error);
205 private static class NetconfOperationExecution implements NetconfOperationChainedExecution {
206 private final NetconfOperation netconfOperation;
207 private NetconfOperationChainedExecution subsequentExecution;
209 private NetconfOperationExecution(NetconfOperation netconfOperation, NetconfOperationChainedExecution subsequentExecution) {
210 this.netconfOperation = netconfOperation;
211 this.subsequentExecution = subsequentExecution;
215 public boolean isExecutionTermination() {
220 public Document execute(Document message) throws NetconfDocumentedException {
221 return netconfOperation.handle(message, subsequentExecution);
224 public static NetconfOperationExecution createExecutionChain(
225 NavigableMap<HandlingPriority, NetconfOperation> sortedByPriority, HandlingPriority handlingPriority) {
226 NetconfOperation netconfOperation = sortedByPriority.get(handlingPriority);
227 HandlingPriority subsequentHandlingPriority = sortedByPriority.lowerKey(handlingPriority);
229 NetconfOperationChainedExecution subsequentExecution = null;
231 if (subsequentHandlingPriority != null) {
232 subsequentExecution = createExecutionChain(sortedByPriority, subsequentHandlingPriority);
234 subsequentExecution = EXECUTION_TERMINATION_POINT;
237 return new NetconfOperationExecution(netconfOperation, subsequentExecution);
242 public String toString() {
243 return "NetconfOperationRouterImpl{" + "netconfOperationServiceSnapshot=" + netconfOperationServiceSnapshot