opendaylight/sal/connection/api/src/main/java/org/opendaylight/controller/sal/connection/IPluginInConnectionService.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.connection;
  10
  11 import java.util.Map;
  12
  13 import org.opendaylight.controller.sal.core.Node;
  14 import org.opendaylight.controller.sal.utils.Status;
  15
  16 /**
  17  * @file IPluginInConnectionService.java
  18  *
  19  * @brief Connection interface to be implemented by protocol plugins
  20  */
  21 public interface IPluginInConnectionService {
  22     /**
  23      * Disconnect a Node that is connected to this Controller.
  24      *
  25      * @param node
  26      * @param flow
  27      */
  28     public Status disconnect(Node node);
  29
  30     /**
  31      * Connect to a node
  32      *
  33      * @param connectionIdentifier Convenient identifier for the applications to make use of
  34      * @param params Connection Params in Map format. This is entirely handled by the south-bound
  35      * plugins and is an opaque value for SAL. Typical values keyed inside this params are
  36      * Management IP-Address, Username, Password, Security Keys, etc...
  37      *
  38      * @return Node
  39      */
  40     public Node connect (String connectionIdentifier, Map<ConnectionConstants, String> params);
  41
  42     /**
  43      * View Change notification
  44      */
  45     public void notifyClusterViewChanged();
  46
  47     /**
  48      * Node Disconnected from the node's master controller.
  49      */
  50     public void notifyNodeDisconnectFromMaster(Node node);
  51
  52 }