Package | Description |
---|---|
com.sshtools.client.sftp |
Modifier and Type | Method and Description |
---|---|
boolean |
SftpFile.canRead()
Determine whether the user has read access to the file.
|
boolean |
SftpFile.canWrite()
Determine whether the user has write access to the file.
|
void |
SftpClientTask.cd(String dir)
Changes the working directory on the remote server, or the user's default
directory if
null or any empty string is provided as the
directory path. |
void |
SftpClientTask.cdup()
Change the working directory to the parent directory
|
void |
AbstractSftpTask.changePermissions(SftpFile file,
int permissions)
Change the permissions of a file.
|
void |
AbstractSftpTask.changePermissions(String filename,
int permissions)
Change the permissions of a file.
|
void |
AbstractSftpTask.changePermissions(String filename,
String permissions)
Change the permissions of a file.
|
void |
SftpClientTask.chgrp(String gid,
String path)
Sets the group ID for the file or directory.
|
void |
SftpClientTask.chmod(int permissions,
String path)
Changes the access permissions or modes of the specified file or
directory.
|
void |
SftpClientTask.chown(String uid,
String path)
Sets the user ID to owner for the file or directory.
|
void |
SftpFile.close()
Close the file.
|
void |
AbstractSftpTask.closeFile(SftpFile file)
Close a file or directory.
|
DirectoryOperation |
SftpClientTask.copyLocalDirectory(String localdir,
String remotedir,
boolean recurse,
boolean sync,
boolean commit,
FileTransferProgress progress)
Copy the contents of a local directory into a remote directory.
|
DirectoryOperation |
SftpClientTask.copyRemoteDirectory(String remotedir,
String localdir,
boolean recurse,
boolean sync,
boolean commit,
FileTransferProgress progress)
Copy the contents of a remote directory to a local directory
|
void |
AbstractSftpTask.createLink(String targetpath,
String linkpath,
boolean symbolic)
Create a symbolic link.
|
void |
AbstractSftpTask.createSymbolicLink(String targetpath,
String linkpath)
Create a symbolic link.
|
void |
SftpFile.delete()
Delete this file/directory from the remote server.
|
static String |
SftpClientTask.formatLongname(SftpFile file)
Format a String with the details of the file.
|
SftpFileAttributes |
SftpClientTask.get(String path)
Download the remote file to the local computer
|
SftpFileAttributes |
SftpClientTask.get(String path,
boolean resume)
Download the remote file to the local computer
|
SftpFileAttributes |
SftpClientTask.get(String path,
FileTransferProgress progress)
Download the remote file to the local computer.
|
SftpFileAttributes |
SftpClientTask.get(String path,
FileTransferProgress progress,
boolean resume)
Download the remote file to the local computer.
|
SftpFileAttributes |
SftpClientTask.get(String remote,
OutputStream local)
Download the remote file into an OutputStream.
|
SftpFileAttributes |
SftpClientTask.get(String remote,
OutputStream local,
FileTransferProgress progress)
Download the remote file writing it to the specified
OutputStream . |
SftpFileAttributes |
SftpClientTask.get(String remote,
OutputStream local,
FileTransferProgress progress,
long position)
Download the remote file writing it to the specified
OutputStream . |
SftpFileAttributes |
SftpClientTask.get(String remote,
OutputStream local,
long position)
Download the remote file into an OutputStream.
|
SftpFileAttributes |
SftpClientTask.get(String remote,
String local)
Download the remote file into the local file.
|
SftpFileAttributes |
SftpClientTask.get(String remote,
String local,
boolean resume)
Download the remote file into the local file.
|
SftpFileAttributes |
SftpClientTask.get(String remote,
String local,
FileTransferProgress progress)
Download the remote file to the local computer.
|
SftpFileAttributes |
SftpClientTask.get(String remote,
String local,
FileTransferProgress progress,
boolean resume)
Download the remote file to the local computer.
|
String |
AbstractSftpTask.getAbsolutePath(SftpFile file)
Get the absolute path of a file.
|
String |
SftpClientTask.getAbsolutePath(String path)
Get the absolute path for a file.
|
String |
AbstractSftpTask.getAbsolutePath(String path)
Get the absolute path of a file.
|
SftpFileAttributes |
SftpFile.getAttributes()
Get the files attributes.
|
SftpFileAttributes |
AbstractSftpTask.getAttributes(SftpFile file)
Get the attributes of a file.
|
SftpFileAttributes |
AbstractSftpTask.getAttributes(String path)
Get the attributes of a file.
|
protected SftpFileAttributes |
AbstractSftpTask.getAttributes(String path,
int messageId) |
byte[] |
AbstractSftpTask.getCanonicalNewline()
Returns the canonical newline convention in use when reading/writing text
files.
|
String |
SftpClientTask.getDefaultDirectory()
Get the default directory (or HOME directory)
|
String |
AbstractSftpTask.getDefaultDirectory()
Gets the users default directory.
|
int |
SftpClientTask.getEOL(byte[] nl) |
int |
SftpClientTask.getEOL(String line) |
SftpFile |
AbstractSftpTask.getFile(String path)
Utility method to obtain an
SftpFile instance for a given path. |
SftpFile[] |
SftpClientTask.getFiles(String remote)
Download the remote files to the local computer
|
SftpFile[] |
SftpClientTask.getFiles(String remote,
boolean resume)
Download the remote files to the local computer
|
SftpFile[] |
SftpClientTask.getFiles(String remote,
FileTransferProgress progress)
Download the remote files to the local computer.
|
SftpFile[] |
SftpClientTask.getFiles(String remote,
FileTransferProgress progress,
boolean resume)
Download the remote files to the local computer.
|
SftpFile[] |
SftpClientTask.getFiles(String remote,
String local)
Download the remote files into the local file.
|
SftpFile[] |
SftpClientTask.getFiles(String remote,
String local,
boolean resume)
Download the remote files into the local file.
|
SftpFile[] |
SftpClientTask.getFiles(String remote,
String local,
FileTransferProgress progress,
boolean resume)
Download the remote file to the local computer.
|
InputStream |
SftpClientTask.getInputStream(String remotefile)
Create an InputStream for reading a remote file.
|
InputStream |
SftpClientTask.getInputStream(String remotefile,
long position)
Create an InputStream for reading a remote file.
|
SftpFileAttributes |
AbstractSftpTask.getLinkAttributes(String path)
Get the attributes of a file.
|
void |
AbstractSftpTask.getOKRequestStatus(UnsignedInteger32 requestId)
Verify that an OK status has been returned for a request id.
|
OutputStream |
SftpClientTask.getOutputStream(String remotefile)
Create an OutputStream for writing to a remote file.
|
SftpFile |
SftpFile.getParent()
Get the parent of the current file.
|
int |
SftpClientTask.getRemoteEOL() |
String |
SftpClientTask.getRemoteNewline() |
String |
AbstractSftpTask.getSymbolicLinkTarget(String linkpath)
Get the target path of a symbolic link.
|
long |
DirectoryOperation.getTransferSize()
Get the total number of bytes that this operation will transfer
|
boolean |
SftpFileAttributes.isAppendOnly() |
boolean |
SftpFileAttributes.isArchive() |
boolean |
SftpFileAttributes.isAttributeBitSet(long attributeBit) |
boolean |
SftpFile.isBlock()
Determine whether the file is pointing to a block special file.
|
boolean |
SftpFileAttributes.isCaseInsensitive() |
boolean |
SftpFile.isCharacter()
Determine whether the file is pointing to a character mode device.
|
boolean |
SftpFileAttributes.isCompressed() |
boolean |
SftpFile.isDirectory()
Determine whether the file object is pointing to a directory.
|
boolean |
SftpClientTask.isDirectoryOrLinkedDirectory(SftpFile file)
Determine whether the file object is pointing to a symbolic link that is
pointing to a directory.
|
boolean |
SftpFileAttributes.isEncrypted() |
boolean |
SftpFile.isFifo()
Determine whether the file is pointing to a pipe.
|
boolean |
SftpFile.isFile()
Determine whether the file object is pointing to a file.
|
boolean |
SftpFileAttributes.isHidden() |
boolean |
SftpFileAttributes.isImmutable() |
boolean |
SftpFile.isLink()
Determine whether the file object is a symbolic link.
|
boolean |
SftpFileAttributes.isReadOnly() |
boolean |
SftpFile.isSocket()
Determine whether the file is pointing to a socket.
|
boolean |
SftpFileAttributes.isSparse() |
boolean |
SftpFileAttributes.isSync() |
boolean |
SftpFileAttributes.isSystem() |
void |
SftpClientTask.lcd(String path)
Changes the local working directory.
|
int |
AbstractSftpTask.listChildren(SftpFile file,
Vector<SftpFile> children)
List the children of a directory.
|
void |
AbstractSftpTask.lockFile(byte[] handle,
long offset,
long length,
int lockFlags) |
SftpFile[] |
SftpClientTask.ls()
List the contents of the current remote working directory.
|
SftpFile[] |
SftpClientTask.ls(String path)
List the contents remote directory.
|
void |
AbstractSftpTask.makeDirectory(String path)
Make a directory.
|
void |
AbstractSftpTask.makeDirectory(String path,
SftpFileAttributes attrs)
Make a directory.
|
String[] |
RegularExpressionMatching.matchFileNamesWithPattern(File[] files,
String fileNameRegExp)
returns each of the files that match the pattern fileNameRegExp
|
String[] |
NoRegExpMatching.matchFileNamesWithPattern(File[] files,
String fileNameRegExp)
opens and returns the requested filename string
|
SftpFile[] |
RegularExpressionMatching.matchFilesWithPattern(SftpFile[] files,
String fileNameRegExp)
returns each of the SftpFiles that match the pattern fileNameRegExp
|
SftpFile[] |
Perl5RegExpMatching.matchFilesWithPattern(SftpFile[] files,
String fileNameRegExp)
compiles fileNameRegExp into a regular expression and pattern
matches on each file's name, and returns those that match.
|
SftpFile[] |
NoRegExpMatching.matchFilesWithPattern(SftpFile[] files,
String fileNameRegExp)
returns files
|
SftpFile[] |
GlobRegExpMatching.matchFilesWithPattern(SftpFile[] files,
String fileNameRegExp)
compiles fileNameRegExp into a regular expression and pattern
matches on each file's name, and returns those that match.
|
SftpFile[] |
SftpClientTask.matchRemoteFiles(String remote)
Called by getFileMatches() to do regular expression pattern matching on
the files in 'remote''s parent directory.
|
void |
SftpClientTask.mkdir(String dir)
Creates a new directory on the remote server.
|
void |
SftpClientTask.mkdirs(String dir)
Create a directory or set of directories.
|
SftpFile |
AbstractSftpTask.openDirectory(String path)
Open a directory.
|
SftpFile |
SftpClientTask.openFile(String fileName) |
SftpFile |
AbstractSftpTask.openFile(String absolutePath,
int flags)
Open a file.
|
SftpFile |
AbstractSftpTask.openFile(String absolutePath,
int flags,
SftpFileAttributes attrs)
Open a file.
|
SftpFile |
AbstractSftpTask.openFileVersion5(String absolutePath,
int flags,
int accessFlags,
SftpFileAttributes attrs) |
void |
AbstractSftpTask.performOptimizedRead(byte[] handle,
long length,
int blocksize,
OutputStream out,
int outstandingRequests,
FileTransferProgress progress)
Performs an optimized read of a file through use of asynchronous
messages.
|
void |
AbstractSftpTask.performOptimizedRead(byte[] handle,
long length,
int blocksize,
OutputStream out,
int outstandingRequests,
FileTransferProgress progress,
long position)
Performs an optimized read of a file through use of asynchronous
messages.
|
void |
AbstractSftpTask.performOptimizedWrite(byte[] handle,
int blocksize,
int outstandingRequests,
InputStream in,
int buffersize,
FileTransferProgress progress)
Performs an optimized write of a file through asynchronous messaging and
through buffering the local file into memory.
|
void |
AbstractSftpTask.performOptimizedWrite(byte[] handle,
int blocksize,
int outstandingRequests,
InputStream in,
int buffersize,
FileTransferProgress progress,
long position)
Performs an optimized write of a file through asynchronous messaging and
through buffering the local file into memory.
|
void |
AbstractSftpTask.performSynchronousRead(byte[] handle,
int blocksize,
OutputStream out,
FileTransferProgress progress,
long position)
Perform a synchronous read of a file from the remote file system.
|
UnsignedInteger32 |
AbstractSftpTask.postReadRequest(byte[] handle,
long offset,
int len)
Post a read request to the server and return the request id; this is used
to optimize file downloads.
|
UnsignedInteger32 |
AbstractSftpTask.postWriteRequest(byte[] handle,
long position,
byte[] data,
int off,
int len)
Send a write request for an open file but do not wait for the response
from the server.
|
void |
SftpClientTask.put(InputStream in,
String remote)
Upload the contents of an InputStream to the remote computer.
|
void |
SftpClientTask.put(InputStream in,
String remote,
FileTransferProgress progress)
Upload a file to the remote computer reading from the specified
InputStream . |
void |
SftpClientTask.put(InputStream in,
String remote,
FileTransferProgress progress,
long position) |
void |
SftpClientTask.put(InputStream in,
String remote,
long position)
Upload the contents of an InputStream to the remote computer.
|
void |
SftpClientTask.put(String local)
Upload a file to the remote computer
|
void |
SftpClientTask.put(String local,
boolean resume)
Upload a file to the remote computer
|
void |
SftpClientTask.put(String local,
FileTransferProgress progress)
Upload a file to the remote computer.
|
void |
SftpClientTask.put(String local,
FileTransferProgress progress,
boolean resume)
Upload a file to the remote computer.
|
void |
SftpClientTask.put(String local,
String remote)
Upload a file to the remote computer
|
void |
SftpClientTask.put(String local,
String remote,
boolean resume)
Upload a file to the remote computer
|
void |
SftpClientTask.put(String local,
String remote,
FileTransferProgress progress)
Upload a file to the remote computer.
|
void |
SftpClientTask.put(String local,
String remote,
FileTransferProgress progress,
boolean resume)
Upload a file to the remote computer.
|
void |
SftpClientTask.putFiles(String local)
Upload the contents of an InputStream to the remote computer.
|
void |
SftpClientTask.putFiles(String local,
boolean resume)
Upload files to the remote computer
|
void |
SftpClientTask.putFiles(String local,
FileTransferProgress progress)
Upload files to the remote computer
|
void |
SftpClientTask.putFiles(String local,
FileTransferProgress progress,
boolean resume)
Upload files to the remote computer
|
void |
SftpClientTask.putFiles(String local,
String remote)
Upload files to the remote computer
|
void |
SftpClientTask.putFiles(String local,
String remote,
boolean resume)
Upload files to the remote computer
|
void |
SftpClientTask.putFiles(String local,
String remote,
FileTransferProgress progress)
Upload files to the remote computer.
|
void |
SftpClientTask.putFiles(String local,
String remote,
FileTransferProgress progress,
boolean resume)
make local copies of some of the variables, then call putfilematches,
which calls "put" on each file that matches the regexp local.
|
int |
AbstractSftpTask.readFile(byte[] handle,
UnsignedInteger64 offset,
byte[] output,
int off,
int len)
Read a block of data from an open file.
|
void |
AbstractSftpTask.recurseMakeDirectory(String path)
Recurse through a hierarchy of directories creating them as necessary.
|
void |
AbstractSftpTask.removeDirectory(String path)
Remove an empty directory.
|
void |
AbstractSftpTask.removeFile(String filename)
Remove a file.
|
void |
SftpClientTask.rename(String oldpath,
String newpath)
Rename a file on the remote computer.
|
void |
AbstractSftpTask.renameFile(String oldpath,
String newpath)
Rename an existing file.
|
void |
AbstractSftpTask.renameFile(String oldpath,
String newpath,
int flags) |
void |
SftpClientTask.rm(String path)
Remove a file or directory from the remote computer.
|
void |
SftpClientTask.rm(String path,
boolean force,
boolean recurse)
Remove a file or directory on the remote computer with options to force
deletion of existing files and recursion.
|
SftpMessage |
AbstractSftpTask.sendExtensionMessage(String request,
byte[] requestData)
Send an extension message and return the response.
|
void |
SftpFileAttributes.setAppendOnly(boolean value) |
void |
SftpFileAttributes.setArchive(boolean value) |
void |
AbstractSftpTask.setAttributes(SftpFile file,
SftpFileAttributes attrs)
Sets the attributes of a file.
|
void |
AbstractSftpTask.setAttributes(String path,
SftpFileAttributes attrs)
Sets the attributes of a file.
|
void |
SftpFileAttributes.setCaseSensitive(boolean value) |
void |
SftpFileAttributes.setCompressed(boolean value) |
void |
SftpFileAttributes.setEncrypted(boolean value) |
void |
SftpFileAttributes.setHidden(boolean value) |
void |
SftpFileAttributes.setImmutable(boolean value) |
void |
SftpFileAttributes.setReadOnly(boolean value) |
void |
SftpFileAttributes.setSparse(boolean value) |
void |
SftpFileAttributes.setSync(boolean value) |
void |
SftpFileAttributes.setSystem(boolean value) |
SftpFileAttributes |
SftpClientTask.stat(String path)
Returns the attributes of the file from the remote computer.
|
SftpFileAttributes |
SftpClientTask.statLink(String path)
Returns the attributes of the link from the remote computer.
|
void |
SftpClientTask.symlink(String path,
String link)
Create a symbolic link on the remote computer.
|
void |
AbstractSftpTask.unlockFile(byte[] handle,
long offset,
long length) |
boolean |
SftpClientTask.verifyFiles(String localFile,
String remoteFile)
Verify a local and remote file.
|
boolean |
SftpClientTask.verifyFiles(String localFile,
String remoteFile,
long offset,
long length)
Verify a local and remote file.
|
void |
AbstractSftpTask.writeFile(byte[] handle,
UnsignedInteger64 offset,
byte[] data,
int off,
int len)
Write a block of data to an open file.
|
Constructor and Description |
---|
SftpFileInputStream(SftpFile file) |
SftpFileInputStream(SftpFile file,
long position)
Creates a new SftpFileInputStream object.
|
SftpFileOutputStream(SftpFile file)
Creates a new SftpFileOutputStream object.
|
Copyright © 2016. All rights reserved.