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

Go to download

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.3.0

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.util.MapUtil.newLinkedHashMap;

import java.util.Map;

import com.feilong.core.Validate;
import com.feilong.core.lang.StringUtil;
import com.jcraft.jsch.Session;

/**
 * Sftp Session 工具.
 *
 * @author feilong
 * @since 1.10.4
 */
class SftpSessionUtil{

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

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

    /**
     * Builds the session pretty string.
     *
     * @param session
     *            the session
     *
     * @return the string
     */
    static String buildSessionPrettyString(Session session){
        Validate.notNull(session, "session can't be null!");

        return StringUtil.formatPattern("{}@{}:{}", session.getUserName(), session.getHost(), session.getPort());
    }

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

    /**
     * Gets the map for log.
     *
     * @param session
     *            the session
     *
     * @return the map for log
     */
    static Map getMapForLog(Session session){
        Map map = newLinkedHashMap();
        map.put("serverVersion", session.getServerVersion());
        map.put("clientVersion", session.getClientVersion());
        map.put("serverAliveCountMax", session.getServerAliveCountMax());
        map.put("serverAliveInterval", session.getServerAliveInterval());
        map.put("timeout", session.getTimeout());
        return map;
    }
}