ch.exense.commons.processes

Class ManagedProcess

java.lang.Object

ch.exense.commons.processes.ManagedProcess

All Implemented Interfaces:

Closeable, AutoCloseable

public class ManagedProcess
extends Object
implements Closeable

Author:

jcomte

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ManagedProcess.ManagedProcessException

Constructor Summary

Constructors

Constructor and Description
ManagedProcess(List<String> commands)
ManagedProcess(List<String> commands, File logDirectory)
ManagedProcess(String command)
ManagedProcess(String name, List<String> commands)
ManagedProcess(String name, List<String> commands, File logDirectory, boolean redirectOuput)
ManagedProcess(String name, String command)

Method Summary

Modifier and Type	Method and Description
void	close()
File	getExecutionDirectory()
String	getId()
File	getProcessErrorLog()
InputStream	getProcessInputStream()
File	getProcessOutputLog()
OutputStream	getProcessOutputStream()
void	start()
int	waitFor(long timeout) Causes the current thread to wait, if necessary, until the process has terminated, or the specified waiting time elapses.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedProcess

public ManagedProcess(String command)
               throws ManagedProcess.ManagedProcessException

Parameters:

command - the command to be executed (the program and its arguments) formatted as string

Throws:

ManagedProcess.ManagedProcessException

ManagedProcess

public ManagedProcess(String name,
                      String command)
               throws ManagedProcess.ManagedProcessException

Parameters:

name - a string describing the process. This is used to prefix the ID which uniquely identifies the process instance

command - the command to be executed (the program and its arguments) formatted as string

Throws:

ManagedProcess.ManagedProcessException

ManagedProcess

public ManagedProcess(List<String> commands)
               throws ManagedProcess.ManagedProcessException

Parameters:

commands - the list containing the program and its arguments

Throws:

ManagedProcess.ManagedProcessException

ManagedProcess

public ManagedProcess(String name,
                      List<String> commands)
               throws ManagedProcess.ManagedProcessException

Parameters:

name - a string describing the process. This is used to prefix the ID which uniquely identifies the process instance

commands - the list containing the program and its arguments

Throws:

ManagedProcess.ManagedProcessException

ManagedProcess

public ManagedProcess(List<String> commands,
                      File logDirectory)
               throws ManagedProcess.ManagedProcessException

Parameters:

commands - the list containing the program and its arguments

logDirectory - the directory where the logs (stdout and stderr) of the process will be written to

Throws:

ManagedProcess.ManagedProcessException

ManagedProcess

public ManagedProcess(String name,
                      List<String> commands,
                      File logDirectory,
                      boolean redirectOuput)
               throws ManagedProcess.ManagedProcessException

Parameters:

name - a string describing the process. This is used to prefix the ID wich uniquely identifies the process instance

commands - the list containing the program and its arguments

logDirectory - the directory where the logs (stdout and stderr) of the process will be written to

Throws:

ManagedProcess.ManagedProcessException

Method Detail

getId

public String getId()

getProcessOutputStream

public OutputStream getProcessOutputStream()

getProcessInputStream

public InputStream getProcessInputStream()
                                  throws Exception

Throws:

Exception

getProcessOutputLog

public File getProcessOutputLog()

getProcessErrorLog

public File getProcessErrorLog()

getExecutionDirectory

public File getExecutionDirectory()

start

public void start()
           throws ManagedProcess.ManagedProcessException

Throws:

ManagedProcess.ManagedProcessException

waitFor

public int waitFor(long timeout)
            throws TimeoutException,
                   InterruptedException

Causes the current thread to wait, if necessary, until the process has terminated, or the specified waiting time elapses.

Parameters:

timeout - the maximum time to wait in ms

Throws:

TimeoutException - if the process doesn't exit within the defined timeout

InterruptedException - if the thread is interrupted while waiting for the process to exit

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException