netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/api/RemoteDeviceConnector.java

   1 /*
   2  * Copyright (c) 2016 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.netconf.topology.singleton.api;
   9
  10 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  11 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  12
  13 /**
  14  * Provides API for connection ODL (master) with device.
  15  */
  16 // FIXME: way more documentation is needed here
  17 public interface RemoteDeviceConnector {
  18
  19     /**
  20      * Create device communicator and open device connection.
  21      *
  22      * @param deviceHandler Device handler
  23      * @throws NullPointerException if {@code deviceHandler} is null
  24      */
  25     // FIXME: this should return a resource corresponding to the device connection
  26     void startRemoteDeviceConnection(RemoteDeviceHandler<NetconfSessionPreferences> deviceHandler);
  27
  28     /**
  29      * Stop device communicator.
  30      */
  31     // FIXME: see above, this should live in the returned resource
  32     void stopRemoteDeviceConnection();
  33 }