org.arquillian.spacelift.process

Interface ProcessExecution

public interface ProcessExecution

Representation of a process execution. It automatically consumes process output and error output to avoid process getting stuck.

Author:

Karel Piwko

Method Summary

Methods

Modifier and Type	Method and Description
ProcessExecution	appendOutput(Sentence line) Adds a line to output of this process
boolean	executionFailed() Checks whether getExitCode() was 0
int	getExitCode() Returns exit code
List<String>	getOutput() Returns stdout and stderr of the process in the form of array
String	getProcessId() Returns identification of the process
OutputStream	getStdin() Returns stdin of the process
InputStream	getStdoutAndStdErr() Returns stdout combined with stderr of the process
boolean	isFinished() Checks whether process has finished
boolean	isMarkedAsFinished() Checks whether process is marked as finished
void	markAsFinished() Marks process execution as finished.
void	terminate() Forcefully terminates the process execution

Method Detail

getProcessId

String getProcessId()

Returns identification of the process

Returns:

process id

appendOutput

ProcessExecution appendOutput(Sentence line)

Adds a line to output of this process

Parameters:

line -

Returns:

this

getOutput

List<String> getOutput()

Returns stdout and stderr of the process in the form of array

Returns:

current output of the process

getStdin

OutputStream getStdin()

Returns stdin of the process

Returns:

getStdoutAndStdErr

InputStream getStdoutAndStdErr()

Returns stdout combined with stderr of the process

Returns:

markAsFinished

void markAsFinished()

Marks process execution as finished. This means that process did what we expected and might be considered as finished. This is handy for environments where a native process starts another process we have no control of, but we can determine process termination by scanning its stdout or stderr.

isMarkedAsFinished

boolean isMarkedAsFinished()

Checks whether process is marked as finished

isFinished

boolean isFinished()

Checks whether process has finished

Returns:

true if process has finished, false otherwise

getExitCode

int getExitCode()
                throws IllegalStateException

Returns exit code

Returns:

exit code

Throws:

IllegalStateException - thrown if process is not finished

executionFailed

boolean executionFailed()

Checks whether getExitCode() was 0

Returns:

true if exit code is not 0, false otherwise

terminate

void terminate()

Forcefully terminates the process execution