com.pastdev.jsch

Interface SessionFactory

All Known Implementing Classes:

DefaultSessionFactory

public interface SessionFactory

An interface for creating 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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SessionFactory.SessionFactoryBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static int	SSH_PORT

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.

Field Detail

SSH_PORT

static final int SSH_PORT

See Also:

Constant Field Values

Method Detail

getHostname

java.lang.String getHostname()

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

Returns:

The hostname

getPort

int getPort()

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

Returns:

The port

getProxy

com.jcraft.jsch.Proxy getProxy()

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

Returns:

The proxy or null

getUsername

java.lang.String getUsername()

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

Returns:

The username

getUserInfo

com.jcraft.jsch.UserInfo getUserInfo()

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

Returns:

The userInfo

newSession

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

Returns a new session using the configured properties.

Returns:

A new session

Throws:

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

See Also:

JSch.getSession(String, String, int)

newSessionFactoryBuilder

SessionFactory.SessionFactoryBuilder newSessionFactoryBuilder()

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

Returns:

A builder for a session factory