com.palantir.giraffe.host

Interface HostControlSystem

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractHostControlSystem

public interface HostControlSystem
extends Closeable

Combines a file system and an execution system for a local or remote host.

HostControlSystems are open on creation and should be closed after use. Clients should not close the underlying systems individually.

Method Summary

Methods

Modifier and Type	Method and Description
Command	getCommand(Path executable, Object... args) Gets a command on this host's execution system.
Command	getCommand(String executable, Object... args) Gets a command on this host's execution system.
ExecutionSystem	getExecutionSystem() Returns this host's ExecutionSystem.
FileSystem	getFileSystem() Returns this host's FileSystem.
Host	getHost() Returns the Host controlled by this system.
String	getHostname() Returns the name of the host controlled by this system.
Path	getPath(String first, String... more) Gets a path on this host's file system.
URI	uri() Returns this system's URI.

Methods inherited from interface java.io.Closeable

close

Method Detail

getPath

Path getPath(String first,
           String... more)

Gets a path on this host's file system.

See Also:

FileSystem.getPath(java.lang.String, java.lang.String...)

getCommand

Command getCommand(String executable,
                 Object... args)

Gets a command on this host's execution system.

See Also:

ExecutionSystem.getCommand(String, Object...)

getCommand

Command getCommand(Path executable,
                 Object... args)

Gets a command on this host's execution system.

See Also:

ExecutionSystem.getCommand(Path, Object...)

getFileSystem

FileSystem getFileSystem()

Returns this host's FileSystem. The system is open and should not be closed.

getExecutionSystem

ExecutionSystem getExecutionSystem()

Returns this host's ExecutionSystem. The system is open and should not be closed.

getHost

Host getHost()

Returns the Host controlled by this system.

getHostname

String getHostname()

Returns the name of the host controlled by this system.

uri

URI uri()

Returns this system's URI.