org.dromara.hutool.extra.ssh.engine.sshj

类 SshjSession

java.lang.Object

org.dromara.hutool.extra.ssh.engine.sshj.SshjSession

所有已实现的接口:

Closeable, AutoCloseable, Wrapper<Object>, Session

public class SshjSession
extends Object
implements Session

基于SSHJ（https://github.com/hierynomus/sshj）的Session封装

作者:

looly

构造器概要

构造器

构造器和说明
SshjSession(Connector connector) 构造
SshjSession(net.schmizz.sshj.SSHClient ssh) 构造

方法概要

限定符和类型	方法和说明
boolean	bindLocalPort(String remoteHost, int remotePort, int localPort) 绑定端口到本地。
boolean	bindLocalPort(String remoteHost, int remotePort, String localHost, int localPort) 绑定端口到本地。
boolean	bindRemotePort(int bindPort, String host, int port) 绑定ssh服务端的serverPort端口, 到host主机的port端口上.
void	close()
String	exec(String cmd, Charset charset, OutputStream errStream) 执行Shell命令（使用EXEC方式） 此方法单次发送一个命令到服务端，不读取环境变量，不会产生阻塞。
String	execByShell(String cmd, Charset charset, OutputStream errStream) 执行Shell命令 此方法单次发送一个命令到服务端，自动读取环境变量，可能产生阻塞。
net.schmizz.sshj.connection.channel.direct.Session	getRaw()
boolean	isConnected() 是否连接状态
SshjSftp	openSftp(Charset charset) 打开SFTP会话
void	unBindLocalPort(int localPort) 解除本地端口映射
void	unBindRemotePort(int localPort) 解除远程端口映射

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

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

构造器详细资料

SshjSession

public SshjSession(Connector connector)

构造

参数:

connector - Connector，保存连接和验证信息等

SshjSession

public SshjSession(net.schmizz.sshj.SSHClient ssh)

构造

参数:

ssh - SSHClient

方法详细资料

getRaw

public net.schmizz.sshj.connection.channel.direct.Session getRaw()

指定者:

getRaw 在接口中 Wrapper<Object>

isConnected

public boolean isConnected()

从接口复制的说明: Session

是否连接状态

指定者:

isConnected 在接口中 Session

返回:

是否连接状态

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

IOException

openSftp

public SshjSftp openSftp(Charset charset)

打开SFTP会话

参数:

charset - 编码

返回:

SshjSftp

bindLocalPort

public boolean bindLocalPort(String remoteHost,
                             int remotePort,
                             int localPort)
                      throws SshException

绑定端口到本地。 一个会话可绑定多个端口
当请求localHost:localPort时，通过SSH到服务器，转发请求到remoteHost:remotePort
此方法用于访问本地无法访问但是服务器可以访问的地址，如内网数据库库等

参数:

remoteHost - 远程主机

remotePort - 远程端口

localPort - 本地端口

返回:

成功与否

抛出:

SshException - 端口绑定失败异常

bindLocalPort

public boolean bindLocalPort(String remoteHost,
                             int remotePort,
                             String localHost,
                             int localPort)
                      throws IORuntimeException

绑定端口到本地。 一个会话可绑定多个端口
当请求localHost:localPort时，通过SSH到服务器，转发请求到remoteHost:remotePort
此方法用于访问本地无法访问但是服务器可以访问的地址，如内网数据库库等

参数:

remoteHost - 远程主机

remotePort - 远程端口

localHost - 本地主机

localPort - 本地端口

返回:

成功与否

抛出:

IORuntimeException - 端口绑定失败异常

unBindLocalPort

public void unBindLocalPort(int localPort)
                     throws IORuntimeException

解除本地端口映射

参数:

localPort - 需要解除的本地端口

抛出:

IORuntimeException - 端口解绑失败异常

bindRemotePort

public boolean bindRemotePort(int bindPort,
                              String host,
                              int port)
                       throws IORuntimeException

绑定ssh服务端的serverPort端口, 到host主机的port端口上.
即数据从ssh服务端的serverPort端口, 流经ssh客户端, 达到host:port上.

参数:

bindPort - ssh服务端上要被绑定的端口

host - 转发到的host

port - host上的端口

返回:

成功与否

抛出:

IORuntimeException - 端口绑定失败异常

unBindRemotePort

public void unBindRemotePort(int localPort)

解除远程端口映射

参数:

localPort - 需要解除的本地端口

exec

public String exec(String cmd,
                   Charset charset,
                   OutputStream errStream)

执行Shell命令（使用EXEC方式）

此方法单次发送一个命令到服务端，不读取环境变量，不会产生阻塞。

参数:

cmd - 命令

charset - 发送和读取内容的编码

errStream - 错误信息输出到的位置

返回:

执行返回结果

execByShell

public String execByShell(String cmd,
                          Charset charset,
                          OutputStream errStream)

执行Shell命令

此方法单次发送一个命令到服务端，自动读取环境变量，可能产生阻塞。

参数:

cmd - 命令

charset - 发送和读取内容的编码

errStream - 错误信息输出到的位置

返回:

执行返回结果