cn.hutool.extra.ssh

类 JschUtil

java.lang.Object

cn.hutool.extra.ssh.JschUtil

public class JschUtil
extends Object

Jsch工具类
Jsch是Java Secure Channel的缩写。JSch是一个SSH2的纯Java实现。
它允许你连接到一个SSH服务器，并且可以使用端口转发，X11转发，文件传输等。

从以下版本开始:

4.0.0

作者:

Looly

字段概要

字段

限定符和类型	字段和说明
static String	SSH_NONE 不使用SSH的值

构造器概要

构造器

构造器和说明
JschUtil()

方法概要

方法

限定符和类型	方法和说明
static boolean	bindPort(com.jcraft.jsch.Session session, String remoteHost, int remotePort, int localPort) 绑定端口到本地。
static void	close(com.jcraft.jsch.Channel channel) 关闭会话通道
static void	close(com.jcraft.jsch.Session session) 关闭SSH连接会话
static void	close(String key) 关闭SSH连接会话
static void	closeAll() 关闭所有SSH连接会话
static com.jcraft.jsch.Channel	createChannel(com.jcraft.jsch.Session session, ChannelType channelType) 创建Channel连接
static com.jcraft.jsch.Session	createSession(String sshHost, int sshPort, String sshUser, String sshPass) 新建一个新的SSH会话
static Sftp	createSftp(com.jcraft.jsch.Session session) 创建Sftp
static Sftp	createSftp(String sshHost, int sshPort, String sshUser, String sshPass) 创建Sftp
static String	exec(com.jcraft.jsch.Session session, String cmd, Charset charset) 执行Shell命令
static String	exec(com.jcraft.jsch.Session session, String cmd, Charset charset, OutputStream errStream) 执行Shell命令
static int	generateLocalPort() 生成一个本地端口，用于远程端口映射
static com.jcraft.jsch.Session	getSession(String sshHost, int sshPort, String sshUser, String sshPass) 获得一个SSH会话，重用已经使用的会话
static int	openAndBindPortToLocal(Connector sshConn, String remoteHost, int remotePort) 打开SSH会话，并绑定远程端口到本地的一个随机端口
static com.jcraft.jsch.Channel	openChannel(com.jcraft.jsch.Session session, ChannelType channelType) 打开Channel连接
static com.jcraft.jsch.Session	openSession(String sshHost, int sshPort, String sshUser, String sshPass) 打开一个新的SSH会话
static com.jcraft.jsch.ChannelSftp	openSftp(com.jcraft.jsch.Session session) 打开SFTP连接
static com.jcraft.jsch.ChannelShell	openShell(com.jcraft.jsch.Session session) 打开Shell连接
static boolean	unBindPort(com.jcraft.jsch.Session session, int localPort) 解除端口映射

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

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

字段详细资料

SSH_NONE

public static final String SSH_NONE

不使用SSH的值

另请参阅:

常量字段值

构造器详细资料

JschUtil

public JschUtil()

方法详细资料

generateLocalPort

public static int generateLocalPort()

生成一个本地端口，用于远程端口映射

返回:

未被使用的本地端口

getSession

public static com.jcraft.jsch.Session getSession(String sshHost,
                                 int sshPort,
                                 String sshUser,
                                 String sshPass)

获得一个SSH会话，重用已经使用的会话

参数:

sshHost - 主机

sshPort - 端口

sshUser - 用户名

sshPass - 密码

返回:

SSH会话

openSession

public static com.jcraft.jsch.Session openSession(String sshHost,
                                  int sshPort,
                                  String sshUser,
                                  String sshPass)

打开一个新的SSH会话

参数:

sshHost - 主机

sshPort - 端口

sshUser - 用户名

sshPass - 密码

返回:

SSH会话

createSession

public static com.jcraft.jsch.Session createSession(String sshHost,
                                    int sshPort,
                                    String sshUser,
                                    String sshPass)

新建一个新的SSH会话

参数:

sshHost - 主机

sshPort - 端口

sshUser - 机用户名

sshPass - 密码

返回:

SSH会话

从以下版本开始:

4.5.2

bindPort

public static boolean bindPort(com.jcraft.jsch.Session session,
               String remoteHost,
               int remotePort,
               int localPort)
                        throws JschRuntimeException

绑定端口到本地。 一个会话可绑定多个端口

参数:

session - 需要绑定端口的SSH会话

remoteHost - 远程主机

remotePort - 远程端口

localPort - 本地端口

返回:

成功与否

抛出:

JschRuntimeException - 端口绑定失败异常

unBindPort

public static boolean unBindPort(com.jcraft.jsch.Session session,
                 int localPort)

解除端口映射

参数:

session - 需要解除端口映射的SSH会话

localPort - 需要解除的本地端口

返回:

解除成功与否

openAndBindPortToLocal

public static int openAndBindPortToLocal(Connector sshConn,
                         String remoteHost,
                         int remotePort)
                                  throws JschRuntimeException

打开SSH会话，并绑定远程端口到本地的一个随机端口

参数:

sshConn - SSH连接信息对象

remoteHost - 远程主机

remotePort - 远程端口

返回:

映射后的本地端口

抛出:

JschRuntimeException - 连接异常

openSftp

public static com.jcraft.jsch.ChannelSftp openSftp(com.jcraft.jsch.Session session)

打开SFTP连接

参数:

session - Session会话

返回:

ChannelSftp

从以下版本开始:

4.0.3

createSftp

public static Sftp createSftp(String sshHost,
              int sshPort,
              String sshUser,
              String sshPass)

创建Sftp

参数:

sshHost - 远程主机

sshPort - 远程主机端口

sshUser - 远程主机用户名

sshPass - 远程主机密码

返回:

Sftp

从以下版本开始:

4.0.3

createSftp

public static Sftp createSftp(com.jcraft.jsch.Session session)

创建Sftp

参数:

session - SSH会话

返回:

Sftp

从以下版本开始:

4.0.5

openShell

public static com.jcraft.jsch.ChannelShell openShell(com.jcraft.jsch.Session session)

打开Shell连接

参数:

session - Session会话

返回:

ChannelShell

从以下版本开始:

4.0.3

openChannel

public static com.jcraft.jsch.Channel openChannel(com.jcraft.jsch.Session session,
                                  ChannelType channelType)

打开Channel连接

参数:

session - Session会话

channelType - 通道类型，可以是shell或sftp等，见ChannelType

返回:

Channel

从以下版本开始:

4.5.2

createChannel

public static com.jcraft.jsch.Channel createChannel(com.jcraft.jsch.Session session,
                                    ChannelType channelType)

创建Channel连接

参数:

session - Session会话

channelType - 通道类型，可以是shell或sftp等，见ChannelType

返回:

Channel

从以下版本开始:

4.5.2

exec

public static String exec(com.jcraft.jsch.Session session,
          String cmd,
          Charset charset)

执行Shell命令

参数:

session - Session会话

cmd - 命令

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

返回:

ChannelExec

从以下版本开始:

4.0.3

exec

public static String exec(com.jcraft.jsch.Session session,
          String cmd,
          Charset charset,
          OutputStream errStream)

执行Shell命令

参数:

session - Session会话

cmd - 命令

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

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

返回:

ChannelExec

从以下版本开始:

4.3.1

close

public static void close(com.jcraft.jsch.Session session)

关闭SSH连接会话

参数:

session - SSH会话

close

public static void close(com.jcraft.jsch.Channel channel)

关闭会话通道

参数:

channel - 会话通道

从以下版本开始:

4.0.3

close

public static void close(String key)

关闭SSH连接会话

参数:

key - 主机，格式为user@host:port

closeAll

public static void closeAll()

关闭所有SSH连接会话