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