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