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.ssh;
27 import java.io.OutputStream;
30 * Provides utility method(s) to call commands on remote host via SSH.
32 public interface SshConnection {
35 * Connect to SSH server.
40 * Connect to SSH Server using a retry mechanism
42 void connectWithRetry();
45 * Disconnect from SSH server.
50 * Exec remote command over SSH. Return command execution status.
51 * Command output is written to out or err stream.
53 * @param cmd command to execute
54 * @param out content of sysout will go to this stream
55 * @param err content of syserr will go to this stream
56 * @return command execution status
58 int execCommand(String cmd, OutputStream out, OutputStream err);
61 * Exec remote command over SSH with pseudo-tty. Return command execution status.
62 * Command output is written to out stream only as pseudo-tty writes to one stream only.
64 * @param cmd command to execute
65 * @param out content of sysout will go to this stream
66 * @return command execution status
68 int execCommandWithPty(String cmd, OutputStream out);
71 * Set the command execution timeout
72 * @param timeout time in milliseconds
74 void setExecTimeout(long timeout);