Package org.apache.sshd.sftp.client

Interface RawSftpClient

All Known Subinterfaces:

FullAccessSftpClient

All Known Implementing Classes:

AbstractCheckFileExtension, AbstractMD5HashExtension, AbstractOpenSSHStatCommandExtension, AbstractSftpClient, AbstractSftpClientExtension, CheckFileHandleExtensionImpl, CheckFileNameExtensionImpl, CopyDataExtensionImpl, CopyFileExtensionImpl, DefaultSftpClient, FilenameTranslationControlExtensionImpl, MD5FileExtensionImpl, MD5HandleExtensionImpl, OpenSSHFsyncExtensionImpl, OpenSSHLimitsExtensionImpl, OpenSSHPosixRenameExtensionImpl, OpenSSHStatHandleExtensionImpl, OpenSSHStatPathExtensionImpl, SftpFileSystem.Wrapper, SpaceAvailableExtensionImpl

public interface RawSftpClient

Method Summary

Modifier and Type	Method	Description
Buffer	receive(int id)
Buffer	receive(int id, long timeout)
Buffer	receive(int id, java.time.Duration timeout)
int	send(int cmd, Buffer buffer)
SftpMessage	write(int cmd, Buffer buffer)

Method Detail

send

int send(int cmd,
         Buffer buffer)
  throws java.io.IOException

Parameters:

cmd - Command to send - Note: only lower 8-bits are used

buffer - The Buffer containing the command data

Returns:

The assigned request id

Throws:

java.io.IOException - if failed to send command

write

SftpMessage write(int cmd,
                  Buffer buffer)
           throws java.io.IOException

Throws:

java.io.IOException

receive

Buffer receive(int id)
        throws java.io.IOException

Parameters:

id - The expected request id

Returns:

The received response Buffer containing the request id

Throws:

java.io.IOException - If connection closed or interrupted

receive

Buffer receive(int id,
               long timeout)
        throws java.io.IOException

Parameters:

id - The expected request id

timeout - The amount of time to wait for the response

Returns:

The received response Buffer containing the request id

Throws:

java.io.IOException - If connection closed or interrupted

receive

Buffer receive(int id,
               java.time.Duration timeout)
        throws java.io.IOException

Parameters:

id - The expected request id

timeout - The amount of time to wait for the response

Returns:

The received response Buffer containing the request id

Throws:

java.io.IOException - If connection closed or interrupted