xapi.shell.api

Interface ShellCommand

All Known Implementing Classes:

ShellCommandDefault

public interface ShellCommand

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	STATUS_DESTROYED
static Integer	STATUS_FAILED

Method Summary

Methods

Modifier and Type	Method and Description
xapi.collect.api.Fifo<String>	commands()
ShellCommand	commands(String... text)
String	directory()
ShellCommand	directory(String directory)
String	owner()
ShellCommand	owner(String owner)
ShellResult	run(xapi.util.api.SuccessHandler<ShellResult> callback, ArgumentProcessor processor) Starts the command; returns a future and accepts a callback.

Field Detail

STATUS_DESTROYED

static final Integer STATUS_DESTROYED

STATUS_FAILED

static final Integer STATUS_FAILED

Method Detail

owner

String owner()

Returns:

The user to initiate the command (not yet used)

commands

xapi.collect.api.Fifo<String> commands()

Returns:

A simple linked list with a join method; perfect for chaining together command fragments. (ProcessBuilder uses String[], but it's nice to have add without array bounds checks,

directory

String directory()

Returns:

- The direct in which to launch the command. Defaults to "."

owner

ShellCommand owner(String owner)

directory

ShellCommand directory(String directory)

commands

ShellCommand commands(String... text)

run

ShellResult run(xapi.util.api.SuccessHandler<ShellResult> callback,
              ArgumentProcessor processor)

Starts the command; returns a future and accepts a callback.

Parameters:

callback - - optional success handler, to allow pushing work forward

processor - - optional argument handler, to manipulate the command being run.

Returns:

- A ShellResult future, for platforms that can afford to block on results.