git.opendaylight Code Review - controller.git/blob

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