2 * ============LICENSE_START=======================================================
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
13 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 * ============LICENSE_END=========================================================
25 package org.onap.appc.adapter.netconf;
27 import org.onap.appc.exceptions.APPCException;
31 public interface NetconfClient {
34 * Open connection to netconf device.
36 * @param connectionDetails object providing details required for netconf connection
38 void connect(NetconfConnectionDetails connectionDetails) throws APPCException;
41 * Send Netconf message to device and receive response.
43 * @param message input netconf xml message
44 * @return output netconf xml message
46 String exchangeMessage(String message) throws APPCException;
49 * send configuration to Netconf server
51 * @param configuration - xml configuration payload
53 void configure(String configuration) throws APPCException;
56 * returns running configuration of Netconf server
58 String getConfiguration() throws APPCException;
61 * Disconnect from netconf device.
63 void disconnect() throws APPCException;