Apache Mina SSHD 2.15.0 · org.apache.sshd.scp.client.AbstractScpClient

Modifier and Type	Class and Description
public static interface	AbstractScpClient.ScpOperationExecutor<T>

Access	Constructor and Description
protected	AbstractScpClient()

Method Summary

Modifier and Type	Method and Description
protected Collection<ScpClient.Option>	addTargetIsDirectory(Collection<ScpClient.Option> options)
public void	download(String[] remote, String local, Collection<ScpClient.Option> options) Implements org.apache.sshd.scp.client.ScpClient.download.
public void	download(String[] remote, Path local, Collection<ScpClient.Option> options) Implements org.apache.sshd.scp.client.ScpClient.download.
public void	download(String remote, Path local, Collection<ScpClient.Option> options) Implements org.apache.sshd.scp.client.ScpClient.download.
public void	download(String remote, String local, Collection<ScpClient.Option> options) Implements org.apache.sshd.scp.client.ScpClient.download.
protected abstract void	download(String remote, FileSystem fs, Path local, Collection<ScpClient.Option> options)
protected void	handleCommandExitStatus(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) 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.
protected void	handleCommandExitStatus(String The attempted remote copy command cmd, Integer The exit status - if `null` then no status was reported exitStatus) 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 boolean	isOpen()
protected ChannelExec	openCommandChannel(ClientSession session, String cmd)
protected abstract <T> void	runUpload(String remote, Collection<ScpClient.Option> options, Collection<T> local, AbstractScpClient.ScpOperationExecutor<T> executor)
public void	upload(String[] local, String remote, Collection<ScpClient.Option> options) Implements org.apache.sshd.scp.client.ScpClient.upload.
public void	upload(Path[] local, String remote, Collection<ScpClient.Option> options) Implements org.apache.sshd.scp.client.ScpClient.upload.

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

AbstractScpClient	back to summary
protected AbstractScpClient()

Method Detail

addTargetIsDirectory	back to summary
protected Collection<ScpClient.Option> addTargetIsDirectory(Collection<ScpClient.Option> options)

download	back to summary
public void download(String[] remote, String local, Collection<ScpClient.Option> options) throws IOException Implements org.apache.sshd.scp.client.ScpClient.download. Annotations @Override

download

back to summary

public void download(String[] remote, String local, Collection<ScpClient.Option> options) throws IOException

Implements org.apache.sshd.scp.client.ScpClient.download.

Annotations

@Override

download	back to summary
public void download(String[] remote, Path local, Collection<ScpClient.Option> options) throws IOException Implements org.apache.sshd.scp.client.ScpClient.download. Annotations @Override

download

back to summary

public void download(String[] remote, Path local, Collection<ScpClient.Option> options) throws IOException

Implements org.apache.sshd.scp.client.ScpClient.download.

Annotations

@Override

download	back to summary
public void download(String remote, Path local, Collection<ScpClient.Option> options) throws IOException Implements org.apache.sshd.scp.client.ScpClient.download. Annotations @Override

download

back to summary

public void download(String remote, Path local, Collection<ScpClient.Option> options) throws IOException

Implements org.apache.sshd.scp.client.ScpClient.download.

Annotations

@Override

download	back to summary
public void download(String remote, String local, Collection<ScpClient.Option> options) throws IOException Implements org.apache.sshd.scp.client.ScpClient.download. Annotations @Override

download

back to summary

public void download(String remote, String local, Collection<ScpClient.Option> options) throws IOException

Implements org.apache.sshd.scp.client.ScpClient.download.

Annotations

@Override

download	back to summary
protected abstract void download(String remote, FileSystem fs, Path local, Collection<ScpClient.Option> options) throws IOException

handleCommandExitStatus back to summary

handleCommandExitStatus	back to summary
protected void handleCommandExitStatus(String cmd, ClientChannel channel) 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 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 Exceptions IOException: If failed the command See Also `handleCommandExitStatus(String, Integer)`

protected void handleCommandExitStatus(String cmd, ClientChannel channel) 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

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

Exceptions

IOException:: If failed the command

handleCommandExitStatus back to summary

handleCommandExitStatus	back to summary
protected void handleCommandExitStatus(String cmd, Integer exitStatus) 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 cmd:String The attempted remote copy command exitStatus:Integer The exit status - if `null` then no status was reported Exceptions IOException: If received non-OK exit status

protected void handleCommandExitStatus(String cmd, Integer exitStatus) 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

cmd:String: The attempted remote copy command
exitStatus:Integer: The exit status - if null then no status was reported

Exceptions

IOException:: If received non-OK exit status

isOpen	back to summary
public boolean isOpen()

openCommandChannel	back to summary
protected ChannelExec openCommandChannel(ClientSession session, String cmd) throws IOException

runUpload	back to summary
protected abstract <T> void runUpload(String remote, Collection<ScpClient.Option> options, Collection<T> local, AbstractScpClient.ScpOperationExecutor<T> executor) throws IOException

upload	back to summary
public void upload(String[] local, String remote, Collection<ScpClient.Option> options) throws IOException Implements org.apache.sshd.scp.client.ScpClient.upload. Annotations @Override

upload

back to summary

public void upload(String[] local, String remote, Collection<ScpClient.Option> options) throws IOException

Implements org.apache.sshd.scp.client.ScpClient.upload.

Annotations

@Override

upload	back to summary
public void upload(Path[] local, String remote, Collection<ScpClient.Option> options) throws IOException Implements org.apache.sshd.scp.client.ScpClient.upload. Annotations @Override

upload

back to summary

public void upload(Path[] local, String remote, Collection<ScpClient.Option> options) throws IOException

Implements org.apache.sshd.scp.client.ScpClient.upload.

Annotations

@Override

public abstract Class AbstractScpClient

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Interface AbstractScpClient.ScpOperationExecutor<T>

Method Summary

Method Detail