com.pastdev.jsch.SessionFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsch-extension Show documentation
A set of extensions on top of JSch providing a full SCP protocol implementation, tunneling including multi-hop, a Java 7 FileSystem like implementation for Java 6 and remote command execution
There is a newer version: 0.1.11
Show newest version
package com.pastdev.jsch;


import java.util.Map;


import com.jcraft.jsch.JSch;
import com.jcraft.jsch.JSchException;
import com.jcraft.jsch.Proxy;
import com.jcraft.jsch.Session;
import com.jcraft.jsch.UserInfo;


/**
 * An interface for creating {@link Session} objects from a common
 * configuration. Also supports creation of other SessionFactory instances that
 * are initialized from the same configuration and can be modified as necessary.
 */
public interface SessionFactory {
    public static final int SSH_PORT = 22;

    /**
     * Returns the hostname that sessions built by this factory will connect to.
     * 
     * @return The hostname
     */
    public String getHostname();

    /**
     * Returns the port that sessions built by this factory will connect to.
     * 
     * @return The port
     */
    public int getPort();

    /**
     * Returns the proxy that sessions built by this factory will connect
     * through, if any. If none was configured, null will be
     * returned.
     * 
     * @return The proxy or null
     */
    public Proxy getProxy();

    /**
     * Returns the username that sessions built by this factory will connect
     * with.
     * 
     * @return The username
     */
    public String getUsername();

    /**
     * Returns the userInfo that sessions built by this factory will connect
     * with.
     * 
     * @return The userInfo
     */
    public UserInfo getUserInfo();

    /**
     * Returns a new session using the configured properties.
     * 
     * @return A new session
     * @throws JSchException
     *             If username or hostname are invalid
     * 
     * @see com.jcraft.jsch.JSch#getSession(String, String, int)
     */
    public Session newSession() throws JSchException;

    /**
     * Returns a builder for another session factory pre-initialized with the
     * configuration for this session factory.
     * 
     * @return A builder for a session factory
     */
    public SessionFactoryBuilder newSessionFactoryBuilder();

    abstract public class SessionFactoryBuilder {
        protected Map config;
        protected String hostname;
        protected JSch jsch;
        protected int port;
        protected Proxy proxy;
        protected String username;
        protected UserInfo userInfo;

        protected SessionFactoryBuilder( JSch jsch, String username, String hostname, int port, Proxy proxy, Map config, UserInfo userInfo ) {
            this.jsch = jsch;
            this.username = username;
            this.hostname = hostname;
            this.port = port;
            this.proxy = proxy;
            this.config = config;
            this.userInfo = userInfo;
        }

        /**
         * Replaces the current config with config
         * 
         * @param config
         *            The new config
         * @return This builder
         * 
         * @see com.pastdev.jsch.DefaultSessionFactory#setConfig(Map)
         */
        public SessionFactoryBuilder setConfig( Map config ) {
            this.config = config;
            return this;
        }

        /**
         * Replaces the current hostname with hostname
         * 
         * @param hostname
         *            The new hostname
         * @return This builder
         */
        public SessionFactoryBuilder setHostname( String hostname ) {
            this.hostname = hostname;
            return this;
        }

        /**
         * Replaces the current port with port
         * 
         * @param port
         *            The new port
         * @return This builder
         */
        public SessionFactoryBuilder setPort( int port ) {
            this.port = port;
            return this;
        }

        /**
         * Replaces the current proxy with proxy
         * 
         * @param proxy
         *            The new proxy
         * @return This builder
         * 
         * @see com.pastdev.jsch.DefaultSessionFactory#setProxy(Proxy)
         */
        public SessionFactoryBuilder setProxy( Proxy proxy ) {
            this.proxy = proxy;
            return this;
        }

        /**
         * Replaces the current username with username
         * 
         * @param username
         *            The new username
         * @return This builder
         */
        public SessionFactoryBuilder setUsername( String username ) {
            this.username = username;
            return this;
        }

        /**
         * Replaces the current userInfo with userInfo
         * 
         * @param userInfo
         *            The new userInfo
         * @return This builder
         */
        public SessionFactoryBuilder setUserInfo( UserInfo userInfo ) {
            this.userInfo = userInfo;
            return this;
        }

        /**
         * Builds and returns a the new SessionFactory instance.
         * 
         * @return The built SessionFactory
         */
        abstract public SessionFactory build();
    }
}