me.gregorias.dfuntest

Interface Environment

All Known Implementing Classes:

AbstractConfigurationEnvironment, LocalEnvironment, SSHEnvironment

public interface Environment

Class which represents the environment on which given application is run, such as local or remote host. It tries to provide uniform console-like environment independent of what kind of environment it is.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFilesFromLocalDisk(java.nio.file.Path srcPath, java.lang.String destRelPath)
void	copyFilesToLocalDisk(java.lang.String srcRelPath, java.nio.file.Path destPath)
java.lang.String	getHostname()
int	getId()
java.lang.String	getName()
java.lang.Object	getProperty(java.lang.String key)
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)
void	setProperty(java.lang.String key, java.lang.Object value) Set arbitrary property of this environment.

Method Detail

copyFilesFromLocalDisk

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

Parameters:

srcPath - Local source path.

destRelPath - Relative destination directory on this environment.

Throws:

java.io.IOException

copyFilesToLocalDisk

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

Parameters:

srcRelPath - Relative source path on this environment.

destPath - Local destination directory.

Throws:

java.io.IOException

getHostname

java.lang.String getHostname()

Returns:

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

getId

int getId()

Returns:

Numeric identifier of this environment.

getName

java.lang.String getName()

getProperty

java.lang.Object getProperty(java.lang.String key)
                             throws java.util.NoSuchElementException

Throws:

java.util.NoSuchElementException

runCommand

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

Synchronously runs arbitrary command on this environment's OS.

Parameters:

command -

Returns:

Finished process.

Throws:

CommandException

java.lang.InterruptedException

java.io.IOException

runCommandAsynchronously

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

Throws:

java.io.IOException

removeFile

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

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.io.IOException

java.lang.InterruptedException

setProperty

void setProperty(java.lang.String key,
               java.lang.Object value)

Set arbitrary property of this environment.

Parameters:

key -

value -