org.arquillian.spacelift.task.os

Class CommandTool

java.lang.Object

org.arquillian.spacelift.task.Task<Object,ProcessResult>

org.arquillian.spacelift.task.os.CommandTool

public class CommandTool
extends Task<Object,ProcessResult>

Tool that is able to execute an external, operating system dependent command.

Author:

Karel Piwko

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Integer>	allowedExitCodes
protected CommandBuilder	commandBuilder
static File	CURRENT_USER_DIR Representation of current process working directory for purposes of spawning new process
protected Map<String,String>	environment
protected ProcessInteraction	interaction
protected boolean	isDaemon
protected org.arquillian.spacelift.task.os.ProcessReference	processRef
protected File	workingDirectory

Constructor Summary

Constructors

Constructor and Description
CommandTool()

Method Summary

Modifier and Type	Method and Description
CommandTool	addEnvironment(CharSequence... envVariables) Adds a sequence of key, value environment variables to the default process environment
CommandTool	addEnvironment(Map<? extends CharSequence,? extends CharSequence> envVariables) Adds a map of key, value environment variables to the default process environment
CommandTool	command(Command command) Sets the command.
CommandTool	command(CommandBuilder commandBuilder) Sets the command.
Execution<ProcessResult>	execute()
CommandTool	interaction(ProcessInteraction interaction) Sets interaction for the command
CommandTool	interaction(ProcessInteractionBuilder interactionBuilder) Sets interaction for the command
CommandTool	parameter(CharSequence parameter) Adds a parameter to the command to be executed
CommandTool	parameters(CharSequence... parameters) Adds a list of parameters to the command to be executed
CommandTool	parameters(List<? extends CharSequence> parameters) Adds a list of parameters to the command to be executed
protected ProcessResult	process(Object input)
CommandTool	programName(CharSequence programName) Sets executable to be executed.
CommandTool	runAsDaemon() Indicates that command should be executed as daemon and survive JVM process.
CommandTool	shouldExitWith(Integer... exitCodes) Adds list of valid exit codes for the command.
CommandTool	splitToParameters(CharSequence sequenceToBeParsed) Splits sequenceToBeParsed into list of parameters, using unescaped spaces as delimiters
CommandTool	workingDir(String workingDirectory) Deprecated.
CommandTool	workingDirectory(File workingDirectory)
CommandTool	workingDirectory(String workingDirectory) Sets working directory for the command

Methods inherited from class org.arquillian.spacelift.task.Task

getExecutionService, run, setExecutionService, setPreviousTask, then, then

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_USER_DIR

public static final File CURRENT_USER_DIR

Representation of current process working directory for purposes of spawning new process

commandBuilder

protected CommandBuilder commandBuilder

interaction

protected ProcessInteraction interaction

allowedExitCodes

protected List<Integer> allowedExitCodes

workingDirectory

protected File workingDirectory

environment

protected Map<String,String> environment

isDaemon

protected boolean isDaemon

processRef

protected org.arquillian.spacelift.task.os.ProcessReference processRef

Constructor Detail

CommandTool

public CommandTool()

Method Detail

programName

public CommandTool programName(CharSequence programName)
                        throws IllegalArgumentException

Sets executable to be executed. This can either a an absolute path or executed on path of underlying file system

Parameters:

programName - program name

Throws:

IllegalArgumentException - If program name is null or empty

parameters

public CommandTool parameters(List<? extends CharSequence> parameters)

Adds a list of parameters to the command to be executed

Parameters:

parameters - parameters

parameters

public CommandTool parameters(CharSequence... parameters)

Adds a list of parameters to the command to be executed

Parameters:

parameters - parameters

parameter

public CommandTool parameter(CharSequence parameter)

Adds a parameter to the command to be executed

Parameters:

parameter - parameter

splitToParameters

public CommandTool splitToParameters(CharSequence sequenceToBeParsed)

Splits sequenceToBeParsed into list of parameters, using unescaped spaces as delimiters

Parameters:

sequenceToBeParsed - string to be parsed

interaction

public CommandTool interaction(ProcessInteraction interaction)

Sets interaction for the command

Parameters:

interaction - the interaction

interaction

public CommandTool interaction(ProcessInteractionBuilder interactionBuilder)

Sets interaction for the command

Parameters:

interactionBuilder - the interaction

command

public CommandTool command(Command command)

Sets the command. Overrides all previous parameters and program name

Parameters:

command - the command

command

public CommandTool command(CommandBuilder commandBuilder)

Sets the command. Overrides all previous parameters and program name

Parameters:

command - the command

shouldExitWith

public CommandTool shouldExitWith(Integer... exitCodes)

Adds list of valid exit codes for the command. If command finishes execution and exit code does not match the one set, ExecutionException is thrown

By default, allowed exit code is set to 0

Parameters:

exitCodes - the exit code

others - possible other codes

See Also:

ExecutionException

workingDirectory

public CommandTool workingDirectory(File workingDirectory)
                             throws IllegalArgumentException

Throws:

IllegalArgumentException

workingDirectory

public CommandTool workingDirectory(String workingDirectory)
                             throws IllegalArgumentException

Sets working directory for the command

Parameters:

workingDirectory - working directory, can be null to use current directory of running Java process

Throws:

IllegalArgumentException - if working directory does not exist

workingDir

@Deprecated
public CommandTool workingDir(String workingDirectory)
                                   throws IllegalArgumentException

Deprecated.

Throws:

IllegalArgumentException

addEnvironment

public CommandTool addEnvironment(Map<? extends CharSequence,? extends CharSequence> envVariables)
                           throws IllegalArgumentException

Adds a map of key, value environment variables to the default process environment

Parameters:

envVariables - environment variables. Value might be null.

Throws:

IllegalArgumentException

addEnvironment

public CommandTool addEnvironment(CharSequence... envVariables)
                           throws IllegalArgumentException

Adds a sequence of key, value environment variables to the default process environment

Parameters:

envVariables - environment variables. Value might be null.

Throws:

IllegalArgumentException - If values do not form complete pairs or if key is null

runAsDaemon

public CommandTool runAsDaemon()

Indicates that command should be executed as daemon and survive JVM process.

execute

public Execution<ProcessResult> execute()
                                 throws ExecutionException

Overrides:

execute in class Task<Object,ProcessResult>

Throws:

ExecutionException

process

protected ProcessResult process(Object input)
                         throws Exception

Specified by:

process in class Task<Object,ProcessResult>

Throws:

Exception