Table of Contents

Class: BaseFtpClient ./pyGlobus/ftpClient.py
Methods   
__init__
abort
add_plugin
cache_url_state
delete
exists
flush_url_state
get
get_handle
get_user_data
list
mkdir
modification_time
move
partial_get
partial_put
partial_third_party_transfer
put
remove_plugin
rmdir
set_user_data
size
third_party_transfer
verbose_list
  __init__ 
__init__ ( self )

Exceptions   
RuntimeError, "Class can not be initialized"
  abort 
abort ( self )

Abort the current operation.

Raises:

A FtpClientException is thrown if an error occurs while aborting the current operation.

Exceptions   
ex
  add_plugin 
add_plugin ( self,  plugin )

Add a plugin to an FTP client handle.

This function adds a plugin to an FTP client handle after it has been created. Plugins may be added to an ftp client handle whenever an operation is not in progress. The plugin will be appended to the list of plugins present in the handle, and will be invoked during any subsequent operations processed with this handle.

Only one instance of a particular plugin may be added to a particular handle.

Arguments

plugin A Plugin class.

Raises

A FtpClientException is thrown if unable to add the plugin.

Exceptions   
ex
  cache_url_state 
cache_url_state ( self,  url )

Cache the connection to the FTP server.

When the url is cached, the library will not close the connection after completing an operation.

Arguments:

  • url The URL of the server to cache.

Raises:

A FtpClientException is thrown if unable to cache the url state.

Exceptions   
ex
  delete 
delete (
        self,
        url,
        attr,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "delete method has not been implemented in child class"
  exists 
exists (
        self,
        url,
        callback,
        arg,
        attr=None,
        )

Exceptions   
NotImplementedError, "exists method has not been implemented in child class"
  flush_url_state 
flush_url_state ( self,  url )

Remove the url from the connection cache.

If an idle connection to the server exists, it will be closed.

Arguments:

  • url The URL to remove from the cache.

Raises:

A FtpClientException is thrown if unable to flush the url state.

Exceptions   
ex
  get 
get (
        self,
        dest_file,
        url,
        attr,
        marker,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "get method has not been implemented in child class"
  get_handle 
get_handle ( self )

Return the underlying ftp client handle.

XXX This handle is only valid as long as this object exists. When the object is destroyed, the memory this handle points to is freed.

Returns:

A string containing the pointer.

  get_user_data 
get_user_data ( self )

Returns the user data associated with the handle.

Access to this data is not synchronized.

Returns:

The data set with the set_user_data method.

Raises:

An FtpClientException is thrown if unable to get the data.

Exceptions   
ex
  list 
list (
        self,
        url,
        attr,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "list method has not been implemented in child class"
  mkdir 
mkdir (
        self,
        url,
        attr,
        )

Exceptions   
NotImplementedError, "method mkdir has not been implemented in child class"
  modification_time 
modification_time (
        self,
        url,
        callback,
        arg,
        attr=None,
        )

Exceptions   
NotImplementedError, " modification_time method has not been implemented in child class"
  move 
move (
        self,
        srcUrl,
        destUrl,
        attr,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "move method has not been implemented in child class"
  partial_get 
partial_get (
        self,
        dest_file,
        url,
        offset,
        endOffset,
        attr,
        marker,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "partial_get method has not been implemented in child class"
  partial_put 
partial_put (
        self,
        src_file,
        url,
        offset,
        endOffset,
        attr,
        marker,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "partial_put method has not been implemented in child class"
  partial_third_party_transfer 
partial_third_party_transfer (
        self,
        srcUrl,
        destUrl,
        offset,
        endOffset,
        srcAttr,
        destAttr,
        marker,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "partial_third_party_transfer method has not been implemented in child class"
  put 
put (
        self,
        src_file,
        url,
        attr,
        marker,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "put method has not been implemented in child class"
  remove_plugin 
remove_plugin ( self,  plugin )

Remove a plugin to an FTP client handle.

This function removes a plugin from an FTP client handle after it has been created. Plugins may be removed from an ftp client handle whenever an operation is not in progress. The plugin will be removed from the list of plugins, and will not be used during any subsequent operations processed with this handle.

Arguments

plugin A Plugin class.

Raises

A FtpClientException is thrown if unable to remove the plugin.

Exceptions   
ex
  rmdir 
rmdir (
        self,
        url,
        attr,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "rmdir method has not been implemented in child class"
  set_user_data 
set_user_data ( self,  data )

Associate some data with the handle.

Access to this data is not synchronized.

Arguments:

  • data The user data to set.

Raises:

An FtpClientException is thrown if unable to set the data.

Exceptions   
ex
  size 
size (
        self,
        url,
        callback,
        arg,
        attr=None,
        )

Exceptions   
NotImplementedError, "size method has not been implemented in child class"
  third_party_transfer 
third_party_transfer (
        self,
        srcUrl,
        destUrl,
        srcAttr,
        destAttr,
        marker,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "third_party_transfer method has not been implemented in child class"
  verbose_list 
verbose_list (
        self,
        url,
        attr,
        callback,
        arg,
        )

Exceptions   
NotImplementedError, "verbose_list method has not been implemented in child class"

Table of Contents

This document was automatically generated on Tue Feb 4 16:47:03 2003 by HappyDoc version 2.1