Class DefaultSftpClient

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.client.subsystem.AbstractSubsystemClient

org.apache.sshd.sftp.client.impl.AbstractSftpClient

org.apache.sshd.sftp.client.impl.DefaultSftpClient

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientChannelHolder, ClientSessionHolder, SubsystemClient, ChannelHolder, NamedResource, SessionContextHolder, SessionHolder<ClientSession>, FullAccessSftpClient, RawSftpClient, SftpClient, SftpErrorDataHandler

public class DefaultSftpClient
extends AbstractSftpClient

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	DefaultSftpClient.SftpChannelSubsystem

Nested classes/interfaces inherited from interface SftpClient

SftpClient.Attribute, SftpClient.Attributes, SftpClient.CloseableHandle, SftpClient.CopyMode, SftpClient.DirEntry, SftpClient.Handle, SftpClient.OpenMode

Field Summary

Fields

Modifier and Type	Field	Description
private final ChannelSubsystem	channel
private final ClientSession	clientSession
private final AtomicBoolean	closing
private final AtomicInteger	cmdId
private final NavigableMap<String,byte[]>	exposedExtensions
private final NavigableMap<String,byte[]>	extensions
private SftpMessage	lastMessage
private final Map<Integer,Buffer>	messages
private Charset	nameDecodingCharset
private final Buffer	receiveBuffer
private final AtomicInteger	versionHolder

Fields inherited from class AbstractSftpClient

errorDataHandler, INIT_COMMAND_SIZE, SFTP_CLIENT_CMD_TIMEOUT

Fields inherited from class AbstractLoggingBean

log

Fields inherited from interface NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface SftpClient

DEFAULT_CHANNEL_MODES, EMPTY_DIR_ENTRIES, IO_BUFFER_SIZE, MIN_BUFFER_SIZE, MIN_READ_BUFFER_SIZE, MIN_WRITE_BUFFER_SIZE

Fields inherited from interface SftpErrorDataHandler

EMPTY

Constructor Summary

Constructors

Constructor	Description
DefaultSftpClient(ClientSession clientSession, SftpVersionSelector initialVersionSelector, SftpErrorDataHandler errorDataHandler)

Method Summary

Modifier and Type	Method	Description
void	close()
protected ChannelSubsystem	createSftpChannelSubsystem(ClientSession clientSession)
protected int	data(byte[] buf, int start, int len)	Receive binary data from server main stream
ClientChannel	getClientChannel()
ClientSession	getClientSession()
Charset	getNameDecodingCharset()
NavigableMap<String,byte[]>	getServerExtensions()
int	getVersion()
protected void	handleInitResponse(Buffer buffer)
protected void	init(ClientSession session, SftpVersionSelector initialVersionSelector, Duration initializationTimeout)
boolean	isClosing()
boolean	isOpen()
int	negotiateVersion(SftpVersionSelector selector)
protected void	process(Buffer incoming)	Process an SFTP packet
Buffer	receive(int id)
Buffer	receive(int id, long idleTimeout)
Buffer	receive(int id, Duration idleTimeout)
protected boolean	receive(Buffer incoming)	Read SFTP packets from buffer
int	send(int cmd, Buffer buffer)
void	setNameDecodingCharset(Charset nameDecodingCharset)
protected Buffer	waitForInitResponse(Duration initializationTimeout)
SftpMessage	write(int cmd, Buffer buffer)

Methods inherited from class AbstractSftpClient

canonicalPath, checkAttributes, checkAttributesResponse, checkCommandStatus, checkDataResponse, checkDirResponse, checkHandle, checkHandleResponse, checkOneName, checkOneNameResponse, checkResponseStatus, checkResponseStatus, close, errorData, getChannel, getExtension, getExtension, getParsedServerExtensions, getParsedServerExtensions, getReadBufferSize, getReferencedName, getWriteBufferSize, handleUnexpectedAttributesPacket, handleUnexpectedHandlePacket, handleUnexpectedPacket, handleUnknownDataPacket, handleUnknownDirListingPacket, handleUnknownOneNamePacket, link, listDir, lock, lstat, mkdir, open, openDir, openRemoteFileChannel, put, putReferencedName, read, read, readAttributes, readDir, readDir, readLink, remove, rename, response, rmdir, rpc, setStat, setStat, stat, stat, throwStatusException, unlock, write, write, writeAttributes

Methods inherited from class AbstractSubsystemClient

toString

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface SessionHolder

getSessionContext

Methods inherited from interface SftpClient

getExtension, getName, open, open, openRemoteFileChannel, openRemotePathChannel, openRemotePathChannel, put, put, put, put, put, put, put, put, put, put, put, read, read, read, read, read, read, read, read, readDir, readEntries, rename, rename, singleSessionInstance, symLink, write, write, write, write, write, write

Methods inherited from interface SubsystemClient

getSession

Field Details

clientSession

private final ClientSession clientSession

channel

private final ChannelSubsystem channel

messages

private final Map<Integer,Buffer> messages

cmdId

private final AtomicInteger cmdId

receiveBuffer

private final Buffer receiveBuffer

versionHolder

private final AtomicInteger versionHolder

closing

private final AtomicBoolean closing

extensions

private final NavigableMap<String,byte[]> extensions

exposedExtensions

private final NavigableMap<String,byte[]> exposedExtensions

nameDecodingCharset

private Charset nameDecodingCharset

lastMessage

private SftpMessage lastMessage

Constructor Details

DefaultSftpClient

public DefaultSftpClient(ClientSession clientSession,
 SftpVersionSelector initialVersionSelector,
 SftpErrorDataHandler errorDataHandler)
                  throws IOException

Parameters:

clientSession - The ClientSession

initialVersionSelector - The initial SftpVersionSelector - if null then version 6 is assumed.

errorDataHandler - The SftpErrorDataHandler to handle incoming data through the error stream - if null the data is silently ignored

Throws:

IOException - If failed to initialize

Method Details

getVersion

public int getVersion()

Returns:

The negotiated SFTP protocol version

getClientSession

public ClientSession getClientSession()

Returns:

The underlying ClientSession used

getClientChannel

public ClientChannel getClientChannel()

Returns:

The underlying ClientChannel used

getServerExtensions

public NavigableMap<String,byte[]> getServerExtensions()

Returns:

An (unmodifiable) NavigableMap of the reported server extensions. where key=extension name (case insensitive)

getNameDecodingCharset

public Charset getNameDecodingCharset()

Returns:

The (never null) Charset used to decode referenced files/folders names

See Also:

• SftpModuleProperties.NAME_DECODING_CHARSET

setNameDecodingCharset

public void setNameDecodingCharset(Charset nameDecodingCharset)

isClosing

public boolean isClosing()

isOpen

public boolean isOpen()

close

public void close()
           throws IOException

Throws:

IOException

data

protected int data(byte[] buf,
 int start,
 int len)
            throws IOException

Receive binary data from server main stream

Parameters:

buf - The buffer containing the incoming data

start - Offset in buffer to read the data

len - Available data in buffer

Returns:

Actual size of received data

Throws:

IOException - If failed to receive incoming data

receive

protected boolean receive(Buffer incoming)
                   throws IOException

Read SFTP packets from buffer

Parameters:

incoming - The received Buffer

Returns:

true if data from incoming buffer was processed

Throws:

IOException - if failed to process the buffer

See Also:

• process(Buffer)

process

protected void process(Buffer incoming)
                throws IOException

Process an SFTP packet

Parameters:

incoming - The received Buffer

Throws:

IOException - if failed to process the buffer

send

public int send(int cmd,
 Buffer buffer)
         throws 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:

IOException - if failed to send command

write

public SftpMessage write(int cmd,
 Buffer buffer)
                  throws IOException

Throws:

IOException

receive

public Buffer receive(int id)
               throws IOException

Parameters:

id - The expected request id

Returns:

The received response Buffer containing the request id

Throws:

IOException - If connection closed or interrupted

receive

public Buffer receive(int id,
 long idleTimeout)
               throws IOException

Parameters:

id - The expected request id

idleTimeout - The amount of time to wait for the response

Returns:

The received response Buffer containing the request id

Throws:

IOException - If connection closed or interrupted

receive

public Buffer receive(int id,
 Duration idleTimeout)
               throws IOException

Parameters:

id - The expected request id

idleTimeout - The amount of time to wait for the response

Returns:

The received response Buffer containing the request id

Throws:

IOException - If connection closed or interrupted

init

protected void init(ClientSession session,
 SftpVersionSelector initialVersionSelector,
 Duration initializationTimeout)
             throws IOException

Throws:

IOException

handleInitResponse

protected void handleInitResponse(Buffer buffer)
                           throws IOException

Throws:

IOException

waitForInitResponse

protected Buffer waitForInitResponse(Duration initializationTimeout)
                              throws IOException

Throws:

IOException

negotiateVersion

public int negotiateVersion(SftpVersionSelector selector)
                     throws IOException

Parameters:

selector - The SftpVersionSelector to use - ignored if null

Returns:

The selected version (may be same as current)

Throws:

IOException - If failed to negotiate

createSftpChannelSubsystem

protected ChannelSubsystem createSftpChannelSubsystem(ClientSession clientSession)