org.hkijena.jipipe.utils

Class ProcessUtils

java.lang.Object

org.hkijena.jipipe.utils.ProcessUtils

public class ProcessUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessUtils.ExtendedExecutor
static class	ProcessUtils.ProcessTree Wrapper around an existing process that models a process tree
static class	ProcessUtils.RunCancellationExecuteWatchdog Based on ExecuteWatchdog.
static class	ProcessUtils.RunCancellationWatchdog A watchdog that monitors a sub-process of a JIPipeRunnable and watches for the JIPipeRunnable to be cancelled.

Method Summary

Modifier and Type	Method and Description
static long	getProcessID(Process p) Gets the process ID of a process
static void	killProcessTree(long pid, JIPipeProgressInfo progressInfo)
static void	launchProcess(ProcessEnvironment environment, JIPipeExpressionVariablesMap variables, Map<String,String> overrideEnvironmentVariables, boolean handleQuoting, JIPipeProgressInfo progressInfo) Runs a process detached
static String	queryFast(Path executable, JIPipeProgressInfo progressInfo, String... args) Queries standard output with a timeout.
static void	runProcess(ProcessEnvironment environment, JIPipeExpressionVariablesMap variables, Map<String,String> overrideEnvironmentVariables, boolean handleQuoting, JIPipeProgressInfo progressInfo) Runs a process
static void	setupLogger(org.apache.commons.exec.CommandLine commandLine, org.apache.commons.exec.DefaultExecutor executor, JIPipeProgressInfo progressInfo)
static boolean	shouldHandleQuoting() Test for handling quoting in addArgument
static boolean	systemIsMacM1()

Methods inherited from class java.lang.Object

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

Method Detail

systemIsMacM1

public static boolean systemIsMacM1()

shouldHandleQuoting

public static boolean shouldHandleQuoting()

Test for handling quoting in addArgument

Returns:

if should handle quoting

getProcessID

public static long getProcessID(Process p)

Gets the process ID of a process

Parameters:

p - the process

Returns:

the pid or -1 if it is not found

runProcess

public static void runProcess(ProcessEnvironment environment,
                              JIPipeExpressionVariablesMap variables,
                              Map<String,String> overrideEnvironmentVariables,
                              boolean handleQuoting,
                              JIPipeProgressInfo progressInfo)

Runs a process

Parameters:

environment - the process environment

variables - additional variables for the arguments (can be null)

overrideEnvironmentVariables - additional environment variables

handleQuoting - if argument quoting is handled by commons exec (can be buggy)

progressInfo - the progress info

launchProcess

public static void launchProcess(ProcessEnvironment environment,
                                 JIPipeExpressionVariablesMap variables,
                                 Map<String,String> overrideEnvironmentVariables,
                                 boolean handleQuoting,
                                 JIPipeProgressInfo progressInfo)

Runs a process detached

Parameters:

environment - the process environment

variables - additional variables for the arguments (can be null)

overrideEnvironmentVariables - additional environment variables

handleQuoting - if argument quoting is handled by commons exec (can be buggy)

progressInfo - the progress info

setupLogger

public static void setupLogger(org.apache.commons.exec.CommandLine commandLine,
                               org.apache.commons.exec.DefaultExecutor executor,
                               JIPipeProgressInfo progressInfo)

queryFast

public static String queryFast(Path executable,
                               JIPipeProgressInfo progressInfo,
                               String... args)

Queries standard output with a timeout. Does not listen to cancellation signals

Parameters:

executable - the executable

progressInfo - the progress info

args - executable args

Returns:

the stdout

killProcessTree

public static void killProcessTree(long pid,
                                   JIPipeProgressInfo progressInfo)