com.sap.cloud.server.odata

Class SystemProcess

java.lang.Object

com.sap.cloud.server.odata.SystemProcess

public class SystemProcess
extends java.lang.Object

Functions for executing system processes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHOW_ERROR_OUTPUT Bit flag.
static int	SHOW_FULL_COMMAND Bit flag.
static int	SHOW_PROGRAM_NAME Bit flag.

Constructor Summary

Constructors

Constructor and Description
SystemProcess(StringList command) Construct a new system process, but don't start it yet.

Method Summary

Modifier and Type	Method and Description
void	checkExitCode(int code) Check that the process exited with the specified code.
ByteStream	getErrorByteStream() Return error byte stream for the process, available only once SystemProcess.start has been called.
CharStream	getErrorCharStream() Return error char stream for the process, available only once SystemProcess.start has been called.
java.lang.RuntimeException	getException(java.lang.String message) See getException(String, RuntimeException).
java.lang.RuntimeException	getException(java.lang.String message, java.lang.RuntimeException cause) Kill the process if it is still running, and return an exception indicating process failure.
int	getExitCode() Return exit code for the process, available only once SystemProcess.waitForExit has been called.
ByteStream	getInputByteStream() Return input byte stream for the process, available only once SystemProcess.start has been called.
CharStream	getInputCharStream() Return input char stream for the process, available only once SystemProcess.start has been called.
int	getShowInExceptions() Return what can be shown in exception messages? Defaults to SHOW_FULL_COMMAND + SHOW_ERROR_OUTPUT.
void	kill() Kill the process if it is running.
void	setShowInExceptions(int value) Set what can be shown in exception messages? Defaults to SHOW_FULL_COMMAND + SHOW_ERROR_OUTPUT.
void	start() Start tthe process.
void	waitForExit() Wait for the process to finish executing.

Methods inherited from class java.lang.Object

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

Field Detail

SHOW_FULL_COMMAND

public static final int SHOW_FULL_COMMAND

Bit flag. Use for SystemProcess.showInExceptions if full command should be shown.

See Also:

Constant Field Values

SHOW_PROGRAM_NAME

public static final int SHOW_PROGRAM_NAME

Bit flag. Use for SystemProcess.showInExceptions if program name should be shown.

See Also:

Constant Field Values

SHOW_ERROR_OUTPUT

public static final int SHOW_ERROR_OUTPUT

Bit flag. Use for SystemProcess.showInExceptions if error output should be shown.

See Also:

Constant Field Values

Constructor Detail

SystemProcess

public SystemProcess(StringList command)

Construct a new system process, but don't start it yet.

See Also:

SystemProcess.start.

Parameters:

command - System command.

Method Detail

checkExitCode

public void checkExitCode(int code)

Check that the process exited with the specified code.

Parameters:

code - Expected exit code.

getErrorByteStream

public ByteStream getErrorByteStream()

Return error byte stream for the process, available only once SystemProcess.start has been called.

Returns:

Error byte stream for the process, available only once SystemProcess.start has been called.

getErrorCharStream

public CharStream getErrorCharStream()

Return error char stream for the process, available only once SystemProcess.start has been called.

Returns:

Error char stream for the process, available only once SystemProcess.start has been called.

getException

public java.lang.RuntimeException getException(java.lang.String message)

See getException(String, RuntimeException).

Parameters:

message - Message parameter.

Returns:

(see linked method).

getException

public java.lang.RuntimeException getException(java.lang.String message,
                                               java.lang.RuntimeException cause)

Kill the process if it is still running, and return an exception indicating process failure.

Parameters:

message - (nullable) Error message.

cause - (nullable) Root cause.

Returns:

An exception to indicate that the process failed.

getExitCode

public int getExitCode()

Return exit code for the process, available only once SystemProcess.waitForExit has been called.

Returns:

Exit code for the process, available only once SystemProcess.waitForExit has been called.

getInputByteStream

public ByteStream getInputByteStream()

Return input byte stream for the process, available only once SystemProcess.start has been called.

Returns:

Input byte stream for the process, available only once SystemProcess.start has been called.

getInputCharStream

public CharStream getInputCharStream()

Return input char stream for the process, available only once SystemProcess.start has been called.

Returns:

Input char stream for the process, available only once SystemProcess.start has been called.

getShowInExceptions

public int getShowInExceptions()

Return what can be shown in exception messages? Defaults to SHOW_FULL_COMMAND + SHOW_ERROR_OUTPUT.

See Also:

SHOW_FULL_COMMAND, SHOW_PROGRAM_NAME, SHOW_ERROR_OUTPUT.

Returns:

What can be shown in exception messages? Defaults to SHOW_FULL_COMMAND + SHOW_ERROR_OUTPUT.

kill

public void kill()

Kill the process if it is running.

setShowInExceptions

public void setShowInExceptions(int value)

Set what can be shown in exception messages? Defaults to SHOW_FULL_COMMAND + SHOW_ERROR_OUTPUT.

See Also:

SHOW_FULL_COMMAND, SHOW_PROGRAM_NAME, SHOW_ERROR_OUTPUT.

Parameters:

value - What can be shown in exception messages? Defaults to SHOW_FULL_COMMAND + SHOW_ERROR_OUTPUT.

start

public void start()

Start tthe process.

waitForExit

public void waitForExit()

Wait for the process to finish executing.