opendaylight/adsal/sal/api/src/main/java/org/opendaylight/controller/sal/flowprogrammer/IFlowProgrammerService.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
   9 package org.opendaylight.controller.sal.flowprogrammer;
  10
  11 import org.opendaylight.controller.sal.core.Node;
  12 import org.opendaylight.controller.sal.utils.Status;
  13
  14 /**
  15  * Interface that defines the methods available to the functional modules above
  16  * SAL for installing/modifying/removing flows on a network node
  17  */
  18 @Deprecated
  19 public interface IFlowProgrammerService {
  20     /**
  21      * Synchronously add a flow to the network node
  22      *
  23      * @param node
  24      *            The target network node
  25      * @param flow
  26      *            The flow to install
  27      * @return The status of this request
  28      */
  29     Status addFlow(Node node, Flow flow);
  30
  31     /**
  32      * Synchronously modify existing flow on the switch
  33      *
  34      * @param node
  35      *            The target network node
  36      * @param oldFlow
  37      *            The existing flow to modify
  38      * @param newFlow
  39      *            The new flow to install
  40      * @return The status of this request
  41      */
  42     Status modifyFlow(Node node, Flow oldFlow, Flow newFlow);
  43
  44     /**
  45      * Synchronously remove the flow from the network node
  46      *
  47      * @param node
  48      *            The target network node
  49      * @param flow
  50      *            The flow to remove
  51      * @return The status of this request
  52      */
  53     Status removeFlow(Node node, Flow flow);
  54
  55     /**
  56      * Asynchronously add a flow to the network node
  57      *
  58      * @param node
  59      *            The target network node
  60      * @param flow
  61      *            The flow to install
  62      * @return The status of this request containing the unique request id
  63      */
  64     Status addFlowAsync(Node node, Flow flow);
  65
  66     /**
  67      * Asynchronously modify existing flow on the switch
  68      *
  69      * @param node
  70      *            The target network node
  71      * @param oldFlow
  72      *            The existing flow to modify
  73      * @param newFlow
  74      *            The new flow to install
  75      * @return The status of this request containing the unique request id
  76      */
  77     Status modifyFlowAsync(Node node, Flow oldFlow, Flow newFlow);
  78
  79     /**
  80      * Asynchronously remove the flow from the network node
  81      *
  82      * @param node
  83      *            The target network node
  84      * @param flow
  85      *            The flow to remove
  86      * @return The status of this request containing the unique request id
  87      */
  88     Status removeFlowAsync(Node node, Flow flow);
  89
  90     /**
  91      * Remove all flows present on the network node
  92      *
  93      * @param node
  94      *            The target network node
  95      * @return The status of this request containing the unique request id
  96      */
  97     Status removeAllFlows(Node node);
  98
  99     /**
 100      * Send Barrier message synchronously. The caller will be blocked until the
 101      * solicitation response arrives.
 102      *
 103      * Solicit the network node to report whether all the requests sent so far
 104      * are completed. When this call is done, caller knows that all past flow
 105      * operations requested to the node in asynchronous fashion were satisfied
 106      * by the network node and that in case of any failure, a message was sent
 107      * to the controller.
 108      *
 109      * @param node
 110      *            The network node to solicit
 111      * @return The status of this request containing the unique request id
 112      */
 113     Status syncSendBarrierMessage(Node node);
 114
 115     /**
 116      * Send Barrier message asynchronously. The caller is not blocked.
 117      *
 118      * Solicit the network node to report whether all the requests sent so far
 119      * are completed. When this call is done, caller knows that all past flow
 120      * operations requested to the node in asynchronous fashion were satisfied
 121      * by the network node and that in case of any failure, a message was sent
 122      * to the controller.
 123      *
 124      * @param node
 125      *            The network node to solicit
 126      * @return The status of this request containing the unique request id
 127      */
 128     Status asyncSendBarrierMessage(Node node);
 129 }