org.apache.sshd.client.sftp

Class DefaultSftpClient

java.lang.Object

org.apache.sshd.client.sftp.DefaultSftpClient

All Implemented Interfaces:

SftpClient

public class DefaultSftpClient
extends java.lang.Object
implements SftpClient

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.client.SftpClient

SftpClient.Attribute, SftpClient.Attributes, SftpClient.DirEntry, SftpClient.Handle, SftpClient.OpenMode

Field Summary

Fields

Modifier and Type	Field and Description
static int	SSH_FILEXFER_ATTR_ACMODTIME
static int	SSH_FILEXFER_ATTR_EXTENDED
static int	SSH_FILEXFER_ATTR_PERMISSIONS
static int	SSH_FILEXFER_ATTR_SIZE
static int	SSH_FILEXFER_ATTR_UIDGID
static int	SSH_FX_BAD_MESSAGE
static int	SSH_FX_CONNECTION_LOST
static int	SSH_FX_EOF
static int	SSH_FX_FAILURE
static int	SSH_FX_NO_CONNECTION
static int	SSH_FX_NO_SUCH_FILE
static int	SSH_FX_OK
static int	SSH_FX_OP_UNSUPPORTED
static int	SSH_FX_PERMISSION_DENIED
static int	SSH_FXF_APPEND
static int	SSH_FXF_CREAT
static int	SSH_FXF_EXCL
static int	SSH_FXF_READ
static int	SSH_FXF_TRUNC
static int	SSH_FXF_WRITE
static int	SSH_FXP_ATTRS
static int	SSH_FXP_CLOSE
static int	SSH_FXP_DATA
static int	SSH_FXP_EXTENDED
static int	SSH_FXP_EXTENDED_REPLY
static int	SSH_FXP_FSETSTAT
static int	SSH_FXP_FSTAT
static int	SSH_FXP_HANDLE
static int	SSH_FXP_INIT
static int	SSH_FXP_LSTAT
static int	SSH_FXP_MKDIR
static int	SSH_FXP_NAME
static int	SSH_FXP_OPEN
static int	SSH_FXP_OPENDIR
static int	SSH_FXP_READ
static int	SSH_FXP_READDIR
static int	SSH_FXP_READLINK
static int	SSH_FXP_REALPATH
static int	SSH_FXP_REMOVE
static int	SSH_FXP_RENAME
static int	SSH_FXP_RMDIR
static int	SSH_FXP_SETSTAT
static int	SSH_FXP_STAT
static int	SSH_FXP_STATUS
static int	SSH_FXP_SYMLINK
static int	SSH_FXP_VERSION
static int	SSH_FXP_WRITE

Fields inherited from interface org.apache.sshd.client.SftpClient

S_IFBLK, S_IFCHR, S_IFDIR, S_IFIFO, S_IFLNK, S_IFMT, S_IFREG, S_IFSOCK, S_IRGRP, S_IROTH, S_IRUSR, S_ISGID, S_ISUID, S_ISVTX, S_IWGRP, S_IWOTH, S_IWUSR, S_IXGRP, S_IXOTH, S_IXUSR

Constructor Summary

Constructors

Constructor and Description
DefaultSftpClient(ClientSession clientSession)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	canonicalPath(java.lang.String path)
protected SftpClient.Attributes	checkAttributes(Buffer buffer)
protected int	checkData(Buffer buffer, int dstoff, byte[] dst)
protected SftpClient.DirEntry[]	checkDir(Buffer buffer)
protected SftpClient.Handle	checkHandle(Buffer buffer)
protected java.lang.String	checkOneName(Buffer buffer)
protected void	checkStatus(Buffer buffer)
void	close() Close the client.
void	close(SftpClient.Handle handle)
protected int	data(byte[] buf, int start, int len) Receive binary data
protected void	init()
SftpClient.Attributes	lstat(java.lang.String path)
void	mkdir(java.lang.String path)
SftpClient.Handle	open(java.lang.String path, java.util.EnumSet<SftpClient.OpenMode> options)
SftpClient.Handle	openDir(java.lang.String path)
protected void	process(Buffer incoming) Process an SFTP packet
protected Buffer	read()
int	read(SftpClient.Handle handle, long fileOffset, byte[] dst, int dstoff, int len)
java.io.InputStream	read(java.lang.String path)
protected SftpClient.Attributes	readAttributes(Buffer buffer)
SftpClient.DirEntry[]	readDir(SftpClient.Handle handle)
java.lang.Iterable<SftpClient.DirEntry>	readDir(java.lang.String path)
java.lang.String	readLink(java.lang.String path)
protected boolean	receive(Buffer incoming) Read SFTP packets from buffer
protected Buffer	receive(int id)
void	remove(java.lang.String path)
void	rename(java.lang.String oldPath, java.lang.String newPath)
void	rmdir(java.lang.String path)
protected int	send(int cmd, Buffer buffer)
void	setStat(SftpClient.Handle handle, SftpClient.Attributes attributes)
void	setStat(java.lang.String path, SftpClient.Attributes attributes)
SftpClient.Attributes	stat(SftpClient.Handle handle)
SftpClient.Attributes	stat(java.lang.String path)
void	symLink(java.lang.String linkPath, java.lang.String targetPath)
void	write(SftpClient.Handle handle, long fileOffset, byte[] src, int srcoff, int len)
java.io.OutputStream	write(java.lang.String path)
protected void	writeAttributes(Buffer buffer, SftpClient.Attributes attributes)

Methods inherited from class java.lang.Object

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

Field Detail

SSH_FXP_INIT

public static final int SSH_FXP_INIT

See Also:

Constant Field Values

SSH_FXP_VERSION

public static final int SSH_FXP_VERSION

See Also:

Constant Field Values

SSH_FXP_OPEN

public static final int SSH_FXP_OPEN

See Also:

Constant Field Values

SSH_FXP_CLOSE

public static final int SSH_FXP_CLOSE

See Also:

Constant Field Values

SSH_FXP_READ

public static final int SSH_FXP_READ

See Also:

Constant Field Values

SSH_FXP_WRITE

public static final int SSH_FXP_WRITE

See Also:

Constant Field Values

SSH_FXP_LSTAT

public static final int SSH_FXP_LSTAT

See Also:

Constant Field Values

SSH_FXP_FSTAT

public static final int SSH_FXP_FSTAT

See Also:

Constant Field Values

SSH_FXP_SETSTAT

public static final int SSH_FXP_SETSTAT

See Also:

Constant Field Values

SSH_FXP_FSETSTAT

public static final int SSH_FXP_FSETSTAT

See Also:

Constant Field Values

SSH_FXP_OPENDIR

public static final int SSH_FXP_OPENDIR

See Also:

Constant Field Values

SSH_FXP_READDIR

public static final int SSH_FXP_READDIR

See Also:

Constant Field Values

SSH_FXP_REMOVE

public static final int SSH_FXP_REMOVE

See Also:

Constant Field Values

SSH_FXP_MKDIR

public static final int SSH_FXP_MKDIR

See Also:

Constant Field Values

SSH_FXP_RMDIR

public static final int SSH_FXP_RMDIR

See Also:

Constant Field Values

SSH_FXP_REALPATH

public static final int SSH_FXP_REALPATH

See Also:

Constant Field Values

SSH_FXP_STAT

public static final int SSH_FXP_STAT

See Also:

Constant Field Values

SSH_FXP_RENAME

public static final int SSH_FXP_RENAME

See Also:

Constant Field Values

SSH_FXP_READLINK

public static final int SSH_FXP_READLINK

See Also:

Constant Field Values

SSH_FXP_SYMLINK

public static final int SSH_FXP_SYMLINK

See Also:

Constant Field Values

SSH_FXP_STATUS

public static final int SSH_FXP_STATUS

See Also:

Constant Field Values

SSH_FXP_HANDLE

public static final int SSH_FXP_HANDLE

See Also:

Constant Field Values

SSH_FXP_DATA

public static final int SSH_FXP_DATA

See Also:

Constant Field Values

SSH_FXP_NAME

public static final int SSH_FXP_NAME

See Also:

Constant Field Values

SSH_FXP_ATTRS

public static final int SSH_FXP_ATTRS

See Also:

Constant Field Values

SSH_FXP_EXTENDED

public static final int SSH_FXP_EXTENDED

See Also:

Constant Field Values

SSH_FXP_EXTENDED_REPLY

public static final int SSH_FXP_EXTENDED_REPLY

See Also:

Constant Field Values

SSH_FX_OK

public static final int SSH_FX_OK

See Also:

Constant Field Values

SSH_FX_EOF

public static final int SSH_FX_EOF

See Also:

Constant Field Values

SSH_FX_NO_SUCH_FILE

public static final int SSH_FX_NO_SUCH_FILE

See Also:

Constant Field Values

SSH_FX_PERMISSION_DENIED

public static final int SSH_FX_PERMISSION_DENIED

See Also:

Constant Field Values

SSH_FX_FAILURE

public static final int SSH_FX_FAILURE

See Also:

Constant Field Values

SSH_FX_BAD_MESSAGE

public static final int SSH_FX_BAD_MESSAGE

See Also:

Constant Field Values

SSH_FX_NO_CONNECTION

public static final int SSH_FX_NO_CONNECTION

See Also:

Constant Field Values

SSH_FX_CONNECTION_LOST

public static final int SSH_FX_CONNECTION_LOST

See Also:

Constant Field Values

SSH_FX_OP_UNSUPPORTED

public static final int SSH_FX_OP_UNSUPPORTED

See Also:

Constant Field Values

SSH_FILEXFER_ATTR_SIZE

public static final int SSH_FILEXFER_ATTR_SIZE

See Also:

Constant Field Values

SSH_FILEXFER_ATTR_UIDGID

public static final int SSH_FILEXFER_ATTR_UIDGID

See Also:

Constant Field Values

SSH_FILEXFER_ATTR_PERMISSIONS

public static final int SSH_FILEXFER_ATTR_PERMISSIONS

See Also:

Constant Field Values

SSH_FILEXFER_ATTR_ACMODTIME

public static final int SSH_FILEXFER_ATTR_ACMODTIME

See Also:

Constant Field Values

SSH_FILEXFER_ATTR_EXTENDED

public static final int SSH_FILEXFER_ATTR_EXTENDED

See Also:

Constant Field Values

SSH_FXF_READ

public static final int SSH_FXF_READ

See Also:

Constant Field Values

SSH_FXF_WRITE

public static final int SSH_FXF_WRITE

See Also:

Constant Field Values

SSH_FXF_APPEND

public static final int SSH_FXF_APPEND

See Also:

Constant Field Values

SSH_FXF_CREAT

public static final int SSH_FXF_CREAT

See Also:

Constant Field Values

SSH_FXF_TRUNC

public static final int SSH_FXF_TRUNC

See Also:

Constant Field Values

SSH_FXF_EXCL

public static final int SSH_FXF_EXCL

See Also:

Constant Field Values

Constructor Detail

DefaultSftpClient

public DefaultSftpClient(ClientSession clientSession)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

close

public void close()
           throws java.io.IOException

Description copied from interface: SftpClient

Close the client.

Specified by:

close in interface SftpClient

Throws:

java.io.IOException

data

protected int data(byte[] buf,
       int start,
       int len)
            throws java.io.IOException

Receive binary data

Throws:

java.io.IOException

receive

protected boolean receive(Buffer incoming)
                   throws java.io.IOException

Read SFTP packets from buffer

Throws:

java.io.IOException

process

protected void process(Buffer incoming)
                throws java.io.IOException

Process an SFTP packet

Throws:

java.io.IOException

send

protected int send(int cmd,
       Buffer buffer)
            throws java.io.IOException

Throws:

java.io.IOException

receive

protected Buffer receive(int id)
                  throws java.io.IOException

Throws:

java.io.IOException

read

protected Buffer read()
               throws java.io.IOException

Throws:

java.io.IOException

init

protected void init()
             throws java.io.IOException

Throws:

java.io.IOException

checkStatus

protected void checkStatus(Buffer buffer)
                    throws java.io.IOException

Throws:

java.io.IOException

checkHandle

protected SftpClient.Handle checkHandle(Buffer buffer)
                                 throws java.io.IOException

Throws:

java.io.IOException

checkAttributes

protected SftpClient.Attributes checkAttributes(Buffer buffer)
                                         throws java.io.IOException

Throws:

java.io.IOException

checkOneName

protected java.lang.String checkOneName(Buffer buffer)
                                 throws java.io.IOException

Throws:

java.io.IOException

readAttributes

protected SftpClient.Attributes readAttributes(Buffer buffer)
                                        throws java.io.IOException

Throws:

java.io.IOException

writeAttributes

protected void writeAttributes(Buffer buffer,
                   SftpClient.Attributes attributes)
                        throws java.io.IOException

Throws:

java.io.IOException

open

public SftpClient.Handle open(java.lang.String path,
                     java.util.EnumSet<SftpClient.OpenMode> options)
                       throws java.io.IOException

Specified by:

open in interface SftpClient

Throws:

java.io.IOException

close

public void close(SftpClient.Handle handle)
           throws java.io.IOException

Specified by:

close in interface SftpClient

Throws:

java.io.IOException

remove

public void remove(java.lang.String path)
            throws java.io.IOException

Specified by:

remove in interface SftpClient

Throws:

java.io.IOException

rename

public void rename(java.lang.String oldPath,
          java.lang.String newPath)
            throws java.io.IOException

Specified by:

rename in interface SftpClient

Throws:

java.io.IOException

read

public int read(SftpClient.Handle handle,
       long fileOffset,
       byte[] dst,
       int dstoff,
       int len)
         throws java.io.IOException

Specified by:

read in interface SftpClient

Throws:

java.io.IOException

checkData

protected int checkData(Buffer buffer,
            int dstoff,
            byte[] dst)
                 throws SshException

Throws:

SshException

write

public void write(SftpClient.Handle handle,
         long fileOffset,
         byte[] src,
         int srcoff,
         int len)
           throws java.io.IOException

Specified by:

write in interface SftpClient

Throws:

java.io.IOException

mkdir

public void mkdir(java.lang.String path)
           throws java.io.IOException

Specified by:

mkdir in interface SftpClient

Throws:

java.io.IOException

rmdir

public void rmdir(java.lang.String path)
           throws java.io.IOException

Specified by:

rmdir in interface SftpClient

Throws:

java.io.IOException

openDir

public SftpClient.Handle openDir(java.lang.String path)
                          throws java.io.IOException

Specified by:

openDir in interface SftpClient

Throws:

java.io.IOException

readDir

public SftpClient.DirEntry[] readDir(SftpClient.Handle handle)
                              throws java.io.IOException

Specified by:

readDir in interface SftpClient

Throws:

java.io.IOException

checkDir

protected SftpClient.DirEntry[] checkDir(Buffer buffer)
                                  throws java.io.IOException

Throws:

java.io.IOException

canonicalPath

public java.lang.String canonicalPath(java.lang.String path)
                               throws java.io.IOException

Specified by:

canonicalPath in interface SftpClient

Throws:

java.io.IOException

stat

public SftpClient.Attributes stat(java.lang.String path)
                           throws java.io.IOException

Specified by:

stat in interface SftpClient

Throws:

java.io.IOException

lstat

public SftpClient.Attributes lstat(java.lang.String path)
                            throws java.io.IOException

Specified by:

lstat in interface SftpClient

Throws:

java.io.IOException

stat

public SftpClient.Attributes stat(SftpClient.Handle handle)
                           throws java.io.IOException

Specified by:

stat in interface SftpClient

Throws:

java.io.IOException

setStat

public void setStat(java.lang.String path,
           SftpClient.Attributes attributes)
             throws java.io.IOException

Specified by:

setStat in interface SftpClient

Throws:

java.io.IOException

setStat

public void setStat(SftpClient.Handle handle,
           SftpClient.Attributes attributes)
             throws java.io.IOException

Specified by:

setStat in interface SftpClient

Throws:

java.io.IOException

readLink

public java.lang.String readLink(java.lang.String path)
                          throws java.io.IOException

Specified by:

readLink in interface SftpClient

Throws:

java.io.IOException

symLink

public void symLink(java.lang.String linkPath,
           java.lang.String targetPath)
             throws java.io.IOException

Specified by:

symLink in interface SftpClient

Throws:

java.io.IOException

readDir

public java.lang.Iterable<SftpClient.DirEntry> readDir(java.lang.String path)
                                                throws java.io.IOException

Specified by:

readDir in interface SftpClient

Throws:

java.io.IOException

read

public java.io.InputStream read(java.lang.String path)
                         throws java.io.IOException

Specified by:

read in interface SftpClient

Throws:

java.io.IOException

write

public java.io.OutputStream write(java.lang.String path)
                           throws java.io.IOException

Specified by:

write in interface SftpClient

Throws:

java.io.IOException