ch.ethz.ssh2.SFTPInputStream Maven / Gradle / Ivy
Show all versions of ganymed-ssh2 Show documentation
/*
* Copyright (c) 2011 David Kocher. All rights reserved.
* Please refer to the LICENSE.txt for licensing details.
*/
package ch.ethz.ssh2;
import java.io.IOException;
import java.io.InputStream;
/**
* @version $Id:$
*/
public class SFTPInputStream extends InputStream
{
private SFTPv3FileHandle handle;
/**
* Offset (in bytes) in the file to read
*/
private long readOffset = 0;
public SFTPInputStream(SFTPv3FileHandle handle) {
this.handle = handle;
}
/**
* Reads up to len bytes of data from the input stream into
* an array of bytes. An attempt is made to read as many as
* len bytes, but a smaller number may be read, possibly
* zero. The number of bytes actually read is returned as an integer.
*
* @see SFTPv3Client#read(SFTPv3FileHandle,long,byte[],int,int)
*/
@Override
public int read(byte[] buffer, int offset, int len) throws IOException
{
int read = handle.getClient().read(handle, readOffset, buffer, offset, len);
if(read > 0) {
readOffset += read;
}
return read;
}
/**
* Reads the next byte of data from the input stream. The value byte is
* returned as an int in the range 0 to
* 255. If no byte is available because the end of the stream
* has been reached, the value -1 is returned. This method
* blocks until input data is available, the end of the stream is detected,
* or an exception is thrown.
*
* A subclass must provide an implementation of this method.
*
* @return the next byte of data, or -1 if the end of the
* stream is reached.
* @throws IOException if an I/O error occurs.
*/
@Override
public int read() throws IOException {
byte[] buffer = new byte[1];
int b = handle.getClient().read(handle, readOffset, buffer, 0, 1);
if(b > 0) {
readOffset += 1;
}
return b;
}
/**
* Skips over and discards n bytes of data from this input
* stream.
*
* @param n the number of bytes to be skipped.
* @return the actual number of bytes skipped.
*/
@Override
public long skip(long n) {
readOffset += n;
return n;
}
@Override
public void close() throws IOException {
handle.getClient().closeFile(handle);
}
}