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