Package org.apache.sshd.sftp.client.impl

Class SftpRemotePathChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.FileChannel

org.apache.sshd.sftp.client.impl.SftpRemotePathChannel

All Implemented Interfaces:

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

public class SftpRemotePathChannel
extends FileChannel

Nested Class Summary

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

FileChannel.MapMode

Field Summary

Fields

Modifier and Type	Field	Description
protected final AtomicReference<Thread>	blockingThreadHolder
protected final boolean	closeOnExit
protected final SftpClient.CloseableHandle	handle
protected final Object	lock
protected final org.slf4j.Logger	log
protected final Collection<SftpClient.OpenMode>	modes
private final String	path
protected final AtomicLong	posTracker
static final Set<SftpClient.OpenMode>	READ_MODES
protected final SftpClient	sftp
static final Set<SftpClient.OpenMode>	WRITE_MODES

Constructor Summary

Constructors

Constructor	Description
SftpRemotePathChannel(String path, SftpClient sftp, boolean closeOnExit, Collection<SftpClient.OpenMode> modes)

Method Summary

Modifier and Type	Method	Description
protected void	beginBlocking(Object actionHint)
protected long	doRead(Collection<? extends ByteBuffer> buffers, long position)
protected long	doWrite(Collection<? extends ByteBuffer> buffers, long position)
protected void	endBlocking(Object actionHint, boolean completed)
private void	ensureOpen(Collection<SftpClient.OpenMode> reqModes)	Checks that the channel is open and that its current mode contains at least one of the required ones
void	force(boolean metaData)
String	getRemotePath()
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

isOpen

Field Details

READ_MODES

public static final Set<SftpClient.OpenMode> READ_MODES

WRITE_MODES

public static final Set<SftpClient.OpenMode> WRITE_MODES

log

protected final org.slf4j.Logger log

modes

protected final Collection<SftpClient.OpenMode> modes

closeOnExit

protected final boolean closeOnExit

sftp

protected final SftpClient sftp

handle

protected final SftpClient.CloseableHandle handle

lock

protected final Object lock

posTracker

protected final AtomicLong posTracker

blockingThreadHolder

protected final AtomicReference<Thread> blockingThreadHolder

path

private final String path

Constructor Details

SftpRemotePathChannel

public SftpRemotePathChannel(String path,
 SftpClient sftp,
 boolean closeOnExit,
 Collection<SftpClient.OpenMode> modes)
                      throws IOException

Throws:

IOException

Method Details

getRemotePath

public String getRemotePath()

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(Collection<? extends 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(Collection<? extends 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

Specified by:

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

Specified by:

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

beginBlocking

protected void beginBlocking(Object actionHint)

endBlocking

protected void endBlocking(Object actionHint,
 boolean completed)
                    throws AsynchronousCloseException

Throws:

AsynchronousCloseException

ensureOpen

private void ensureOpen(Collection<SftpClient.OpenMode> reqModes)
                 throws IOException

Checks that the channel is open and that its current mode contains at least one of the required ones

Parameters:

reqModes - The required modes - ignored if null/empty

Throws:

IOException - If channel not open or the required modes are not satisfied

toString

public String toString()

Overrides:

toString in class Object