Package com.enterprisedt.net.ftp.ssh

Class AbstractSFTPInputStream

java.lang.Object

java.io.InputStream

com.enterprisedt.net.ftp.FileTransferInputStream

com.enterprisedt.net.ftp.ssh.AbstractSFTPInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class AbstractSFTPInputStream
extends FileTransferInputStream

Represents an input stream of bytes coming from an FTP server, permitting the user to download a file by reading the stream. It can only be used for one download, i.e. after the stream is closed it cannot be reopened.

Version:

$Revision$

Author:

Bruce Blackshaw

Field Summary

Fields

Modifier and Type	Field	Description
protected SSHFTPClient	client	The client being used to perform the transfer
protected com.enterprisedt.net.j2ssh.sftp.SftpFileInputStream	in
protected com.enterprisedt.net.j2ssh.SftpClient	sftp	Implementation object

Fields inherited from class com.enterprisedt.net.ftp.FileTransferInputStream

closed, monitor, monitorCount, monitorEx, monitorInterval, pos, remoteFile, started

Constructor Summary

Constructors

Constructor	Description
AbstractSFTPInputStream(SSHFTPClient client, String remoteFile)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this input stream and releases any system resources associated with the stream.
protected void	start()
protected void	start(boolean firstTime)	Start the transfer

Methods inherited from class com.enterprisedt.net.ftp.FileTransferInputStream

checkMonitor, getRemoteFile, setMonitor

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, read, read, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

client

protected SSHFTPClient client

The client being used to perform the transfer

sftp

protected com.enterprisedt.net.j2ssh.SftpClient sftp

Implementation object

in

protected com.enterprisedt.net.j2ssh.sftp.SftpFileInputStream in

Constructor Details

AbstractSFTPInputStream

public AbstractSFTPInputStream(SSHFTPClient client,
 String remoteFile)
                        throws IOException,
FTPException

Constructor. A connected FTPClient instance must be supplied. This sets up the download. If an offset > 0 is supplied, must be a binary transfer.

Parameters:

client - connected FTPClient instance

remoteFile - remote file

Throws:

IOException

FTPException

Method Details

start

protected void start()
              throws IOException

Throws:

IOException

start

protected void start(boolean firstTime)
              throws IOException

Start the transfer

Throws:

IOException

close

public void close()
           throws IOException

Closes this input stream and releases any system resources associated with the stream. This must be called before any other operations are initiated on the FTPClient.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException - if an I/O error occurs.