com.helger.jsch.session

Class SessionManager

java.lang.Object

com.helger.jsch.session.SessionManager

All Implemented Interfaces:

AutoCloseable

public class SessionManager
extends Object
implements AutoCloseable

Provides a convenience wrapper to sessions that maintains the session connection for you. Every time you obtain your session through a call to getSession() the current session will have its connection verified, and will reconnect if necessary.

Constructor Summary

Constructors

Constructor and Description
SessionManager(ISessionFactory aSessionFactory) Creates a SessionManager for the supplied sessionFactory.

Method Summary

Modifier and Type	Method and Description
void	close()
String	getAsString()
com.jcraft.jsch.Session	getSession() Returns a connected session.
ISessionFactory	getSessionFactory()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionManager

public SessionManager(@Nonnull
                      ISessionFactory aSessionFactory)

Creates a SessionManager for the supplied sessionFactory.

Parameters:

aSessionFactory - The session factory

Method Detail

getSessionFactory

@Nonnull
public ISessionFactory getSessionFactory()

Returns:

the session factory used by this manager. Never null.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

getSession

@Nonnull
public com.jcraft.jsch.Session getSession()
                                             throws com.jcraft.jsch.JSchException

Returns a connected session.

Returns:

A connected session

Throws:

com.jcraft.jsch.JSchException - If unable to connect the session

getAsString

@Nonnull
 @Nonempty
public String getAsString()

toString

public String toString()

Overrides:

toString in class Object