appc-adapters/appc-ssh-adapter/appc-ssh-adapter-api/src/main/java/org/openecomp/appc/adapter/ssh/SshConnection.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : APP-C
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                                              reserved.
   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  */
  21
  22 package org.openecomp.appc.adapter.ssh;
  23
  24 import java.io.OutputStream;
  25
  26 /**
  27  * Provides utility method(s) to call commands on remote host via SSH.
  28  */
  29 public interface SshConnection {
  30
  31         /**
  32          * Connect to SSH server.
  33          */
  34         void connect();
  35
  36         /**
  37          * Connect to SSH Server using a retry mechanism
  38          */
  39         void connectWithRetry();
  40
  41         /**
  42          * Disconnect from SSH server.
  43          */
  44         void disconnect();
  45
  46         /**
  47          * Exec remote command over SSH. Return command execution status.
  48          * Command output is written to out or err stream.
  49          *
  50          * @param cmd command to execute
  51          * @param out content of sysout will go to this stream
  52          * @param err content of syserr will go to this stream
  53          * @return command execution status
  54          */
  55         int execCommand(String cmd, OutputStream out, OutputStream err);
  56
  57         /**
  58          * Exec remote command over SSH with pseudo-tty. Return command execution status.
  59          * Command output is written to out stream only as pseudo-tty writes to one stream only.
  60          *
  61          * @param cmd command to execute
  62          * @param out content of sysout will go to this stream
  63          * @return command execution status
  64          */
  65         int execCommandWithPty(String cmd, OutputStream out);
  66
  67         /**
  68          * Set the command execution timeout
  69          * @param timeout time in milliseconds
  70      */
  71         void setExecTimeout(long timeout);
  72 }