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:

Closeable, AutoCloseable, Channel

public class SftpInputStreamWithChannel
extends InputStreamWithChannel

Implements an input stream for reading from a remote file

Author:

Apache MINA SSHD Project

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
SftpClient	getClient() The client instance
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, read

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpInputStreamWithChannel

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

Throws:

IOException

Method Detail

getClient

public final SftpClient getClient()

The client instance

Returns:

SftpClient instance used to access the remote file

getPath

public final String getPath()

The remotely accessed file path

Returns:

Remote file path

isOpen

public boolean isOpen()

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Overrides:

close in class InputStream

Throws:

IOException