ovsdb/src/main/java/org/opendaylight/ovsdb/sal/connection/IConnectionService.java

   1 package org.opendaylight.ovsdb.sal.connection;
   2
   3 import java.util.Map;
   4
   5 import org.opendaylight.controller.sal.core.Node;
   6 import org.opendaylight.controller.sal.utils.Status;
   7
   8 /**
   9  * Interface that defines the methods available to the functional modules that operate
  10  * above SAL for disconnecting or connecting to a particular node.
  11  */
  12 public interface IConnectionService {
  13     /**
  14      * Disconnect a Node that is connected to this Controller.
  15      *
  16      * @param node
  17      * @param flow
  18      */
  19     public Status disconnect(Node node);
  20
  21     /**
  22      * Connect to a node with a specified node type.
  23      *
  24      * @param type Type of the node representing NodeIDType.
  25      * @param connectionIdentifier Convenient identifier for the applications to make use of
  26      * @param params Connection Params in Map format. This is entirely handled by the south-bound
  27      * plugins and is an opaque value for SAL. Typical values keyed inside this params are
  28      * Management IP-Address, Username, Password, Security Keys, etc...
  29      *
  30      *  @return Node
  31      */
  32     public Node connect (String type, String connectionIdentifier, Map<ConnectionConstants, String> params);
  33
  34
  35     /**
  36      * Discover the node type and Connect to the first plugin that is able to connect with the specified parameters.
  37      *
  38      * @param type Type of the node representing NodeIDType.
  39      * @param connectionIdentifier Convenient identifier for the applications to make use of
  40      * @param params Connection Params in Map format. This is entirely handled by the south-bound
  41      * plugins and is an opaque value for SAL. Typical values keyed inside this params are
  42      * Management IP-Address, Username, Password, Security Keys, etc...
  43      *
  44      *  @return Node
  45      */
  46     public Node connect (String connectionIdentifier, Map<ConnectionConstants, String> params);
  47
  48 }