Package org.apache.sshd.scp.client

Interface ScpClient

All Superinterfaces:

org.apache.sshd.client.session.ClientSessionHolder, org.apache.sshd.common.session.SessionContextHolder, org.apache.sshd.common.session.SessionHolder<org.apache.sshd.client.session.ClientSession>

All Known Subinterfaces:

CloseableScpClient

All Known Implementing Classes:

AbstractScpClient, DefaultScpClient

public interface ScpClient
extends org.apache.sshd.common.session.SessionHolder<org.apache.sshd.client.session.ClientSession>, org.apache.sshd.client.session.ClientSessionHolder

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ScpClient.Option

Method Summary

Modifier and Type	Method	Description
static StringBuilder	appendCommandOption(StringBuilder sb, Collection<ScpClient.Option> options, ScpClient.Option opt)	Appends the specified option command value if appears in provided options collection
static String	createReceiveCommand(String remote, Collection<ScpClient.Option> options)
static String	createSendCommand(String remote, Collection<ScpClient.Option> options)
void	download(String[] remote, String local, Collection<ScpClient.Option> options)
default void	download(String[] remote, String local, ScpClient.Option... options)
void	download(String[] remote, Path local, Collection<ScpClient.Option> options)
default void	download(String[] remote, Path local, ScpClient.Option... options)
void	download(String remote, OutputStream local)
void	download(String remote, String local, Collection<ScpClient.Option> options)
default void	download(String remote, String local, ScpClient.Option... options)
void	download(String remote, Path local, Collection<ScpClient.Option> options)
default void	download(String remote, Path local, ScpClient.Option... options)
default byte[]	downloadBytes(String remote)
default org.apache.sshd.client.session.ClientSession	getSession()
default void	upload(byte[] data, int offset, int len, String remote, Collection<PosixFilePermission> perms, ScpTimestampCommandDetails time)
default void	upload(byte[] data, String remote, Collection<PosixFilePermission> perms, ScpTimestampCommandDetails time)
void	upload(InputStream local, String remote, long size, Collection<PosixFilePermission> perms, ScpTimestampCommandDetails time)
void	upload(String[] local, String remote, Collection<ScpClient.Option> options)
default void	upload(String[] local, String remote, ScpClient.Option... options)
default void	upload(String local, String remote, Collection<ScpClient.Option> options)
default void	upload(String local, String remote, ScpClient.Option... options)
void	upload(Path[] local, String remote, Collection<ScpClient.Option> options)
default void	upload(Path[] local, String remote, ScpClient.Option... options)
default void	upload(Path local, String remote, Collection<ScpClient.Option> options)
default void	upload(Path local, String remote, ScpClient.Option... options)

Methods inherited from interface org.apache.sshd.client.session.ClientSessionHolder

getClientSession

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSessionContext

Method Details

getSession

default org.apache.sshd.client.session.ClientSession getSession()

Specified by:

getSession in interface org.apache.sshd.common.session.SessionHolder<org.apache.sshd.client.session.ClientSession>

download

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

Throws:

IOException

download

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

Throws:

IOException

download

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

Throws:

IOException

download

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

Throws:

IOException

download

void download(String remote,
 OutputStream local)
       throws IOException

Throws:

IOException

downloadBytes

default byte[] downloadBytes(String remote)
                      throws IOException

Throws:

IOException

download

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

Throws:

IOException

download

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

Throws:

IOException

download

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

Throws:

IOException

download

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

createSendCommand

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

createReceiveCommand

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

appendCommandOption

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 - The StringBuilder target

options - The command options - ignored if null

opt - The required option

Returns:

The updated builder