getAttrs(self, path, followLinks)

Return the attributes for the given path.

path is the path to return attributes for as a string. followLinks is a boolean. if it is True, follow symbolic links and return attributes for the real path at the base. if it is False, return attributes for the specified path.

gotVersion(self, otherVersion, extData)

Called when the client sends their version info.

otherVersion is an integer representing the version of the SFTP protocol they are claiming. extData is a dictionary of extended_name : extended_data items. These items are sent by the client to indicate additional features.

makeDirectory(self, path, attrs)

Make a directory.

path is the name of the directory to create as a string. attrs is a dictionary of attributes to create the directory with. It's meaning is the same as the attrs in the openFile method.

makeLink(self, linkPath, targetPath)

Create a symbolic link.

linkPath is is the pathname of the symlink as a string targetPath is the path of the target of the link as a string.

openDirectory(self, path)

Open a directory for scanning.

path is the directory to open.

This method returns an iterable object that has a close() method, or a Deferred that is called back with same.

The close() method is called when the client is finished reading from the directory. At this point, the iterable will no longer be used.

The iterable should return triples of the form (filename, longname, attrs) or Deferreds that return the same. The sequence must support __getitem__, but otherwise may be any 'sequence-like' object.

filename is the name of the file relative to the directory. logname is an expanded format of the filename. The recommended format is: -rwxr-xr-x 1 mjos staff 348911 Mar 25 14:29 t-filexfer 1234567890 123 12345678 12345678 12345678 123456789012

The first line is sample output, the second is the length of the field. The fields are: permissions, link count, user owner, group owner, size in bytes, modification time.

openFile(self, filename, flags, attrs)

Called when the clients asks to open a file.

filename is a string representing the file to open.

flags is a integer of the flags to open the file with, ORed together.
The flags and their values are listed at the bottom of this file.

attrs is a list of attributes to open the file with.  It is a
dictionary, consisting of 0 or more keys.  The possible keys are:
    size: the size of the file in bytes
    uid: the user ID of the file as an integer
    gid: the group ID of the file as an integer
    permissions: the permissions of the file with as an integer.
    the bit representation of this field is defined by POSIX.
    atime: the access time of the file as seconds since the epoch.
    mtime: the modification time of the file as seconds since the epoch.
    ext_*: extended attributes.  The server is not required to
    understand this, but it may.

NOTE: there is no way to indicate text or binary files.  it is up
to the SFTP client to deal with this.

This method returns an object that meets the ISFTPFile interface.
Alternatively, it can return a Deferred that will be called back
with the object.

readLink(self, path)

Find the root of a set of symbolic links.

path is the path of the symlink to read.

realPath(self, path)

Convert any path to an absolute path.

path is the path to convert as a string.

removeDirectory(self, path)

Remove a directory (non-recursively)

path is the directory to remove.

It is an error to remove a directory that has files or directories in it.

removeFile(self, filename)

Remove the given file.

filename is the name of the file as a string.

renameFile(self, oldpath, newpath)

Rename the given file.

oldpath is the current location of the file. newpath is the new file name.

setAttrs(self, path, attrs)

Set the attributes for the path.

path is the path to set attributes for as a string. attrs is a idctionary in the same format as the attrs argument to openFile.