co.cask.cdap.runtime.spi.ssh

Interface SSHSession

All Superinterfaces:

AutoCloseable

public interface SSHSession
extends AutoCloseable

This interface represents an SSH session, which allow performing remote ssh commands and scp.

Method Summary

Modifier and Type	Method and Description
void	close() Close this SSH session.
void	copy(InputStream input, String targetPath, String targetName, long size, int permission, Long lastAccessTime, Long lastModifiedTime) Copies content to remote host.
void	copy(Path sourceFile, String targetPath) Copies a local file to the given target path
PortForwarding	createLocalPortForward(String targetHost, int targetPort, int originatePort, PortForwarding.DataConsumer dataConsumer) Creates a local port forwarding channel from this SSH session.
SSHProcess	execute(List<String> commands) Executes a sequence of commands on the remote host.
default SSHProcess	execute(String... commands) Executes a sequence of commands on the remote host.
String	executeAndWait(List<String> commands) Executes a sequence of commands on the remote host and block until execution completed.
default String	executeAndWait(String... commands) Executes a sequence of commands on the remote host and block until execution completed.
InetSocketAddress	getAddress() Returns the remote host and port that this session is connected to.
String	getUsername() Returns the remote user name that this session used to connect to the remote host.
boolean	isAlive() Returns true if the session is alive; otherwise return false.

Method Detail

isAlive

boolean isAlive()

Returns true if the session is alive; otherwise return false.

getAddress

InetSocketAddress getAddress()

Returns the remote host and port that this session is connected to.

Returns:

a InetSocketAddress containing the target host and port of this session

getUsername

String getUsername()

Returns the remote user name that this session used to connect to the remote host.

Returns:

the remote user name

execute

default SSHProcess execute(String... commands)
                    throws IOException

Executes a sequence of commands on the remote host.

Parameters:

commands - the commands to execute

Returns:

the command result

Throws:

IOException - if failed to execute command remotely

execute

SSHProcess execute(List<String> commands)
            throws IOException

Executes a sequence of commands on the remote host.

Parameters:

commands - the commands to execute

Returns:

the command result

Throws:

IOException - if failed to execute command remotely

executeAndWait

default String executeAndWait(String... commands)
                       throws IOException

Executes a sequence of commands on the remote host and block until execution completed.

Parameters:

commands - the commands to execute

Returns:

the output to stdout by the commands

Throws:

IOException - if failed to execute command or command exit with non-zero values.

executeAndWait

String executeAndWait(List<String> commands)
               throws IOException

Executes a sequence of commands on the remote host and block until execution completed.

Parameters:

commands - the commands to execute

Returns:

the output to stdout by the commands

Throws:

IOException - if failed to execute command or command exit with non-zero values.

copy

void copy(Path sourceFile,
          String targetPath)
   throws IOException

Copies a local file to the given target path

Parameters:

sourceFile - source file

targetPath - the target path to copy to

Throws:

IOException - if

copy

void copy(InputStream input,
          String targetPath,
          String targetName,
          long size,
          int permission,
          @Nullable
          Long lastAccessTime,
          @Nullable
          Long lastModifiedTime)
   throws IOException

Copies content to remote host.

Parameters:

input - InputStream for the source content

targetPath - target path. If the path is an existing directory, file with the targetName will be created under the given path. If the path doesn't exist or is an existing file, content will be written/overwritten to the given path

targetName - file name in the targetPath if targetPath is a directory

size - size of the content

permission - permission of the target file

lastAccessTime - the optional file last access time in milliseconds. Both this and the lastModifiedTime should not be null to have time to be set

lastModifiedTime - the optional file last modified time in milliseconds. Both this and the lastAccessTime should not be null to have time to be set

Throws:

IOException - if failed to copy the content

createLocalPortForward

PortForwarding createLocalPortForward(String targetHost,
                                      int targetPort,
                                      int originatePort,
                                      PortForwarding.DataConsumer dataConsumer)
                               throws IOException

Creates a local port forwarding channel from this SSH session.

Parameters:

targetHost - the target hostname to forward to

targetPort - the target port to forward to

originatePort - the original port that the client is connect to

dataConsumer - A PortForwarding.DataConsumer for consuming incoming data from the forwarding channel

Returns:

a PortForwarding for communicating with the forwarding channel

Throws:

IOException - if failed to open the port forwarding channel

close

void close()

Close this SSH session.

Specified by:

close in interface AutoCloseable