org.alfresco.extension.util

Class ProcessInvoker

java.lang.Object

org.alfresco.extension.util.ProcessInvoker

public class ProcessInvoker
extends Object

This class provides an easy and safe way to execute an external process (shell script, CLI program, etc.), capturing not only the exit code but also any output that process writes to stdout or stderr.

Version:

$Id$

Author:

Peter Monks (peter.monks@alfresco.com)

Constructor Summary

Constructors

Constructor and Description
ProcessInvoker()

Method Summary

Methods

Modifier and Type	Method and Description
Triple	execute(String[] commandAndParameters) Executes (forks) an external process.
Triple	execute(String[] commandAndParameters, long waitTime) Executes (forks) an external process.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessInvoker

public ProcessInvoker()

Method Detail

execute

public Triple execute(String[] commandAndParameters)
               throws IOException,
                      InterruptedException

Executes (forks) an external process. Note that this won't invoke built-in commands (such as "dir" on Windows or "ulimit" on Linux).

Parameters:

commandAndParameters - The command to execute (at index 0) along with the list of parameters (may not be null or empty).

Returns:

The status code, stdout and stderr returned by the process. Note that extremely large outputs should be avoided, since they can overflow the heap.

Throws:

IOException

InterruptedException

execute

public Triple execute(String[] commandAndParameters,
             long waitTime)
               throws IOException,
                      InterruptedException

Executes (forks) an external process. Note that this won't invoke built-in commands (such as "dir" on Windows or "ulimit" on Linux).

Parameters:

commandAndParameters - The command to execute (at index 0) along with the list of parameters (may not be null or empty).

waitTime - The maximum time to wait (in ms) for the command to complete (must be > 0).

Returns:

The status code, stdout and stderr returned by the process. Note that extremely large outputs should be avoided, since they can overflow the heap.

Throws:

IOException

InterruptedException