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

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