com.xebialabs.overthere.local

Class LocalConnection

java.lang.Object

com.xebialabs.overthere.spi.BaseOverthereConnection

com.xebialabs.overthere.local.LocalConnection

All Implemented Interfaces:

OverthereConnection, OverthereConnectionBuilder, java.io.Closeable, java.lang.AutoCloseable

public class LocalConnection
extends BaseOverthereConnection
implements OverthereConnectionBuilder

A connection to the local host.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCAL_PROTOCOL Name of the protocol handled by this connection builder, i.e.

Fields inherited from class com.xebialabs.overthere.spi.BaseOverthereConnection

canStartProcess, connectionTemporaryDirectory, connectionTimeoutMillis, deleteTemporaryDirectoryOnDisconnect, mapper, options, os, protocol, random, temporaryDirectoryPath, temporaryFileCreationRetries, workingDirectory

Constructor Summary

Constructors

Constructor and Description
LocalConnection(java.lang.String protocol, ConnectionOptions options) Constructs a connection to the local host.
LocalConnection(java.lang.String protocol, ConnectionOptions options, AddressPortMapper mapper) Constructs a connection to the local host.

Method Summary

Methods

Modifier and Type	Method and Description
OverthereConnection	connect() Creates the connection that corresponds to the arguments that were passed in the two-arg constructor of this class.
void	doClose() To be overridden by a base class to implement connection specific disconnection logic.
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 path) Creates a reference to a file on the host.
protected OverthereFile	getFileForTempFile(OverthereFile parent, java.lang.String name) Invoked by BaseOverthereConnection.getTempFile(String) and BaseOverthereConnection.createConnectionTemporaryDirectory() to create an OverthereFile object for a file or directory in the system or connection temporary directory.
static OverthereConnection	getLocalConnection() Creates a connection to the local host.
OverthereProcess	startProcess(CmdLine cmd) Starts a command with its argument and returns control to the caller.
java.lang.String	toString() Subclasses MUST implement toString properly.

Methods inherited from class com.xebialabs.overthere.spi.BaseOverthereConnection

canStartProcess, close, equals, execute, execute, execute, getHostOperatingSystem, getOptions, getTempFile, getTempFile, getWorkingDirectory, hashCode, setWorkingDirectory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOCAL_PROTOCOL

public static final java.lang.String LOCAL_PROTOCOL

Name of the protocol handled by this connection builder, i.e. "local".

See Also:

Constant Field Values

Constructor Detail

LocalConnection

public LocalConnection(java.lang.String protocol,
               ConnectionOptions options,
               AddressPortMapper mapper)

Constructs a connection to the local host.

LocalConnection

public LocalConnection(java.lang.String protocol,
               ConnectionOptions options)

Constructs a connection to the local host.

Method Detail

connect

public OverthereConnection connect()

Description copied from interface: OverthereConnectionBuilder

Creates the connection that corresponds to the arguments that were passed in the two-arg constructor of this class. The first argument is a String that specifies the type (and is identical to the name field of the Protocol annotation). The second argument is the ConnectionOptions.

Specified by:

connect in interface OverthereConnectionBuilder

Returns:

the created connection.

doClose

public void doClose()

Description copied from class: BaseOverthereConnection

To be overridden by a base class to implement connection specific disconnection logic.

Specified by:

doClose in class BaseOverthereConnection

getFile

public OverthereFile getFile(java.lang.String path)
                      throws RuntimeIOException

Description copied from interface: OverthereConnection

Creates a reference to a file on the host.

Specified by:

getFile in interface OverthereConnection

Parameters:

path - the path of the host

Returns:

a reference to the file

Throws:

RuntimeIOException

getFile

public OverthereFile getFile(OverthereFile parent,
                    java.lang.String child)
                      throws RuntimeIOException

Description copied from interface: OverthereConnection

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

Specified by:

getFile in interface OverthereConnection

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

Throws:

RuntimeIOException

getFileForTempFile

protected OverthereFile getFileForTempFile(OverthereFile parent,
                               java.lang.String name)

Description copied from class: BaseOverthereConnection

Invoked by BaseOverthereConnection.getTempFile(String) and BaseOverthereConnection.createConnectionTemporaryDirectory() to create an OverthereFile object for a file or directory in the system or connection temporary directory.

Specified by:

getFileForTempFile in class BaseOverthereConnection

Parameters:

parent - parent of the file to create

name - name of the file to create.

Returns:

the created file object

startProcess

public OverthereProcess startProcess(CmdLine cmd)

Description copied from class: BaseOverthereConnection

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

Specified by:

startProcess in interface OverthereConnection

Overrides:

startProcess in class BaseOverthereConnection

Parameters:

cmd - the command line to execute.

Returns:

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

toString

public java.lang.String toString()

Description copied from class: BaseOverthereConnection

Subclasses MUST implement toString properly.

Specified by:

toString in interface OverthereConnection

Specified by:

toString in class BaseOverthereConnection

getLocalConnection

public static OverthereConnection getLocalConnection()

Creates a connection to the local host.