com.maverick.sftp

Class SftpFileInputStream

java.lang.Object

java.io.InputStream

com.maverick.sftp.SftpFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class SftpFileInputStream
extends InputStream

An InputStream to read the contents of a remote file.

 // Create an SshClient forcing SSH2 connectivity.
 SshConnector con = SshConnector.getInstance();
 con.setSupportedVersions(SshConnector.SSH2);
 
 // Connect and authenticate an SshClient
 Ssh2Client ssh = (Ssh2Client) con.connect(....);
 ....
 
 SftpClient sftp=new SftpClient(ssh);
 
 //read file as input stream
        InputStream in = sftp.getInputStream("streamTest");
        
         // Read the data
         int read;
         while((read = in.read()) > -1){
                //do something with data
         }
 
         // Close the file and the stream
         in.close();

Author:

Lee David Painter

Constructor Summary

Constructors

Constructor and Description
SftpFileInputStream(SftpFile file)
SftpFileInputStream(SftpFile file, long position) Creates a new SftpFileInputStream object.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close() Closes the SFTP file handle.
protected void	finalize() This method will only be available in J2SE builds
protected boolean	isEOFMessage(int status)
int	read()
int	read(byte[] buffer, int offset, int len)
void	setMaximumAsyncRequests(int maximumAsyncRequests)

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpFileInputStream

public SftpFileInputStream(SftpFile file)
                    throws SftpStatusException,
                           SshException

Parameters:

file -

Throws:

SftpStatusException

SshException

SftpFileInputStream

public SftpFileInputStream(SftpFile file,
                           long position)
                    throws SftpStatusException,
                           SshException

Creates a new SftpFileInputStream object.

Parameters:

file -

position - at which to start reading

Throws:

SftpStatusException

SshException

Method Detail

setMaximumAsyncRequests

public void setMaximumAsyncRequests(int maximumAsyncRequests)

read

public int read(byte[] buffer,
                int offset,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

isEOFMessage

protected boolean isEOFMessage(int status)

available

public int available()

Overrides:

available in class InputStream

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Closes the SFTP file handle.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

finalize

protected void finalize()
                 throws IOException

This method will only be available in J2SE builds

Overrides:

finalize in class Object

Throws:

IOException