org.apache.sshd.common.scp

Class ScpHelper

java.lang.Object

org.apache.sshd.common.scp.ScpHelper

public class ScpHelper
extends Object

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COPY_BUFFER_SIZE Default size (in bytes) of send / receive buffer size
static int	DEFAULT_RECEIVE_BUFFER_SIZE
static int	DEFAULT_SEND_BUFFER_SIZE
static int	ERROR
protected InputStream	in
protected static org.slf4j.Logger	log
static int	MIN_COPY_BUFFER_SIZE The minimum size for sending / receiving files
static int	MIN_RECEIVE_BUFFER_SIZE
static int	MIN_SEND_BUFFER_SIZE
static int	OK
protected OutputStream	out
protected FileSystemView	root
static int	S_IRGRP
static int	S_IROTH
static int	S_IRUSR
static int	S_IWGRP
static int	S_IWOTH
static int	S_IWUSR
static int	S_IXGRP
static int	S_IXOTH
static int	S_IXUSR
static int	WARNING

Constructor Summary

Constructors

Constructor and Description
ScpHelper(InputStream in, OutputStream out, FileSystemView root)

Method Summary

Methods

Modifier and Type	Method and Description
void	ack()
static EnumSet<SshFile.Permission>	fromOctalPerms(String str)
int	readAck(boolean canEof)
String	readLine()
String	readLine(boolean canEof)
void	receive(SshFile path, boolean recursive, boolean shouldBeDir, boolean preserve, int bufferSize)
void	receiveDir(String header, SshFile path, long[] time, boolean preserve, int bufferSize)
void	receiveFile(String header, SshFile path, long[] time, boolean preserve, int bufferSize)
void	send(List<String> paths, boolean recursive, boolean preserve, int bufferSize)
void	sendDir(SshFile path, boolean preserve, int bufferSize)
void	sendFile(SshFile path, boolean preserve, int bufferSize)
static String	toOctalPerms(EnumSet<SshFile.Permission> perms)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final org.slf4j.Logger log

OK

public static final int OK

See Also:

Constant Field Values

WARNING

public static final int WARNING

See Also:

Constant Field Values

ERROR

public static final int ERROR

See Also:

Constant Field Values

DEFAULT_COPY_BUFFER_SIZE

public static final int DEFAULT_COPY_BUFFER_SIZE

Default size (in bytes) of send / receive buffer size

See Also:

Constant Field Values

DEFAULT_RECEIVE_BUFFER_SIZE

public static final int DEFAULT_RECEIVE_BUFFER_SIZE

See Also:

Constant Field Values

DEFAULT_SEND_BUFFER_SIZE

public static final int DEFAULT_SEND_BUFFER_SIZE

See Also:

Constant Field Values

MIN_COPY_BUFFER_SIZE

public static final int MIN_COPY_BUFFER_SIZE

The minimum size for sending / receiving files

See Also:

Constant Field Values

MIN_RECEIVE_BUFFER_SIZE

public static final int MIN_RECEIVE_BUFFER_SIZE

See Also:

Constant Field Values

MIN_SEND_BUFFER_SIZE

public static final int MIN_SEND_BUFFER_SIZE

See Also:

Constant Field Values

S_IRUSR

public static final int S_IRUSR

See Also:

Constant Field Values

S_IWUSR

public static final int S_IWUSR

See Also:

Constant Field Values

S_IXUSR

public static final int S_IXUSR

See Also:

Constant Field Values

S_IRGRP

public static final int S_IRGRP

See Also:

Constant Field Values

S_IWGRP

public static final int S_IWGRP

See Also:

Constant Field Values

S_IXGRP

public static final int S_IXGRP

See Also:

Constant Field Values

S_IROTH

public static final int S_IROTH

See Also:

Constant Field Values

S_IWOTH

public static final int S_IWOTH

See Also:

Constant Field Values

S_IXOTH

public static final int S_IXOTH

See Also:

Constant Field Values

root

protected final FileSystemView root

in

protected final InputStream in

out

protected final OutputStream out

Constructor Detail

ScpHelper

public ScpHelper(InputStream in,
         OutputStream out,
         FileSystemView root)

Method Detail

receive

public void receive(SshFile path,
           boolean recursive,
           boolean shouldBeDir,
           boolean preserve,
           int bufferSize)
             throws IOException

Throws:

IOException

receiveDir

public void receiveDir(String header,
              SshFile path,
              long[] time,
              boolean preserve,
              int bufferSize)
                throws IOException

Throws:

IOException

receiveFile

public void receiveFile(String header,
               SshFile path,
               long[] time,
               boolean preserve,
               int bufferSize)
                 throws IOException

Throws:

IOException

readLine

public String readLine()
                throws IOException

Throws:

IOException

readLine

public String readLine(boolean canEof)
                throws IOException

Throws:

IOException

send

public void send(List<String> paths,
        boolean recursive,
        boolean preserve,
        int bufferSize)
          throws IOException

Throws:

IOException

sendFile

public void sendFile(SshFile path,
            boolean preserve,
            int bufferSize)
              throws IOException

Throws:

IOException

sendDir

public void sendDir(SshFile path,
           boolean preserve,
           int bufferSize)
             throws IOException

Throws:

IOException

toOctalPerms

public static String toOctalPerms(EnumSet<SshFile.Permission> perms)

fromOctalPerms

public static EnumSet<SshFile.Permission> fromOctalPerms(String str)

ack

public void ack()
         throws IOException

Throws:

IOException

readAck

public int readAck(boolean canEof)
            throws IOException

Throws:

IOException