org.openksavi.sponge.core.util

Class ProcessUtils

java.lang.Object

org.openksavi.sponge.core.util.ProcessUtils

public abstract class ProcessUtils
extends Object

This class defines a set of process utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_PROCESS_ENV_NAME
static String	TAG_PROCESS_ARGUMENT
static String	TAG_PROCESS_CHARSET
static String	TAG_PROCESS_ENV
static String	TAG_PROCESS_EXECUTABLE
static String	TAG_PROCESS_REDIRECT_TYPE
static String	TAG_PROCESS_WAIT_FOR_OUTPUT_LINE_REGEXP
static String	TAG_PROCESS_WAIT_FOR_OUTPUT_LINE_TIMEOUT
static String	TAG_PROCESS_WAIT_SECONDS
static String	TAG_PROCESS_WORKING_DIR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProcessUtils()

Method Summary

Modifier and Type	Method and Description
static ProcessConfiguration.Builder	createProcessConfigurationBuilder(Configuration configuration)
static ProcessInstance	startProcess(SpongeEngine engine, ProcessConfiguration processConfiguration)
static ProcessInstance	startProcessAndWaitForOutputLine(SpongeEngine engine, ProcessConfiguration processConfiguration)
static ProcessInstance	startProcessWithOutputLineConsumer(SpongeEngine engine, ProcessConfiguration processConfiguration, Consumer<String> outputConsumer) Starts a new process.

Methods inherited from class java.lang.Object

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

Field Detail

TAG_PROCESS_EXECUTABLE

public static final String TAG_PROCESS_EXECUTABLE

See Also:

Constant Field Values

TAG_PROCESS_ARGUMENT

public static final String TAG_PROCESS_ARGUMENT

See Also:

Constant Field Values

TAG_PROCESS_WORKING_DIR

public static final String TAG_PROCESS_WORKING_DIR

See Also:

Constant Field Values

TAG_PROCESS_ENV

public static final String TAG_PROCESS_ENV

See Also:

Constant Field Values

TAG_PROCESS_WAIT_SECONDS

public static final String TAG_PROCESS_WAIT_SECONDS

See Also:

Constant Field Values

TAG_PROCESS_REDIRECT_TYPE

public static final String TAG_PROCESS_REDIRECT_TYPE

See Also:

Constant Field Values

TAG_PROCESS_CHARSET

public static final String TAG_PROCESS_CHARSET

See Also:

Constant Field Values

TAG_PROCESS_WAIT_FOR_OUTPUT_LINE_REGEXP

public static final String TAG_PROCESS_WAIT_FOR_OUTPUT_LINE_REGEXP

See Also:

Constant Field Values

TAG_PROCESS_WAIT_FOR_OUTPUT_LINE_TIMEOUT

public static final String TAG_PROCESS_WAIT_FOR_OUTPUT_LINE_TIMEOUT

See Also:

Constant Field Values

ATTR_PROCESS_ENV_NAME

public static final String ATTR_PROCESS_ENV_NAME

See Also:

Constant Field Values

Constructor Detail

ProcessUtils

protected ProcessUtils()

Method Detail

createProcessConfigurationBuilder

public static ProcessConfiguration.Builder createProcessConfigurationBuilder(Configuration configuration)

startProcess

public static ProcessInstance startProcess(SpongeEngine engine,
                                           ProcessConfiguration processConfiguration)

startProcessAndWaitForOutputLine

public static ProcessInstance startProcessAndWaitForOutputLine(SpongeEngine engine,
                                                               ProcessConfiguration processConfiguration)

startProcessWithOutputLineConsumer

public static ProcessInstance startProcessWithOutputLineConsumer(SpongeEngine engine,
                                                                 ProcessConfiguration processConfiguration,
                                                                 Consumer<String> outputConsumer)

Starts a new process. Waits the specified time if necessary.

Parameters:

engine - the engine.

processConfiguration - the process configuration,

outputConsumer - the process output consumer. May be null. Applicable only if the redirect type is LOGGER.

Returns:

a new process instance.