cn.orionsec.kit.net.host.ssh.command

Interface ICommandExecutor

All Superinterfaces:

AutoCloseable, Closeable, Executable, HostConnector, IHostExecutor, Runnable, SafeCloseable, TimeoutEndpoint

All Known Implementing Classes:

CommandExecutor

public interface ICommandExecutor
extends IHostExecutor, HostConnector, TimeoutEndpoint

远程命令执行器 api

Since:

2022/5/17 15:29

Version:

1.0.0

Author:

Jiahang Li

Method Summary

Modifier and Type	Method and Description
void	errorStreamHandler(Consumer<InputStream> errorStreamHandler) 设置错误输出流处理器
String	getCommand() 获取执行的命令
byte[]	getCommandBytes() 获取执行的命令 byte
InputStream	getErrorStream() 获取错误输出流
int	getExitCode() 获取退出码
default boolean	isSuccessExit() 是否正常退出
boolean	isTimeout() 是否超时
void	merge() 合并标准输出流和错误输出流
void	pty(boolean enable) 是否使用伪终端 如果使用 当程序关闭时 命令进程一起关闭 如果不使用 当程序关闭时 命令进程可能不会一起关闭 必须在 HostConnector.connect() 之前调用
void	timeout(long timeout, TimeoutChecker<TimeoutEndpoint> checker) 设置超时时间
default void	timeout(long timeout, TimeUnit unit, TimeoutChecker<TimeoutEndpoint> checker) 设置超时时间
void	transferError(OutputStream out) 传输错误输出流到指定输出流

Methods inherited from interface cn.orionsec.kit.net.host.ssh.IHostExecutor

callback, env, env, exit, exit, getInputStream, getOutputStream, interrupt, isDone, run, sendSignal, setAgentForwarding, streamHandler, transfer, write, write, write, writeLine, writeLine, x11Forward

Methods inherited from interface cn.orionsec.kit.lang.able.Executable

exec

Methods inherited from interface cn.orionsec.kit.lang.able.SafeCloseable

close

Methods inherited from interface cn.orionsec.kit.net.host.HostConnector

connect, connect, disconnect, disconnectChannel, disconnectSession, getChannel, getSession, isClosed, isConnected, isEof

Methods inherited from interface cn.orionsec.kit.lang.support.timeout.TimeoutEndpoint

checkTimeout, isDone

Method Detail

merge

void merge()

合并标准输出流和错误输出流

pty

void pty(boolean enable)

是否使用伪终端

如果使用 当程序关闭时 命令进程一起关闭 如果不使用 当程序关闭时 命令进程可能不会一起关闭

必须在 HostConnector.connect() 之前调用

Parameters:

enable - 是否使用

errorStreamHandler

void errorStreamHandler(Consumer<InputStream> errorStreamHandler)

设置错误输出流处理器

Parameters:

errorStreamHandler - 错误输出流处理器

transferError

void transferError(OutputStream out)
            throws IOException

传输错误输出流到指定输出流

Parameters:

out - out

Throws:

IOException - IOException

timeout

void timeout(long timeout,
             TimeoutChecker<TimeoutEndpoint> checker)

设置超时时间

Parameters:

timeout - timeout

checker - checker

timeout

default void timeout(long timeout,
                     TimeUnit unit,
                     TimeoutChecker<TimeoutEndpoint> checker)

设置超时时间

Parameters:

timeout - timeout

unit - unit

checker - checker

getExitCode

int getExitCode()

获取退出码

Returns:

0正常结束

isSuccessExit

default boolean isSuccessExit()

是否正常退出

Returns:

返回码是否为 0

isTimeout

boolean isTimeout()

是否超时

Returns:

是否超时

getCommand

String getCommand()

获取执行的命令

Returns:

command

getCommandBytes

byte[] getCommandBytes()

获取执行的命令 byte

Returns:

command

getErrorStream

InputStream getErrorStream()

获取错误输出流

Returns:

错误输出流