com.xebialabs.overthere

Interface OverthereConnection

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

BaseOverthereConnection, CifsConnection, CifsTelnetConnection, CifsWinRmConnection, CifsWinrsConnection, LocalConnection, SshTunnelConnection

public interface OverthereConnection
extends java.io.Closeable

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canStartProcess() Checks whether a process can be started on this connection.
void	close() Closes the connection.
int	execute(CmdLine commandLine) Executes a command with its arguments and prints all the output on stdout and stderr to the console.
int	execute(OverthereExecutionOutputHandler stdoutHandler, OverthereExecutionOutputHandler stderrHandler, CmdLine commandLine) Executes a command with its arguments.
int	execute(OverthereProcessOutputHandler handler, CmdLine commandLine) Deprecated. use execute(OverthereExecutionOutputHandler, OverthereExecutionOutputHandler, CmdLine)
OverthereFile	getFile(OverthereFile parent, java.lang.String child) Creates a reference to a file in a directory on the host.
OverthereFile	getFile(java.lang.String hostPath) Creates a reference to a file on the host.
OperatingSystemFamily	getHostOperatingSystem() Return the OS family of the host.
OverthereFile	getTempFile(java.lang.String nameTemplate) Creates a reference to a temporary file on the host.
OverthereFile	getTempFile(java.lang.String prefix, java.lang.String suffix) Creates a reference to a temporary file on the host.
OverthereFile	getWorkingDirectory() Returns the working directory.
void	setWorkingDirectory(OverthereFile workingDirectory) Sets the working directory in which commands are executed.
OverthereProcess	startProcess(CmdLine commandLine) Starts a command with its argument and returns control to the caller.
java.lang.String	toString() Implementations MUST implement toString properly.

Method Detail

getHostOperatingSystem

OperatingSystemFamily getHostOperatingSystem()

Return the OS family of the host.

Returns:

the OS family

getFile

OverthereFile getFile(java.lang.String hostPath)

Creates a reference to a file on the host.

Parameters:

hostPath - the path of the host

Returns:

a reference to the file

getFile

OverthereFile getFile(OverthereFile parent,
                    java.lang.String child)

Creates a reference to a file in a directory on the host.

Parameters:

parent - the reference to the directory on the host

child - the name of the file in the directory

Returns:

a reference to the file in the directory

getTempFile

OverthereFile getTempFile(java.lang.String nameTemplate)

Creates a reference to a temporary file on the host. This file has a unique name and will be automatically removed when this connection is closed. N.B.: The file is not actually created until a put method is invoked.

Parameters:

nameTemplate - the template on which to base the name of the temporary file. May be null.

Returns:

a reference to the temporary file on the host

getTempFile

OverthereFile getTempFile(java.lang.String prefix,
                        java.lang.String suffix)
                          throws RuntimeIOException

Creates a reference to a temporary file on the host. This file has a unique name and will be automatically removed when this connection is closed. N.B.: The file is not actually created until a put method is invoked.

Parameters:

prefix - the prefix string to be used in generating the file's name; must be at least three characters long

suffix - the suffix string to be used in generating the file's name; may be null, in which case the suffix ".tmp" will be used

Returns:

a reference to the temporary file on the host

Throws:

RuntimeIOException

getWorkingDirectory

OverthereFile getWorkingDirectory()

Returns the working directory.

Returns:

the working directory, may be null.

setWorkingDirectory

void setWorkingDirectory(OverthereFile workingDirectory)

Sets the working directory in which commands are executed. If set to null, the working directory that is used depends on the connection implementation.

Parameters:

workingDirectory - the working directory, may be null.

execute

int execute(OverthereProcessOutputHandler handler,
          CmdLine commandLine)

Deprecated. use execute(OverthereExecutionOutputHandler, OverthereExecutionOutputHandler, CmdLine)

Executes a command with its arguments.

Parameters:

handler - the handler that will be invoked when the executed command generated output.

commandLine - the command line to execute.

Returns:

the exit value of the executed command. Usually 0 on successful execution.

execute

int execute(CmdLine commandLine)

Executes a command with its arguments and prints all the output on stdout and stderr to the console.

Parameters:

commandLine - the command line to execute.

Returns:

the exit value of the executed command. Usually 0 on successful execution.

execute

int execute(OverthereExecutionOutputHandler stdoutHandler,
          OverthereExecutionOutputHandler stderrHandler,
          CmdLine commandLine)

Executes a command with its arguments.

Parameters:

stdoutHandler - the handler that will be invoked when the executed command generated output on stdout.

stderrHandler - the handler that will be invoked when the executed command generated output on stderr.

commandLine - the command line to execute.

Returns:

the exit value of the executed command. Usually 0 on successful execution.

startProcess

OverthereProcess startProcess(CmdLine commandLine)

Starts a command with its argument and returns control to the caller.

Parameters:

commandLine - the command line to execute.

Returns:

an object representing the executing command or null if this is not supported by the host connection.

canStartProcess

boolean canStartProcess()

Checks whether a process can be started on this connection.

Returns:

true if a process can be started on this connection, false otherwise

close

void close()

Closes the connection. Does not throw IOException but can throw RuntimeIOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

toString

java.lang.String toString()

Implementations MUST implement toString properly.

Overrides:

toString in class java.lang.Object