ProcessAwaitExecutor (orion-kit 2.0.1 API)

java.lang.Object
- cn.orionsec.kit.ext.process.BaseProcessExecutor
- - cn.orionsec.kit.ext.process.ProcessAwaitExecutor

All Implemented Interfaces:

Executable, SafeCloseable, Closeable, AutoCloseable
```
public class ProcessAwaitExecutor
extends BaseProcessExecutor
```
同步进程执行器

Since:

2020/4/17 13:44

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields
Modifier and Type Field and Description

protected Runnable callback
执行完毕回调

protected ExecutorService scheduler
pool
- Fields inherited from class cn.orionsec.kit.ext.process.BaseProcessExecutor
  addEnv, command, dir, env, redirectError, removeEnv

Fields
Modifier and Type	Field and Description
`protected Runnable`	`callback` 执行完毕回调
`protected ExecutorService`	`scheduler` pool

Constructor Summary

Constructors
Constructor and Description
`ProcessAwaitExecutor(String command)`
`ProcessAwaitExecutor(String[] command)`
`ProcessAwaitExecutor(String[] command, String dir)`
`ProcessAwaitExecutor(String command, String dir)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessAwaitExecutor`	`callback(Runnable callback)` 回调
`void`	`close()` 关闭
`ProcessAwaitExecutor`	`errorStreamHandler(Consumer<InputStream> errorStreamHandler)` 设置标错误出流处理器
`void`	`exec()` 执行
`ProcessAwaitExecutor`	`exit()` 退出
`InputStream`	`getErrorStream()`
`int`	`getExitCode()` 获取exit code 会阻塞
`InputStream`	`getInputStream()`
`OutputStream`	`getOutputStream()`
`Process`	`getProcess()` 获取进程
`ProcessBuilder`	`getProcessBuilder()` 获取进程构建器
`long`	`getWaitFor()`
`ProcessAwaitExecutor`	`inherit()` 合并子流到系统流
`ProcessAwaitExecutor`	`interrupt()` 中断键入 ctrl+c
`boolean`	`isAlive()` 是否正在执行
`boolean`	`isClose()`
`boolean`	`isDone()`
`boolean`	`isInherit()`
`ProcessAwaitExecutor`	`scheduler(ExecutorService scheduler)` 设置读取线程池
`ProcessAwaitExecutor`	`streamHandler(Consumer<InputStream> streamHandler)` 设置标准输出流处理器
`ProcessAwaitExecutor`	`sync()` 执行命令同步获取结果
`ProcessAwaitExecutor`	`waitFor()` 等待命令执行完毕
`ProcessAwaitExecutor`	`waitFor(long timeout)` 是否等待命令执行完毕
`ProcessAwaitExecutor`	`write(byte[] command)` 写入命令
`ProcessAwaitExecutor`	`write(byte[] command, boolean lf)` 写入命令
`ProcessAwaitExecutor`	`write(String command)` 写入命令
`ProcessAwaitExecutor`	`write(String command, String charset)` 写入命令
`ProcessAwaitExecutor`	`writeLine(String command)` 写入命令
`ProcessAwaitExecutor`	`writeLine(String command, String charset)` 写入命令

Methods inherited from class cn.orionsec.kit.ext.process.BaseProcessExecutor
addEnv, addEnv, dir, getAddEnv, getCommand, getDir, getEnv, getTerminalCommand, redirectError, removeEnv, removeEnv, terminal, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - callback
```
protected Runnable callback
```
    执行完毕回调
  - scheduler
```
protected ExecutorService scheduler
```
    pool
- Constructor Detail
  - ProcessAwaitExecutor
```
public ProcessAwaitExecutor(String command)
```
  - ProcessAwaitExecutor
```
public ProcessAwaitExecutor(String[] command)
```
  - ProcessAwaitExecutor
```
public ProcessAwaitExecutor(String command,
                            String dir)
```
  - ProcessAwaitExecutor
```
public ProcessAwaitExecutor(String[] command,
                            String dir)
```
- Method Detail
  - inherit
```
public ProcessAwaitExecutor inherit()
```
    合并子流到系统流
    
    Returns:
    
    this
  - waitFor
```
public ProcessAwaitExecutor waitFor()
```
    等待命令执行完毕
    
    Returns:
    
    this
  - waitFor
```
public ProcessAwaitExecutor waitFor(long timeout)
```
    是否等待命令执行完毕
    
    Parameters:
    
    timeout - 超时时间
    
    Returns:
    
    this
  - sync
```
public ProcessAwaitExecutor sync()
```
    执行命令同步获取结果
    
    Returns:
    
    this
  - streamHandler
```
public ProcessAwaitExecutor streamHandler(Consumer<InputStream> streamHandler)
```
    设置标准输出流处理器
    
    Parameters:
    
    streamHandler - 标准输出流处理器
    
    Returns:
    
    this
  - errorStreamHandler
```
public ProcessAwaitExecutor errorStreamHandler(Consumer<InputStream> errorStreamHandler)
```
    设置标错误出流处理器
    
    Parameters:
    
    errorStreamHandler - 错误输出流处理器
    
    Returns:
    
    this
  - scheduler
```
public ProcessAwaitExecutor scheduler(ExecutorService scheduler)
```
    设置读取线程池
    
    Parameters:
    
    scheduler - pool
    
    Returns:
    
    this
  - callback
```
public ProcessAwaitExecutor callback(Runnable callback)
```
    回调
    
    Parameters:
    
    callback - 回调方法
    
    Returns:
    
    this
  - write
```
public ProcessAwaitExecutor write(String command)
```
    写入命令
    
    Parameters:
    
    command - command
    
    Returns:
    
    this
  - writeLine
```
public ProcessAwaitExecutor writeLine(String command)
```
    写入命令
    
    Parameters:
    
    command - command
    
    Returns:
    
    this
  - write
```
public ProcessAwaitExecutor write(String command,
                                  String charset)
```
    写入命令
    
    Parameters:
    
    command - command
    
    charset - 编码格式
    
    Returns:
    
    this
  - writeLine
```
public ProcessAwaitExecutor writeLine(String command,
                                      String charset)
```
    写入命令
    
    Parameters:
    
    command - command
    
    charset - 编码格式
    
    Returns:
    
    this
  - write
```
public ProcessAwaitExecutor write(byte[] command)
```
    写入命令
    
    Parameters:
    
    command - command
    
    Returns:
    
    this
  - write
```
public ProcessAwaitExecutor write(byte[] command,
                                  boolean lf)
```
    写入命令
    
    Parameters:
    
    command - command
    
    lf - 是否键入 \n
    
    Returns:
    
    this
  - interrupt
```
public ProcessAwaitExecutor interrupt()
```
    中断键入 ctrl+c
    
    Returns:
    
    this
  - exit
```
public ProcessAwaitExecutor exit()
```
    退出
    
    Returns:
    
    this
  - exec
```
public void exec()
```
    Description copied from interface: Executable
    
    执行
  - close
```
public void close()
```
    Description copied from class: BaseProcessExecutor
    
    关闭
    
    Specified by:
    
    close in interface SafeCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in class BaseProcessExecutor
  - isAlive
```
public boolean isAlive()
```
    是否正在执行
    
    Specified by:
    
    isAlive in class BaseProcessExecutor
    
    Returns:
    
    true执行中
  - getExitCode
```
public int getExitCode()
```
    获取exit code 会阻塞
    
    Specified by:
    
    getExitCode in class BaseProcessExecutor
    
    Returns:
    
    -1 未执行完毕 0 成功 1 失败
  - getProcess
```
public Process getProcess()
```
    Description copied from class: BaseProcessExecutor
    
    获取进程
    
    Specified by:
    
    getProcess in class BaseProcessExecutor
    
    Returns:
    
    Process
  - getProcessBuilder
```
public ProcessBuilder getProcessBuilder()
```
    Description copied from class: BaseProcessExecutor
    
    获取进程构建器
    
    Specified by:
    
    getProcessBuilder in class BaseProcessExecutor
    
    Returns:
    
    ProcessBuilder
  - getInputStream
```
public InputStream getInputStream()
```
  - getErrorStream
```
public InputStream getErrorStream()
```
  - getOutputStream
```
public OutputStream getOutputStream()
```
  - isInherit
```
public boolean isInherit()
```
  - getWaitFor
```
public long getWaitFor()
```
  - isDone
```
public boolean isDone()
```
  - isClose
```
public boolean isClose()
```

Class ProcessAwaitExecutor

Field Summary

Fields inherited from class cn.orionsec.kit.ext.process.BaseProcessExecutor

Constructor Summary

Method Summary

Methods inherited from class cn.orionsec.kit.ext.process.BaseProcessExecutor

Methods inherited from class java.lang.Object

Field Detail

callback

scheduler

Constructor Detail

ProcessAwaitExecutor

ProcessAwaitExecutor

ProcessAwaitExecutor

ProcessAwaitExecutor

Method Detail

inherit

waitFor

waitFor

sync

streamHandler

errorStreamHandler

scheduler

callback

write

writeLine

write

writeLine

write

write

interrupt

exit

exec

close

isAlive

getExitCode

getProcess

getProcessBuilder

getInputStream

getErrorStream

getOutputStream

isInherit

getWaitFor

isDone

isClose