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

Class SftpInputStream

java.lang.Object

java.io.InputStream

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

All Implemented Interfaces:

Closeable, AutoCloseable, ConnectedTestable

public final class SftpInputStream
extends InputStream
implements ConnectedTestable

This class implements a SFTP input stream.

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

Constructor Summary

Constructors

Constructor and Description
SftpInputStream(SftpChannel channel, String path) Create a new SFTP input stream.
SftpInputStream(SftpChannel channel, String path, long skip) Create a new SFTP input stream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
boolean	isConnected() Answer whether this object is currently connected.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
long	skip(long n)

Methods inherited from class java.io.InputStream

mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpInputStream

public SftpInputStream(SftpChannel channel,
                       String path)
                throws NotConnectedException

Create a new SFTP input stream.

Parameters:

channel - The SFTP channel

path - The file path

Throws:

IllegalArgumentException - if the SFTP channel is null

IllegalArgumentException - if the path is null or blank

NotConnectedException - in case of being not connected

SftpInputStream

public SftpInputStream(SftpChannel channel,
                       String path,
                       long skip)
                throws NotConnectedException

Create a new SFTP input stream.

Parameters:

channel - The SFTP channel

path - The file path

skip - The number of bytes to skip before reading input

Throws:

IllegalArgumentException - if the SFTP channel is null

IllegalArgumentException - if the path is null or blank

NotConnectedException - in case of being not connected

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

read

public final int read()

Specified by:

read in class InputStream

read

public final int read(byte[] b)

Overrides:

read in class InputStream

read

public final int read(byte[] b,
                      int off,
                      int len)

Overrides:

read in class InputStream

skip

public final long skip(long n)
                throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public final int available()

Overrides:

available in class InputStream

close

public final void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream