ReadFile Event

This event is fired when a file read request is received.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void readFile(SftpserverReadFileEvent e) {}
  ...
}

public class SftpserverReadFileEvent {
  public long connectionID;
  public String handle;
  public int offset;
  public int size;
  public int operationStatus;
}

Remarks

This event is fired when a request to read block from a file is received from the client. The ConnectionID parameter specifies in which session the request was received, and Handle indicates an opened file handle. Offset andSize denote the location and size of the file piece.

Inside the event handler, pass the appropriate file chunk to the component via SetClientBuffer method.

Set OperationStatus to one of the below values according to the outcome of the request processing: