com.feilong.net.filetransfer.sftp.SFTPUtil Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
There is a newer version: 4.0.8
Show newest version
/*
 * Copyright (C) 2008 feilong
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.feilong.net.filetransfer.sftp;

import static com.feilong.core.Validator.isNotNullOrEmpty;
import static com.feilong.core.Validator.isNullOrEmpty;
import static com.feilong.core.bean.ConvertUtil.toMapUseEntrys;
import static com.feilong.core.bean.ConvertUtil.toProperties;
import static com.feilong.core.lang.ObjectUtil.defaultIfNull;

import java.util.Properties;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.feilong.core.Validate;
import com.feilong.json.JsonUtil;
import com.feilong.lib.lang3.StringUtils;
import com.feilong.lib.lang3.tuple.Pair;
import com.jcraft.jsch.JSch;
import com.jcraft.jsch.JSchException;
import com.jcraft.jsch.Session;

/**
 * SFTP 工具类.
 *
 * @author feilong
 * @since 1.7.1
 */
class SFTPUtil{

    /** The Constant LOGGER. */
    private static final Logger     LOGGER                    = LoggerFactory.getLogger(SFTPUtil.class);

    /**
     * 默认的 config.
     *
     * @since 3.0.8
     */
    private static final Properties DEFAULT_CONFIG_PROPERTIES = toProperties(
                    toMapUseEntrys(                                                                     //
                                    //设置第一次登陆的时候提示，可选值：(ask | yes | no)  
                                    Pair.of("StrictHostKeyChecking", "no")));

    /** Don't let anyone instantiate this class. */
    private SFTPUtil(){
        //AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
        //see 《Effective Java》 2nd
        throw new AssertionError("No " + getClass().getName() + " instances for you!");
    }

    //---------------------------------------------------------------

    /**
     * 连接session.
     *
     * @param sftpFileTransferConfig
     *            sftp 文件传输的配置
     * @return 如果 sftpFileTransferConfig 是null,抛出 {@link NullPointerException}

     * 
     *         如果 sftpFileTransferConfig.hostName 是null,抛出 {@link NullPointerException}

     *         如果 sftpFileTransferConfig.hostName 是blank,抛出 {@link IllegalArgumentException}

     *         如果 sftpFileTransferConfig.userName 是null,抛出 {@link NullPointerException}

     *         如果 sftpFileTransferConfig.userName 是blank,抛出 {@link IllegalArgumentException}

     * 
     * @throws JSchException
     *             the j sch exception
     */
    static Session connect(SFTPFileTransferConfig sftpFileTransferConfig) throws JSchException{
        Validate.notNull(sftpFileTransferConfig, "sftpFileTransferConfig can't be null!");

        String hostName = sftpFileTransferConfig.getHostName();
        String userName = sftpFileTransferConfig.getUserName();

        Validate.notBlank(hostName, "hostName can't be blank!");
        Validate.notBlank(userName, "userName can't be blank!");

        if (LOGGER.isDebugEnabled()){
            LOGGER.debug("will use [sftpFileTransferConfig]:[{}] to create session", JsonUtil.format(sftpFileTransferConfig));
        }
        //---------------------------------------------------------------
        JSch jsch = new JSch();

        Session session = jsch.getSession(userName, hostName, defaultIfNull(sftpFileTransferConfig.getPort(), 22));

        //---------------------------------------------------------------
        session.setPassword(sftpFileTransferConfig.getPassword());
        session.setTimeout(sftpFileTransferConfig.getSessionTimeout());

        Properties useConfig = build(sftpFileTransferConfig.getSshConfig());
        if (isNotNullOrEmpty(useConfig)){
            session.setConfig(useConfig);
        }
        if (LOGGER.isDebugEnabled()){
            LOGGER.debug(StringUtils.center("session connecting......", 50, "------"));
        }

        //---------------------------------------------------------------
        session.connect();
        return session;
    }

    /**
     * Builds the.
     *
     * @param customConfig
     *            the custom config
     * @return the properties
     * @since 3.0.8
     */
    private static Properties build(Properties customConfig){
        //如果自定义的是 null 那么使用默认的
        if (isNullOrEmpty(customConfig)){
            return DEFAULT_CONFIG_PROPERTIES;
        }

        //---------------------------------------------------------------
        //否则融合,以自定义的覆盖默认的
        Properties properties = new Properties();
        properties.putAll(DEFAULT_CONFIG_PROPERTIES);
        properties.putAll(customConfig);
        return properties;
    }
}