Back to index

nordugrid-arc-nox  1.1.0~rc6
Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions
storage.client.ShepherdClient Class Reference
Inheritance diagram for storage.client.ShepherdClient:
Inheritance graph
[legend]
Collaboration diagram for storage.client.ShepherdClient:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def put
def get
def delete
def stat
def toggleReport
def reset
def call
def call_raw

Public Attributes

 ns
 urls
 https
 print_xml
 xmlnode_class
 ssl_config
 cfg
 get_trusted_dns_method
 connection_cache
 semapool

Static Public Attributes

 NS_class = arc.NS

Private Member Functions

def _putget

Detailed Description

Definition at line 714 of file client.py.


Constructor & Destructor Documentation

def storage.client.ShepherdClient.__init__ (   self,
  url,
  print_xml = False,
  ssl_config = {} 
)

Definition at line 716 of file client.py.

00716 
00717     def __init__(self, url, print_xml = False, ssl_config = {}):
00718         ns = self.NS_class('she', shepherd_uri)
00719         Client.__init__(self, url, ns, print_xml, ssl_config = ssl_config)


Member Function Documentation

def storage.client.ShepherdClient._putget (   self,
  putget,
  requests 
) [private]

Definition at line 720 of file client.py.

00720 
00721     def _putget(self, putget, requests):
00722         tree = XMLTree(from_tree =
00723             ('she:' + putget, [
00724                 ('she:' + putget + 'RequestList', [
00725                     ('she:' + putget + 'RequestElement', [
00726                         ('she:requestID', requestID),
00727                         ('she:' + putget + 'RequestDataList', [
00728                             ('she:' + putget + 'RequestDataElement', [
00729                                 ('she:property', property),
00730                                 ('she:value', value)
00731                             ]) for property, value in requestData
00732                         ])
00733                     ]) for requestID, requestData in requests.items()
00734                 ])
00735             ])
00736         )
00737         msg = self.call(tree)
00738         xml = self.xmlnode_class(msg)
00739         try:
00740             response = dict([
00741                 (str(node.Get('requestID')), [
00742                     (str(n.Get('property')), str(n.Get('value')))
00743                         for n in get_child_nodes(node.Get(putget + 'ResponseDataList'))
00744                 ]) for node in get_child_nodes(get_data_node(xml))])
00745             return response
00746         except:
00747             raise Exception, msg

Here is the call graph for this function:

Here is the caller graph for this function:

def arcom.client.Client.call (   self,
  tree,
  return_tree_only = False 
) [inherited]
Create a SOAP message from an XMLTree and send it to the service.

call(tree, return_tree_only = False)

tree is an XMLTree object containing the content of the request
return_tree_only indicates that we only need to put the response into an XMLTree

Definition at line 60 of file client.py.

00060 
00061     def call(self, tree, return_tree_only = False):
00062         """ Create a SOAP message from an XMLTree and send it to the service.
00063         
00064         call(tree, return_tree_only = False)
00065         
00066         tree is an XMLTree object containing the content of the request
00067         return_tree_only indicates that we only need to put the response into an XMLTree
00068         """
00069         # create a new PayloadSOAP object with the given namespace
00070         out = arc.PayloadSOAP(self.ns)
00071         # add the content of the XMLTree to the XMLNode of the SOAP object
00072         tree.add_to_node(out)
00073         if self.print_xml:
00074             msg = out.GetXML()
00075             print 'Request:'
00076             print XMLTree(out).pretty_xml(indent = '    ', prefix = '        #   ')
00077             print
00078         # call the service and get back the response, and the HTTP status
00079         resp = self.call_raw(out)
00080         if self.print_xml:
00081             print 'Response:'
00082             try:
00083                 print XMLTree(from_string = resp).pretty_xml(indent = '    ', prefix = '        #   ')
00084             except:
00085                 print resp
00086             print
00087         if return_tree_only:
00088             # wrap the response into an XMLTree and return only the tree
00089             return XMLTree(from_string = resp, forget_namespace = True).get_trees('///')[0]
00090         else:
00091             return resp

Here is the call graph for this function:

Here is the caller graph for this function:

def arcom.client.Client.call_raw (   self,
  outpayload 
) [inherited]
Send a POST request with the SOAP XML message.

call_raw(outpayload)

outpayload is an XMLNode with the SOAP message

Definition at line 99 of file client.py.

00099 
00100     def call_raw(self, outpayload):
00101         """ Send a POST request with the SOAP XML message.
00102         
00103         call_raw(outpayload)
00104         
00105         outpayload is an XMLNode with the SOAP message
00106         """
00107         tid = thread.get_ident()
00108         s = self.connection_cache.get(tid, None)
00109         if s:
00110             try:
00111                 resp, status = s.process(outpayload)
00112                 if not self._fawlty(resp, status):
00113                     return resp.GetXML()
00114             except:
00115                 pass
00116             self.connection_cache[tid] = None
00117         if len(self.urls) == 0:
00118             log.msg(arc.WARNING, 'No URLs to connect to (in %s)' % str(self.__class__.__name__))
00119             raise Exception, 'No URLs to connect'
00120         random.shuffle(self.urls)
00121         #print "available URLs", [url.fullstr() for url in self.urls]
00122         for url in self.urls:
00123             #print "trying URL", url.fullstr()
00124             try:
00125                 s = arc.ClientSOAP(self.cfg, url)
00126                 if self.get_trusted_dns_method:
00127                     dnlist = self.get_trusted_dns_method()
00128                     if dnlist:
00129                         dnlistconf = arc.DNListHandlerConfig(dnlist, 'outgoing')
00130                         # _s points to the superclass, but not the object, so it needs the object as first argument
00131                         s._s._s.AddSecHandler(s, dnlistconf, arc.TLSSec)
00132                 resp, status = s.process(outpayload)
00133                 fawlty = self._fawlty(resp, status)
00134                 if fawlty:
00135                     raise Exception, fawlty
00136                 resp = resp.GetXML()
00137                 self.connection_cache[tid] = s
00138                 return resp
00139             except:
00140                 log.msg(arc.WARNING, "ERROR connecting to", url.fullstr())
00141                 pass
00142         log.msg(arc.ERROR, "ERROR connecting to all of these:", ', '.join([url.fullstr() for url in self.urls]))
00143         raise

Here is the call graph for this function:

Here is the caller graph for this function:

def storage.client.ShepherdClient.delete (   self,
  requests 
)

Definition at line 757 of file client.py.

00757 
00758     def delete(self, requests):
00759         tree = XMLTree(from_tree =
00760             ('she:delete', [
00761                 ('she:deleteRequestList', [
00762                     ('she:deleteRequestElement', [
00763                         ('she:requestID', requestID),
00764                         ('she:referenceID', referenceID)
00765                     ]) for requestID, referenceID in requests.items()
00766                 ])
00767             ])
00768         )
00769         self.semapool.acquire()
00770         msg = self.call(tree)
00771         self.semapool.release()
00772         xml = self.xmlnode_class(msg)
00773         return parse_node(get_data_node(xml), ['requestID', 'status'])
00774         

Here is the call graph for this function:

def storage.client.ShepherdClient.get (   self,
  requests 
)

Definition at line 754 of file client.py.

00754 
00755     def get(self, requests):
00756         return self._putget('get', requests)

Here is the call graph for this function:

def storage.client.ShepherdClient.put (   self,
  requests 
)

Definition at line 748 of file client.py.

00748 
00749     def put(self, requests):
00750         self.semapool.acquire()
00751         res = self._putget('put', requests)
00752         self.semapool.release()
00753         return res

Here is the call graph for this function:

def arcom.client.Client.reset (   self) [inherited]

Definition at line 56 of file client.py.

00056 
00057     def reset(self):
00058         tid = thread.get_ident()
00059         self.connection_cache[tid] = None

def storage.client.ShepherdClient.stat (   self,
  requests 
)

Definition at line 775 of file client.py.

00775 
00776     def stat(self, requests):
00777         tree = XMLTree(from_tree =
00778             ('she:stat', [
00779                 ('she:statRequestList', [
00780                     ('she:statRequestElement', [
00781                         ('she:requestID', requestID),
00782                         ('she:referenceID', referenceID)
00783                     ]) for requestID, referenceID in requests.items()
00784                 ])
00785             ])
00786         )
00787         msg = self.call(tree)
00788         xml = self.xmlnode_class(msg)
00789         return parse_to_dict(get_data_node(xml),
00790             ['requestID', 'referenceID', 'state', 'checksumType', 'checksum', 'acl', 'size', 'GUID', 'localID'])

Here is the call graph for this function:

def storage.client.ShepherdClient.toggleReport (   self,
  doReporting 
)

Definition at line 791 of file client.py.

00791 
00792     def toggleReport(self, doReporting):
00793         tree = XMLTree(from_tree =
00794             ('she:toggleReport', [
00795                 ('she:doReporting', doReporting and true or false)
00796             ])
00797         )
00798         return self.call(tree, True)

Here is the call graph for this function:


Member Data Documentation

Definition at line 34 of file client.py.

Definition at line 36 of file client.py.

Definition at line 35 of file client.py.

Definition at line 30 of file client.py.

Definition at line 24 of file client.py.

arcom.client.Client.NS_class = arc.NS [static, inherited]

Definition at line 13 of file client.py.

Definition at line 31 of file client.py.

Definition at line 38 of file client.py.

Definition at line 33 of file client.py.

Definition at line 29 of file client.py.

Definition at line 32 of file client.py.


The documentation for this class was generated from the following file: