Remove duplicate dependency declaration
[controller.git] / opendaylight / netconf / netconf-impl / src / main / java / org / opendaylight / controller / netconf / impl / osgi / NetconfOperationRouterImpl.java
1 /*
2  * Copyright (c) 2013 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.controller.netconf.impl.osgi;
9
10 import com.google.common.base.Preconditions;
11 import com.google.common.collect.Maps;
12 import com.google.common.collect.Sets;
13 import java.util.Collections;
14 import java.util.HashSet;
15 import java.util.Map;
16 import java.util.NavigableMap;
17 import java.util.Set;
18 import java.util.TreeMap;
19 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
20 import org.opendaylight.controller.netconf.impl.DefaultCommitNotificationProducer;
21 import org.opendaylight.controller.netconf.impl.NetconfServerSession;
22 import org.opendaylight.controller.netconf.impl.mapping.CapabilityProvider;
23 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCloseSession;
24 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCommit;
25 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultGetSchema;
26 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultNetconfOperation;
27 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultStartExi;
28 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultStopExi;
29 import org.opendaylight.controller.netconf.mapping.api.HandlingPriority;
30 import org.opendaylight.controller.netconf.mapping.api.NetconfOperation;
31 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationChainedExecution;
32 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationService;
33 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationServiceSnapshot;
34 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
37 import org.w3c.dom.Document;
38
39 public class NetconfOperationRouterImpl implements NetconfOperationRouter {
40
41     private static final Logger LOG = LoggerFactory.getLogger(NetconfOperationRouterImpl.class);
42
43     private final NetconfOperationServiceSnapshot netconfOperationServiceSnapshot;
44     private Set<NetconfOperation> allNetconfOperations;
45
46     private NetconfOperationRouterImpl(NetconfOperationServiceSnapshot netconfOperationServiceSnapshot) {
47         this.netconfOperationServiceSnapshot = netconfOperationServiceSnapshot;
48     }
49
50     private synchronized void initNetconfOperations(Set<NetconfOperation> allOperations) {
51         allNetconfOperations = allOperations;
52     }
53
54     /**
55      * Factory method to produce instance of NetconfOperationRouter
56      */
57     public static NetconfOperationRouter createOperationRouter(NetconfOperationServiceSnapshot netconfOperationServiceSnapshot,
58                                                                CapabilityProvider capabilityProvider, DefaultCommitNotificationProducer commitNotifier) {
59         NetconfOperationRouterImpl router = new NetconfOperationRouterImpl(netconfOperationServiceSnapshot);
60
61         Preconditions.checkNotNull(netconfOperationServiceSnapshot);
62         Preconditions.checkNotNull(capabilityProvider);
63
64         final String sessionId = netconfOperationServiceSnapshot.getNetconfSessionIdForReporting();
65
66         final Set<NetconfOperation> defaultNetconfOperations = Sets.newHashSet();
67         defaultNetconfOperations.add(new DefaultGetSchema(capabilityProvider, sessionId));
68         defaultNetconfOperations.add(new DefaultCloseSession(sessionId, router));
69         defaultNetconfOperations.add(new DefaultStartExi(sessionId));
70         defaultNetconfOperations.add(new DefaultStopExi(sessionId));
71         defaultNetconfOperations.add(new DefaultCommit(commitNotifier, capabilityProvider, sessionId, router));
72
73         router.initNetconfOperations(getAllNetconfOperations(defaultNetconfOperations, netconfOperationServiceSnapshot));
74
75         return router;
76     }
77
78     private static Set<NetconfOperation> getAllNetconfOperations(Set<NetconfOperation> defaultNetconfOperations,
79             NetconfOperationServiceSnapshot netconfOperationServiceSnapshot) {
80         Set<NetconfOperation> result = new HashSet<>();
81         result.addAll(defaultNetconfOperations);
82
83         for (NetconfOperationService netconfOperationService : netconfOperationServiceSnapshot.getServices()) {
84             final Set<NetconfOperation> netOpsFromService = netconfOperationService.getNetconfOperations();
85             for (NetconfOperation netconfOperation : netOpsFromService) {
86                 Preconditions.checkState(!result.contains(netconfOperation),
87                         "Netconf operation %s already present", netconfOperation);
88                 result.add(netconfOperation);
89             }
90         }
91         return Collections.unmodifiableSet(result);
92     }
93
94     @Override
95     public synchronized Document onNetconfMessage(Document message,
96             NetconfServerSession session) throws NetconfDocumentedException {
97         Preconditions.checkNotNull(allNetconfOperations, "Operation router was not initialized properly");
98
99         NetconfOperationExecution netconfOperationExecution;
100
101         String messageAsString = "";
102         try {
103             messageAsString = XmlUtil.toString(message);
104             netconfOperationExecution = getNetconfOperationWithHighestPriority(message, session);
105         } catch (IllegalArgumentException | IllegalStateException e) {
106             LOG.warn("Unable to handle rpc {} on session {}", messageAsString, session, e);
107
108             String errorMessage = String.format("Unable to handle rpc %s on session %s", messageAsString, session);
109             Map<String, String> errorInfo = Maps.newHashMap();
110
111             NetconfDocumentedException.ErrorTag tag;
112             if (e instanceof IllegalArgumentException) {
113                 errorInfo.put(NetconfDocumentedException.ErrorTag.operation_not_supported.toString(), e.getMessage());
114                 tag = NetconfDocumentedException.ErrorTag.operation_not_supported;
115             } else {
116                 errorInfo.put(NetconfDocumentedException.ErrorTag.operation_failed.toString(), e.getMessage());
117                 tag = NetconfDocumentedException.ErrorTag.operation_failed;
118             }
119
120             throw new NetconfDocumentedException(errorMessage, e, NetconfDocumentedException.ErrorType.application,
121                     tag, NetconfDocumentedException.ErrorSeverity.error, errorInfo);
122         } catch (RuntimeException e) {
123             throw handleUnexpectedEx("Unexpected exception during netconf operation sort", e);
124         }
125
126         try {
127             return executeOperationWithHighestPriority(message, netconfOperationExecution, messageAsString);
128         } catch (RuntimeException e) {
129             throw handleUnexpectedEx("Unexpected exception during netconf operation execution", e);
130         }
131     }
132
133     @Override
134     public void close() throws Exception {
135         netconfOperationServiceSnapshot.close();
136     }
137
138     private NetconfDocumentedException handleUnexpectedEx(String s, Exception e) throws NetconfDocumentedException {
139         LOG.error(s, e);
140
141         Map<String, String> info = Maps.newHashMap();
142         info.put(NetconfDocumentedException.ErrorSeverity.error.toString(), e.toString());
143         return new NetconfDocumentedException("Unexpected error",
144                 NetconfDocumentedException.ErrorType.application,
145                 NetconfDocumentedException.ErrorTag.operation_failed,
146                 NetconfDocumentedException.ErrorSeverity.error, info);
147     }
148
149     private Document executeOperationWithHighestPriority(Document message,
150             NetconfOperationExecution netconfOperationExecution, String messageAsString)
151             throws NetconfDocumentedException {
152         LOG.debug("Forwarding netconf message {} to {}", messageAsString, netconfOperationExecution.netconfOperation);
153         return netconfOperationExecution.execute(message);
154     }
155
156     private NetconfOperationExecution getNetconfOperationWithHighestPriority(
157             Document message, NetconfServerSession session) throws NetconfDocumentedException {
158
159         NavigableMap<HandlingPriority, NetconfOperation> sortedByPriority = getSortedNetconfOperationsWithCanHandle(
160                 message, session);
161
162         Preconditions.checkArgument(sortedByPriority.isEmpty() == false,
163                 "No %s available to handle message %s", NetconfOperation.class.getName(),
164                 XmlUtil.toString(message));
165
166         return NetconfOperationExecution.createExecutionChain(sortedByPriority, sortedByPriority.lastKey());
167     }
168
169     private TreeMap<HandlingPriority, NetconfOperation> getSortedNetconfOperationsWithCanHandle(Document message,
170             NetconfServerSession session) throws NetconfDocumentedException {
171         TreeMap<HandlingPriority, NetconfOperation> sortedPriority = Maps.newTreeMap();
172
173         for (NetconfOperation netconfOperation : allNetconfOperations) {
174             final HandlingPriority handlingPriority = netconfOperation.canHandle(message);
175             if (netconfOperation instanceof DefaultNetconfOperation) {
176                 ((DefaultNetconfOperation) netconfOperation).setNetconfSession(session);
177             }
178             if (!handlingPriority.equals(HandlingPriority.CANNOT_HANDLE)) {
179
180                 Preconditions.checkState(!sortedPriority.containsKey(handlingPriority),
181                         "Multiple %s available to handle message %s with priority %s",
182                         NetconfOperation.class.getName(), message, handlingPriority);
183                 sortedPriority.put(handlingPriority, netconfOperation);
184             }
185         }
186         return sortedPriority;
187     }
188
189     public static final NetconfOperationChainedExecution EXECUTION_TERMINATION_POINT = new NetconfOperationChainedExecution() {
190         @Override
191         public boolean isExecutionTermination() {
192             return true;
193         }
194
195         @Override
196         public Document execute(Document requestMessage) throws NetconfDocumentedException {
197             throw new NetconfDocumentedException("This execution represents the termination point in operation execution and cannot be executed itself",
198                     NetconfDocumentedException.ErrorType.application,
199                     NetconfDocumentedException.ErrorTag.operation_failed,
200                     NetconfDocumentedException.ErrorSeverity.error);
201         }
202     };
203
204     private static class NetconfOperationExecution implements NetconfOperationChainedExecution {
205         private final NetconfOperation netconfOperation;
206         private NetconfOperationChainedExecution subsequentExecution;
207
208         private NetconfOperationExecution(NetconfOperation netconfOperation, NetconfOperationChainedExecution subsequentExecution) {
209             this.netconfOperation = netconfOperation;
210             this.subsequentExecution = subsequentExecution;
211         }
212
213         @Override
214         public boolean isExecutionTermination() {
215             return false;
216         }
217
218         @Override
219         public Document execute(Document message) throws NetconfDocumentedException {
220             return netconfOperation.handle(message, subsequentExecution);
221         }
222
223         public static NetconfOperationExecution createExecutionChain(
224                 NavigableMap<HandlingPriority, NetconfOperation> sortedByPriority, HandlingPriority handlingPriority) {
225             NetconfOperation netconfOperation = sortedByPriority.get(handlingPriority);
226             HandlingPriority subsequentHandlingPriority = sortedByPriority.lowerKey(handlingPriority);
227
228             NetconfOperationChainedExecution subsequentExecution = null;
229
230             if (subsequentHandlingPriority != null) {
231                 subsequentExecution = createExecutionChain(sortedByPriority, subsequentHandlingPriority);
232             } else {
233                 subsequentExecution = EXECUTION_TERMINATION_POINT;
234             }
235
236             return new NetconfOperationExecution(netconfOperation, subsequentExecution);
237         }
238     }
239
240     @Override
241     public String toString() {
242         return "NetconfOperationRouterImpl{" + "netconfOperationServiceSnapshot=" + netconfOperationServiceSnapshot
243                 + '}';
244     }
245 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.