alluxio.shell

Class ShellCommand

java.lang.Object

alluxio.shell.ShellCommand

Direct Known Subclasses:

CollectAlluxioInfoCommand.AlluxioCommand, ScpCommand, SshCommand

@NotThreadSafe
public class ShellCommand
extends Object

Object representation of a shell command.

Constructor Summary

Constructors

Constructor and Description
ShellCommand(String[] execString) Creates a ShellCommand object with the command to exec.

Method Summary

Modifier and Type	Method and Description
String[]	getCommand() Gets the command.
String	run() Runs a command and returns its stdout on success.
CommandReturn	runWithOutput() Runs a command and returns its output and exit code in Object.
String	toString() Converts the command to string repr.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShellCommand

public ShellCommand(String[] execString)

Creates a ShellCommand object with the command to exec.

Parameters:

execString - shell command

Method Detail

run

public String run()
           throws IOException

Runs a command and returns its stdout on success. Stderr is redirected to stdout.

Returns:

the output

Throws:

IOException - if the command returns a non-zero exit code

runWithOutput

public CommandReturn runWithOutput()
                            throws IOException

Runs a command and returns its output and exit code in Object. Preserves the output when the execution fails. If the command execution fails (not by an interrupt), try to wrap the Exception in the CommandReturn. Stderr is redirected to stdout.

Returns:

CommandReturn object representation of stdout, stderr and exit code

Throws:

IOException

toString

public String toString()

Converts the command to string repr.

Overrides:

toString in class Object

Returns:

the shell command

getCommand

public String[] getCommand()

Gets the command. The original array is immutable.

Returns:

a copy of the command string array