org.apache.sshd.client

Interface SftpClient

All Known Implementing Classes:

DefaultSftpClient

public interface SftpClient

Author:

Apache MINA Project

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SftpClient.Attribute
static class	SftpClient.Attributes
static class	SftpClient.DirEntry
static class	SftpClient.Handle
static class	SftpClient.OpenMode

Field Summary

Fields

Modifier and Type	Field and Description
static int	S_IFBLK
static int	S_IFCHR
static int	S_IFDIR
static int	S_IFIFO
static int	S_IFLNK
static int	S_IFMT
static int	S_IFREG
static int	S_IFSOCK
static int	S_IRGRP
static int	S_IROTH
static int	S_IRUSR
static int	S_ISGID
static int	S_ISUID
static int	S_ISVTX
static int	S_IWGRP
static int	S_IWOTH
static int	S_IWUSR
static int	S_IXGRP
static int	S_IXOTH
static int	S_IXUSR

Method Summary

Methods

Modifier and Type	Method and Description
String	canonicalPath(String canonical)
void	close() Close the client.
void	close(SftpClient.Handle handle)
SftpClient.Attributes	lstat(String path)
void	mkdir(String path)
SftpClient.Handle	open(String path, EnumSet<SftpClient.OpenMode> options)
SftpClient.Handle	openDir(String path)
int	read(SftpClient.Handle handle, long fileOffset, byte[] dst, int dstoff, int len)
InputStream	read(String path)
InputStream	read(String path, EnumSet<SftpClient.OpenMode> mode)
SftpClient.DirEntry[]	readDir(SftpClient.Handle handle)
Iterable<SftpClient.DirEntry>	readDir(String path)
String	readLink(String path)
void	remove(String path)
void	rename(String oldPath, String newPath)
void	rmdir(String path)
void	setStat(SftpClient.Handle handle, SftpClient.Attributes attributes)
void	setStat(String path, SftpClient.Attributes attributes)
SftpClient.Attributes	stat(SftpClient.Handle handle)
SftpClient.Attributes	stat(String path)
void	symLink(String linkPath, String targetPath)
void	write(SftpClient.Handle handle, long fileOffset, byte[] src, int srcoff, int len)
OutputStream	write(String path)
OutputStream	write(String path, EnumSet<SftpClient.OpenMode> mode)

Field Detail

S_IFMT

static final int S_IFMT

See Also:

Constant Field Values

S_IFSOCK

static final int S_IFSOCK

See Also:

Constant Field Values

S_IFLNK

static final int S_IFLNK

See Also:

Constant Field Values

S_IFREG

static final int S_IFREG

See Also:

Constant Field Values

S_IFBLK

static final int S_IFBLK

See Also:

Constant Field Values

S_IFDIR

static final int S_IFDIR

See Also:

Constant Field Values

S_IFCHR

static final int S_IFCHR

See Also:

Constant Field Values

S_IFIFO

static final int S_IFIFO

See Also:

Constant Field Values

S_ISUID

static final int S_ISUID

See Also:

Constant Field Values

S_ISGID

static final int S_ISGID

See Also:

Constant Field Values

S_ISVTX

static final int S_ISVTX

See Also:

Constant Field Values

S_IRUSR

static final int S_IRUSR

See Also:

Constant Field Values

S_IWUSR

static final int S_IWUSR

See Also:

Constant Field Values

S_IXUSR

static final int S_IXUSR

See Also:

Constant Field Values

S_IRGRP

static final int S_IRGRP

See Also:

Constant Field Values

S_IWGRP

static final int S_IWGRP

See Also:

Constant Field Values

S_IXGRP

static final int S_IXGRP

See Also:

Constant Field Values

S_IROTH

static final int S_IROTH

See Also:

Constant Field Values

S_IWOTH

static final int S_IWOTH

See Also:

Constant Field Values

S_IXOTH

static final int S_IXOTH

See Also:

Constant Field Values

Method Detail

close

void close()
           throws IOException

Close the client.

Throws:

IOException

open

SftpClient.Handle open(String path,
                     EnumSet<SftpClient.OpenMode> options)
                       throws IOException

Throws:

IOException

close

void close(SftpClient.Handle handle)
           throws IOException

Throws:

IOException

remove

void remove(String path)
            throws IOException

Throws:

IOException

rename

void rename(String oldPath,
          String newPath)
            throws IOException

Throws:

IOException

read

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

Throws:

IOException

write

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

Throws:

IOException

mkdir

void mkdir(String path)
           throws IOException

Throws:

IOException

rmdir

void rmdir(String path)
           throws IOException

Throws:

IOException

openDir

SftpClient.Handle openDir(String path)
                          throws IOException

Throws:

IOException

readDir

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

Throws:

IOException

canonicalPath

String canonicalPath(String canonical)
                     throws IOException

Throws:

IOException

stat

SftpClient.Attributes stat(String path)
                           throws IOException

Throws:

IOException

lstat

SftpClient.Attributes lstat(String path)
                            throws IOException

Throws:

IOException

stat

SftpClient.Attributes stat(SftpClient.Handle handle)
                           throws IOException

Throws:

IOException

setStat

void setStat(String path,
           SftpClient.Attributes attributes)
             throws IOException

Throws:

IOException

setStat

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

Throws:

IOException

readLink

String readLink(String path)
                throws IOException

Throws:

IOException

symLink

void symLink(String linkPath,
           String targetPath)
             throws IOException

Throws:

IOException

readDir

Iterable<SftpClient.DirEntry> readDir(String path)
                                      throws IOException

Throws:

IOException

read

InputStream read(String path)
                 throws IOException

Throws:

IOException

read

InputStream read(String path,
               EnumSet<SftpClient.OpenMode> mode)
                 throws IOException

Throws:

IOException

write

OutputStream write(String path)
                   throws IOException

Throws:

IOException

write

OutputStream write(String path,
                 EnumSet<SftpClient.OpenMode> mode)
                   throws IOException

Throws:

IOException