com.whaleal.icefrog.extra.ssh.JschSessionPool Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefrog-extra Show documentation
icefrog 扩展工具类（提供其它类库的封装）
There is a newer version: 1.1.71
package com.whaleal.icefrog.extra.ssh;

import com.jcraft.jsch.Session;
import com.whaleal.icefrog.core.lang.SimpleCache;
import com.whaleal.icefrog.core.util.StrUtil;

import java.util.HashMap;
import java.util.Iterator;
import java.util.Map.Entry;

/**
 * Jsch会话池
 *
 * @author looly
 */
public enum JschSessionPool {
    INSTANCE;

    /**
     * SSH会话池，key：host，value：Session对象
     */
    private final SimpleCache cache = new SimpleCache<>(new HashMap<>());

    /**
     * 获取Session，不存在返回null
     *
     * @param key 键
     * @return Session
     */
    public Session get( String key ) {
        return cache.get(key);
    }

    /**
     * 获得一个SSH跳板机会话，重用已经使用的会话
     *
     * @param sshHost 跳板机主机
     * @param sshPort 跳板机端口
     * @param sshUser 跳板机用户名
     * @param sshPass 跳板机密码
     * @return SSH会话
     */
    public Session getSession( String sshHost, int sshPort, String sshUser, String sshPass ) {
        final String key = StrUtil.format("{}@{}:{}", sshUser, sshHost, sshPort);
        return this.cache.get(key, Session::isConnected, () -> JschUtil.openSession(sshHost, sshPort, sshUser, sshPass));
    }

    /**
     * 获得一个SSH跳板机会话，重用已经使用的会话
     *
     * @param sshHost    跳板机主机
     * @param sshPort    跳板机端口
     * @param sshUser    跳板机用户名
     * @param prvkey     跳板机私钥路径
     * @param passphrase 跳板机私钥密码
     * @return SSH会话
     */
    public Session getSession( String sshHost, int sshPort, String sshUser, String prvkey, byte[] passphrase ) {
        final String key = StrUtil.format("{}@{}:{}", sshUser, sshHost, sshPort);
        return this.cache.get(key, Session::isConnected, () -> JschUtil.openSession(sshHost, sshPort, sshUser, prvkey, passphrase));
    }

    /**
     * 加入Session
     *
     * @param key     键
     * @param session Session
     */
    public void put( String key, Session session ) {
        this.cache.put(key, session);
    }

    /**
     * 关闭SSH连接会话
     *
     * @param key 主机，格式为user@host:port
     */
    public void close( String key ) {
        Session session = get(key);
        if (session != null && session.isConnected()) {
            session.disconnect();
        }
        this.cache.remove(key);
    }

    /**
     * 移除指定Session
     *
     * @param session Session会话
     */
    public void remove( Session session ) {
        if (null != session) {
            final Iterator> iterator = this.cache.iterator();
            Entry entry;
            while (iterator.hasNext()) {
                entry = iterator.next();
                if (session.equals(entry.getValue())) {
                    iterator.remove();
                    break;
                }
            }
        }
    }

    /**
     * 关闭所有SSH连接会话
     */
    public void closeAll() {
        Session session;
        for (Entry entry : this.cache) {
            session = entry.getValue();
            if (session != null && session.isConnected()) {
                session.disconnect();
            }
        }
        cache.clear();
    }
}