Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.server.FileHandle

Modifier and Type	Field and Description
private final int	access
private final Collection<FileAttribute<?>>	fileAttributes
private final SeekableByteChannel	fileChannel
private final List<FileLock>	locks
private final Set<StandardOpenOption>	openOptions

Access	Constructor and Description
public	FileHandle(SftpSubsystem subsystem, Path file, String handle, int flags, int access, Map<String, Object> attrs)

Method Summary

Modifier and Type	Method and Description
public void	append(byte[] data)
public void	append(byte[] data, int doff, int length)
private boolean	canRead()
private boolean	canWrite()
public void	close() Overrides org.apache.sshd.sftp.server.Handle.close. Implements java.nio.channels.Channel.close. Closes this channel.
public int	getAccessMask()
public final Collection<FileAttribute<?>>	getFileAttributes()
public SeekableByteChannel	getFileChannel()
public final Set<StandardOpenOption>	getOpenOptions()
public static Set<StandardOpenOption>	getOpenOptions(int flags, int access)
public boolean	isOpenAppend()
public void	lock(long offset, long length, int mask)
public int	read(byte[] data, long offset)
public int	read(byte[] data, int doff, int length, long offset)
public int	read(byte[] data, int doff, int length, long offset, AtomicReference<Boolean> eof)
public static FileAttribute<?>	toFileAttribute(String key, Object val)
public static Collection<FileAttribute<?>>	toFileAttributes(Map<String, ?> attrs)
public void	unlock(long offset, long length)
public void	write(byte[] data, long offset)
public void	write(byte[] data, int doff, int length, long offset)

Inherited from org.apache.sshd.sftp.server.Handle:: attributeKeys clearAttributes computeAttributeIfAbsent getAttribute getAttributesCount getFile getFileHandle getSubsystem isOpen removeAttribute safe setAttribute signalHandleOpen signalHandleOpening toString

access	back to summary
private final int access

fileAttributes	back to summary
private final Collection<FileAttribute<?>> fileAttributes

fileChannel	back to summary
private final SeekableByteChannel fileChannel

locks	back to summary
private final List<FileLock> locks

openOptions	back to summary
private final Set<StandardOpenOption> openOptions

FileHandle	back to summary
public FileHandle(SftpSubsystem subsystem, Path file, String handle, int flags, int access, Map<String, Object> attrs) throws IOException

Method Detail

append	back to summary
public void append(byte[] data) throws IOException

append	back to summary
public void append(byte[] data, int doff, int length) throws IOException

canRead	back to summary
private boolean canRead()

canWrite	back to summary
private boolean canWrite()

close back to summary

close	back to summary
public void close() throws IOException Overrides org.apache.sshd.sftp.server.Handle.close. Implements java.nio.channels.Channel.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Overrides org.apache.sshd.sftp.server.Handle.close.

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

getAccessMask	back to summary
public int getAccessMask()

getFileAttributes	back to summary
public final Collection<FileAttribute<?>> getFileAttributes()

getFileChannel	back to summary
public SeekableByteChannel getFileChannel()

getOpenOptions	back to summary
public final Set<StandardOpenOption> getOpenOptions()

getOpenOptions	back to summary
public static Set<StandardOpenOption> getOpenOptions(int flags, int access)

isOpenAppend	back to summary
public boolean isOpenAppend()

lock	back to summary
public void lock(long offset, long length, int mask) throws IOException

read	back to summary
public int read(byte[] data, long offset) throws IOException

read	back to summary
public int read(byte[] data, int doff, int length, long offset) throws IOException

read	back to summary
public int read(byte[] data, int doff, int length, long offset, AtomicReference<Boolean> eof) throws IOException Annotations @SuppressWarnings:resource

toFileAttribute	back to summary
public static FileAttribute<?> toFileAttribute(String key, Object val)

toFileAttributes	back to summary
public static Collection<FileAttribute<?>> toFileAttributes(Map<String, ?> attrs)

unlock	back to summary
public void unlock(long offset, long length) throws IOException

write	back to summary
public void write(byte[] data, long offset) throws IOException

write	back to summary
public void write(byte[] data, int doff, int length, long offset) throws IOException

public Class FileHandle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail