opendaylight/netconf/netconf-mapping-api/src/main/java/org/opendaylight/controller/netconf/mapping/api/NetconfOperationChainedExecution.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.mapping.api;
   9
  10 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  11 import org.w3c.dom.Document;
  12
  13 /**
  14  * Single link in netconf operation execution chain.
  15  * Wraps the execution of a single netconf operation.
  16  */
  17 public interface NetconfOperationChainedExecution {
  18
  19     /**
  20      * @return true if this is termination point in operation execution, false
  21      *         if there is a subsequent operation present that needs to be
  22      *         executed
  23      */
  24     boolean isExecutionTermination();
  25
  26     /**
  27      * Do not execute if this is termination point
  28      */
  29     Document execute(Document requestMessage) throws NetconfDocumentedException;
  30 }