Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	DefaultSftpClient.SftpChannelSubsystem

Field Summary

Modifier and Type	Field and 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 final Map<Integer, Buffer>	messages
private Charset	nameDecodingCharset
private final Buffer	receiveBuffer
private final AtomicInteger	versionHolder

Inherited from org.apache.sshd.sftp.client.impl.AbstractSftpClient:: errorDataHandler INIT_COMMAND_SIZE SFTP_CLIENT_CMD_TIMEOUT

Constructor Summary

Access	Constructor and Description
public	DefaultSftpClient(ClientSession The `ClientSession` clientSession, SftpVersionSelector The initial `SftpVersionSelector` - if `null` then version 6 is assumed. initialVersionSelector, SftpErrorDataHandler The `SftpErrorDataHandler` to handle incoming data through the error stream - if `null` the data is silently ignored errorDataHandler)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.nio.channels.Channel.close. Closes this channel.
protected ChannelSubsystem	createSftpChannelSubsystem(ClientSession clientSession)
protected int	Returns: Actual size of received data data(byte[] The buffer containing the incoming data buf, int Offset in buffer to read the data start, int Available data in buffer len) Receive binary data from server main stream
public ClientChannel	getClientChannel() Implements org.apache.sshd.client.channel.ClientChannelHolder.getClientChannel.
public ClientSession	getClientSession() Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.
public Charset	getNameDecodingCharset() Implements org.apache.sshd.sftp.client.SftpClient.getNameDecodingCharset.
public NavigableMap<String, byte[]>	getServerExtensions() Implements org.apache.sshd.sftp.client.SftpClient.getServerExtensions.
public int	getVersion() Implements org.apache.sshd.sftp.client.SftpClient.getVersion.
protected void	handleInitResponse(Buffer buffer)
protected void	init(ClientSession session, SftpVersionSelector initialVersionSelector, Duration initializationTimeout)
public boolean	isClosing() Implements org.apache.sshd.sftp.client.SftpClient.isClosing.
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public int	Returns: The selected version (may be same as current) negotiateVersion(SftpVersionSelector The `SftpVersionSelector` to use - ignored if `null` selector)
protected void	process(Buffer The received `Buffer` incoming) Process an SFTP packet
protected boolean	Returns: `true` if data from incoming buffer was processed receive(Buffer The received `Buffer` incoming) Read SFTP packets from buffer
public Buffer	receive(int The expected request id id) Implements org.apache.sshd.sftp.client.RawSftpClient.receive.
public Buffer	receive(int The expected request id id, long The amount of time to wait for the response idleTimeout) Implements org.apache.sshd.sftp.client.RawSftpClient.receive.
public Buffer	receive(int The expected request id id, Duration The amount of time to wait for the response idleTimeout) Implements org.apache.sshd.sftp.client.RawSftpClient.receive.
public int	send(int Command to send - Note: only lower 8-bits are used cmd, Buffer The `Buffer` containing the command data buffer) Implements org.apache.sshd.sftp.client.RawSftpClient.send.
public void	setNameDecodingCharset(Charset nameDecodingCharset) Implements org.apache.sshd.sftp.client.SftpClient.setNameDecodingCharset.
protected Buffer	waitForInitResponse(Duration initializationTimeout)
public SftpMessage	write(int cmd, Buffer buffer) Implements org.apache.sshd.sftp.client.RawSftpClient.write.

Field Detail

channel	back to summary
private final ChannelSubsystem channel

clientSession	back to summary
private final ClientSession clientSession

closing	back to summary
private final AtomicBoolean closing

cmdId	back to summary
private final AtomicInteger cmdId

exposedExtensions	back to summary
private final NavigableMap<String, byte[]> exposedExtensions

extensions	back to summary
private final NavigableMap<String, byte[]> extensions

messages	back to summary
private final Map<Integer, Buffer> messages

nameDecodingCharset	back to summary
private Charset nameDecodingCharset

receiveBuffer	back to summary
private final Buffer receiveBuffer

versionHolder	back to summary
private final AtomicInteger versionHolder

Constructor Detail

DefaultSftpClient back to summary

DefaultSftpClient	back to summary
public DefaultSftpClient(ClientSession clientSession, SftpVersionSelector initialVersionSelector, SftpErrorDataHandler errorDataHandler) throws IOException Parameters clientSession:ClientSession The `ClientSession` initialVersionSelector:SftpVersionSelector The initial `SftpVersionSelector` - if `null` then version 6 is assumed. errorDataHandler:SftpErrorDataHandler The `SftpErrorDataHandler` to handle incoming data through the error stream - if `null` the data is silently ignored Exceptions IOException: If failed to initialize

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

Parameters

clientSession:ClientSession: The ClientSession
initialVersionSelector:SftpVersionSelector: The initial SftpVersionSelector - if null then version 6 is assumed.
errorDataHandler:SftpErrorDataHandler: The SftpErrorDataHandler to handle incoming data through the error stream - if null the data is silently ignored

Exceptions

IOException:: If failed to initialize

Method Detail

close back to summary

close	back to summary
public void close() throws IOException 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

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

createSftpChannelSubsystem	back to summary
protected ChannelSubsystem createSftpChannelSubsystem(ClientSession clientSession)

data	back to summary
protected int data(byte[] buf, int start, int len) throws IOException Receive binary data from server main stream Parameters buf:byte[] The buffer containing the incoming data start:int Offset in buffer to read the data len:int Available data in buffer Returns:int Actual size of received data Exceptions IOException: If failed to receive incoming data

getClientChannel back to summary

getClientChannel	back to summary
public ClientChannel getClientChannel() Implements org.apache.sshd.client.channel.ClientChannelHolder.getClientChannel. Returns:ClientChannel Doc from org.apache.sshd.client.channel.ClientChannelHolder.getClientChannel. The underlying `ClientChannel` used Annotations @Override

public ClientChannel getClientChannel()

Implements org.apache.sshd.client.channel.ClientChannelHolder.getClientChannel.

Returns:ClientChannel

Doc from org.apache.sshd.client.channel.ClientChannelHolder.getClientChannel.

The underlying ClientChannel used

Annotations

@Override

getClientSession back to summary

getClientSession	back to summary
public ClientSession getClientSession() Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession. Returns:ClientSession Doc from org.apache.sshd.client.session.ClientSessionHolder.getClientSession. The underlying `ClientSession` used Annotations @Override

public ClientSession getClientSession()

Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

Returns:ClientSession

Doc from org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

The underlying ClientSession used

Annotations

@Override

getNameDecodingCharset back to summary

getNameDecodingCharset	back to summary
public Charset getNameDecodingCharset() Implements org.apache.sshd.sftp.client.SftpClient.getNameDecodingCharset. Returns:Charset Doc from org.apache.sshd.sftp.client.SftpClient.getNameDecodingCharset. The (never `null`) `Charset` used to decode referenced files/folders names Annotations @Override

public Charset getNameDecodingCharset()

Implements org.apache.sshd.sftp.client.SftpClient.getNameDecodingCharset.

Returns:Charset

Doc from org.apache.sshd.sftp.client.SftpClient.getNameDecodingCharset.

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

Annotations

@Override

getServerExtensions back to summary

getServerExtensions	back to summary
public NavigableMap<String, byte[]> getServerExtensions() Implements org.apache.sshd.sftp.client.SftpClient.getServerExtensions. Returns:NavigableMap<String, byte[]> Doc from org.apache.sshd.sftp.client.SftpClient.getServerExtensions. An (unmodifiable) `NavigableMap` of the reported server extensions. where key=extension name (case insensitive) Annotations @Override

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

Implements org.apache.sshd.sftp.client.SftpClient.getServerExtensions.

Returns:NavigableMap<String, byte[]>

Doc from org.apache.sshd.sftp.client.SftpClient.getServerExtensions.

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

Annotations

@Override

getVersion	back to summary
public int getVersion() Implements org.apache.sshd.sftp.client.SftpClient.getVersion. Returns:int Doc from org.apache.sshd.sftp.client.SftpClient.getVersion. The negotiated SFTP protocol version Annotations @Override

getVersion

back to summary

public int getVersion()

Implements org.apache.sshd.sftp.client.SftpClient.getVersion.

Returns:int

Doc from org.apache.sshd.sftp.client.SftpClient.getVersion.

The negotiated SFTP protocol version

Annotations

@Override

handleInitResponse	back to summary
protected void handleInitResponse(Buffer buffer) throws IOException

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

isClosing	back to summary
public boolean isClosing() Implements org.apache.sshd.sftp.client.SftpClient.isClosing. Annotations @Override

isClosing

back to summary

public boolean isClosing()

Implements org.apache.sshd.sftp.client.SftpClient.isClosing.

Annotations

@Override

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

negotiateVersion	back to summary
public int negotiateVersion(SftpVersionSelector selector) throws IOException Parameters selector:SftpVersionSelector The `SftpVersionSelector` to use - ignored if `null` Returns:int The selected version (may be same as current) Exceptions IOException: If failed to negotiate

process back to summary

process	back to summary
protected void process(Buffer incoming) throws IOException Process an SFTP packet Parameters incoming:Buffer The received `Buffer` Exceptions IOException: if failed to process the buffer

protected void process(Buffer incoming) throws IOException

Process an SFTP packet

Parameters

incoming:Buffer: The received Buffer

Exceptions

IOException:: if failed to process the buffer

receive back to summary

receive	back to summary
protected boolean receive(Buffer incoming) throws IOException Read SFTP packets from buffer Parameters incoming:Buffer The received `Buffer` Returns:boolean `true` if data from incoming buffer was processed Exceptions IOException: if failed to process the buffer See Also `process(Buffer)`

protected boolean receive(Buffer incoming) throws IOException

Read SFTP packets from buffer

Parameters

incoming:Buffer: The received Buffer

Returns:boolean

true if data from incoming buffer was processed

Exceptions

IOException:: if failed to process the buffer

See Also

process(Buffer)

receive back to summary

receive	back to summary
public Buffer receive(int id) throws IOException Implements org.apache.sshd.sftp.client.RawSftpClient.receive. Parameters id:int Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. The expected request id Returns:Buffer Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. The received response `Buffer` containing the request id Annotations @Override Exceptions IOException: Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. If connection closed or interrupted

public Buffer receive(int id) throws IOException

Implements org.apache.sshd.sftp.client.RawSftpClient.receive.

Parameters

id:int

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

The expected request id

Returns:Buffer

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

The received response Buffer containing the request id

Annotations

@Override

Exceptions

IOException:

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

If connection closed or interrupted

receive back to summary

receive	back to summary
public Buffer receive(int id, long idleTimeout) throws IOException Implements org.apache.sshd.sftp.client.RawSftpClient.receive. Parameters id:int Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. The expected request id idleTimeout:long Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. The amount of time to wait for the response Returns:Buffer Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. The received response `Buffer` containing the request id Annotations @Override Exceptions IOException: Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. If connection closed or interrupted

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

Implements org.apache.sshd.sftp.client.RawSftpClient.receive.

Parameters

id:int

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

The expected request id

idleTimeout:long

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

The amount of time to wait for the response

Returns:Buffer

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

The received response Buffer containing the request id

Annotations

@Override

Exceptions

IOException:

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

If connection closed or interrupted

receive back to summary

receive	back to summary
public Buffer receive(int id, Duration idleTimeout) throws IOException Implements org.apache.sshd.sftp.client.RawSftpClient.receive. Parameters id:int Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. The expected request id idleTimeout:Duration Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. The amount of time to wait for the response Returns:Buffer Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. The received response `Buffer` containing the request id Annotations @Override Exceptions IOException: Doc from org.apache.sshd.sftp.client.RawSftpClient.receive. If connection closed or interrupted

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

Implements org.apache.sshd.sftp.client.RawSftpClient.receive.

Parameters

id:int

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

The expected request id

idleTimeout:Duration

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

The amount of time to wait for the response

Returns:Buffer

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

The received response Buffer containing the request id

Annotations

@Override

Exceptions

IOException:

Doc from org.apache.sshd.sftp.client.RawSftpClient.receive.

If connection closed or interrupted

send back to summary

send	back to summary
public int send(int cmd, Buffer buffer) throws IOException Implements org.apache.sshd.sftp.client.RawSftpClient.send. Parameters cmd:int Doc from org.apache.sshd.sftp.client.RawSftpClient.send. Command to send - Note: only lower 8-bits are used buffer:Buffer Doc from org.apache.sshd.sftp.client.RawSftpClient.send. The `Buffer` containing the command data Returns:int Doc from org.apache.sshd.sftp.client.RawSftpClient.send. The assigned request id Annotations @Override Exceptions IOException: Doc from org.apache.sshd.sftp.client.RawSftpClient.send. if failed to send command

public int send(int cmd, Buffer buffer) throws IOException

Implements org.apache.sshd.sftp.client.RawSftpClient.send.

Parameters

cmd:int

Doc from org.apache.sshd.sftp.client.RawSftpClient.send.

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

buffer:Buffer

Doc from org.apache.sshd.sftp.client.RawSftpClient.send.

The Buffer containing the command data

Returns:int

Doc from org.apache.sshd.sftp.client.RawSftpClient.send.

The assigned request id

Annotations

@Override

Exceptions

IOException:

Doc from org.apache.sshd.sftp.client.RawSftpClient.send.

if failed to send command

setNameDecodingCharset	back to summary
public void setNameDecodingCharset(Charset nameDecodingCharset) Implements org.apache.sshd.sftp.client.SftpClient.setNameDecodingCharset. Annotations @Override

setNameDecodingCharset

back to summary

public void setNameDecodingCharset(Charset nameDecodingCharset)

Implements org.apache.sshd.sftp.client.SftpClient.setNameDecodingCharset.

Annotations

@Override

waitForInitResponse	back to summary
protected Buffer waitForInitResponse(Duration initializationTimeout) throws IOException

write	back to summary
public SftpMessage write(int cmd, Buffer buffer) throws IOException Implements org.apache.sshd.sftp.client.RawSftpClient.write. Annotations @Override

write

back to summary

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

Implements org.apache.sshd.sftp.client.RawSftpClient.write.

Annotations

@Override

org.apache.sshd.sftp.client.impl back to summary

protected Class DefaultSftpClient.SftpChannelSubsystem

Class Inheritance

extends ChannelSubsystem

Constructor Summary

Access	Constructor and Description
protected	SftpChannelSubsystem()

Method Summary

Modifier and Type	Method and Description
protected ChannelAsyncOutputStream	createAsyncInput(Session session)
protected OutputStream	createErrOutputStream(Session session)
protected OutputStream	createStdOutputStream(Session session)
protected void	doOpen() Overrides org.apache.sshd.client.channel.ChannelSubsystem.doOpen.

Inherited from org.apache.sshd.client.channel.ChannelSubsystem:: getSubsystem handleFailure handleSuccess onClose toString

Constructor Detail

SftpChannelSubsystem	back to summary
protected SftpChannelSubsystem()

Method Detail

createAsyncInput	back to summary
protected ChannelAsyncOutputStream createAsyncInput(Session session)

createErrOutputStream	back to summary
protected OutputStream createErrOutputStream(Session session)

createStdOutputStream	back to summary
protected OutputStream createStdOutputStream(Session session)

doOpen	back to summary
protected void doOpen() throws IOException Overrides org.apache.sshd.client.channel.ChannelSubsystem.doOpen. Annotations @Override

doOpen

back to summary

protected void doOpen() throws IOException

Overrides org.apache.sshd.client.channel.ChannelSubsystem.doOpen.

Annotations

@Override

public Class DefaultSftpClient

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class DefaultSftpClient.SftpChannelSubsystem

Constructor Summary

Method Summary

Constructor Detail

Method Detail