Merge "Bug 451 - Fix netconf exception handling"
[controller.git] / opendaylight / netconf / netconf-util / src / main / java / org / opendaylight / controller / netconf / util / mapping / AbstractLastNetconfOperation.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.util.mapping;
9
10 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
11 import org.opendaylight.controller.netconf.mapping.api.HandlingPriority;
12 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationChainedExecution;
13 import org.opendaylight.controller.netconf.util.xml.XmlElement;
14 import org.w3c.dom.Document;
15 import org.w3c.dom.Element;
16
17 public abstract class AbstractLastNetconfOperation extends AbstractNetconfOperation {
18
19     protected AbstractLastNetconfOperation(String netconfSessionIdForReporting) {
20         super(netconfSessionIdForReporting);
21     }
22
23     @Override
24     protected Element handle(Document document, XmlElement operationElement,
25             NetconfOperationChainedExecution subsequentOperation) throws NetconfDocumentedException {
26         if (!subsequentOperation.isExecutionTermination()){
27             throw new NetconfDocumentedException(String.format("No netconf operation expected to be subsequent to %s, but is %s", this, subsequentOperation),
28                     NetconfDocumentedException.ErrorType.application,
29                     NetconfDocumentedException.ErrorTag.malformed_message,
30                     NetconfDocumentedException.ErrorSeverity.error);
31         }
32
33         return handleWithNoSubsequentOperations(document, operationElement);
34     }
35
36     @Override
37     protected HandlingPriority getHandlingPriority() {
38         return HandlingPriority.HANDLE_WITH_DEFAULT_PRIORITY;
39     }
40
41     protected abstract Element handleWithNoSubsequentOperations(Document document, XmlElement operationElement) throws NetconfDocumentedException;
42 }