Package com.sshtools.common.sftp

Interface OpenFile

All Known Implementing Classes:

PseduoRandomOpenFile, RandomAccessOpenFile

public interface OpenFile

Method Summary

Modifier and Type	Method	Description
void	close()
default Optional<com.sshtools.common.util.UnsignedInteger32>	getAccessFlags()
AbstractFile	getFile()
long	getFilePointer()
com.sshtools.common.util.UnsignedInteger32	getFlags()
byte[]	getHandle()
default boolean	isLocked()
boolean	isTextMode()
default void	lock(long offset, long length, int lockFlags)
default int	lockFlags()
void	processEvent(Event evt)
int	read(byte[] buf, int start, int numBytesToRead)
void	seek(long longValue)
default void	unlock(long offset, long length)
void	write(byte[] data, int off, int len)

Method Details

getFile

AbstractFile getFile()

getAccessFlags

default Optional<com.sshtools.common.util.UnsignedInteger32> getAccessFlags()

getFlags

com.sshtools.common.util.UnsignedInteger32 getFlags()

isTextMode

boolean isTextMode()

getFilePointer

long getFilePointer()
             throws IOException

Throws:

IOException

seek

void seek(long longValue)
   throws IOException

Throws:

IOException

read

int read(byte[] buf,
 int start,
 int numBytesToRead)
  throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

write

void write(byte[] data,
 int off,
 int len)
    throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

close

void close()
    throws IOException

Throws:

IOException

processEvent

void processEvent(Event evt)

getHandle

byte[] getHandle()

lock

default void lock(long offset,
 long length,
 int lockFlags)
           throws IOException

Throws:

IOException

unlock

default void unlock(long offset,
 long length)
             throws IOException

Throws:

IOException

lockFlags

default int lockFlags()

isLocked

default boolean isLocked()