org.jahia.utils

Class ProcessHelper

java.lang.Object

org.jahia.utils.ProcessHelper

public final class ProcessHelper
extends Object

Utility class for executing external processes.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
ProcessHelper()

Method Summary

Modifier and Type	Method and Description
static int	execute(String command) Executes the external process using the provided command.
static int	execute(String command, String[] arguments) Executes the external process using the provided command, arguments (optional).
static int	execute(String command, String[] arguments, Map<String,Object> parameterSubstitutionMap) Executes the external process using the provided command, arguments (optional), parameter substitution map to expand variables in the command or arguments in form of ${variable} (optional).
static int	execute(String command, String[] arguments, Map<String,Object> parameterSubstitutionMap, File workingDir, StringBuilder resultOut, StringBuilder resultErr) Executes the external process using the provided command, arguments (optional), parameter substitution map to expand variables in the command or arguments in form of ${variable} (optional) and a working directory (optional).
static int	execute(String command, String[] arguments, Map<String,Object> parameterSubstitutionMap, File workingDir, StringBuilder resultOut, StringBuilder resultErr, boolean redirectOutputs) Executes the external process using the provided command, arguments (optional), parameter substitution map to expand variables in the command or arguments in form of ${variable} (optional) and a working directory (optional).

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessHelper

public ProcessHelper()

Method Detail

execute

public static int execute(String command)
                   throws JahiaRuntimeException

Executes the external process using the provided command.

Parameters:

command - the command to be executed

Returns:

the execution status

Throws:

JahiaRuntimeException - in case the process execution failed

execute

public static int execute(String command,
                          String[] arguments)
                   throws JahiaRuntimeException

Executes the external process using the provided command, arguments (optional).

Parameters:

command - the command to be executed

arguments - optional arguments for the command

Returns:

the execution status

Throws:

JahiaRuntimeException - in case the process execution failed

execute

public static int execute(String command,
                          String[] arguments,
                          Map<String,Object> parameterSubstitutionMap)
                   throws JahiaRuntimeException

Executes the external process using the provided command, arguments (optional), parameter substitution map to expand variables in the command or arguments in form of ${variable} (optional).

Parameters:

command - the command to be executed

arguments - optional arguments for the command

parameterSubstitutionMap - optional values for variables to be expanded

Returns:

the execution status

Throws:

JahiaRuntimeException - in case the process execution failed

execute

public static int execute(String command,
                          String[] arguments,
                          Map<String,Object> parameterSubstitutionMap,
                          File workingDir,
                          StringBuilder resultOut,
                          StringBuilder resultErr)
                   throws JahiaRuntimeException

Executes the external process using the provided command, arguments (optional), parameter substitution map to expand variables in the command or arguments in form of ${variable} (optional) and a working directory (optional). Buffers for process output and error stream can be provided.

Parameters:

command - the command to be executed

arguments - optional arguments for the command

parameterSubstitutionMap - optional values for variables to be expanded

workingDir - optional working directory for the process to be started from

resultOut - the buffer to write the process execution output into (optional)

resultErr - the buffer to write the process execution error into (optional)

Returns:

the execution status

Throws:

JahiaRuntimeException - in case the process execution failed

execute

public static int execute(String command,
                          String[] arguments,
                          Map<String,Object> parameterSubstitutionMap,
                          File workingDir,
                          StringBuilder resultOut,
                          StringBuilder resultErr,
                          boolean redirectOutputs)
                   throws JahiaRuntimeException

Executes the external process using the provided command, arguments (optional), parameter substitution map to expand variables in the command or arguments in form of ${variable} (optional) and a working directory (optional). Buffers for process output and error stream can be provided.

Parameters:

command - the command to be executed

arguments - optional arguments for the command

parameterSubstitutionMap - optional values for variables to be expanded

workingDir - optional working directory for the process to be started from

resultOut - the buffer to write the process execution output into (optional)

resultErr - the buffer to write the process execution error into (optional)

Returns:

the execution status

Throws:

JahiaRuntimeException - in case the process execution failed