appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/onap/appc/adapter/netconf/NetconfClientRestconf.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.onap.appc.adapter.netconf;
  26
  27 import org.onap.appc.exceptions.APPCException;
  28
  29
  30
  31 public interface NetconfClientRestconf {
  32
  33     /*
  34     mount device to controller
  35      @param deviceMountPointName - the name of the mounting point in controller
  36      @param payload - json data describing device info
  37      */
  38     void connect(String deviceMountPointName, String payload) throws APPCException;
  39
  40     /*
  41     check connection to device
  42     @param deviceMountPointName - the name of the mounting point in controller
  43      */
  44     boolean checkConnection(String deviceMountPointName) throws APPCException;
  45
  46     /*
  47         send configuration to Netconf server
  48          @param configuration - xml configuration payload
  49          @param deviceMountPointName - the name of the mounting point in controller
  50          @param moduleName - name of the yang model
  51          @param nodeName - name of the node created in server
  52         */
  53     void configure(String configuration, String deviceMountPointName, String moduleName, String nodeName) throws APPCException;
  54
  55     /*
  56         returns configuration of Netconf server
  57          @param deviceMountPointName - the name of the mounting point in controller
  58          @param moduleName - name of the yang model
  59          @param nodeName - name of the node created in server
  60         */
  61     String getConfiguration(String deviceName, String moduleName, String nodeName) throws APPCException;
  62
  63     /*
  64     unmount device
  65      @param deviceMountPointName - the name of the mounting point in controller
  66      */
  67     void disconnect(String deviceMountPointName) throws APPCException;
  68 }