app-c/appc/appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/openecomp/appc/adapter/netconf/NetconfClient.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 NetconfClient {
  29
  30     /**
  31      * Open connection to netconf device.
  32      *
  33      * @param connectionDetails object providing details required for netconf connection
  34      */
  35     void connect(NetconfConnectionDetails connectionDetails) throws APPCException;
  36
  37     /**
  38      * Send Netconf message to device and receive response.
  39      *
  40      * @param message input netconf xml message
  41      * @return output netconf xml message
  42      */
  43     String exchangeMessage(String message) throws APPCException;
  44
  45     /**
  46      * send configuration to Netconf server
  47      *
  48      * @param configuration - xml configuration payload
  49      */
  50     void configure(String configuration) throws APPCException;
  51
  52     /**
  53      * returns running configuration of Netconf server
  54         */
  55     String getConfiguration() throws APPCException;
  56
  57     /**
  58      * Disconnect from netconf device.
  59      */
  60     void disconnect() throws APPCException;
  61 }