com.jn.langx.commandline

类 DefaultCommandLineExecutor

java.lang.Object

com.jn.langx.commandline.DefaultCommandLineExecutor

所有已实现的接口:

CommandLineExecutor

直接已知子类:

DaemonCommandLineExecutor

public class DefaultCommandLineExecutor
extends Object
implements CommandLineExecutor

The default class to start a subprocess. The implementation allows to

• set a current working directory for the subprocess
• provide a set of environment variables passed to the subprocess
• capture the subprocess output of stdout and stderr using an ExecuteStreamHandler
• kill long-running processes using an ExecuteWatchdog
• define a set of expected exit values
• terminate any started processes when the main process is terminating using a ProcessDestroyer

The following example shows the basic usage:

 Executor exec = new DefaultExecutor();
 CommandLine cl = new CommandLine("ls -l");
 int exitvalue = exec.execute(cl);
 

版本:

$Id: DefaultExecutor.java 1636056 2014-11-01 21:12:52Z ggregory $

字段概要

从接口继承的字段 com.jn.langx.commandline.CommandLineExecutor

INVALID_EXITVALUE

构造器概要

构造器

构造器和说明
DefaultCommandLineExecutor() Default constructor creating a default PumpStreamHandler and sets the working directory of the subprocess to the current working directory.

方法概要

限定符和类型	方法和说明
protected Thread	createThread(Runnable runnable, String name) Factory method to create a thread waiting for the result of an asynchronous execution.
int	execute(CommandLine command) Methods for starting synchronous execution.
void	execute(CommandLine command, ExecuteResultHandler handler) Methods for starting asynchronous execution.
int	execute(CommandLine command, Map<String,String> environment) Methods for starting synchronous execution.
void	execute(CommandLine command, Map<String,String> environment, ExecuteResultHandler handler) Methods for starting asynchronous execution.
protected Thread	getExecutorThread() Get the worker thread being used for asynchronous execution.
ProcessDestroyer	getProcessDestroyer() Set the handler for cleanup of started processes if the main process is going to terminate.
ExecuteStreamHandler	getStreamHandler() Get the StreamHandler used for providing input and retrieving the output.
ExecuteWatchdog	getWatchdog() Get the watchdog used to kill of processes running, typically, too long time.
File	getWorkingDirectory() Get the working directory of the created process.
boolean	isFailure(int exitValue) Checks whether exitValue signals a failure.
protected Process	launch(CommandLine command, Map<String,String> env, File dir) Creates a process that runs a command.
void	setExitValue(int value) Define the exitValue of the process to be considered successful.
void	setExitValues(int[] values) Define a list of exitValue of the process to be considered successful.
void	setProcessDestroyer(ProcessDestroyer processDestroyer) Get the handler for cleanup of started processes if the main process is going to terminate.
void	setStreamHandler(ExecuteStreamHandler streamHandler) Set a custom the StreamHandler used for providing input and retrieving the output.
void	setWatchdog(ExecuteWatchdog watchDog) Set the watchdog used to kill of processes running, typically, too long time.
void	setWorkingDirectory(File dir) Set the working directory of the created process.

从类继承的方法 java.lang.Object

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

构造器详细资料

DefaultCommandLineExecutor

public DefaultCommandLineExecutor()

Default constructor creating a default PumpStreamHandler and sets the working directory of the subprocess to the current working directory.

The PumpStreamHandler pumps the output of the subprocess into our System.out and System.err to avoid into our System.out and System.err to avoid a blocked or deadlocked subprocess (seeProcess).

方法详细资料

getStreamHandler

public ExecuteStreamHandler getStreamHandler()

从接口复制的说明: CommandLineExecutor

Get the StreamHandler used for providing input and retrieving the output.

指定者:

getStreamHandler 在接口中 CommandLineExecutor

返回:

the StreamHandler

另请参阅:

CommandLineExecutor.getStreamHandler()

setStreamHandler

public void setStreamHandler(ExecuteStreamHandler streamHandler)

从接口复制的说明: CommandLineExecutor

Set a custom the StreamHandler used for providing input and retrieving the output. If you don't provide a proper stream handler the executed process might block when writing to stdout and/or stderr (see Process).

指定者:

setStreamHandler 在接口中 CommandLineExecutor

参数:

streamHandler - the stream handler

另请参阅:

CommandLineExecutor.setStreamHandler(com.jn.langx.commandline.ExecuteStreamHandler)

getWatchdog

public ExecuteWatchdog getWatchdog()

从接口复制的说明: CommandLineExecutor

Get the watchdog used to kill of processes running, typically, too long time.

指定者:

getWatchdog 在接口中 CommandLineExecutor

返回:

the watchdog

另请参阅:

CommandLineExecutor.getWatchdog()

setWatchdog

public void setWatchdog(ExecuteWatchdog watchDog)

从接口复制的说明: CommandLineExecutor

Set the watchdog used to kill of processes running, typically, too long time.

指定者:

setWatchdog 在接口中 CommandLineExecutor

参数:

watchDog - the watchdog

另请参阅:

CommandLineExecutor.setWatchdog(com.jn.langx.commandline.ExecuteWatchdog)

getProcessDestroyer

public ProcessDestroyer getProcessDestroyer()

从接口复制的说明: CommandLineExecutor

Set the handler for cleanup of started processes if the main process is going to terminate.

指定者:

getProcessDestroyer 在接口中 CommandLineExecutor

返回:

the ProcessDestroyer

另请参阅:

CommandLineExecutor.getProcessDestroyer()

setProcessDestroyer

public void setProcessDestroyer(ProcessDestroyer processDestroyer)

从接口复制的说明: CommandLineExecutor

Get the handler for cleanup of started processes if the main process is going to terminate.

指定者:

setProcessDestroyer 在接口中 CommandLineExecutor

参数:

processDestroyer - the ProcessDestroyer

另请参阅:

CommandLineExecutor.setProcessDestroyer(ProcessDestroyer)

getWorkingDirectory

public File getWorkingDirectory()

从接口复制的说明: CommandLineExecutor

Get the working directory of the created process.

指定者:

getWorkingDirectory 在接口中 CommandLineExecutor

返回:

the working directory

另请参阅:

CommandLineExecutor.getWorkingDirectory()

setWorkingDirectory

public void setWorkingDirectory(File dir)

从接口复制的说明: CommandLineExecutor

Set the working directory of the created process. The working directory must exist when you start the process.

指定者:

setWorkingDirectory 在接口中 CommandLineExecutor

参数:

dir - the working directory

另请参阅:

CommandLineExecutor.setWorkingDirectory(java.io.File)

execute

public int execute(CommandLine command)
            throws ExecuteException,
                   IOException

从接口复制的说明: CommandLineExecutor

Methods for starting synchronous execution. The child process inherits all environment variables of the parent process.

指定者:

execute 在接口中 CommandLineExecutor

参数:

command - the command to execute

返回:

process exit value

抛出:

ExecuteException - execution of subprocess failed or the subprocess returned a exit value indicating a failure CommandLineExecutor.setExitValue(int).

IOException

另请参阅:

CommandLineExecutor.execute(CommandLine)

execute

public int execute(CommandLine command,
                   Map<String,String> environment)
            throws ExecuteException,
                   IOException

从接口复制的说明: CommandLineExecutor

Methods for starting synchronous execution.

指定者:

execute 在接口中 CommandLineExecutor

参数:

command - the command to execute

environment - The environment for the new process. If null, the environment of the current process is used.

返回:

process exit value

抛出:

ExecuteException - execution of subprocess failed or the subprocess returned a exit value indicating a failure CommandLineExecutor.setExitValue(int).

IOException

另请参阅:

CommandLineExecutor.execute(CommandLine, java.util.Map)

execute

public void execute(CommandLine command,
                    ExecuteResultHandler handler)
             throws ExecuteException,
                    IOException

从接口复制的说明: CommandLineExecutor

Methods for starting asynchronous execution. The child process inherits all environment variables of the parent process. Result provided to callback handler.

指定者:

execute 在接口中 CommandLineExecutor

参数:

command - the command to execute

handler - capture process termination and exit code

抛出:

ExecuteException - execution of subprocess failed

IOException

另请参阅:

CommandLineExecutor.execute(CommandLine, com.jn.langx.commandline.ExecuteResultHandler)

execute

public void execute(CommandLine command,
                    Map<String,String> environment,
                    ExecuteResultHandler handler)
             throws ExecuteException,
                    IOException

从接口复制的说明: CommandLineExecutor

Methods for starting asynchronous execution. The child process inherits all environment variables of the parent process. Result provided to callback handler.

指定者:

execute 在接口中 CommandLineExecutor

参数:

command - the command to execute

environment - The environment for the new process. If null, the environment of the current process is used.

handler - capture process termination and exit code

抛出:

ExecuteException - execution of subprocess failed

IOException

另请参阅:

CommandLineExecutor.execute(CommandLine, java.util.Map, com.jn.langx.commandline.ExecuteResultHandler)

setExitValue

public void setExitValue(int value)

从接口复制的说明: CommandLineExecutor

Define the exitValue of the process to be considered successful. If a different exit value is returned by the process then CommandLineExecutor.execute(CommandLine) will throw an ExecuteException

指定者:

setExitValue 在接口中 CommandLineExecutor

参数:

value - the exit code representing successful execution

另请参阅:

CommandLineExecutor.setExitValue(int)

setExitValues

public void setExitValues(int[] values)

从接口复制的说明: CommandLineExecutor

Define a list of exitValue of the process to be considered successful. The caller can pass one of the following values

• an array of exit values to be considered successful
• an empty array for auto-detect of successful exit codes relying on CommandLineExecutor.isFailure(int)
• null to indicate to skip checking of exit codes

If an undefined exit value is returned by the process then CommandLineExecutor.execute(CommandLine) will throw an ExecuteException.

指定者:

setExitValues 在接口中 CommandLineExecutor

参数:

values - a list of the exit codes

另请参阅:

CommandLineExecutor.setExitValues(int[])

isFailure

public boolean isFailure(int exitValue)

从接口复制的说明: CommandLineExecutor

Checks whether exitValue signals a failure. If no exit values are set than the default conventions of the OS is used. e.g. most OS regard an exit code of '0' as successful execution and everything else as failure.

指定者:

isFailure 在接口中 CommandLineExecutor

参数:

exitValue - the exit value (return code) to be checked

返回:

true if exitValue signals a failure

另请参阅:

CommandLineExecutor.isFailure(int)

createThread

protected Thread createThread(Runnable runnable,
                              String name)

Factory method to create a thread waiting for the result of an asynchronous execution.

参数:

runnable - the runnable passed to the thread

name - the name of the thread

返回:

the thread

launch

protected Process launch(CommandLine command,
                         Map<String,String> env,
                         File dir)
                  throws IOException

Creates a process that runs a command.

参数:

command - the command to run

env - the environment for the command

dir - the working directory for the command

返回:

the process started

抛出:

IOException - forwarded from the particular launcher used

getExecutorThread

protected Thread getExecutorThread()

Get the worker thread being used for asynchronous execution.

返回:

the worker thread