Interface ExecuteOptions

public interface ExecuteOptions

This interface defines options for executing a process.

Method Summary

Modifier and Type	Method	Description
static ExecuteOptions	executeOptions()	Creates a new ExecuteOptions instance.
ExecuteOptions	withEnvironmentVariable(String name, String value)	Defines an environment variable to be used by the process.
ExecuteOptions	withExitCodeBehavior(ExitCodeBehavior behavior)	Sets whether non-zero exit codes throw an exception, or are silently ignored.
ExecuteOptions	withStderrBehavior(StderrBehavior behavior)	Sets how stderr (standard error) output is handled.
ExecuteOptions	withTimeout(int seconds)	Sets the maximum duration the process is allowed to run in seconds.
ExecuteOptions	withTimeout(Duration duration)	Sets the maximum duration the process is allowed to run.
ExecuteOptions	withTimeoutBehavior(TimeoutBehavior behavior)	Sets the behavior regarding whether timeouts should throw an exception or be silently ignored.

Method Details

withTimeout

ExecuteOptions withTimeout(int seconds)

Sets the maximum duration the process is allowed to run in seconds. Defaults to 10 seconds. To disable the timeout, use 0.

Use withTimeoutBehavior(burp.api.montoya.utilities.shell.TimeoutBehavior) to define the behavior regarding whether timeouts should throw an exception or be silently ignored.

Parameters:

seconds - The timeout duration, in seconds. Use 0 for unlimited.

Returns:

An ExecuteOptions instance with the updated timeout.

withTimeout

ExecuteOptions withTimeout(Duration duration)

Sets the maximum duration the process is allowed to run. Defaults to 10 seconds. To disable the timeout, use Duration.ZERO.

Use withTimeoutBehavior(burp.api.montoya.utilities.shell.TimeoutBehavior) to define the behavior regarding whether timeouts should throw an exception or be silently ignored.

Parameters:

duration - The timeout duration. Use Duration.ZERO for unlimited.

Returns:

An ExecuteOptions instance with the updated timeout.

withTimeoutBehavior

ExecuteOptions withTimeoutBehavior(TimeoutBehavior behavior)

Sets the behavior regarding whether timeouts should throw an exception or be silently ignored. Defaults to TimeoutBehavior.FAIL_ON_TIMEOUT.

Parameters:

behavior - The timeout behavior.

Returns:

An ExecuteOptions instance with the updated timeout behavior.

withStderrBehavior

ExecuteOptions withStderrBehavior(StderrBehavior behavior)

Sets how stderr (standard error) output is handled. Defaults to StderrBehavior.DISCARD.

Parameters:

behavior - The stderr handling behavior.

Returns:

An ExecuteOptions instance with the updated stderr behavior.

withExitCodeBehavior

ExecuteOptions withExitCodeBehavior(ExitCodeBehavior behavior)

Sets whether non-zero exit codes throw an exception, or are silently ignored. Defaults to ExitCodeBehavior.FAIL_ON_NON_ZERO.

Parameters:

behavior - The non-zero exit code handling behavior.

Returns:

An ExecuteOptions instance with the updated non-zero exit behavior.

withEnvironmentVariable

ExecuteOptions withEnvironmentVariable(String name,
 String value)

Defines an environment variable to be used by the process.

Parameters:

name - The variable name.

value - The variable value.

Returns:

An ExecuteOptions instance with the added variable.

executeOptions

static ExecuteOptions executeOptions()

Creates a new ExecuteOptions instance.

Returns:

An ExecuteOptions instance with default settings.