com.helger.jsch.session

Class DefaultSessionFactory

java.lang.Object

com.helger.jsch.session.DefaultSessionFactory

All Implemented Interfaces:

ISessionFactory

public class DefaultSessionFactory
extends Object
implements ISessionFactory

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_JSCH_DOT_SSH
static String	PROPERTY_JSCH_KNOWN_HOSTS_FILE
static String	PROPERTY_JSCH_PRIVATE_KEY_FILES

Fields inherited from interface com.helger.jsch.session.ISessionFactory

SSH_PORT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getHostname()
int	getPort()
com.jcraft.jsch.Proxy	getProxy()
com.jcraft.jsch.UserInfo	getUserInfo()
String	getUsername()
com.jcraft.jsch.Session	newSession()
AbstractSessionFactoryBuilder	newSessionFactoryBuilder() Returns a builder for another session factory pre-initialized with the configuration for this session factory.
void	setConfig(com.helger.commons.collection.impl.ICommonsMap<String,String> config) Sets the configuration options for the sessions created by this factory.
void	setConfig(String key, String value) Adds a single configuration options for the sessions created by this factory.
void	setHostname(String hostname) Sets the hostname.
void	setIdentitiesFromPrivateKeys(List<String> privateKeys) Configures this factory to use a list of identities authenticated by the supplied private keys.
void	setIdentityFromPrivateKey(String privateKey) Configures this factory to use a single identity authenticated by the supplied private key.
void	setIdentityFromPrivateKey(String privateKey, 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(InputStream knownHosts) Sets the known hosts from the stream.
void	setKnownHosts(String knownHosts) Sets the known hosts from a file at path knownHosts.
void	setPassword(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(String username) Sets the username.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.jsch.session.ISessionFactory

getAsString

Field Detail

PROPERTY_JSCH_DOT_SSH

public static final String PROPERTY_JSCH_DOT_SSH

See Also:

Constant Field Values

PROPERTY_JSCH_KNOWN_HOSTS_FILE

public static final String PROPERTY_JSCH_KNOWN_HOSTS_FILE

See Also:

Constant Field Values

PROPERTY_JSCH_PRIVATE_KEY_FILES

public static final String PROPERTY_JSCH_PRIVATE_KEY_FILES

See Also:

Constant Field Values

Constructor Detail

DefaultSessionFactory

public DefaultSessionFactory()

Creates a default DefaultSessionFactory.

DefaultSessionFactory

public DefaultSessionFactory(String username,
                             String hostname,
                             int port)

Constructs a DefaultSessionFactory with the supplied properties.

Parameters:

username - The username

hostname - The hostname

port - The port

Method Detail

setConfig

public void setConfig(com.helger.commons.collection.impl.ICommonsMap<String,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 com.jcraft.jsch.Session#applyConfig()

Parameters:

config - The configuration options

See Also:

Session.setConfig(java.util.Hashtable)

setConfig

public void setConfig(@Nonnull
                      String key,
                      @Nonnull
                      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 com.jcraft.jsch.Session#applyConfig()

Parameters:

key - The name of the option

value - The value of the option

See Also:

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

getHostname

public String getHostname()

Specified by:

getHostname in interface ISessionFactory

Returns:

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

setHostname

public void setHostname(String hostname)

Sets the hostname.

Parameters:

hostname - The hostname.

setPassword

public void setPassword(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

getPort

public int getPort()

Specified by:

getPort in interface ISessionFactory

Returns:

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

setPort

public void setPort(int port)

Sets the port.

Parameters:

port - The port

getProxy

public com.jcraft.jsch.Proxy getProxy()

Specified by:

getProxy in interface ISessionFactory

Returns:

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

setProxy

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

Sets the proxy through which all connections will be piped.

Parameters:

proxy - The proxy

getUsername

public String getUsername()

Specified by:

getUsername in interface ISessionFactory

Returns:

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

setUsername

public void setUsername(String username)

Sets the username.

Parameters:

username - The username

getUserInfo

public com.jcraft.jsch.UserInfo getUserInfo()

Specified by:

getUserInfo in interface ISessionFactory

Returns:

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

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 - User info

See Also:

Keyboard Interactive Authentication Example

setIdentityFromPrivateKey

public void setIdentityFromPrivateKey(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(String privateKey,
                                      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(List<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(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(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)

newSession

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

Specified by:

newSession in interface ISessionFactory

Returns:

a new session using the configured properties.

Throws:

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

See Also:

JSch.getSession(String, String, int)

newSessionFactoryBuilder

public AbstractSessionFactoryBuilder newSessionFactoryBuilder()

Description copied from interface: ISessionFactory

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

Specified by:

newSessionFactoryBuilder in interface ISessionFactory

Returns:

A builder for a session factory