Package pyGlobus :: Module replicaManagement :: Class SessionAttr
[show private | hide private]
[frames | no frames]

Class SessionAttr


The main interface to the replica management session attribute module.

t provides get and set methods for all of the various handle specific attributes, and hides the underlying memory management.
Method Summary
  __init__(self, handle)
Construct an instance.
  __del__(self)
Destroys an instance.
  copy(self)
Copy the session attributes.
  get_caching(self)
Get the catalog connection caching behavior.
  get_ftp_handleattr(self)
Get the GridFTP handle attributes.
  get_ftp_update_frequency(self)
Get the rollback and restart information update frequency.
  get_handle(self)
Return the underlying replica management handle attr handle.
  get_third_party_transfer(self)
Get the catalog connection third_party_transfer behavior.
  set_caching(self, caching)
Set the catalog connection caching behavior.
  set_ftp_handleattr(self, ftpAttr)
Set the GridFTP handle attributes.
  set_ftp_update_frequency(self, frequency)
Set the rollback and restart information update frequency.
  set_third_party_transfer(self, third_party_transfer)
Set whether to initiate an FTP third party transfer or to buffer the transfer locally.

Method Details

__init__(self, handle=None)
(Constructor)

Construct an instance.

This will activate the globus_replica_management_module, and create the session attr handle..
Parameters:
handle - A SWIG'ized pointer to a globus_replica_management_handleattr.
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to activate the module, or create the attribute.

__del__(self)
(Destructor)

Destroys an instance.

It will close the connection, and deactivate the globus_replica_management module, and delete the handle.
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to destroy the module. This exception can't be caught, and should never happend. It's there mainly for debugging if it does happen. :-)

copy(self)

Copy the session attributes.
Returns:

A new SessionAttr instance with the same setting as self.

**Raisess**

A SessionAttrException is thrown if unable to copy the attr.

get_caching(self)

Get the catalog connection caching behavior.
Returns:
A boolean, true if caching is enable, false otherwise.
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to get the caching behavior.

get_ftp_handleattr(self)

Get the GridFTP handle attributes.

These attributes are used when initializing the GridFTP handle.
Returns:
A HandleAttr instance.
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to get the ftp handleattr.

get_ftp_update_frequency(self)

Get the rollback and restart information update frequency.
Returns:
how often the rollback and restart information is generated during a transfer is pushed out to the rollback and restart information entry, expressed as a multiple of 5 second intervals
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to get the update frequency.

get_handle(self)

Return the underlying replica management handle attr handle.
Returns:
A string containing the pointer.

Warning: This handle is only valid as long as this object exists. When

get_third_party_transfer(self)

Get the catalog connection third_party_transfer behavior.
Returns:
A boolean, true if third_party_transfer is enable, false otherwise.
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to get the third_party_transfer behavior.

set_caching(self, caching)

Set the catalog connection caching behavior.
Parameters:
caching - boolean, whether to enable caching.
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to set the caching behavior.

set_ftp_handleattr(self, ftpAttr)

Set the GridFTP handle attributes.

These attributes are used when initializing the GridFTP handle.
Parameters:
ftpAttr - A HandleAttr instance.
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to set the ftp handleattr.

set_ftp_update_frequency(self, frequency)

Set the rollback and restart information update frequency.
Parameters:
frequency - how often the rollback and restart information is generated during a transfer is pushed out to the rollback and restart information entry, expressed as a multiple of 5 second intervals
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to set the update frequency.

set_third_party_transfer(self, third_party_transfer)

Set whether to initiate an FTP third party transfer or to buffer the transfer locally.

he default is to use third party transfer.
Parameters:
third_party_transfer - boolean, whether to enable third_party_transfer.
Raises:
SessionAttrException - A SessionAttrException is thrown if unable to set the third_party_transfer behavior.

Generated by Epydoc 2.0 on Mon Oct 13 13:47:23 2003 http://epydoc.sf.net