com.pastdev.jsch

Class DefaultSessionFactory

java.lang.Object

com.pastdev.jsch.DefaultSessionFactory

All Implemented Interfaces:

SessionFactory

public class DefaultSessionFactory
extends java.lang.Object
implements SessionFactory

The default implementation of SessionFactory. This class provides sane defaults for all conventional configuration including

username: System property user.name
hostname: localhost
port: 22
.ssh directory: System property jsch.dotSsh, or system property user.home concatenated with "/.ssh"
known hosts: System property jsch.knownHosts.file or, .ssh directory concatenated with "/known_hosts".
private keys: First checks for an agent proxy using ConnectorFactory.createConnector(), then system property jsch.privateKey.files split on ",", otherwise, .ssh directory concatenated with all 3 of "/id_rsa", "/id_dsa", and "/id_ecdsa" if they exist.

Nested Class Summary

Nested classes/interfaces inherited from interface com.pastdev.jsch.SessionFactory

SessionFactory.SessionFactoryBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_JSCH_DOT_SSH
static java.lang.String	PROPERTY_JSCH_KNOWN_HOSTS_FILE
static java.lang.String	PROPERTY_JSCH_PRIVATE_KEY_FILES

Fields inherited from interface com.pastdev.jsch.SessionFactory

SSH_PORT

Constructor Summary

Constructors

Constructor and Description
DefaultSessionFactory() Creates a default DefaultSessionFactory.
DefaultSessionFactory(java.lang.String username, java.lang.String hostname, java.lang.Integer port) Constructs a DefaultSessionFactory with the supplied properties.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getHostname() Returns the hostname that sessions built by this factory will connect to.
int	getPort() Returns the port that sessions built by this factory will connect to.
com.jcraft.jsch.Proxy	getProxy() Returns the proxy that sessions built by this factory will connect through, if any.
com.jcraft.jsch.UserInfo	getUserInfo() Returns the userInfo that sessions built by this factory will connect with.
java.lang.String	getUsername() Returns the username that sessions built by this factory will connect with.
com.jcraft.jsch.Session	newSession() Returns a new session using the configured properties.
SessionFactory.SessionFactoryBuilder	newSessionFactoryBuilder() Returns a builder for another session factory pre-initialized with the configuration for this session factory.
void	setConfig(java.util.Map<java.lang.String,java.lang.String> config) Sets the configuration options for the sessions created by this factory.
void	setConfig(java.lang.String key, java.lang.String value) Adds a single configuration options for the sessions created by this factory.
void	setHostname(java.lang.String hostname) Sets the hostname.
void	setIdentitiesFromPrivateKeys(java.util.List<java.lang.String> privateKeys) Configures this factory to use a list of identities authenticated by the supplied private keys.
void	setIdentityFromPrivateKey(java.lang.String privateKey) Configures this factory to use a single identity authenticated by the supplied private key.
void	setIdentityFromPrivateKey(java.lang.String privateKey, java.lang.String passPhrase) Configures this factory to use a single identity authenticated by the supplied private key and pass phrase.
void	setIdentityRepository(com.jcraft.jsch.IdentityRepository identityRepository) Sets the IdentityRepository for this factory.
void	setKnownHosts(java.io.InputStream knownHosts) Sets the known hosts from the stream.
void	setKnownHosts(java.lang.String knownHosts) Sets the known hosts from a file at path knownHosts.
void	setPassword(java.lang.String password) Sets the password used to authenticate username.
void	setPort(int port) Sets the port.
void	setProxy(com.jcraft.jsch.Proxy proxy) Sets the proxy through which all connections will be piped.
void	setUserInfo(com.jcraft.jsch.UserInfo userInfo) Sets the UserInfo for use with keyboard-interactive authentication.
void	setUsername(java.lang.String username) Sets the username.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_JSCH_DOT_SSH

public static final java.lang.String PROPERTY_JSCH_DOT_SSH

See Also:

Constant Field Values

PROPERTY_JSCH_KNOWN_HOSTS_FILE

public static final java.lang.String PROPERTY_JSCH_KNOWN_HOSTS_FILE

See Also:

Constant Field Values

PROPERTY_JSCH_PRIVATE_KEY_FILES

public static final java.lang.String PROPERTY_JSCH_PRIVATE_KEY_FILES

See Also:

Constant Field Values

Constructor Detail

DefaultSessionFactory

public DefaultSessionFactory()

Creates a default DefaultSessionFactory.

DefaultSessionFactory

public DefaultSessionFactory(java.lang.String username,
                     java.lang.String hostname,
                     java.lang.Integer port)

Constructs a DefaultSessionFactory with the supplied properties.

Parameters:

username - The username

hostname - The hostname

port - The port

Method Detail

getHostname

public java.lang.String getHostname()

Description copied from interface: SessionFactory

Returns the hostname that sessions built by this factory will connect to.

Specified by:

getHostname in interface SessionFactory

Returns:

The hostname

getPort

public int getPort()

Description copied from interface: SessionFactory

Returns the port that sessions built by this factory will connect to.

Specified by:

getPort in interface SessionFactory

Returns:

The port

getProxy

public com.jcraft.jsch.Proxy getProxy()

Description copied from interface: SessionFactory

Returns the proxy that sessions built by this factory will connect through, if any. If none was configured, null will be returned.

Specified by:

getProxy in interface SessionFactory

Returns:

The proxy or null

getUsername

public java.lang.String getUsername()

Description copied from interface: SessionFactory

Returns the username that sessions built by this factory will connect with.

Specified by:

getUsername in interface SessionFactory

Returns:

The username

getUserInfo

public com.jcraft.jsch.UserInfo getUserInfo()

Description copied from interface: SessionFactory

Returns the userInfo that sessions built by this factory will connect with.

Specified by:

getUserInfo in interface SessionFactory

Returns:

The userInfo

newSession

public com.jcraft.jsch.Session newSession()
                                   throws com.jcraft.jsch.JSchException

Description copied from interface: SessionFactory

Returns a new session using the configured properties.

Specified by:

newSession in interface SessionFactory

Returns:

A new session

Throws:

com.jcraft.jsch.JSchException - If username or hostname are invalid

See Also:

JSch.getSession(String, String, int)

newSessionFactoryBuilder

public SessionFactory.SessionFactoryBuilder newSessionFactoryBuilder()

Description copied from interface: SessionFactory

Returns a builder for another session factory pre-initialized with the configuration for this session factory.

Specified by:

newSessionFactoryBuilder in interface SessionFactory

Returns:

A builder for a session factory

setConfig

public void setConfig(java.util.Map<java.lang.String,java.lang.String> config)

Sets the configuration options for the sessions created by this factory. This method will replace the current SessionFactory config map. If you want to add, rather than replace, see setConfig(String, String). All of these options will be added one at a time using Session.setConfig(String, String). Details on the supported options can be found in the source for Session.applyConfig().

Parameters:

config - The configuration options

See Also:

Session.setConfig(java.util.Hashtable), Session.applyConfig()

setConfig

public void setConfig(java.lang.String key,
             java.lang.String value)

Adds a single configuration options for the sessions created by this factory. Details on the supported options can be found in the source for Session.applyConfig().

Parameters:

key - The name of the option

value - The value of the option

See Also:

setConfig(Map), Session.setConfig(java.util.Hashtable), Session.applyConfig()

setHostname

public void setHostname(java.lang.String hostname)

Sets the hostname.

Parameters:

hostname - The hostname.

setIdentityFromPrivateKey

public void setIdentityFromPrivateKey(java.lang.String privateKey)
                               throws com.jcraft.jsch.JSchException

Configures this factory to use a single identity authenticated by the supplied private key. The private key should be the path to a private key file in OpenSSH format. Clears out the current IdentityRepository before adding this key.

Parameters:

privateKey - Path to a private key file

Throws:

com.jcraft.jsch.JSchException - If the key is invalid

setIdentityFromPrivateKey

public void setIdentityFromPrivateKey(java.lang.String privateKey,
                             java.lang.String passPhrase)
                               throws com.jcraft.jsch.JSchException

Configures this factory to use a single identity authenticated by the supplied private key and pass phrase. The private key should be the path to a private key file in OpenSSH format. Clears out the current IdentityRepository before adding this key.

Parameters:

privateKey - Path to a private key file

passPhrase - Pass phrase for private key

Throws:

com.jcraft.jsch.JSchException - If the key is invalid

setIdentitiesFromPrivateKeys

public void setIdentitiesFromPrivateKeys(java.util.List<java.lang.String> privateKeys)
                                  throws com.jcraft.jsch.JSchException

Configures this factory to use a list of identities authenticated by the supplied private keys. The private keys should be the paths to a private key files in OpenSSH format. Clears out the current IdentityRepository before adding these keys.

Parameters:

privateKeys - A list of paths to private key files

Throws:

com.jcraft.jsch.JSchException - If one (or more) of the keys are invalid

setIdentityRepository

public void setIdentityRepository(com.jcraft.jsch.IdentityRepository identityRepository)

Sets the IdentityRepository for this factory. This will replace any current IdentityRepository, so you should be sure to call this before any of the setIdentit(y|ies)Xxx if you plan on using both.

Parameters:

identityRepository - The identity repository

See Also:

JSch.setIdentityRepository(IdentityRepository)

setKnownHosts

public void setKnownHosts(java.io.InputStream knownHosts)
                   throws com.jcraft.jsch.JSchException

Sets the known hosts from the stream. Mostly useful if you distribute your known_hosts in the jar for your application rather than allowing users to manage their own known hosts.

Parameters:

knownHosts - A stream of known hosts

Throws:

com.jcraft.jsch.JSchException - If an I/O error occurs

See Also:

JSch.setKnownHosts(InputStream)

setKnownHosts

public void setKnownHosts(java.lang.String knownHosts)
                   throws com.jcraft.jsch.JSchException

Sets the known hosts from a file at path knownHosts.

Parameters:

knownHosts - The path to a known hosts file

Throws:

com.jcraft.jsch.JSchException - If an I/O error occurs

See Also:

JSch.setKnownHosts(String)

setPassword

public void setPassword(java.lang.String password)

Sets the password used to authenticate username. This mode of authentication is not recommended as it would keep the password in memory and if the application dies and writes a heap dump, it would be available. Using Identity would be better, or even using ssh agent support.

Parameters:

password - the password for username

setPort

public void setPort(int port)

Sets the port.

Parameters:

port - The port

setProxy

public void setProxy(com.jcraft.jsch.Proxy proxy)

Sets the proxy through which all connections will be piped.

Parameters:

proxy - The proxy

setUserInfo

public void setUserInfo(com.jcraft.jsch.UserInfo userInfo)

Sets the UserInfo for use with keyboard-interactive authentication. This may be useful, however, setting the password with setPassword(String) is likely sufficient.

Parameters:

userInfo -

See Also:

Keyboard Interactive Authentication Example

setUsername

public void setUsername(java.lang.String username)

Sets the username.

Parameters:

username - The username

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object