Package com.logicaldoc.util.exec

Class Exec

java.lang.Object

com.logicaldoc.util.exec.Exec

public class Exec
extends Object

Utility class used to execute system commands

Since:

6.3

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
Exec()

Method Summary

Modifier and Type	Method	Description
int	exec(String commandLine, List<String> env, File dir, int timeout)	Execute the command by using the Runtime.exec
int	exec(String commandLine, List<String> env, File dir, Writer outputWriter, int timeout)
int	exec(String commandLine, List<String> env, File dir, StringBuilder buffer, int timeout)
int	exec(List<String> commandLine)	Execute the command by using the Runtime.getRuntime().exec()
int	exec(List<String> commandLine, List<String> env, File dir, int timeout)	Executes the command by using the Runtime.getRuntime().exec()
String	execGetOutput(String commandLine, List<String> env, File dir)	Execute the command by using the Runtime.getRuntime().exec()
String	execGetOutput(List<String> commandLine, List<String> env, File dir, int timeout)	Executes the command by using the Runtime.getRuntime().exec()
int	execPB(List<String> commandLine, File directory, int timeout)	Executes the command by using the process builder.
int	execPB(List<String> commandLine, Map<String,String> environment, File directory, int timeout)	Executes the command by using the process builder.
boolean	isWindows()	Checks if you are running on Windows
void	setErrPrefix(String errPrefix)
void	setOutPrefix(String outPrefix)

Methods inherited from class java.lang.Object

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

Constructor Details

Exec

public Exec()

Method Details

setErrPrefix

public void setErrPrefix(String errPrefix)

setOutPrefix

public void setOutPrefix(String outPrefix)

isWindows

public boolean isWindows()

Checks if you are running on Windows

Returns:

true if the execution platform is Windows

execPB

public int execPB(List<String> commandLine,
 Map<String,String> environment,
 File directory,
 int timeout)
           throws IOException

Executes the command by using the process builder.

Parameters:

commandLine - The command line to process. The path of the command must be listed in the allowed-commands.txt

environment - The environemnt variables

directory - The folder where the command will be executed

timeout - The timeout in seconds

Returns:

the return value

Throws:

IOException - raised in case of errors during execution

execPB

public int execPB(List<String> commandLine,
 File directory,
 int timeout)
           throws IOException

Executes the command by using the process builder.

Parameters:

commandLine - The command line to process. The path of the command must be listed in the allowed-commands.txt

directory - The folder where the command will be executed

timeout - The timeout in seconds

Returns:

the return value

Throws:

IOException - raised in case of errors during execution

exec

public int exec(List<String> commandLine)
         throws IOException

Execute the command by using the Runtime.getRuntime().exec()

Parameters:

commandLine - the list of elements in the command line. The path of the command must be listed in the allowed-commands.txt

Returns:

the command execution return value

Throws:

IOException - raised in case of errors during execution

exec

public int exec(List<String> commandLine,
 List<String> env,
 File dir,
 int timeout)
         throws IOException

Executes the command by using the Runtime.getRuntime().exec()

Parameters:

commandLine - the list of elements in the command line. The path of the command must be listed in the allowed-commands.txt

env - the environment variables

dir - the current folder

timeout - maximum execution time expressed in seconds

Returns:

the return code of the command

Throws:

IOException - raised in case of errors during execution

execGetOutput

public String execGetOutput(List<String> commandLine,
 List<String> env,
 File dir,
 int timeout)
                     throws IOException

Executes the command by using the Runtime.getRuntime().exec()

Parameters:

commandLine - the list of elements in the command line. The path of the command must be listed in the allowed-commands.txt

env - the environment variables

dir - the current folder

timeout - maximum execution time expressed in seconds

Returns:

The output of the command

Throws:

IOException - raised in case of errors during execution

execGetOutput

public String execGetOutput(String commandLine,
 List<String> env,
 File dir)
                     throws IOException

Execute the command by using the Runtime.getRuntime().exec()

Parameters:

commandLine - the command line string. The path of the command must be listed in the allowed-commands.txt

env - the execution environment

dir - the current folder

Returns:

The output of the command

Throws:

IOException - If the execution caused an error

exec

public int exec(String commandLine,
 List<String> env,
 File dir,
 StringBuilder buffer,
 int timeout)
         throws IOException

Throws:

IOException

exec

public int exec(String commandLine,
 List<String> env,
 File dir,
 Writer outputWriter,
 int timeout)
         throws IOException

Throws:

IOException

exec

public int exec(String commandLine,
 List<String> env,
 File dir,
 int timeout)
         throws IOException

Execute the command by using the Runtime.exec

Parameters:

commandLine - the command line. The path of the command must be listed in the allowed-commands.txt

env - the environment variables

dir - the current execution directory

timeout - maximum execution time expressed in seconds

Returns:

the command return value

Throws:

IOException - raised if the command produced an error