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

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