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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright (C) 2017 Amdocs
   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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  */
  22
  23 package org.openecomp.appc.adapter.netconf;
  24
  25 import org.openecomp.appc.exceptions.APPCException;
  26
  27
  28
  29 public interface NetconfClient {
  30
  31     /**
  32      * Open connection to netconf device.
  33      *
  34      * @param connectionDetails object providing details required for netconf connection
  35      */
  36     void connect(NetconfConnectionDetails connectionDetails) throws APPCException;
  37
  38     /**
  39      * Send Netconf message to device and receive response.
  40      *
  41      * @param message input netconf xml message
  42      * @return output netconf xml message
  43      */
  44     String exchangeMessage(String message) throws APPCException;
  45
  46     /**
  47      * send configuration to Netconf server
  48      *
  49      * @param configuration - xml configuration payload
  50      */
  51     void configure(String configuration) throws APPCException;
  52
  53     /**
  54      * returns running configuration of Netconf server
  55         */
  56     String getConfiguration() throws APPCException;
  57
  58     /**
  59      * Disconnect from netconf device.
  60      */
  61     void disconnect() throws APPCException;
  62 }