Module rlsClient :: Class RlsClient
[show private | hide private]
[frames | no frames]

Class RlsClient


A class to wrap the RLS client functions
Method Summary
instance of class RlsClient __init__(self, url, cert, key, proxy)
Constructs an instance.
None __del__(self)
Destroy an instance.
integer get_timeout(self)
Get the IO timeout, in seconds, for connecting to servers.
None lrc_add(self, lfn, pfn)
Add a mapping for a PFN to an existing LFN.
dictionary lrc_add_bulk(self, mappingDict)
Add multiple LFN to PFN mappings for existing LFNs.
None lrc_attr_add(self, fn, attr)
Set an attribute value for an entry (LFN or PFN) in the LRC
None lrc_attr_define(self, attr)
Define an attribute in the LRC
None lrc_attr_delete(self, attr, clear)
Delete an attribute definition in the LRC
list lrc_attr_get(self, objtype, name)
Get definitions of attributes from LRC.
None lrc_attr_modify(self, fn, attr)
Modify an attribute value for an entry (LFN or PFN) in the LRC
None lrc_attr_rm(self, fn, attr)
Remove an attribute value from an entry (LFN or PFN) in the LRC
dictionary lrc_attr_search(self, attr1, op, attr2, offset, reslimit)
Search for objects (LFNs or PFNs) in a LRC database that have the specified attribute whose value matches a boolean expression.
list lrc_attr_value_get(self, fn, objtype, attrname)
Get attributes in LRC for a specific object (LFN or PFN)
None lrc_clear(self)
Clear all mappings from LRC database.
None lrc_create_lfn(self, lfn, pfn)
Create LFN with associated PFN in LRC
dictionary lrc_create_lfn_bulk(self, mappingDict)
Create multiple LFN to PFN mappings.
None lrc_delete(self, lfn, pfn)
Delete a mapping for a PFN to an existing LFN.
dictionary lrc_delete_bulk(self, mappingDict)
Delete multiple LFN to PFN mappings in the LRC.
  lrc_exists(self, fn, objtype)
Query LRC for existence of a LFN or PFN **Arguments:** @param fn: LFN or PFN object for which to check existence @type fn: string @param objtype: Type of object argument fn refers to.
[[string],[string]] lrc_exists_bulk(self, names, objtype)
Query LRC for existence of a LFN or PFN in bulk.
list lrc_get_lfn(self, pfn, offset, reslimit)
Query LRC with PFN to obtain LFNs
dictionary lrc_get_lfn_bulk(self, pfnList)
Query LRC with a list of PFNs to obtain LFNs
dictionary lrc_get_lfn_wc(self, pfnpat, offset, reslimit)
Query LRC with PFN wildcard expression to obtain LFNs.
list lrc_get_pfn(self, lfn, offset, reslimit)
Query LRC with LFN to obtain PFNs
dictionary lrc_get_pfn_bulk(self, lfnList)
Query LRC with a list of LFNs to obtain PFNs
dictionary lrc_get_pfn_wc(self, lfnpat, offset, reslimit)
Query LRC with LFN wildcard expression to obtain PFNs.
integer lrc_mapping_exists(self, lfn, pfn)
Query LRC for existence of a specific LFN to PFN mapping.
None lrc_rli_add(self, url, pattern, bloom)
LRC servers send information about LFNs in their database to the the list of RLI servers in the database, added with this function.
None lrc_rli_delete(self, url, pattern)
Delete an entry from the LRC rli/partition tables.
list lrc_rli_get_part(self, url, pattern)
Get RLI update partitions from LRC server.
dictionary lrc_rli_info(self, url)
Get info about RLI server updated by an LRC server.
dictionary lrc_rli_list(self)
Return URLs of RLIs that LRC sends updates to.
None ping(self)
Ping the server.
None rename_lfn(self, oldlfn, newlfn)
Rename an LFN.
[(string,string)] rename_lfn_bulk(self, lfnmap)
Bulk rename LFNs.
None rename_pfn(self, oldpfn, newpfn)
Rename an PFN.
[(string,string)] rename_pfn_bulk(self, pfnmap)
Bulk rename PFNs.
list rli_get_lrc(self, lfn, offset, reslimit)
Return LRCs mapped to LFN in the RLI database.
dictionary rli_get_lrc_bulk(self, lfnList)
Return LRCs mapped to LFNs in the RLI database.
dictionary rli_get_lrc_wc(self, lfnpat, offset, reslimit)
Query RLI with LFN wildcard expression to obtain LRCs.
integer rli_lfn_exists(self, lfn)
Check if LFN exists in RLI database.
[[string],[string]] rli_lfn_exists_bulk(self, names)
Query RLI for existence of a LFN or PFN in bulk.
integer rli_lrc_exists(self, lrc)
Check if LRC exists in RLI database.
list rli_lrc_list(self)
Query RLI for list of LRCs updating the RLI.
None set_timeout(self, seconds)
Set the IO timeout, in seconds, for connecting to servers.

Method Details

__init__(self, url, cert=None, key=None, proxy=None)
(Constructor)

Constructs an instance.

Create a new RlsClient instance. This will init the RLS Globus module and open a connection to the RLS server pointed to by url.

If cert = None, key = None, and proxy = None then GSI will use its standard search path to find appropriate credentials.

If cert and key are both defined then X509_USER_CERT and X509_USER_KEY will be set in the environment and X509_USER_PROXY will be cleared.

If cert and key are both None and proxy is defined then X509_USER_PROXY will be set in the environment.
Parameters:
url - url for the RLS server to establish a connection with
           (type=string)
cert - path to certificate file to use for authentication
           (type=string)
key - path to key file to use for authentication
           (type=string)
proxy - path to proxy file to use for authentication
           (type=string)
Returns:
an instance of class RlsClient
           (type=instance of class RlsClient)
Raises:
RlsClientException - thrown if unable to init the module or open the connection to the server.

__del__(self)
(Destructor)

Destroy an instance.

Destroys the handle thus terminating the connection to the server and deactivates the Globus modules.
Returns:
None
           (type=None)
Raises:
RlsClientException - thrown if unable to destroy the handle or deactivate the modules.

get_timeout(self)

Get the IO timeout, in seconds, for connecting to servers. Zero means there is no timeout.

Note that this is a global timeout and is not limited to this RlsClient object.
Returns:
timeout in seconds
           (type=integer)
Raises:
RlsClientException - raised if unable to contact or query the RLI.

lrc_add(self, lfn, pfn)

Add a mapping for a PFN to an existing LFN. The LFN must exist.
Parameters:
lfn - LFN to which the PFN is to be mapped
           (type=string)
pfn - PFN to map to the LFN
           (type=string)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to add the PFN.

lrc_add_bulk(self, mappingDict)

Add multiple LFN to PFN mappings for existing LFNs. Each LFN must already exist in the LRC.
Parameters:
mappingDict - dictionary containing the mappings where LFNs are the keys and PFNs are the values, or where the values are lists of PFNs for each LFN
           (type=dictionary)
Returns:
Dictionary containing any mappings that could not be added.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to communicate with the RLS server.

lrc_attr_add(self, fn, attr)

Set an attribute value for an entry (LFN or PFN) in the LRC
Parameters:
fn - The filename object for which the attribute value will be set.
           (type=string)
attr - An instance of class RlsAttr or a derived class with name, objtype, type, and value set. See documentation for class RlsAttr.
           (type=instance of RlsAttr)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to contact the LRC or add the attribute.

lrc_attr_define(self, attr)

Define an attribute in the LRC
Parameters:
attr - Instance of class RlsAttr or a derived class. The instance must have name, objtype, and type set. See documentation for methods of class RlsAttr.
           (type=instance of RlsAttr)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to define the attribute.

lrc_attr_delete(self, attr, clear=0)

Delete an attribute definition in the LRC
Parameters:
attr - Instance of class RlsAttr or a derived class. The instance must have name, objtype, and type set. See documentation for methods of class RlsAttr.
           (type=instance of RlsAttr)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to delete the attribute definition.

lrc_attr_get(self, objtype, name=None)

Get definitions of attributes from LRC.
Parameters:
objtype - The type of object (LFN or PFN) for which to get attribute definitions. Should be one of obj_lrc_lfn or obj_lrc_pfn, which are both defined in this module.
           (type=integer)
name - Name of particular attribute to get. If None all attributes for the specified object type are returned.
           (type=string)
Returns:
A list of instances of class RlsAttr.
           (type=list)
Raises:
RlsClientException - raised if unable to contact the LRC or get the definition.

lrc_attr_modify(self, fn, attr)

Modify an attribute value for an entry (LFN or PFN) in the LRC
Parameters:
fn - The filename object for which the attribute value will be modified.
           (type=string)
attr - An instance of class RlsAttr or a derived class with name, objtype, type, and value set. See documentation for class RlsAttr.
           (type=instance of RlsAttr)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to contact the LRC or add the attribute.

lrc_attr_rm(self, fn, attr)

Remove an attribute value from an entry (LFN or PFN) in the LRC
Parameters:
fn - The filename object for which the attribute value will be removed.
           (type=string)
attr - An instance of class RlsAttr or a derived class with name, objtype, type, and value set. See documentation for class RlsAttr.
           (type=instance of RlsAttr)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to contact the LRC or remove the attribute.

lrc_attr_search(self, attr1, op, attr2=None, offset=0, reslimit=0)

Search for objects (LFNs or PFNs) in a LRC database that have the specified attribute whose value matches a boolean expression.
Parameters:
attr1 - An instance of class RlsAttr or a derived class with name, objtype, type, and value set and which is used to search on. See documentation for class RlsAttr.
           (type=instance of RlsAttr)
op - Operator to be used in searching for values. Should be one of
  • attr_op_all all values returned
  • attr_op_eq values matching operand 1 returned
  • attr_op_ne values not matching operand 1
  • attr_op_gt values greater than operand 1
  • attr_op_ge values greater than or equal to attr1 value
  • attr_op_lt values less than operand 1
  • attr_op_le values less than or equal to attr1 value
  • attr_op_btw values between attr1 and attr2 value
  • attr_op_like Strings "like" operand1 (SQL like)

           (type=integer)
attr2 - Second instance of class RlsAttr if a second operand for operator is required
           (type=instance of RlsAttr)
offset - Offset into result list. Used in conjunction with reslimit to retrieve results a few at a time. Use 0 to begin with first result.
           (type=integer)
reslimit - Maximum number of results to return. Used in conjunction with offset to retrieve results a few at a time. Use 0 to retrieve all results.
           (type=integer)
Returns:
A dictionary object with attribute names as keys and attribute values as values.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to contact the LRC or perform the search.

lrc_attr_value_get(self, fn, objtype, attrname=None)

Get attributes in LRC for a specific object (LFN or PFN)
Parameters:
fn - The filename of the object (LFN or PFN) for which to get attributes.
           (type=string)
objtype - The type of object (LFN or PFN) for which to get attribute. Should be one of obj_lrc_lfn or obj_lrc_pfn, which are both defined in this module.
           (type=integer)
attrname - Name of particular attribute to get. If None all attributes for the specified filename are returned.
           (type=string)
Returns:
A list of instances of class RlsAttr.
           (type=list)
Raises:
RlsClientException - raised if unable to contact the LRC or get the definition.

lrc_clear(self)

Clear all mappings from LRC database. User needs both ADMIN and LRCUPDATE privileges to perform this operation.

Note that if the LRC is cleared this will not be reflected in any RLI servers updated by the LRC until the next softstate update, even if immediate updates are enabled.
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to contact the LRC or clear the LRC.

lrc_create_lfn(self, lfn, pfn)

Create LFN with associated PFN in LRC
Parameters:
lfn - The LFN to create in LRC
           (type=string)
pfn - The PFN to associate with LFN
           (type=string)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to create the LFN.

lrc_create_lfn_bulk(self, mappingDict)

Create multiple LFN to PFN mappings.
Parameters:
mappingDict - dictionary containing the mappings where LFNs are the keys and PFNs are the values
           (type=dictionary)
Returns:
Dictionary containing any mappings that could not be added.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to communicate with the RLS server.

lrc_delete(self, lfn, pfn)

Delete a mapping for a PFN to an existing LFN.
Parameters:
lfn - LFN to which the PFN was mapped
           (type=string)
pfn - PFN for which the map to LFN is to be deleted
           (type=string)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to delete the PFN.

lrc_delete_bulk(self, mappingDict)

Delete multiple LFN to PFN mappings in the LRC.
Parameters:
mappingDict - dictionary containing the mappings where LFNs are the keys and PFNs are the values, or where the values are lists of PFNs for each LFN
           (type=dictionary)
Returns:
Dictionary containing any mappings that could not be deleted.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to communicate with the RLS server.

lrc_exists(self, fn, objtype)

Query LRC for existence of a LFN or PFN

**Arguments:**

@param fn: LFN or PFN object for which to check existence
        @type fn: string

@param objtype: Type of object argument fn refers to. Should be
either obj_lrc_lfn or obj_lrc_pfn, both of which are defined
in this module.
        @type objtype: integer

@return: 1 if exists or 0 if not
        @rtype: integer

@raise RlsClientException: raised if unable to query
the LRC.

lrc_exists_bulk(self, names, objtype)

Query LRC for existence of a LFN or PFN in bulk.

**Arguments:**
Parameters:
names - LFN or PFN object for which to check existence
           (type=[string])
objtype - Type of object argument fn refers to. Should be either obj_lrc_lfn or obj_lrc_pfn, both of which are defined in this module.
           (type=integer)
Returns:
Two lists of names ( namesThatExist, NamesThatDont )
           (type=[[string],[string]])
Raises:
RlsClientException - raised if unable to query the LRC.

lrc_get_lfn(self, pfn, offset=0, reslimit=0)

Query LRC with PFN to obtain LFNs
Parameters:
pfn - The PFN to query the LRC with
           (type=string)
offset - offset into result list. Used in conjunction with reslimit to retrieve results a few at a time. Use 0 to begin with first result.
           (type=integer)
reslimit - Maximum number of results to return. Used in conjunction with offset to retrieve results a few at a time. Use 0 to retrieve all results.
           (type=integer)
Returns:
a list of LFNs.
           (type=list)
Raises:
RlsClientException - raised if unable to query the LRC or if the PFN is not known to the LRC.

lrc_get_lfn_bulk(self, pfnList)

Query LRC with a list of PFNs to obtain LFNs
Parameters:
pfnList - The list of PFNs to query the LRC with
           (type=list)
Returns:
A dictionary where the PFNs are the keys and the values are the LFNs or list of LFNs associated with the PFN key.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to query the LRC.

lrc_get_lfn_wc(self, pfnpat, offset=0, reslimit=0)

Query LRC with PFN wildcard expression to obtain LFNs.
Parameters:
pfnpat - The wildcard expression to search with. Can contain either Unix file globbing chars (* matches 0 or more characters, ? matches any single character) or SQL "like" wildcard characters (% matches 0 or more charactes, _ matches any single character)
           (type=string)
offset - Offset into result list. Used in conjunction with reslimit to retrieve results a few at a time. Use 0 to begin with first result.
           (type=integer)
reslimit - maximum number of results to return. Used in conjunction with offset to retrieve results a few at a time. Use 0 to retrieve all results.
           (type=integer)
Returns:
A dictionary object with PFNs as keys and LFNs as values.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to query the LRC.

lrc_get_pfn(self, lfn, offset=0, reslimit=0)

Query LRC with LFN to obtain PFNs
Parameters:
lfn - LFN to query the LRC with
           (type=string)
offset - offset into result list. Used in conjunction with reslimit to retrieve results a few at a time. Use 0 to begin with first result.
           (type=integer)
reslimit - maximum number of results to return. Used in conjunction with offset to retrieve results a few at a time. Use 0 to retrieve all results.
           (type=integer)
Returns:
list of PFNs.
           (type=list)
Raises:
RlsClientException - raised if unable to query the LRC or if the LFN is not known to the LRC.

lrc_get_pfn_bulk(self, lfnList)

Query LRC with a list of LFNs to obtain PFNs
Parameters:
lfnList - The list of LFNs to query the LRC with
           (type=list)
Returns:
A dictionary where the LFNs are the keys and the values are the PFNs or list of PFNs associated with the LFN key.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to query the LRC.

lrc_get_pfn_wc(self, lfnpat, offset=0, reslimit=0)

Query LRC with LFN wildcard expression to obtain PFNs.
Parameters:
lfnpat - The wildcard expression to search with. Can contain either Unix file globbing chars (* matches 0 or more characters, ? matches any single character) or SQL "like" wildcard characters (% matches 0 or more charactes, _ matches any single character)
           (type=string)
offset - offset into result list. Used in conjunction with reslimit to retrieve results a few at a time. Use 0 to begin with first result.
           (type=integer)
reslimit - maximum number of results to return. Used in conjunction with offset to retrieve results a few at a time. Use 0 to retrieve all results.
           (type=integer)
Returns:
a dictionary object with LFNs as keys and PFNs as values.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to query the LRC.

lrc_mapping_exists(self, lfn, pfn)

Query LRC for existence of a specific LFN to PFN mapping.
Parameters:
lfn - LFN part of the mapping
           (type=string)
pfn - PFN part of the mapping
           (type=string)
Returns:
1 if exists or 0 if not
           (type=integer)
Raises:
RlsClientException - raised if unable to query the LRC.

lrc_rli_add(self, url, pattern=None, bloom=0)

LRC servers send information about LFNs in their database to the the list of RLI servers in the database, added with this function. Updates may be partitioned amongst multiple RLIs by specifying one or more patterns for an RLI.
Parameters:
url - URL of RLI server to add
           (type=string)
pattern - If not None used to filter which LFNs are sent to url. Standard Unix wildcard characters (*, ?) may be used to do wildcard matches.
           (type=string)
bloom - If non-zero then update RLI using bloom filters
           (type=integer)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to contact the LRC or add the RLI URL.

lrc_rli_delete(self, url, pattern=None)

Delete an entry from the LRC rli/partition tables.
Parameters:
url - URL of RLI server to remove
           (type=string)
pattern - If not None then only the specific RLI URL/pattern is removed, else all partition information for URL is removed.
           (type=string)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to contact the LRC or delete the RLI URL.

lrc_rli_get_part(self, url=None, pattern=None)

Get RLI update partitions from LRC server.
Parameters:
url - URL of RLI server to retrieve info for. If not None identifies RLI that partition data will be retrieved for. If None then all RLIs are retrieved.
           (type=string)
pattern - If not None returns only partitions with matching patterns, otherwise all patterns are retrieved.
           (type=string)
Returns:
A list of lists. Each individual list has the URL as the first element and the associate pattern as the second element.
           (type=list)
Raises:
RlsClientException - raised if unable to contact the LRC or query the LRC.

lrc_rli_info(self, url)

Get info about RLI server updated by an LRC server.
Parameters:
url - URL of RLI server to retrieve info for
           (type=string)
Returns:
A dictionary object with RLI URLs as keys and lists as values where the list elements are update interval, flags, and last update.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to contact the LRC or query for RLI URLs.

lrc_rli_list(self)

Return URLs of RLIs that LRC sends updates to.
Returns:
A dictionary object with RLI URLs as keys and lists as values where the list elements are update interval, flags, and last update.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to contact the LRC or query for RLI URLs.

ping(self)

Ping the server.
Returns:
None
           (type=None)
Raises:
RlsClientException - thrown if unable to ping the server.

rename_lfn(self, oldlfn, newlfn)

Rename an LFN.

**Arguments:**
Parameters:
oldlfn - Old LFN name. The one to be re-named.
           (type=string)
newlfn - New LFN name.
           (type=string)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to rename.

rename_lfn_bulk(self, lfnmap)

Bulk rename LFNs.

**Arguments:**
Parameters:
lfnmap - A list of pairs (oldLFN_i, newLFN_i)
           (type=[(string,string)])
Returns:
list of mappings which failed.
           (type=[(string,string)])

rename_pfn(self, oldpfn, newpfn)

Rename an PFN.

**Arguments:**
Parameters:
oldpfn - Old PFN name. The one to be re-named.
           (type=string)
newpfn - New PFN name.
           (type=string)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to rename.

rename_pfn_bulk(self, pfnmap)

Bulk rename PFNs.

**Arguments:**
Parameters:
pfnmap - A list of pairs (oldPFN_i, newPFN_i)
           (type=[(string,string)])
Returns:
list of mappings which failed.
           (type=[(string,string)])

rli_get_lrc(self, lfn, offset=0, reslimit=0)

Return LRCs mapped to LFN in the RLI database.
Parameters:
lfn - LFN for which to return LRC mappings
           (type=string)
Returns:
List of LRCs.
           (type=list)
Raises:
RlsClientException - raised if unable to contact the RLI or query on the LFN.

rli_get_lrc_bulk(self, lfnList)

Return LRCs mapped to LFNs in the RLI database.
Parameters:
lfnList - LFNs for which to return LRC mappings
           (type=list)
Returns:
Dictionary where LFNs are the keys and LRCs or a list of LRCs are the values.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to contact the RLI or query on the LFN.

rli_get_lrc_wc(self, lfnpat, offset=0, reslimit=0)

Query RLI with LFN wildcard expression to obtain LRCs.
Parameters:
lfnpat - The wildcard expression to search with. Can contain either Unix file globbing chars (* matches 0 or more characters, ? matches any single character) or SQL "like" wildcard characters (% matches 0 or more charactes, _ matches any single character)
           (type=string)
offset - Offset into result list. Used in conjunction with reslimit to retrieve results a few at a time. Use 0 to begin with first result.
           (type=integer)
reslimit - Maximum number of results to return. Used in conjunction with offset to retrieve results a few at a time. Use 0 to retrieve all results.
           (type=integer)
Returns:
A dictionary object with LFNs as keys and LRCs as values.
           (type=dictionary)
Raises:
RlsClientException - raised if unable to query the RLI.

rli_lfn_exists(self, lfn)

Check if LFN exists in RLI database.
Parameters:
lfn - LFN for which to check existence
           (type=string)
Returns:
1 if the LFN exists or 0 if it does not.
           (type=integer)
Raises:
RlsClientException - raised if unable to contact the RLI or query on the LFN.

rli_lfn_exists_bulk(self, names)

Query RLI for existence of a LFN or PFN in bulk.

**Arguments:**
Parameters:
names - LFN or PFN object for which to check existence
           (type=[string])
Returns:
Two lists of names ( namesThatExist, NamesThatDont )
           (type=[[string],[string]])
Raises:
RlsClientException - raised if unable to query the LRC.

rli_lrc_exists(self, lrc)

Check if LRC exists in RLI database.
Parameters:
lrc - URL for LRC for which to check existence
           (type=string)
Returns:
1 if the LRC exists in the RLI database or 0 if it does not.
           (type=integer)
Raises:
RlsClientException - raised if unable to contact the RLI or query on the LRC.

rli_lrc_list(self)

Query RLI for list of LRCs updating the RLI.
Returns:
A list of lists with the first item in each short list a LRC URL and the second item the time of last update.
           (type=list)
Raises:
RlsClientException - raised if unable to contact or query the RLI.

set_timeout(self, seconds)

Set the IO timeout, in seconds, for connecting to servers. Zero means there is no timeout.

Note that this is a global timeout and is not limited to this RlsClient object.
Parameters:
seconds - timeout in seconds
           (type=integer)
Returns:
None
           (type=None)
Raises:
RlsClientException - raised if unable to contact or query the RLI.

Generated by Epydoc 2.1 on Wed Aug 24 09:10:41 2005 http://epydoc.sf.net