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

Class SftpChannel

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable, Connectable, ConnectedTestable

public final class SftpChannel
extends Object
implements Connectable, Closeable

This class encapsulates a SFTP channel.

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

Constructor Summary

Constructors

Constructor and Description
SftpChannel(SftpSession session, boolean autoCloseSession) Create a new SFTP channel.

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

Constructor Detail

SftpChannel

public SftpChannel(SftpSession session,
                   boolean autoCloseSession)

Create a new SFTP channel. It is still unconnected.

This channel can be connected by a call to its own connect() method.

Parameters:

session - The SFTP session

autoCloseSession - Flag whether to close the SFTP session automatically when this channel will be closed

Throws:

IllegalArgumentException - if the SFTP session is null

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 channel is already closed

NotConnectedException - in case of error

close

public final void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable