A C D E F G H I L M N O P R S T U

A

AbortedException - exception com.ssh.sft.AbortedException.
Signals a user-requested abortion of an SFT operation.
AbortedException(String) - Constructor for class com.ssh.sft.AbortedException
 
AbstractPolicy - class com.ssh.sft.AbstractPolicy.
A default implementation for policies.
AbstractPolicy() - Constructor for class com.ssh.sft.AbstractPolicy
 
AuthenticationException - exception com.ssh.sft.AuthenticationException.
Signals that there has been a problem during the Authentication process
AuthenticationException(String) - Constructor for class com.ssh.sft.AuthenticationException
 
Authenticator - interface com.ssh.sft.Authenticator.
The Dialog during Authentication process.
abort() - Method in class com.ssh.sft.Session
Aborts the session.
access_time - Variable in class com.ssh.sft.FileAttributes
The time of the last access to the file.
authenticate(String) - Method in interface com.ssh.sft.Authenticator
Respond to an authentication query.

C

CharConversion - class com.ssh.sft.CharConversion.
Character conversion specifiers.
com.ssh.sft - package com.ssh.sft
Provides classes for manipulating files on remote hosts via the Secure File Transfer protocol.
complete(Location, SftException) - Method in class com.ssh.sft.AbstractPolicy
 
complete(Location, SftException) - Method in interface com.ssh.sft.Policies.Dir
 
computeHash(String, long, long) - Method in class com.ssh.sft.RegularFile
Get hash of the File represented by this object.
computeMD5() - Method in class com.ssh.sft.RegularFile
Get md5 hash of the File represented by this object.
copy(Location) - Method in class com.ssh.sft.Directory
Copies the directory and its contents recursively.
copy(Location, Policies.CopyDir) - Method in class com.ssh.sft.Directory
Copies the directory and its contents recursively using the specified policy.
copy(Location, Policies.CopyDir, ProgressFactory) - Method in class com.ssh.sft.Directory
Copies the directory and its contents recursively using the specified policy and progresslistener factory.
copy(Location) - Method in class com.ssh.sft.File
Copies the file represented by this object to the destination specified.
copy(Location, ProgressListener) - Method in class com.ssh.sft.File
Copies the file represented by this object to the destination specified, using the progress listener.
copy() - Method in class com.ssh.sft.FileAttributes
Returns a new FileAttributes object with the same fields as this one.
createDir(Location) - Method in class com.ssh.sft.AbstractPolicy
 
createDir(Location) - Method in interface com.ssh.sft.Policies.CopyDir
 
createDirectory(FileAttributes) - Method in class com.ssh.sft.Location
Creates a new directory at this location.
createFile() - Method in class com.ssh.sft.Location
Creates a new file at this location, initially empty.
createProgress(File, Location) - Method in interface com.ssh.sft.ProgressFactory
Create a new progress listener for a file operation.
createSymLink(Location) - Method in class com.ssh.sft.Location
Creates a new symbolic link at this location.
create_time - Variable in class com.ssh.sft.FileAttributes
The time of creation of the file.

D

DOS - Static variable in class com.ssh.sft.CharConversion
The character conversion for DOS files.
DirHandle - class com.ssh.sft.DirHandle.
An iterator over directory contents.
Directory - class com.ssh.sft.Directory.
A remote directory.
delete() - Method in class com.ssh.sft.SshSftParamStruct_character
 
delete() - Method in class com.ssh.sft.SshSftParamStruct_character_reserved
 
delete() - Method in class com.ssh.sft.SshSftParamStruct_character_set
 
delete() - Method in class com.ssh.sft.SshSftParamStruct_extra
 
delete() - Method in class com.ssh.sft.SshSftParamStruct_extra_audit
 
delete() - Method in class com.ssh.sft.SshSftParamStruct_extra_reserved
 

E

enterDir(Directory) - Method in class com.ssh.sft.AbstractPolicy
 
enterDir(Directory) - Method in interface com.ssh.sft.Policies.Dir
Invoked when a directory is about to be entered and its contents are to be processed.

F

File - class com.ssh.sft.File.
A remote file.
FileAttributes - class com.ssh.sft.FileAttributes.
A collection of file attributes.
FileAttributes() - Constructor for class com.ssh.sft.FileAttributes
Constructs a new FileAttributes object with all of the attributes initially unset.
finish() - Method in interface com.ssh.sft.ProgressListener
Notify the listener that the operation has now finished.
fromSource(File) - Method in class com.ssh.sft.AbstractPolicy
 
fromSource(File) - Method in interface com.ssh.sft.Policies.Copy
Invoked to specify the type of CharConversion to use to read from the given src file.

G

getAttributes() - Method in class com.ssh.sft.File
Returns a copy of the attributes of FileAttributes of this file
getCanonicalPath() - Method in class com.ssh.sft.Location
Resolve absolute path of this location.
getErrorCode() - Method in class com.ssh.sft.SftException
Returns the error code of this exception.
getFile(String) - Method in class com.ssh.sft.Directory
Returns a File object representing the file at a named path.
getFile() - Method in class com.ssh.sft.Location
Returns a representation of the file at this location.
getFile(String) - Method in class com.ssh.sft.Session
Returns a File object representing the file at the named path.
getGroup() - Method in class com.ssh.sft.File
Returns the group of the file represented by this object.
getLocation(String) - Method in class com.ssh.sft.Directory
Returns the Location of this file.
getLocation() - Method in class com.ssh.sft.File
Returns the Location of this file.
getLocation(String) - Method in class com.ssh.sft.Session
Returns a Location representing the named path.
getLocation(URI) - Method in class com.ssh.sft.Sft
Returns the Location of a given file.
getMessage() - Method in class com.ssh.sft.SftException
Returns the message of this exception.
getOwner() - Method in class com.ssh.sft.File
Returns the owner of the file represented by this object.
getPath() - Method in class com.ssh.sft.File
Returns the path to the file represented by this object.
getPath() - Method in class com.ssh.sft.Location
Returns the path that this location's session uses to access this location.
getProtocolVersion() - Method in class com.ssh.sft.Session
Returns the version of the SFTP protocol that is used in this session for communicating with the SFTP server.
getSession() - Method in class com.ssh.sft.File
Returns the Session used for accessing to this file.
getSession() - Method in class com.ssh.sft.Location
Returns the session that is used to access this location.
getSize() - Method in class com.ssh.sft.File
Returns the size of the file represented by this object.
getURI() - Method in class com.ssh.sft.File
Returns the URI for this File.
getURI() - Method in class com.ssh.sft.Location
Returns the URI that is used to access this location.
getURI() - Method in class com.ssh.sft.Session
Returns the URI for this session's SFTP server.
gid - Variable in class com.ssh.sft.FileAttributes
The group ID of the file.
group - Variable in class com.ssh.sft.FileAttributes
The name of the group of the file.

H

hasNext() - Method in class com.ssh.sft.DirHandle
Tests if there are more directory entries still available.

I

isConnected() - Method in class com.ssh.sft.Session
Checks if the Session is still connected to the server.

L

Location - class com.ssh.sft.Location.
A location for a remote file.
leaveDir(Directory) - Method in class com.ssh.sft.AbstractPolicy
 
leaveDir(Directory) - Method in interface com.ssh.sft.Policies.Dir
Invoked when the recursive processing of a directory has finished.
list(File) - Method in class com.ssh.sft.AbstractPolicy
 
list(File) - Method in interface com.ssh.sft.Policies.Dir
 

M

MAC - Static variable in class com.ssh.sft.CharConversion
The character conversion for MAC files.
modify_time - Variable in class com.ssh.sft.FileAttributes
The time of the last modificaction of the file.
move(Location) - Method in class com.ssh.sft.Directory
Moves the directory and its contents recursively.
move(Location, Policies.MoveDir) - Method in class com.ssh.sft.Directory
Moves the directory and its contents recursively using the specified policy.
move(Location, Policies.MoveDir, ProgressFactory) - Method in class com.ssh.sft.Directory
Moves the directory and its contents recursively using the specified policy and progresslistener factory.
move(Location) - Method in class com.ssh.sft.File
Moves the file represented by this object to the destination specified.

N

NoSuchFileException - exception com.ssh.sft.NoSuchFileException.
Signals that no file existed in a specified location.
NoSuchFileException() - Constructor for class com.ssh.sft.NoSuchFileException
 
next() - Method in class com.ssh.sft.DirHandle
Returns the next entry in this directory.
nextEntry() - Method in class com.ssh.sft.DirHandle
Returns the next entry in this directory.

O

open() - Method in class com.ssh.sft.Directory
Returns an iterator over this directory's entries.
openFile(URI) - Method in class com.ssh.sft.Sft
Returns the File pointed by the URI.
openInput() - Method in class com.ssh.sft.RegularFile
Opens this file and returns an InputStream for reading from the file.
openLocalSession() - Method in class com.ssh.sft.Sft
Opens an SFTP session to the local host as the current user.
openOutput() - Method in class com.ssh.sft.RegularFile
Opens this file and returns an OutputStream for writting to the file.
openRawInput() - Method in class com.ssh.sft.RegularFile
Opens this file and returns an unbuffered InputStream for reading from this file.
openRawOutput() - Method in class com.ssh.sft.RegularFile
Opens this file and returns an unbuffered OutputStream for writting to this file.
openSession(URI) - Method in class com.ssh.sft.Sft
Opens a new SFTP session using the username, host and port specified in the URI.
overwrite(File, File) - Method in class com.ssh.sft.AbstractPolicy
 
overwrite(File, File) - Method in interface com.ssh.sft.Policies.Copy
Invoked when an existing file is about to be overwritten.
owner - Variable in class com.ssh.sft.FileAttributes
The name of the owner of the file.

P

PermissionDeniedException - exception com.ssh.sft.PermissionDeniedException.
Signals that the user does not have the permissions required for performing a particular file operation.
PermissionDeniedException() - Constructor for class com.ssh.sft.PermissionDeniedException
 
Policies - class com.ssh.sft.Policies.
Interfaces for interactive queries and notifications from the Secure File Transfer service.
Policies() - Constructor for class com.ssh.sft.Policies
 
Policies.All - interface com.ssh.sft.Policies.All.
The universal policy interface.
Policies.Copy - interface com.ssh.sft.Policies.Copy.
The policy interface for copying files.
Policies.CopyDir - interface com.ssh.sft.Policies.CopyDir.
The policy interface for recursive copying of a directory.
Policies.Dir - interface com.ssh.sft.Policies.Dir.
The policy interface for recursive operations on directories.
Policies.Move - interface com.ssh.sft.Policies.Move.
The policy interface for moving files.
Policies.MoveDir - interface com.ssh.sft.Policies.MoveDir.
The policy interface for recursive moving of a directory.
Policies.Remove - interface com.ssh.sft.Policies.Remove.
The policy interface for removing files.
Policies.RemoveDir - interface com.ssh.sft.Policies.RemoveDir.
The policy interface for recursive removal of a directory.
ProgressFactory - interface com.ssh.sft.ProgressFactory.
The interface for creating new ProgressListener objects during a recursive operation.
ProgressListener - interface com.ssh.sft.ProgressListener.
The listener interface for the progression of a single file operation.
permissions - Variable in class com.ssh.sft.FileAttributes
The permissions of the file as a standard UNIX mode value.
progress(long) - Method in interface com.ssh.sft.ProgressListener
Notify the listener that progress has been made in the operation.

R

RegularFile - class com.ssh.sft.RegularFile.
A regular file.
RegularFile() - Constructor for class com.ssh.sft.RegularFile
 
readLink() - Method in class com.ssh.sft.SymLink
Returns the Location that this link references.
remove(File) - Method in class com.ssh.sft.AbstractPolicy
 
remove() - Method in class com.ssh.sft.DirHandle
Removes from this directory the last file that was returned by DirHandle.next() or DirHandle.nextEntry().
remove() - Method in class com.ssh.sft.Directory
Removes the directory and its contents recursively.
remove(Policies.RemoveDir) - Method in class com.ssh.sft.Directory
Removes the directory and its contents recursively using the specified policy.
remove() - Method in class com.ssh.sft.File
Removes the file that is represented by this object.
remove(File) - Method in interface com.ssh.sft.Policies.Remove
Invoked when a file is about to be removed.
removeDir(Directory) - Method in class com.ssh.sft.AbstractPolicy
 
removeDir(Directory) - Method in interface com.ssh.sft.Policies.RemoveDir
 
rename(Location) - Method in class com.ssh.sft.File
Renames the file represented by this object.
report(File, File, int, String) - Method in class com.ssh.sft.AbstractPolicy
 
report(File, int, String) - Method in class com.ssh.sft.AbstractPolicy
 
report(File, File, int, String) - Method in interface com.ssh.sft.Policies.Copy
Invoked when an informative message related to the copy wants to be passed to the application.
report(File, int, String) - Method in interface com.ssh.sft.Policies.Remove
Invoked when an informative message related to the operation wants to be passed to the application.
resolve(String) - Method in class com.ssh.sft.Location
Constructs a new Location by parsing the given parth and then resolving it against this Location object.
resume() - Method in class com.ssh.sft.Session
Resumes the session.

S

SSH_SFT_API_VERSION - Static variable in interface com.ssh.sft.SftLibConstants
 
SSH_SFT_DIR_RECURSIVE - Static variable in interface com.ssh.sft.SftLibConstants
 
SSH_SFT_HASH_MAX_BLOCK_SIZE - Static variable in interface com.ssh.sft.SftLibConstants
 
SSH_SFT_HASH_MAX_ITERATIONS - Static variable in interface com.ssh.sft.SftLibConstants
 
SSH_SFT_HASH_MIN_BLOCK_SIZE - Static variable in interface com.ssh.sft.SftLibConstants
 
SSH_SFT_REQUEST_MAX_NUM - Static variable in interface com.ssh.sft.SftLibConstants
 
SSH_SFT_REQUEST_MAX_SIZE - Static variable in interface com.ssh.sft.SftLibConstants
 
SWIGTYPE_p_SshSecShBroker - class com.ssh.sft.SWIGTYPE_p_SshSecShBroker.
 
SWIGTYPE_p_SshWindowHandle - class com.ssh.sft.SWIGTYPE_p_SshWindowHandle.
 
Session - class com.ssh.sft.Session.
An ongoing SFTP session in a remote or local host.
Sft - class com.ssh.sft.Sft.
The Secure File Transfer service.
Sft() - Constructor for class com.ssh.sft.Sft
Creates a new instance of the SFT service.
Sft(String, Authenticator) - Constructor for class com.ssh.sft.Sft
Creates a new instance of the SFT service.
SftEOFException - exception com.ssh.sft.SftEOFException.
Signals that the end of a file has been reached.
SftEOFException() - Constructor for class com.ssh.sft.SftEOFException
 
SftException - exception com.ssh.sft.SftException.
An exception that is thrown by the Secure File Transfer service.
SftLibConstants - interface com.ssh.sft.SftLibConstants.
 
SshSftParamStruct_character - class com.ssh.sft.SshSftParamStruct_character.
 
SshSftParamStruct_character_reserved - class com.ssh.sft.SshSftParamStruct_character_reserved.
 
SshSftParamStruct_character_set - class com.ssh.sft.SshSftParamStruct_character_set.
 
SshSftParamStruct_extra - class com.ssh.sft.SshSftParamStruct_extra.
 
SshSftParamStruct_extra_audit - class com.ssh.sft.SshSftParamStruct_extra_audit.
 
SshSftParamStruct_extra_reserved - class com.ssh.sft.SshSftParamStruct_extra_reserved.
 
SymLink - class com.ssh.sft.SymLink.
A symbolic link.
SymLink() - Constructor for class com.ssh.sft.SymLink
 
setAttributes(FileAttributes) - Method in class com.ssh.sft.File
Sets the file attributes to this file.
setstat(long, int, Policies.Dir) - Method in class com.ssh.sft.Directory
Sets the permissions of all files under this directory.
size - Variable in class com.ssh.sft.FileAttributes
The size of the file in bytes.
start(File, Location) - Method in class com.ssh.sft.AbstractPolicy
 
start(File, Location) - Method in interface com.ssh.sft.Policies.Copy
Invoked when a file copy operation from src to dst is started.
suspend() - Method in class com.ssh.sft.Session
Suspends the session.

T

toDest(Location) - Method in class com.ssh.sft.AbstractPolicy
 
toDest(Location) - Method in interface com.ssh.sft.Policies.Copy
Invoked to specify the type of CharConversion to use to write to the given destination
toString() - Method in class com.ssh.sft.CharConversion
Returns the name of the conversion.
toString() - Method in class com.ssh.sft.SftException
Returns a String with the class, error code and the message of the exception.
traverse(Policies.Dir) - Method in class com.ssh.sft.Directory
Traverses the directory and its contents recursively.
type - Variable in class com.ssh.sft.FileAttributes
The type of the file.

U

UNIX - Static variable in class com.ssh.sft.CharConversion
The character conversion for UNIX files.
uid - Variable in class com.ssh.sft.FileAttributes
The user ID of the file.

A C D E F G H I L M N O P R S T U