org.apache.sshd.client.subsystem.sftp

Class SftpFileChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.FileChannel

org.apache.sshd.client.subsystem.sftp.SftpFileChannel

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, SeekableByteChannel, WritableByteChannel

public class SftpFileChannel
extends FileChannel

Nested Class Summary

Nested classes/interfaces inherited from class java.nio.channels.FileChannel

FileChannel.MapMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	COPY_BUFSIZE_PROP
static int	DEFAULT_TRANSFER_BUFFER_SIZE
static Set<SftpClient.OpenMode>	READ_MODES
static Set<SftpClient.OpenMode>	WRITE_MODES

Constructor Summary

Constructors

Constructor and Description
SftpFileChannel(SftpPath p, Collection<SftpClient.OpenMode> modes)

Method Summary

Modifier and Type	Method and Description
protected long	doRead(List<ByteBuffer> buffers, long position)
protected long	doWrite(List<ByteBuffer> buffers, long position)
void	force(boolean metaData)
protected void	implCloseChannel()
FileLock	lock(long position, long size, boolean shared)
MappedByteBuffer	map(FileChannel.MapMode mode, long position, long size)
long	position()
FileChannel	position(long newPosition)
int	read(ByteBuffer dst)
long	read(ByteBuffer[] dsts, int offset, int length)
int	read(ByteBuffer dst, long position)
long	size()
String	toString()
long	transferFrom(ReadableByteChannel src, long position, long count)
long	transferTo(long position, long count, WritableByteChannel target)
FileChannel	truncate(long size)
FileLock	tryLock(long position, long size, boolean shared)
int	write(ByteBuffer src)
long	write(ByteBuffer[] srcs, int offset, int length)
int	write(ByteBuffer src, long position)

Methods inherited from class java.nio.channels.FileChannel

lock, open, open, read, tryLock, write

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

begin, close, end, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Field Detail

COPY_BUFSIZE_PROP

public static final String COPY_BUFSIZE_PROP

See Also:

Constant Field Values

DEFAULT_TRANSFER_BUFFER_SIZE

public static final int DEFAULT_TRANSFER_BUFFER_SIZE

See Also:

Constant Field Values

READ_MODES

public static final Set<SftpClient.OpenMode> READ_MODES

WRITE_MODES

public static final Set<SftpClient.OpenMode> WRITE_MODES

Constructor Detail

SftpFileChannel

public SftpFileChannel(SftpPath p,
                       Collection<SftpClient.OpenMode> modes)
                throws IOException

Throws:

IOException

Method Detail

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Specified by:

read in interface SeekableByteChannel

Specified by:

read in class FileChannel

Throws:

IOException

read

public int read(ByteBuffer dst,
                long position)
         throws IOException

Specified by:

read in class FileChannel

Throws:

IOException

read

public long read(ByteBuffer[] dsts,
                 int offset,
                 int length)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Specified by:

read in class FileChannel

Throws:

IOException

doRead

protected long doRead(List<ByteBuffer> buffers,
                      long position)
               throws IOException

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface SeekableByteChannel

Specified by:

write in interface WritableByteChannel

Specified by:

write in class FileChannel

Throws:

IOException

write

public int write(ByteBuffer src,
                 long position)
          throws IOException

Specified by:

write in class FileChannel

Throws:

IOException

write

public long write(ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws IOException

Specified by:

write in interface GatheringByteChannel

Specified by:

write in class FileChannel

Throws:

IOException

doWrite

protected long doWrite(List<ByteBuffer> buffers,
                       long position)
                throws IOException

Throws:

IOException

position

public long position()
              throws IOException

Specified by:

position in interface SeekableByteChannel

Specified by:

position in class FileChannel

Throws:

IOException

position

public FileChannel position(long newPosition)
                     throws IOException

Specified by:

position in interface SeekableByteChannel

Overrides:

position in class FileChannel

Throws:

IOException

size

public long size()
          throws IOException

Specified by:

size in interface SeekableByteChannel

Specified by:

size in class FileChannel

Throws:

IOException

truncate

public FileChannel truncate(long size)
                     throws IOException

Specified by:

truncate in interface SeekableByteChannel

Overrides:

truncate in class FileChannel

Throws:

IOException

force

public void force(boolean metaData)
           throws IOException

Specified by:

force in class FileChannel

Throws:

IOException

transferTo

public long transferTo(long position,
                       long count,
                       WritableByteChannel target)
                throws IOException

Specified by:

transferTo in class FileChannel

Throws:

IOException

transferFrom

public long transferFrom(ReadableByteChannel src,
                         long position,
                         long count)
                  throws IOException

Specified by:

transferFrom in class FileChannel

Throws:

IOException

map

public MappedByteBuffer map(FileChannel.MapMode mode,
                            long position,
                            long size)
                     throws IOException

Specified by:

map in class FileChannel

Throws:

IOException

lock

public FileLock lock(long position,
                     long size,
                     boolean shared)
              throws IOException

Specified by:

lock in class FileChannel

Throws:

IOException

tryLock

public FileLock tryLock(long position,
                        long size,
                        boolean shared)
                 throws IOException

Specified by:

tryLock in class FileChannel

Throws:

IOException

implCloseChannel

protected void implCloseChannel()
                         throws IOException

Specified by:

implCloseChannel in class AbstractInterruptibleChannel

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object