Package | Description |
---|---|
com.sshtools.scp |
This package contains a Secure Copy (SCP) engine suitable for the
lightweight J2SSH Maverick API.
|
com.sshtools.sftp |
The base implementation of the SFTP protocol.
|
Modifier and Type | Method and Description |
---|---|
void |
ScpClient.put(String localFile,
String remoteFile,
boolean recursive)
Uploads a local file onto the remote server.
|
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 |
SftpClient.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 |
SftpClient.cdup()
Change the working directory to the parent directory
|
void |
SftpSubsystemChannel.changePermissions(SftpFile file,
int permissions)
Change the permissions of a file.
|
void |
SftpSubsystemChannel.changePermissions(String filename,
int permissions)
Change the permissions of a file.
|
void |
SftpSubsystemChannel.changePermissions(String filename,
String permissions)
Change the permissions of a file.
|
void |
SftpClient.chgrp(String gid,
String path)
Sets the group ID for the file or directory.
|
void |
SftpClient.chmod(int permissions,
String path)
Changes the access permissions or modes of the specified file or
directory.
|
void |
SftpClient.chown(String uid,
String path)
Sets the user ID to owner for the file or directory.
|
void |
SftpFile.close()
Close the file.
|
void |
SftpSubsystemChannel.closeFile(SftpFile file)
Close a file or directory.
|
DirectoryOperation |
SftpClient.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 |
SftpClient.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 |
SftpSubsystemChannel.createSymbolicLink(String targetpath,
String linkpath)
Create a symbolic link.
|
void |
SftpFile.delete()
Delete this file/directory from the remote server.
|
static String |
SftpClient.formatLongname(SftpFile file)
Format a String with the details of the file.
|
SftpFileAttributes |
SftpClient.get(String path)
Download the remote file to the local computer
|
SftpFileAttributes |
SftpClient.get(String path,
boolean resume)
Download the remote file to the local computer
|
SftpFileAttributes |
SftpClient.get(String path,
FileTransferProgress progress)
Download the remote file to the local computer.
|
SftpFileAttributes |
SftpClient.get(String path,
FileTransferProgress progress,
boolean resume)
Download the remote file to the local computer.
|
SftpFileAttributes |
SftpClient.get(String remote,
OutputStream local)
Download the remote file into an OutputStream.
|
SftpFileAttributes |
SftpClient.get(String remote,
OutputStream local,
FileTransferProgress progress)
Download the remote file writing it to the specified
OutputStream . |
SftpFileAttributes |
SftpClient.get(String remote,
OutputStream local,
FileTransferProgress progress,
long position)
Download the remote file writing it to the specified
OutputStream . |
SftpFileAttributes |
SftpClient.get(String remote,
OutputStream local,
long position)
Download the remote file into an OutputStream.
|
SftpFileAttributes |
SftpClient.get(String remote,
String local)
Download the remote file into the local file.
|
SftpFileAttributes |
SftpClient.get(String remote,
String local,
boolean resume)
Download the remote file into the local file.
|
SftpFileAttributes |
SftpClient.get(String remote,
String local,
FileTransferProgress progress)
Download the remote file to the local computer.
|
SftpFileAttributes |
SftpClient.get(String remote,
String local,
FileTransferProgress progress,
boolean resume)
Download the remote file to the local computer.
|
String |
SftpSubsystemChannel.getAbsolutePath(SftpFile file)
Get the absolute path of a file.
|
String |
SftpSubsystemChannel.getAbsolutePath(String path)
Get the absolute path of a file.
|
String |
SftpClient.getAbsolutePath(String path)
Get the absolute path for a file.
|
SftpFileAttributes |
SftpFile.getAttributes()
Get the files attributes.
|
SftpFileAttributes |
SftpSubsystemChannel.getAttributes(SftpFile file)
Get the attributes of a file.
|
SftpFileAttributes |
SftpSubsystemChannel.getAttributes(String path)
Get the attributes of a file.
|
protected SftpFileAttributes |
SftpSubsystemChannel.getAttributes(String path,
int messageId) |
byte[] |
SftpSubsystemChannel.getCanonicalNewline()
Returns the canonical newline convention in use when reading/writing text
files.
|
String |
SftpSubsystemChannel.getDefaultDirectory()
Gets the users default directory.
|
String |
SftpClient.getDefaultDirectory()
Get the default directory (or HOME directory)
|
SftpFile |
SftpSubsystemChannel.getFile(String path)
Utility method to obtain an
SftpFile instance for a given path. |
SftpFile[] |
SftpClient.getFiles(String remote)
Download the remote files to the local computer
|
SftpFile[] |
SftpClient.getFiles(String remote,
boolean resume)
Download the remote files to the local computer
|
SftpFile[] |
SftpClient.getFiles(String remote,
FileTransferProgress progress)
Download the remote files to the local computer.
|
SftpFile[] |
SftpClient.getFiles(String remote,
FileTransferProgress progress,
boolean resume)
Download the remote files to the local computer.
|
SftpFile[] |
SftpClient.getFiles(String remote,
String local)
Download the remote files into the local file.
|
SftpFile[] |
SftpClient.getFiles(String remote,
String local,
boolean resume)
Download the remote files into the local file.
|
SftpFile[] |
SftpClient.getFiles(String remote,
String local,
FileTransferProgress progress,
boolean resume)
Download the remote file to the local computer.
|
InputStream |
SftpClient.getInputStream(String remotefile)
Create an InputStream for reading a remote file.
|
InputStream |
SftpClient.getInputStream(String remotefile,
long position)
Create an InputStream for reading a remote file.
|
SftpFileAttributes |
SftpSubsystemChannel.getLinkAttributes(String path)
Get the attributes of a file.
|
void |
SftpSubsystemChannel.getOKRequestStatus(UnsignedInteger32 requestId)
Verify that an OK status has been returned for a request id.
|
OutputStream |
SftpClient.getOutputStream(String remotefile)
Create an OutputStream for writing to a remote file.
|
SftpFile |
SftpFile.getParent()
Get the parent of the current file.
|
String |
SftpSubsystemChannel.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 |
SftpFile.isBlock()
Determine whether the file is pointing to a block special file.
|
boolean |
SftpFile.isCharacter()
Determine whether the file is pointing to a character mode device.
|
boolean |
SftpFile.isDirectory()
Determine whether the file object is pointing to a directory.
|
boolean |
SftpClient.isDirectoryOrLinkedDirectory(SftpFile file)
Determine whether the file object is pointing to a symbolic link that is
pointing to a directory.
|
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 |
SftpFile.isLink()
Determine whether the file object is a symbolic link.
|
boolean |
SftpFile.isSocket()
Determine whether the file is pointing to a socket.
|
void |
SftpClient.lcd(String path)
Changes the local working directory.
|
int |
SftpSubsystemChannel.listChildren(SftpFile file,
Vector<SftpFile> children)
List the children of a directory.
|
SftpFile[] |
SftpClient.ls()
List the contents of the current remote working directory.
|
SftpFile[] |
SftpClient.ls(String path)
List the contents remote directory.
|
void |
SftpSubsystemChannel.makeDirectory(String path)
Make a directory.
|
void |
SftpSubsystemChannel.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[] |
SftpClient.matchRemoteFiles(String remote)
Called by getFileMatches() to do regular expression pattern matching on
the files in 'remote''s parent directory.
|
void |
SftpClient.mkdir(String dir)
Creates a new directory on the remote server.
|
void |
SftpClient.mkdirs(String dir)
Create a directory or set of directories.
|
SftpFile |
SftpSubsystemChannel.openDirectory(String path)
Open a directory.
|
SftpFile |
SftpClient.openFile(String fileName) |
SftpFile |
SftpSubsystemChannel.openFile(String absolutePath,
int flags)
Open a file.
|
SftpFile |
SftpSubsystemChannel.openFile(String absolutePath,
int flags,
SftpFileAttributes attrs)
Open a file.
|
void |
SftpSubsystemChannel.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 |
SftpSubsystemChannel.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 |
SftpSubsystemChannel.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 |
SftpSubsystemChannel.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 |
SftpSubsystemChannel.performSynchronousRead(byte[] handle,
int blocksize,
OutputStream out,
FileTransferProgress progress,
long position)
Perform a synchronous read of a file from the remote file system.
|
UnsignedInteger32 |
SftpSubsystemChannel.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 |
SftpSubsystemChannel.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 |
SftpClient.put(InputStream in,
String remote)
Upload the contents of an InputStream to the remote computer.
|
void |
SftpClient.put(InputStream in,
String remote,
FileTransferProgress progress)
Upload a file to the remote computer reading from the specified
InputStream . |
void |
SftpClient.put(InputStream in,
String remote,
FileTransferProgress progress,
long position) |
void |
SftpClient.put(InputStream in,
String remote,
long position)
Upload the contents of an InputStream to the remote computer.
|
void |
SftpClient.put(String local)
Upload a file to the remote computer
|
void |
SftpClient.put(String local,
boolean resume)
Upload a file to the remote computer
|
void |
SftpClient.put(String local,
FileTransferProgress progress)
Upload a file to the remote computer.
|
void |
SftpClient.put(String local,
FileTransferProgress progress,
boolean resume)
Upload a file to the remote computer.
|
void |
SftpClient.put(String local,
String remote)
Upload a file to the remote computer
|
void |
SftpClient.put(String local,
String remote,
boolean resume)
Upload a file to the remote computer
|
void |
SftpClient.put(String local,
String remote,
FileTransferProgress progress)
Upload a file to the remote computer.
|
void |
SftpClient.put(String local,
String remote,
FileTransferProgress progress,
boolean resume)
Upload a file to the remote computer.
|
void |
SftpClient.putFiles(String local)
Upload the contents of an InputStream to the remote computer.
|
void |
SftpClient.putFiles(String local,
boolean resume)
Upload files to the remote computer
|
void |
SftpClient.putFiles(String local,
FileTransferProgress progress)
Upload files to the remote computer
|
void |
SftpClient.putFiles(String local,
FileTransferProgress progress,
boolean resume)
Upload files to the remote computer
|
void |
SftpClient.putFiles(String local,
String remote)
Upload files to the remote computer
|
void |
SftpClient.putFiles(String local,
String remote,
boolean resume)
Upload files to the remote computer
|
void |
SftpClient.putFiles(String local,
String remote,
FileTransferProgress progress)
Upload files to the remote computer.
|
void |
SftpClient.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 |
SftpSubsystemChannel.readFile(byte[] handle,
UnsignedInteger64 offset,
byte[] output,
int off,
int len)
Read a block of data from an open file.
|
void |
SftpSubsystemChannel.recurseMakeDirectory(String path)
Recurse through a hierarchy of directories creating them as necessary.
|
void |
SftpSubsystemChannel.removeDirectory(String path)
Remove an empty directory.
|
void |
SftpSubsystemChannel.removeFile(String filename)
Remove a file.
|
void |
SftpClient.rename(String oldpath,
String newpath)
Rename a file on the remote computer.
|
void |
SftpSubsystemChannel.renameFile(String oldpath,
String newpath)
Rename an existing file.
|
void |
SftpClient.rm(String path)
Remove a file or directory from the remote computer.
|
void |
SftpClient.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 |
SftpSubsystemChannel.sendExtensionMessage(String request,
byte[] requestData)
Send an extension message and return the response.
|
void |
SftpSubsystemChannel.setAttributes(SftpFile file,
SftpFileAttributes attrs)
Sets the attributes of a file.
|
void |
SftpSubsystemChannel.setAttributes(String path,
SftpFileAttributes attrs)
Sets the attributes of a file.
|
SftpFileAttributes |
SftpClient.stat(String path)
Returns the attributes of the file from the remote computer.
|
SftpFileAttributes |
SftpClient.statLink(String path)
Returns the attributes of a link on the remote computer.
|
void |
SftpClient.symlink(String path,
String link)
Create a symbolic link on the remote computer.
|
void |
SftpSubsystemChannel.writeFile(byte[] handle,
UnsignedInteger64 offset,
byte[] data,
int off,
int len)
Write a block of data to an open file.
|
Constructor and Description |
---|
SftpClient(SshClient ssh) |
SftpClient(SshClient ssh,
int Max_Version)
Constructs the SFTP client with a given channel event listener.
|
SftpClient(SshSession session) |
SftpClient(SshSession session,
int Max_Version) |
SftpFileInputStream(SftpFile file) |
SftpFileInputStream(SftpFile file,
long position)
Creates a new SftpFileInputStream object.
|
SftpFileOutputStream(SftpFile file)
Creates a new SftpFileOutputStream object.
|
Copyright © 2014. All rights reserved.