Package org.apache.sshd.client.subsystem.sftp

Class SftpInputStreamWithChannel

java.lang.Object

java.io.InputStream

org.apache.sshd.common.util.io.InputStreamWithChannel

org.apache.sshd.client.subsystem.sftp.SftpInputStreamWithChannel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel

public class SftpInputStreamWithChannel
extends InputStreamWithChannel

Implements an input stream for reading from a remote file

Field Summary

Fields

Modifier and Type	Field	Description
private int	available
private byte[]	bb
private byte[]	buffer
private SftpClient	client
private SftpClient.CloseableHandle	handle
private int	index
private long	offset
private java.lang.String	path

Constructor Summary

Constructors

Constructor	Description
SftpInputStreamWithChannel(SftpClient client, int bufferSize, java.lang.String path, java.util.Collection<SftpClient.OpenMode> mode)

Method Summary

Modifier and Type	Method	Description
void	close()
SftpClient	getClient()	The client instance
java.lang.String	getPath()	The remotely accessed file path
boolean	isOpen()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.InputStream

available, nullInputStream, read, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Detail

client

private final SftpClient client

path

private final java.lang.String path

bb

private byte[] bb

buffer

private byte[] buffer

index

private int index

available

private int available

handle

private SftpClient.CloseableHandle handle

offset

private long offset

Constructor Detail

SftpInputStreamWithChannel

public SftpInputStreamWithChannel(SftpClient client,
                                  int bufferSize,
                                  java.lang.String path,
                                  java.util.Collection<SftpClient.OpenMode> mode)
                           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getClient

public final SftpClient getClient()

The client instance

Returns:

SftpClient instance used to access the remote file

getPath

public final java.lang.String getPath()

The remotely accessed file path

Returns:

Remote file path

isOpen

public boolean isOpen()

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.InputStream

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.nio.channels.Channel

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException