Top Inners Methods
org.apache.sshd.scp.client

public Interface ScpClient

extends SessionHolder<ClientSession>, ClientSessionHolder
Known Direct Subinterfaces
org.apache.sshd.scp.client.CloseableScpClient
Known Direct Implementers
org.apache.sshd.scp.client.AbstractScpClient
Imports
java.io.ByteArrayInputStream, .ByteArrayOutputStream, .IOException, .InputStream, .OutputStream, java.nio.file.Path, java.nio.file.attribute.PosixFilePermission, java.util.Collection, org.apache.sshd.client.session.ClientSession, .ClientSessionHolder, org.apache.sshd.common.session.SessionHolder, org.apache.sshd.common.util.GenericUtils, .ValidateUtils, org.apache.sshd.scp.common.ScpHelper, org.apache.sshd.scp.common.helpers.ScpTimestampCommandDetails
Author
Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
ScpClient.Option

Method Summary

Modifier and TypeMethod and Description
public static StringBuilder

Returns:

The updated builder
appendCommandOption(StringBuilder
The StringBuilder target
sb, Collection<ScpClient.Option>
The command options - ignored if null
options, ScpClient.Option
The required option
opt)

Appends the specified option command value if appears in provided options collection

public static String
createReceiveCommand(String remote, Collection<ScpClient.Option> options)

public static String
createSendCommand(String remote, Collection<ScpClient.Option> options)

public default void
download(String remote, String local, ScpClient.Option... options)

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

public default void
download(String remote, Path local, ScpClient.Option... options)

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

public void
download(String remote, OutputStream local)

public default void
download(String[] remote, String local, ScpClient.Option... options)

public default void
download(String[] remote, Path local, ScpClient.Option... options)

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

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

public default byte[]
downloadBytes(String remote)

public default ClientSession
getSession()

Implements org.apache.sshd.common.session.SessionHolder.getSession.

public default void
upload(String local, String remote, ScpClient.Option... options)

public default void
upload(String local, String remote, Collection<ScpClient.Option> options)

public default void
upload(Path local, String remote, ScpClient.Option... options)

public default void
upload(Path local, String remote, Collection<ScpClient.Option> options)

public default void
upload(String[] local, String remote, ScpClient.Option... options)

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

public default void
upload(Path[] local, String remote, ScpClient.Option... options)

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

public default void
upload(byte[] data, String remote, Collection<PosixFilePermission> perms, ScpTimestampCommandDetails time)

public default void
upload(byte[] data, int offset, int len, String remote, Collection<PosixFilePermission> perms, ScpTimestampCommandDetails time)

public void
upload(InputStream local, String remote, long size, Collection<PosixFilePermission> perms, ScpTimestampCommandDetails time)

Inherited from org.apache.sshd.client.session.ClientSessionHolder:
getClientSession
Inherited from org.apache.sshd.common.session.SessionHolder:
getSessionContext

Method Detail

appendCommandOptionback to summary
public static StringBuilder appendCommandOption(StringBuilder sb, Collection<ScpClient.Option> options, ScpClient.Option opt)

Appends the specified option command value if appears in provided options collection

Parameters
sb:StringBuilder

The StringBuilder target

options:Collection<ScpClient.Option>

The command options - ignored if null

opt:ScpClient.Option

The required option

Returns:StringBuilder

The updated builder

createReceiveCommandback to summary
public static String createReceiveCommand(String remote, Collection<ScpClient.Option> options)
createSendCommandback to summary
public static String createSendCommand(String remote, Collection<ScpClient.Option> options)
downloadback to summary
public default void download(String remote, String local, ScpClient.Option... options) throws IOException
downloadback to summary
public void download(String remote, String local, Collection<ScpClient.Option> options) throws IOException
downloadback to summary
public default void download(String remote, Path local, ScpClient.Option... options) throws IOException
downloadback to summary
public void download(String remote, Path local, Collection<ScpClient.Option> options) throws IOException
downloadback to summary
public void download(String remote, OutputStream local) throws IOException
downloadback to summary
public default void download(String[] remote, String local, ScpClient.Option... options) throws IOException
downloadback to summary
public default void download(String[] remote, Path local, ScpClient.Option... options) throws IOException
downloadback to summary
public void download(String[] remote, String local, Collection<ScpClient.Option> options) throws IOException
downloadback to summary
public void download(String[] remote, Path local, Collection<ScpClient.Option> options) throws IOException
downloadBytesback to summary
public default byte[] downloadBytes(String remote) throws IOException
getSessionback to summary
public default ClientSession getSession()

Implements org.apache.sshd.common.session.SessionHolder.getSession.

Annotations
@Override
uploadback to summary
public default void upload(String local, String remote, ScpClient.Option... options) throws IOException
uploadback to summary
public default void upload(String local, String remote, Collection<ScpClient.Option> options) throws IOException
uploadback to summary
public default void upload(Path local, String remote, ScpClient.Option... options) throws IOException
uploadback to summary
public default void upload(Path local, String remote, Collection<ScpClient.Option> options) throws IOException
uploadback to summary
public default void upload(String[] local, String remote, ScpClient.Option... options) throws IOException
uploadback to summary
public void upload(String[] local, String remote, Collection<ScpClient.Option> options) throws IOException
uploadback to summary
public default void upload(Path[] local, String remote, ScpClient.Option... options) throws IOException
uploadback to summary
public void upload(Path[] local, String remote, Collection<ScpClient.Option> options) throws IOException
uploadback to summary
public default void upload(byte[] data, String remote, Collection<PosixFilePermission> perms, ScpTimestampCommandDetails time) throws IOException
uploadback to summary
public default void upload(byte[] data, int offset, int len, String remote, Collection<PosixFilePermission> perms, ScpTimestampCommandDetails time) throws IOException
uploadback to summary
public void upload(InputStream local, String remote, long size, Collection<PosixFilePermission> perms, ScpTimestampCommandDetails time) throws IOException
org.apache.sshd.scp.client back to summary

public final Enum ScpClient.Option

extends Enum<ScpClient.Option>
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final String
optionValue

public static final ScpClient.Option
PreserveAttributes

public static final ScpClient.Option
Recursive

public static final ScpClient.Option
TargetIsDirectory

Constructor Summary

AccessConstructor and Description
private
Option(String optionValue)

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The option value to use in the issued SCP command
getOptionValue()

public static ScpClient.Option
valueOf(String name)

public static ScpClient.Option[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

optionValueback to summary
private final String optionValue
PreserveAttributesback to summary
public static final ScpClient.Option PreserveAttributes
Recursiveback to summary
public static final ScpClient.Option Recursive
TargetIsDirectoryback to summary
public static final ScpClient.Option TargetIsDirectory

Constructor Detail

Optionback to summary
private Option(String optionValue)

Method Detail

getOptionValueback to summary
public String getOptionValue()
Returns:String

The option value to use in the issued SCP command

valueOfback to summary
public static ScpClient.Option valueOf(String name)
valuesback to summary
public static ScpClient.Option[] values()