Second part of onap rename

[appc.git] / appc-adapters / appc-netconf-adapter / appc-netconf-adapter-bundle / src / main / java / org / onap / appc / adapter / netconf / NetconfClient.java

diff --git a/appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/onap/appc/adapter/netconf/NetconfClient.java b/appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/onap/appc/adapter/netconf/NetconfClient.java
new file mode 100644 (file)
index 0000000..eaed60f
--- /dev/null
+++ b/appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/onap/appc/adapter/netconf/NetconfClient.java
@@ -0,0 +1,64 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP : APPC
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Copyright (C) 2017 Amdocs
+ * =============================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * 
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.appc.adapter.netconf;
+
+import org.onap.appc.exceptions.APPCException;
+
+
+
+public interface NetconfClient {
+
+    /**
+     * Open connection to netconf device.
+     *
+     * @param connectionDetails object providing details required for netconf connection
+     */
+    void connect(NetconfConnectionDetails connectionDetails) throws APPCException;
+
+    /**
+     * Send Netconf message to device and receive response.
+     *
+     * @param message input netconf xml message
+     * @return output netconf xml message
+     */
+    String exchangeMessage(String message) throws APPCException;
+
+    /**
+     * send configuration to Netconf server
+     *
+     * @param configuration - xml configuration payload
+     */
+    void configure(String configuration) throws APPCException;
+
+    /**
+     * returns running configuration of Netconf server
+       */
+    String getConfiguration() throws APPCException;
+
+    /**
+     * Disconnect from netconf device.
+     */
+    void disconnect() throws APPCException;
+}