Apache Mina SSHD 2.15.0 · org.apache.sshd.scp.common.helpers.ScpIoUtils

Modifier and Type	Field and Description
public static final Set<ClientChannelEvent>	COMMAND_WAIT_EVENTS

Access	Constructor and Description
private	ScpIoUtils()

Method Summary

Modifier and Type	Method and Description
public static String	getExitStatusName(Integer exitStatus)
public static void	handleCommandExitStatus(ClientSession The associated `ClientSession` session, String The attempted remote copy command cmd, ClientChannel The `ClientChannel` through which the command was sent - Note: then channel may be in the process of being closed channel, CommandStatusHandler The `CommandStatusHandler` to invoke once the exit status is received. if `null` then `handleCommandExitStatus(ClientSession, String, Integer, Logger)` is called handler, Logger An optional `Logger` to use for issuing log messages - ignored if `null` log) Invoked by the various `upload/download` methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server.
public static void	handleCommandExitStatus(ClientSession The associated `ClientSession` session, String The attempted remote copy command cmd, Integer The exit status - if `null` then no status was reported exitStatus, Logger An optional `Logger` to use for issuing log messages - ignored if `null` log) Invoked by the various `upload/download` methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server
public static ChannelExec	openCommandChannel(ClientSession session, String cmd, Logger log)
public static String	readLine(InputStream in, Charset cs)
public static String	readLine(InputStream in, Charset cs, boolean canEof)
public static ScpAckInfo	sendAcknowledgedCommand(AbstractScpCommandDetails cmd, InputStream in, Charset csIn, OutputStream out, Charset csOut)
public static ScpAckInfo	sendAcknowledgedCommand(String cmd, InputStream in, Charset csIn, OutputStream out, Charset csOut)
public static void	writeLine(OutputStream out, Charset cs, String cmd)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

COMMAND_WAIT_EVENTS	back to summary
public static final Set<ClientChannelEvent> COMMAND_WAIT_EVENTS

ScpIoUtils	back to summary
private ScpIoUtils()

Method Detail

getExitStatusName	back to summary
public static String getExitStatusName(Integer exitStatus)

handleCommandExitStatus back to summary

handleCommandExitStatus	back to summary
public static void handleCommandExitStatus(ClientSession session, String cmd, ClientChannel channel, CommandStatusHandler handler, Logger log) throws IOException Invoked by the various `upload/download` methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server. If no exit status received within `CoreModuleProperties#CHANNEL_CLOSE_TIMEOUT` the no further action is taken. Otherwise, the exit status is examined to ensure it is either OK or WARNING - if not, an `ScpException` is thrown Parameters session:ClientSession The associated `ClientSession` cmd:String The attempted remote copy command channel:ClientChannel The `ClientChannel` through which the command was sent - Note: then channel may be in the process of being closed handler:CommandStatusHandler The `CommandStatusHandler` to invoke once the exit status is received. if `null` then `handleCommandExitStatus(ClientSession, String, Integer, Logger)` is called log:Logger An optional `Logger` to use for issuing log messages - ignored if `null` Exceptions IOException: If failed the command

public static void handleCommandExitStatus(ClientSession session, String cmd, ClientChannel channel, CommandStatusHandler handler, Logger log) throws IOException

Invoked by the various upload/download methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server. If no exit status received within CoreModuleProperties#CHANNEL_CLOSE_TIMEOUT the no further action is taken. Otherwise, the exit status is examined to ensure it is either OK or WARNING - if not, an ScpException is thrown

Parameters

session:ClientSession: The associated ClientSession
cmd:String: The attempted remote copy command
channel:ClientChannel: The ClientChannel through which the command was sent - Note: then channel may be in the process of being closed
handler:CommandStatusHandler: The CommandStatusHandler to invoke once the exit status is received. if null then handleCommandExitStatus(ClientSession, String, Integer, Logger) is called
log:Logger: An optional Logger to use for issuing log messages - ignored if null

Exceptions

IOException:: If failed the command

handleCommandExitStatus back to summary

handleCommandExitStatus	back to summary
public static void handleCommandExitStatus(ClientSession session, String cmd, Integer exitStatus, Logger log) throws IOException Invoked by the various `upload/download` methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server Parameters session:ClientSession The associated `ClientSession` cmd:String The attempted remote copy command exitStatus:Integer The exit status - if `null` then no status was reported log:Logger An optional `Logger` to use for issuing log messages - ignored if `null` Exceptions IOException: If got a an error exit status

public static void handleCommandExitStatus(ClientSession session, String cmd, Integer exitStatus, Logger log) throws IOException

Invoked by the various upload/download methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server

Parameters

session:ClientSession: The associated ClientSession
cmd:String: The attempted remote copy command
exitStatus:Integer: The exit status - if null then no status was reported
log:Logger: An optional Logger to use for issuing log messages - ignored if null

Exceptions

IOException:: If got a an error exit status

openCommandChannel	back to summary
public static ChannelExec openCommandChannel(ClientSession session, String cmd, Logger log) throws IOException

readLine	back to summary
public static String readLine(InputStream in, Charset cs) throws IOException

readLine	back to summary
public static String readLine(InputStream in, Charset cs, boolean canEof) throws IOException

sendAcknowledgedCommand	back to summary
public static ScpAckInfo sendAcknowledgedCommand(AbstractScpCommandDetails cmd, InputStream in, Charset csIn, OutputStream out, Charset csOut) throws IOException

sendAcknowledgedCommand	back to summary
public static ScpAckInfo sendAcknowledgedCommand(String cmd, InputStream in, Charset csIn, OutputStream out, Charset csOut) throws IOException

writeLine	back to summary
public static void writeLine(OutputStream out, Charset cs, String cmd) throws IOException

public final Class ScpIoUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail