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