Package com.sshtools.client.sftp

Class SftpFileInputStream

java.lang.Object

java.io.InputStream

com.sshtools.client.sftp.SftpFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class SftpFileInputStream
extends InputStream

An InputStream to read the contents of a remote file.

Constructor Summary

Constructors

Constructor	Description
SftpFileInputStream(SftpFile file)	Deprecated, for removal: This API element is subject to removal in a future version.
SftpFileInputStream(SftpFile file, long position)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()	Closes the SFTP file handle.
int	read()
int	read(byte[] buffer, int offset, int len)

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, 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

Constructor Details

SftpFileInputStream

@Deprecated(since="3.1.0",
            forRemoval=true)
public SftpFileInputStream(SftpFile file)
                    throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Creates a new SftpFileInputStream object.

Parameters:

file - file

Throws:

SftpStatusException

SshException

See Also:

• SftpClient.getInputStream(String)

SftpFileInputStream

@Deprecated(since="3.1.0",
            forRemoval=true)
public SftpFileInputStream(SftpFile file,
 long position)
                    throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Creates a new SftpFileInputStream object.

Parameters:

file - file

position - at which to start reading

Throws:

SftpStatusException

SshException

See Also:

• SftpClient.getInputStream(String)

Method Details

read

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

Overrides:

read in class InputStream

Throws:

IOException

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 AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException