net.scharlie.lj4l.core.io.remote.sftp

Class SftpSession

java.lang.Object

net.scharlie.lj4l.core.io.remote.sftp.SftpSession

All Implemented Interfaces:

Closeable, AutoCloseable, Connectable, ConnectedTestable

public final class SftpSession
extends Object
implements Connectable, Closeable

This class encapsulates a SFTP session.

Instances of this class are not safe for use by multiple threads.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	connect() Try to connect this object.
boolean	isConnected() Answer whether this object is currently connected.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.scharlie.lj4l.core.io.remote.Connectable

connect, ensureConnected

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

Method Detail

isConnected

public final boolean isConnected()

Description copied from interface: ConnectedTestable

Answer whether this object is currently connected.

Specified by:

isConnected in interface ConnectedTestable

Returns:

answer

connect

public final boolean connect()
                      throws NotConnectedException

Try to connect this object. Return immediately if already connected or after a one-time try.

Specified by:

connect in interface Connectable

Returns:

whether this object is connected

Throws:

IllegalStateException - if this session is already closed

NotConnectedException - if the internal JSch session cannot be opened

NotConnectedException - if a wanted public-key authentication cannot be enabled

close

public final void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable