org.spincast.plugins.processutils

Interface SpincastProcessUtils

All Known Implementing Classes:

SpincastProcessUtilsDefault

public interface SpincastProcessUtils

Utilities related to processes, external programs and projects manipulation.

Method Summary

Modifier and Type	Method and Description
void	executeAsync(ProcessExecutionHandler handler, List<String> cmdArgs) Execute an external program asynchronously.
void	executeAsync(ProcessExecutionHandler handler, long timeoutAmount, TimeUnit timeoutUnit, List<String> cmdArgs) Execute an external program asynchronously.
void	executeAsync(ProcessExecutionHandler handler, long timeoutAmount, TimeUnit timeoutUnit, String... cmdArgs) Execute an external program asynchronously.
void	executeAsync(ProcessExecutionHandler handler, String... cmdArgs) Execute an external program asynchronously.
File	executeGoalOnExternalMavenProject(ResourceInfo projectRootInfo, MavenProjectGoal mavenGoal) Execute the specified goal on an external Maven project.
File	executeGoalOnExternalMavenProject(ResourceInfo projectRootInfo, MavenProjectGoal mavenGoal, Map<String,Object> pomParams) Execute the specified goal on an external Maven project.
SyncExecutionResult	executeSync(long timeoutAmount, TimeUnit timeoutUnit, ExecutionOutputStrategy executionOutputStrategy, List<String> cmdArgs) Execute an external program synchronously.
SyncExecutionResult	executeSync(long timeoutAmount, TimeUnit timeoutUnit, ExecutionOutputStrategy executionOutputStrategy, String... cmdArgs) Execute an external program synchronously.
SyncExecutionResult	executeSync(long timeoutAmount, TimeUnit timeoutUnit, List<String> cmdArgs) Execute an external program synchronously.
SyncExecutionResult	executeSync(long timeoutAmount, TimeUnit timeoutUnit, String... cmdArgs) Execute an external program synchronously.

Method Detail

executeGoalOnExternalMavenProject

File executeGoalOnExternalMavenProject(ResourceInfo projectRootInfo,
                                       MavenProjectGoal mavenGoal)

Execute the specified goal on an external Maven project.

If the project is located on the classpath, it first copies it to the file system (in a temp folder).

Returns:

the root directory of the project. This will be the same as the specified path if on the file system, or will be the created temp directory where the project has been copied (from the classpath) otherwise.

executeGoalOnExternalMavenProject

File executeGoalOnExternalMavenProject(ResourceInfo projectRootInfo,
                                       MavenProjectGoal mavenGoal,
                                       Map<String,Object> pomParams)

Execute the specified goal on an external Maven project.

If the project is located on the classpath, it first copies it to the file system (in a temp folder).

Parameters:

pomParams - Before executing the goal, those parameters are used to replace placeholders in the project's pom.xml using Spincast's TemplatingEngine.

Returns:

the root directory of the project. This will be the same as the specified path if on the file system, or will be the created temp directory where the project has been copied (from the classpath) otherwise.

executeAsync

void executeAsync(ProcessExecutionHandler handler,
                  String... cmdArgs)

Execute an external program asynchronously.

The method will only return when the process is actually created or if an exception occured when trying to do so.

If this creates a process that is not made to exit automatically (for example it starts an HTTP server), you must kill the process by yourself!:

 ProcessExecutionHandlerDefault handler = new ProcessExecutionHandlerDefault();
 {
     // override some methods...
 };
 getSpincastProcessUtils().executeAsync(handler,
                                        "java",
                                        "-jar",
                                        jarFile.getAbsolutePath());
 try {
     //...
 } finally {
     handler.killProcess();
 }
 

Parameters:

handler - to get information from the created process and to be able to kill it.

executeAsync

void executeAsync(ProcessExecutionHandler handler,
                  long timeoutAmount,
                  TimeUnit timeoutUnit,
                  String... cmdArgs)

Execute an external program asynchronously.

The method will only return when the process is actually created or if an exception occured when trying to do so.

If this creates a process that is not made to exit automatically (for example it starts an HTTP server), you must kill the process by yourself!:

 ProcessExecutionHandlerDefault handler = new ProcessExecutionHandlerDefault();
 {
     // override some methods...
 };();
 getSpincastProcessUtils().executeAsync(handler,
                                        "java",
                                        "-jar",
                                        jarFile.getAbsolutePath());
 try {
     //...
 } finally {
     handler.killProcess();
 }
 

Parameters:

handler - to get information from the created process and to be able to kill it.

timeoutAmount - the amount of time the external program is allowed to run before a timeout occurs. When the timeout occurs:

• The process is killed
• onTimeoutException() is called

Note that onExit() will not be called if a timeout occurs!

timeoutUnit - the timeout unit.

executeAsync

void executeAsync(ProcessExecutionHandler handler,
                  List<String> cmdArgs)

Execute an external program asynchronously.

The method will only return when the process is actually created or if an exception occured when trying to do so.

If this creates a process that is not made to exit automatically (for example it starts an HTTP server), you must kill the process by yourself!:

 ProcessExecutionHandlerDefault handler = new ProcessExecutionHandlerDefault();
 {
     // override some methods...
 };
 getSpincastProcessUtils().executeAsync(handler,
                                        "java",
                                        "-jar",
                                        jarFile.getAbsolutePath());
 try {
     //...
 } finally {
     handler.killProcess();
 }
 

Parameters:

handler - to get information from the created process and to be able to kill it.

executeAsync

void executeAsync(ProcessExecutionHandler handler,
                  long timeoutAmount,
                  TimeUnit timeoutUnit,
                  List<String> cmdArgs)

Execute an external program asynchronously.

The method will only return when the process is actually created or if an exception occured when trying to do so.

If this creates a process that is not made to exit automatically (for example it starts an HTTP server), you must kill the process by yourself!:

 ProcessExecutionHandlerDefault handler = new ProcessExecutionHandlerDefault();
 {
     // override some methods...
 };
 getSpincastProcessUtils().executeAsync(handler,
                                        "java",
                                        "-jar",
                                        jarFile.getAbsolutePath());
 try {
     //...
 } finally {
     handler.killProcess();
 }
 

Parameters:

handler - to get information from the created process and to be able to kill it.

timeoutAmount - the amount of time the external program is allowed to run before a timeout occurs. When the timeout occurs:

• The process is killed
• onTimeoutException() is called

Note that onExit() will not be called if a timeout occurs!

timeoutUnit - the timeout unit.

executeSync

SyncExecutionResult executeSync(long timeoutAmount,
                                TimeUnit timeoutUnit,
                                String... cmdArgs)
                         throws LaunchException,
                                TimeoutException

Execute an external program synchronously.

By default SYSTEM is used as the output strategy so it is printed to System.out and System.err.

Parameters:

timeoutAmount - the amount of time the external program is allowed to run before a timeout occurs. When the timeout occurs:

• The process is killed
• A TimeoutException exception is thrown.

timeoutUnit - the timeout unit.

Returns:

an object contaning the information about the execution of the program.

Throws:

TimeoutException - if the specified timeout is exceeded.

LaunchException - if the program can't be launched properly.

executeSync

SyncExecutionResult executeSync(long timeoutAmount,
                                TimeUnit timeoutUnit,
                                List<String> cmdArgs)
                         throws LaunchException,
                                TimeoutException

Execute an external program synchronously.

By default SYSTEM is used as the output strategy so it is printed to System.out and System.err.

Parameters:

timeoutAmount - the amount of time the external program is allowed to run before a timeout occurs. When the timeout occurs:

• The process is killed
• A TimeoutException exception is thrown.

timeoutUnit - the timeout unit.

Returns:

an object contaning the information about the execution of the program.

Throws:

TimeoutException - if the specified timeout is exceeded.

LaunchException - if the program can't be launched properly.

executeSync

SyncExecutionResult executeSync(long timeoutAmount,
                                TimeUnit timeoutUnit,
                                ExecutionOutputStrategy executionOutputStrategy,
                                String... cmdArgs)
                         throws LaunchException,
                                TimeoutException

Execute an external program synchronously.

By default SYSTEM is used as the output strategy so it is printed to System.out and System.err.

Parameters:

timeoutAmount - the amount of time the external program is allowed to run before a timeout occurs. When the timeout occurs:

• The process is killed.
• A TimeoutException exception is thrown.

timeoutUnit - the timeout unit.

executionOutputStrategy - what should be done with the output of the executed program?

Returns:

an object contaning the information about the execution of the program.

Throws:

TimeoutException - if the specified timeout is exceeded.

LaunchException - if the program can't be launched properly.

executeSync

SyncExecutionResult executeSync(long timeoutAmount,
                                TimeUnit timeoutUnit,
                                ExecutionOutputStrategy executionOutputStrategy,
                                List<String> cmdArgs)
                         throws LaunchException,
                                TimeoutException

Execute an external program synchronously.

By default SYSTEM is used as the output strategy so it is printed to System.out and System.err.

Parameters:

timeoutAmount - the amount of time the external program is allowed to run before a timeout occurs. When the timeout occurs:

• The process is killed.
• A TimeoutException exception is thrown.

timeoutUnit - the timeout unit.

executionOutputStrategy - what should be done with the output of the executed program?

Returns:

an object contaning the information about the execution of the program.

Throws:

TimeoutException - if the specified timeout is exceeded.

LaunchException - if the program can't be launched properly.