Package net.schmizz.sshj.sftp
Class SFTPClient
- java.lang.Object
-
- net.schmizz.sshj.sftp.SFTPClient
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
- Direct Known Subclasses:
StatefulSFTPClient
public class SFTPClient extends java.lang.Object implements java.io.Closeable
-
-
Field Summary
Fields Modifier and Type Field Description protected SFTPEngine
engine
protected org.slf4j.Logger
log
Loggerprotected SFTPFileTransfer
xfer
-
Constructor Summary
Constructors Constructor Description SFTPClient(SFTPEngine engine)
-
Method Summary
Modifier and Type Method Description long
atime(java.lang.String path)
java.lang.String
canonicalize(java.lang.String path)
void
chgrp(java.lang.String path, int gid)
void
chmod(java.lang.String path, int perms)
void
chown(java.lang.String path, int uid)
void
close()
void
get(java.lang.String source, java.lang.String dest)
void
get(java.lang.String source, java.lang.String dest, long byteOffset)
void
get(java.lang.String source, LocalDestFile dest)
void
get(java.lang.String source, LocalDestFile dest, long byteOffset)
SFTPFileTransfer
getFileTransfer()
SFTPEngine
getSFTPEngine()
int
gid(java.lang.String path)
java.util.List<RemoteResourceInfo>
ls(java.lang.String path)
java.util.List<RemoteResourceInfo>
ls(java.lang.String path, RemoteResourceFilter filter)
FileAttributes
lstat(java.lang.String path)
void
mkdir(java.lang.String dirname)
void
mkdirs(java.lang.String path)
FileMode
mode(java.lang.String path)
long
mtime(java.lang.String path)
RemoteFile
open(java.lang.String filename)
RemoteFile
open(java.lang.String filename, java.util.Set<OpenMode> mode)
RemoteFile
open(java.lang.String filename, java.util.Set<OpenMode> mode, FileAttributes attrs)
java.util.Set<FilePermission>
perms(java.lang.String path)
void
put(java.lang.String source, java.lang.String dest)
void
put(java.lang.String source, java.lang.String dest, long byteOffset)
void
put(LocalSourceFile source, java.lang.String dest)
void
put(LocalSourceFile source, java.lang.String dest, long byteOffset)
java.lang.String
readlink(java.lang.String path)
void
rename(java.lang.String oldpath, java.lang.String newpath)
void
rename(java.lang.String oldpath, java.lang.String newpath, java.util.Set<RenameFlags> renameFlags)
void
rm(java.lang.String filename)
void
rmdir(java.lang.String dirname)
void
setattr(java.lang.String path, FileAttributes attrs)
long
size(java.lang.String path)
FileAttributes
stat(java.lang.String path)
FileAttributes
statExistence(java.lang.String path)
void
symlink(java.lang.String linkpath, java.lang.String targetpath)
void
truncate(java.lang.String path, long size)
FileMode.Type
type(java.lang.String path)
int
uid(java.lang.String path)
int
version()
-
-
-
Field Detail
-
log
protected final org.slf4j.Logger log
Logger
-
engine
protected final SFTPEngine engine
-
xfer
protected final SFTPFileTransfer xfer
-
-
Constructor Detail
-
SFTPClient
public SFTPClient(SFTPEngine engine)
-
-
Method Detail
-
getSFTPEngine
public SFTPEngine getSFTPEngine()
-
getFileTransfer
public SFTPFileTransfer getFileTransfer()
-
ls
public java.util.List<RemoteResourceInfo> ls(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
ls
public java.util.List<RemoteResourceInfo> ls(java.lang.String path, RemoteResourceFilter filter) throws java.io.IOException
- Throws:
java.io.IOException
-
open
public RemoteFile open(java.lang.String filename, java.util.Set<OpenMode> mode, FileAttributes attrs) throws java.io.IOException
- Throws:
java.io.IOException
-
open
public RemoteFile open(java.lang.String filename, java.util.Set<OpenMode> mode) throws java.io.IOException
- Throws:
java.io.IOException
-
open
public RemoteFile open(java.lang.String filename) throws java.io.IOException
- Throws:
java.io.IOException
-
mkdir
public void mkdir(java.lang.String dirname) throws java.io.IOException
- Throws:
java.io.IOException
-
mkdirs
public void mkdirs(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
statExistence
public FileAttributes statExistence(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
rename
public void rename(java.lang.String oldpath, java.lang.String newpath) throws java.io.IOException
- Throws:
java.io.IOException
-
rename
public void rename(java.lang.String oldpath, java.lang.String newpath, java.util.Set<RenameFlags> renameFlags) throws java.io.IOException
- Throws:
java.io.IOException
-
rm
public void rm(java.lang.String filename) throws java.io.IOException
- Throws:
java.io.IOException
-
rmdir
public void rmdir(java.lang.String dirname) throws java.io.IOException
- Throws:
java.io.IOException
-
symlink
public void symlink(java.lang.String linkpath, java.lang.String targetpath) throws java.io.IOException
- Throws:
java.io.IOException
-
version
public int version()
-
setattr
public void setattr(java.lang.String path, FileAttributes attrs) throws java.io.IOException
- Throws:
java.io.IOException
-
uid
public int uid(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
gid
public int gid(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
atime
public long atime(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
mtime
public long mtime(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
perms
public java.util.Set<FilePermission> perms(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
mode
public FileMode mode(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
type
public FileMode.Type type(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
readlink
public java.lang.String readlink(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
stat
public FileAttributes stat(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
lstat
public FileAttributes lstat(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
chown
public void chown(java.lang.String path, int uid) throws java.io.IOException
- Throws:
java.io.IOException
-
chmod
public void chmod(java.lang.String path, int perms) throws java.io.IOException
- Throws:
java.io.IOException
-
chgrp
public void chgrp(java.lang.String path, int gid) throws java.io.IOException
- Throws:
java.io.IOException
-
truncate
public void truncate(java.lang.String path, long size) throws java.io.IOException
- Throws:
java.io.IOException
-
canonicalize
public java.lang.String canonicalize(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
size
public long size(java.lang.String path) throws java.io.IOException
- Throws:
java.io.IOException
-
get
public void get(java.lang.String source, java.lang.String dest) throws java.io.IOException
- Throws:
java.io.IOException
-
get
public void get(java.lang.String source, java.lang.String dest, long byteOffset) throws java.io.IOException
- Throws:
java.io.IOException
-
put
public void put(java.lang.String source, java.lang.String dest) throws java.io.IOException
- Throws:
java.io.IOException
-
put
public void put(java.lang.String source, java.lang.String dest, long byteOffset) throws java.io.IOException
- Throws:
java.io.IOException
-
get
public void get(java.lang.String source, LocalDestFile dest) throws java.io.IOException
- Throws:
java.io.IOException
-
get
public void get(java.lang.String source, LocalDestFile dest, long byteOffset) throws java.io.IOException
- Throws:
java.io.IOException
-
put
public void put(LocalSourceFile source, java.lang.String dest) throws java.io.IOException
- Throws:
java.io.IOException
-
put
public void put(LocalSourceFile source, java.lang.String dest, long byteOffset) throws java.io.IOException
- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Throws:
java.io.IOException
-
-