me.gregorias.dfuntest

Class SSHEnvironment

java.lang.Object

me.gregorias.dfuntest.AbstractConfigurationEnvironment

me.gregorias.dfuntest.SSHEnvironment

All Implemented Interfaces:

Environment

public class SSHEnvironment
extends AbstractConfigurationEnvironment

An UNIX environment accessible through SSH with public key.

Constructor Summary

Constructors

Constructor and Description
SSHEnvironment(int id, java.lang.String username, java.nio.file.Path privateKeyPath, java.net.InetAddress remoteInetAddress, java.lang.String remoteHomePath, java.util.concurrent.Executor executor, SSHClientFactory sshClientFactory, FileUtils fileUtils)

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFilesFromLocalDisk(java.nio.file.Path srcPath, java.lang.String destRelPath) Copies specified file or directory to destination directory on environment.
void	copyFilesToLocalDisk(java.lang.String srcRelPath, java.nio.file.Path destPath) Copies specified file or directory to destination directory on local host.
java.lang.String	getHostname()
int	getId()
java.lang.String	getName()
void	mkdirs(java.lang.String directoryPath) Create directories in environment if they don't exist.
void	removeFile(java.lang.String relPath) Removes specified file.
RemoteProcess	runCommand(java.util.List<java.lang.String> command) Synchronously runs arbitrary command on this environment's OS.
RemoteProcess	runCommandAsynchronously(java.util.List<java.lang.String> command)

Methods inherited from class me.gregorias.dfuntest.AbstractConfigurationEnvironment

getProperty, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SSHEnvironment

public SSHEnvironment(int id,
              java.lang.String username,
              java.nio.file.Path privateKeyPath,
              java.net.InetAddress remoteInetAddress,
              java.lang.String remoteHomePath,
              java.util.concurrent.Executor executor,
              SSHClientFactory sshClientFactory,
              FileUtils fileUtils)

Parameters:

id - Environment's id

username - Username of remote account

privateKeyPath - Path to private key file

remoteInetAddress - Remote host's address

remoteHomePath - Path to remote home where environment will be placed. May be relative to user's home.

executor - Executor for running remote commands

sshClientFactory - Factory for SSHClients

fileUtils - Local file utils

Method Detail

copyFilesFromLocalDisk

public void copyFilesFromLocalDisk(java.nio.file.Path srcPath,
                          java.lang.String destRelPath)
                            throws java.io.IOException

Description copied from interface: Environment

Copies specified file or directory to destination directory on environment.

Parameters:

srcPath - Local source path.

destRelPath - Relative destination directory on this environment.

Throws:

java.io.IOException

copyFilesToLocalDisk

public void copyFilesToLocalDisk(java.lang.String srcRelPath,
                        java.nio.file.Path destPath)
                          throws java.io.IOException

Description copied from interface: Environment

Copies specified file or directory to destination directory on local host.

Parameters:

srcRelPath - Relative source path on this environment.

destPath - Local destination directory.

Throws:

java.io.IOException

getHostname

public java.lang.String getHostname()

Returns:

Hostname of this environment. May be IP address, WWW address etc.

getId

public int getId()

Returns:

Numeric identifier of this environment

getName

public java.lang.String getName()

Returns:

Human readable name for this environment

mkdirs

public void mkdirs(java.lang.String directoryPath)
            throws java.io.IOException

Create directories in environment if they don't exist. If directoryPath consists of several directories all required parent directories are created as well.

Parameters:

directoryPath - path to create

Throws:

java.io.IOException

removeFile

public void removeFile(java.lang.String relPath)
                throws java.lang.InterruptedException,
                       java.io.IOException

Description copied from interface: Environment

Removes specified file. If path targets a directory its content is removed as well.

Parameters:

relPath - Relative path to file on this environment.

Throws:

java.lang.InterruptedException

java.io.IOException

runCommand

public RemoteProcess runCommand(java.util.List<java.lang.String> command)
                         throws java.lang.InterruptedException,
                                java.io.IOException

Description copied from interface: Environment

Synchronously runs arbitrary command on this environment's OS.

Parameters:

command - Command to run

Returns:

Finished process.

Throws:

java.lang.InterruptedException

java.io.IOException

runCommandAsynchronously

public RemoteProcess runCommandAsynchronously(java.util.List<java.lang.String> command)
                                       throws java.io.IOException

Throws:

java.io.IOException