cn.hutool.extra.ssh

Enum JschSessionPool

java.lang.Object

java.lang.Enum<JschSessionPool>

cn.hutool.extra.ssh.JschSessionPool

All Implemented Interfaces:

Serializable, Comparable<JschSessionPool>

public enum JschSessionPool
extends Enum<JschSessionPool>

Jsch会话池

Author:

looly

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE 单例对象

Method Summary

Modifier and Type	Method and Description
void	close(String key) 关闭SSH连接会话
void	closeAll() 关闭所有SSH连接会话
com.jcraft.jsch.Session	get(String key) 获取Session，不存在返回null
com.jcraft.jsch.Session	getSession(String sshHost, int sshPort, String sshUser, byte[] prvkey, byte[] passphrase) 获得一个SSH跳板机会话，重用已经使用的会话
com.jcraft.jsch.Session	getSession(String sshHost, int sshPort, String sshUser, String sshPass) 获得一个SSH跳板机会话，重用已经使用的会话
com.jcraft.jsch.Session	getSession(String sshHost, int sshPort, String sshUser, String prvkey, byte[] passphrase) 获得一个SSH跳板机会话，重用已经使用的会话
void	put(String key, com.jcraft.jsch.Session session) 加入Session
void	remove(com.jcraft.jsch.Session session) 移除指定Session
static JschSessionPool	valueOf(String name) Returns the enum constant of this type with the specified name.
static JschSessionPool[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final JschSessionPool INSTANCE

单例对象

Method Detail

values

public static JschSessionPool[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JschSessionPool c : JschSessionPool.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JschSessionPool valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

get

public com.jcraft.jsch.Session get(String key)

获取Session，不存在返回null

Parameters:

key - 键

Returns:

Session

getSession

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

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

Parameters:

sshHost - 跳板机主机

sshPort - 跳板机端口

sshUser - 跳板机用户名

sshPass - 跳板机密码

Returns:

SSH会话

getSession

public com.jcraft.jsch.Session getSession(String sshHost,
                                          int sshPort,
                                          String sshUser,
                                          String prvkey,
                                          byte[] passphrase)

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

Parameters:

sshHost - 跳板机主机

sshPort - 跳板机端口

sshUser - 跳板机用户名

prvkey - 跳板机私钥路径

passphrase - 跳板机私钥密码

Returns:

SSH会话

getSession

public com.jcraft.jsch.Session getSession(String sshHost,
                                          int sshPort,
                                          String sshUser,
                                          byte[] prvkey,
                                          byte[] passphrase)

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

Parameters:

sshHost - 跳板机主机

sshPort - 跳板机端口

sshUser - 跳板机用户名

prvkey - 跳板机私钥内容

passphrase - 跳板机私钥密码

Returns:

SSH会话

Since:

5.8.18

put

public void put(String key,
                com.jcraft.jsch.Session session)

加入Session

Parameters:

key - 键

session - Session

close

public void close(String key)

关闭SSH连接会话

Parameters:

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

remove

public void remove(com.jcraft.jsch.Session session)

移除指定Session

Parameters:

session - Session会话

Since:

4.1.15

closeAll

public void closeAll()

关闭所有SSH连接会话