Package io.quarkus.deployment.util

Class ExecUtil

java.lang.Object

io.quarkus.deployment.util.ExecUtil

public class ExecUtil
extends Object

Constructor Summary

Constructors

Constructor	Description
ExecUtil()

Method Summary

Modifier and Type	Method	Description
static void	destroyProcess(Process process)	Kill the process, if still alive, kill it forcibly
static boolean	exec(File directory, String command, String... args)	Execute the specified command from within the specified directory.
static boolean	exec(File directory, Function<InputStream,Runnable> outputFilterFunction, String command, String... args)	Execute the specified command from within the specified directory.
static boolean	exec(String command, String... args)	Execute the specified command from within the current directory.
static boolean	execWithDebugLogging(File directory, String command, String... args)	Execute the specified command from within the specified directory using debug logging.
static boolean	execWithDebugLogging(String command, String... args)	Execute the specified command from within the current directory using debug logging.
static boolean	execWithSystemLogging(File directory, String command, String... args)	Execute the specified command from within the specified directory using system logging.
static boolean	execWithSystemLogging(String command, String... args)	Execute the specified command from within the current directory using system logging.
static boolean	execWithTimeout(File directory, Duration timeout, String command, String... args)	Execute the specified command until the given timeout from within the specified directory.
static boolean	execWithTimeout(File directory, Function<InputStream,Runnable> outputFilterFunction, Duration timeout, String command, String... args)	Execute the specified command until the given timeout from within the specified directory.
static boolean	execWithTimeout(Duration timeout, String command, String... args)	Execute the specified command until the given timeout from within the current directory.
static Process	startProcess(File directory, String command, String... args)	Start a process executing given command with arguments within the specified directory.
static void	useDebugLogging()
static void	useInfoLogging()
static void	useSystemLogging()	There are cases where its preferable to just write to System.out.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecUtil

public ExecUtil()

Method Detail

useInfoLogging

public static void useInfoLogging()

useDebugLogging

public static void useDebugLogging()

useSystemLogging

public static void useSystemLogging()

There are cases where its preferable to just write to System.out. For example from maven-invoker verify scripts, logging can trigger Stack Overflow. For such cases its preferable to use this method.

exec

public static boolean exec(String command,
                           String... args)

Execute the specified command from within the current directory.

Parameters:

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

execWithTimeout

public static boolean execWithTimeout(Duration timeout,
                                      String command,
                                      String... args)

Execute the specified command until the given timeout from within the current directory.

Parameters:

timeout - The timeout

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

exec

public static boolean exec(File directory,
                           String command,
                           String... args)

Execute the specified command from within the specified directory.

Parameters:

directory - The directory

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

execWithTimeout

public static boolean execWithTimeout(File directory,
                                      Duration timeout,
                                      String command,
                                      String... args)

Execute the specified command until the given timeout from within the specified directory.

Parameters:

directory - The directory

timeout - The timeout

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

exec

public static boolean exec(File directory,
                           Function<InputStream,Runnable> outputFilterFunction,
                           String command,
                           String... args)

Execute the specified command from within the specified directory. The method allows specifying an output filter that processes the command output.

Parameters:

directory - The directory

outputFilterFunction - A Function that gets an InputStream and returns an outputFilter.

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

execWithTimeout

public static boolean execWithTimeout(File directory,
                                      Function<InputStream,Runnable> outputFilterFunction,
                                      Duration timeout,
                                      String command,
                                      String... args)

Execute the specified command until the given timeout from within the specified directory. The method allows specifying an output filter that processes the command output.

Parameters:

directory - The directory

outputFilterFunction - A Function that gets an InputStream and returns an outputFilter.

timeout - The timeout

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

execWithDebugLogging

public static boolean execWithDebugLogging(String command,
                                           String... args)

Execute the specified command from within the current directory using debug logging.

Parameters:

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

execWithDebugLogging

public static boolean execWithDebugLogging(File directory,
                                           String command,
                                           String... args)

Execute the specified command from within the specified directory using debug logging.

Parameters:

directory - The directory

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

execWithSystemLogging

public static boolean execWithSystemLogging(String command,
                                            String... args)

Execute the specified command from within the current directory using system logging.

Parameters:

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

execWithSystemLogging

public static boolean execWithSystemLogging(File directory,
                                            String command,
                                            String... args)

Execute the specified command from within the specified directory using system logging.

Parameters:

directory - The directory

command - The command

args - The command arguments

Returns:

true if commands where executed successfully

startProcess

public static Process startProcess(File directory,
                                   String command,
                                   String... args)

Start a process executing given command with arguments within the specified directory.

Parameters:

directory - The directory

command - The command

args - The command arguments

Returns:

the process

destroyProcess

public static void destroyProcess(Process process)

Kill the process, if still alive, kill it forcibly

Parameters:

process - the process to kill