Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.extensions.helpers.AbstractSftpClientExtension

Modifier and Type	Field and Description
private final SftpClient	client
private final String	name
private final RawSftpClient	raw
private final boolean	supported

Access	Constructor and Description
protected	AbstractSftpClientExtension(String name, SftpClient client, RawSftpClient raw, Collection<String> extras)
protected	AbstractSftpClientExtension(String name, SftpClient client, RawSftpClient raw, Map<String, byte[]> extensions)
protected	AbstractSftpClientExtension(String name, SftpClient client, RawSftpClient raw, boolean supported)

Method Summary

Modifier and Type	Method and Description
protected Buffer	Returns: The `Buffer` if this is an `SftpConstants#SSH_FXP_EXTENDED_REPLY`, or `null` if this is a `SftpConstants#SSH_FXP_STATUS` carrying an `SftpConstants#SSH_FX_OK` result checkExtendedReplyBuffer(Buffer The `Buffer` to check buffer)
protected void	checkStatus(Buffer buffer)
public final SftpClient	getClient() Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient.
protected Buffer	Returns: A `Buffer` with the extension name set getCommandBuffer(Object A target path `String` or `Handle` or `byte[]` to be encoded in the buffer target)
protected Buffer	Returns: A `Buffer` with the extension name set getCommandBuffer(Object A target path `String` or `Handle` or `byte[]` to be encoded in the buffer target, int Extra size - beyond the path/handle to be allocated extraSize)
protected Buffer	Returns: A `Buffer` with the extension name set getCommandBuffer(int Extra size - besides the extension name extraSize)
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public final boolean	isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported.
public Buffer	Returns: The updated buffer putTarget(Buffer The `Buffer` buffer, Object A target path `String` or `Handle` or `byte[]` to be encoded in the buffer target)
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 timeout) 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 timeout) 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.
protected void	sendAndCheckExtendedCommandStatus(Buffer buffer)
protected int	sendExtendedCommand(Buffer buffer)
protected void	throwStatusException(int id, SftpStatus status)
public SftpMessage	write(int cmd, Buffer buffer) Implements org.apache.sshd.sftp.client.RawSftpClient.write.

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: debug debug debug debug debug error error error error error getSimplifiedLogger info info warn warn warn warn warn warn warn warn

client	back to summary
private final SftpClient client

name	back to summary
private final String name

raw	back to summary
private final RawSftpClient raw

supported	back to summary
private final boolean supported

AbstractSftpClientExtension	back to summary
protected AbstractSftpClientExtension(String name, SftpClient client, RawSftpClient raw, Collection<String> extras)

AbstractSftpClientExtension	back to summary
protected AbstractSftpClientExtension(String name, SftpClient client, RawSftpClient raw, Map<String, byte[]> extensions)

AbstractSftpClientExtension	back to summary
protected AbstractSftpClientExtension(String name, SftpClient client, RawSftpClient raw, boolean supported)

Method Detail

checkExtendedReplyBuffer back to summary

checkExtendedReplyBuffer	back to summary
protected Buffer checkExtendedReplyBuffer(Buffer buffer) throws IOException Parameters buffer:Buffer The `Buffer` to check Returns:Buffer The `Buffer` if this is an `SftpConstants#SSH_FXP_EXTENDED_REPLY`, or `null` if this is a `SftpConstants#SSH_FXP_STATUS` carrying an `SftpConstants#SSH_FX_OK` result Exceptions IOException: If a non-`SftpConstants#SSH_FX_OK` result or not a `SftpConstants#SSH_FXP_EXTENDED_REPLY` buffer

protected Buffer checkExtendedReplyBuffer(Buffer buffer) throws IOException

Parameters

buffer:Buffer: The Buffer to check

Returns:Buffer

The Buffer if this is an SftpConstants#SSH_FXP_EXTENDED_REPLY, or null if this is a SftpConstants#SSH_FXP_STATUS carrying an SftpConstants#SSH_FX_OK result

Exceptions

IOException:: If a non-SftpConstants#SSH_FX_OK result or not a SftpConstants#SSH_FXP_EXTENDED_REPLY buffer

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

getClient	back to summary
public final SftpClient getClient() Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient. Annotations @Override

getClient

back to summary

public final SftpClient getClient()

Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient.

Annotations

@Override

getCommandBuffer	back to summary
protected Buffer getCommandBuffer(Object target) Parameters target:Object A target path `String` or `Handle` or `byte[]` to be encoded in the buffer Returns:Buffer A `Buffer` with the extension name set See Also `getCommandBuffer(Object, int)`

getCommandBuffer	back to summary
protected Buffer getCommandBuffer(Object target, int extraSize) Parameters target:Object A target path `String` or `Handle` or `byte[]` to be encoded in the buffer extraSize:int Extra size - beyond the path/handle to be allocated Returns:Buffer A `Buffer` with the extension name set See Also `getCommandBuffer(int)`

getCommandBuffer	back to summary
protected Buffer getCommandBuffer(int extraSize) Parameters extraSize:int Extra size - besides the extension name Returns:Buffer A `Buffer` with the extension name set

getName	back to summary
public final String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public final String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations

@Override

isSupported	back to summary
public final boolean isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported. Annotations @Override

isSupported

back to summary

public final boolean isSupported()

Implements org.apache.sshd.common.OptionalFeature.isSupported.

Annotations

@Override

putTarget	back to summary
public Buffer putTarget(Buffer buffer, Object target) Parameters buffer:Buffer The `Buffer` target:Object A target path `String` or `Handle` or `byte[]` to be encoded in the buffer Returns:Buffer The updated buffer Exceptions UnsupportedOperationException: If target is not one of the above supported types

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 timeout) 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 timeout: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 timeout) 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

timeout: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 timeout) 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 timeout: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 timeout) 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

timeout: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

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

sendExtendedCommand	back to summary
protected int sendExtendedCommand(Buffer buffer) throws IOException

throwStatusException	back to summary
protected void throwStatusException(int id, SftpStatus status) 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

public abstract Class AbstractSftpClientExtension

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail