com.helger.jsch.session

Interface ISessionFactory

All Known Implementing Classes:

DefaultSessionFactory

public interface ISessionFactory

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.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SSH_PORT

Method Summary

Modifier and Type	Method and Description
default String	getAsString()
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.

Field Detail

SSH_PORT

static final int SSH_PORT

See Also:

Constant Field Values

Method Detail

getHostname

String getHostname()

Returns:

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

getPort

int getPort()

Returns:

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

getProxy

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

getUsername

String getUsername()

Returns:

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

getUserInfo

com.jcraft.jsch.UserInfo getUserInfo()

Returns:

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

newSession

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

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

@Nonnull
AbstractSessionFactoryBuilder newSessionFactoryBuilder()

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

Returns:

A builder for a session factory

getAsString

@Nonnull
 @Nonempty
default String getAsString()