' %(v.__name__,k)) result += self.bigsection('Aliases', '#ffffff', '#eeaa77', ''.join(nonmembers)) return result pydoc.HTMLDoc.docmodule = strongarm try: object, name = pydoc.resolve(thing, forceload) page = pydoc.html.page(pydoc.describe(object), pydoc.html.document(object, name)) name = os.path.join(doc, name + '.html') file = open(name, 'w') file.write(page) file.close() except (ImportError, pydoc.ErrorDuringImport), value: log.debug(str(value)) pydoc.HTMLDoc.docmodule = docmodule def _writetypesdoc(doc, thing, forceload=0): """Write HTML documentation to a file in the current directory. """ try: object, name = pydoc.resolve(thing, forceload) name = os.path.join(doc, name + '.html') except (ImportError, pydoc.ErrorDuringImport), value: log.debug(str(value)) return # inner classes cdict = {} fdict = {} elements_dict = {} types_dict = {} for kname,klass in inspect.getmembers(thing, inspect.isclass): if thing is not inspect.getmodule(klass): continue cdict[kname] = inspect.getmembers(klass, inspect.isclass) for iname,iklass in cdict[kname]: key = (kname,iname) fdict[key] = _writedoc(doc, iklass) if issubclass(iklass, ElementDeclaration): try: typecode = iklass() except (AttributeError,RuntimeError), ex: elements_dict[iname] = _writebrokedoc(doc, ex, iname) continue elements_dict[iname] = None if typecode.pyclass is not None: elements_dict[iname] = _writedoc(doc, typecode.pyclass) continue if issubclass(iklass, TypeDefinition): try: typecode = iklass(None) except (AttributeError,RuntimeError), ex: types_dict[iname] = _writebrokedoc(doc, ex, iname) continue types_dict[iname] = None if typecode.pyclass is not None: types_dict[iname] = _writedoc(doc, typecode.pyclass) continue def strongarm(self, object, name=None, mod=None, funcs={}, classes={}, *ignored): """Produce HTML documentation for a class object.""" realname = object.__name__ name = name or realname bases = object.__bases__ object, name = pydoc.resolve(object, forceload) contents = [] push = contents.append if name == realname: title = 'class %s' % ( name, realname) else: title = '%s = class %s' % ( name, name, realname) mdict = {} if bases: parents = [] for base in bases: parents.append(self.classlink(base, object.__module__)) title = title + '(%s)' % pydoc.join(parents, ', ') doc = self.markup(pydoc.getdoc(object), self.preformat, funcs, classes, mdict) doc = doc and '%s
' % doc for iname,iclass in cdict[name]: fname = fdict[(name,iname)] if elements_dict.has_key(iname): push('class %s: element declaration typecode
'\ %(fname,iname)) pyclass = elements_dict[iname] if pyclass is not None: push('
- instance attributes:')
push('
- pyclass: instances serializable to XML
' %(fname,iname)) pyclass = types_dict[iname] if pyclass is not None: push('
- instance attributes:')
push('
- pyclass: instances serializable to XML
' %(fname,iname)) contents = ''.join(contents) return self.section(title, '#000000', '#ffc8d8', contents, 3, doc) doclass = pydoc.HTMLDoc.docclass pydoc.HTMLDoc.docclass = strongarm try: page = pydoc.html.page(pydoc.describe(object), pydoc.html.document(object, name)) file = open(name, 'w') file.write(page) file.close() except (ImportError, pydoc.ErrorDuringImport), value: log.debug(str(value)) pydoc.HTMLDoc.docclass = doclass def _writebrokedoc(doc, ex, name, forceload=0): try: fname = os.path.join(doc, name + '.html') page = pydoc.html.page(pydoc.describe(ex), pydoc.html.document(str(ex), fname)) file = open(fname, 'w') file.write(page) file.close() except (ImportError, pydoc.ErrorDuringImport), value: log.debug(str(value)) return name + '.html' def _writepydoc(doc, *args): """create pydoc html pages doc -- destination directory for documents *args -- modules run thru pydoc """ ok = True if not os.path.isdir(doc): os.makedirs(doc) if os.path.curdir not in sys.path: sys.path.append(os.path.curdir) for f in args: if f.startswith('./'): f = f[2:] name = os.path.sep.join(f.strip('.py').split(os.path.sep)) try: e = __import__(name) except Exception,ex: raise # _writebrokedoc(doc, ex, name) # continue if name.endswith('_client'): _writeclientdoc(doc, e) continue if name.endswith('_types'): _writetypesdoc(doc, e) continue try: _writedoc(doc, e) except IndexError,ex: _writebrokedoc(doc, ex, name) continue ZSI-2.1-a1/ZSI/generate/wsdl2dispatch.py 0000755 0001751 0001751 00000036732 10656174245 016132 0 ustar zsi zsi #!/usr/bin/env python import inspect from cStringIO import StringIO import ZSI, string, sys, getopt, urlparse, types, warnings from ZSI.wstools import WSDLTools from ZSI.ServiceContainer import ServiceSOAPBinding, SimpleWSResource, WSAResource from ZSI.generate import WsdlGeneratorError, Wsdl2PythonError from utility import TextProtect, GetModuleBaseNameFromWSDL, \ NCName_to_ClassName, GetPartsSubNames, TextProtectAttributeName from containers import BindingDescription from wsdl2python import MessageWriter, WriteServiceModule,\ MessageTypecodeContainer, SchemaDescription # Split last token rsplit = lambda x,sep,: (x[:x.rfind(sep)], x[x.rfind(sep)+1:],) if sys.version_info[0:2] == (2, 4, 0, 'final', 0)[0:2]: rsplit = lambda x,sep,: x.rsplit(sep, 1) class SOAPService: def __init__(self, service): self.classdef = StringIO() self.initdef = StringIO() self.location = '' self.methods = [] def newMethod(self): '''name -- operation name ''' self.methods.append(StringIO()) return self.methods[-1] class ServiceModuleWriter: '''Creates a skeleton for a SOAP service instance. ''' indent = ' '*4 server_module_suffix = '_server' func_aname = TextProtectAttributeName func_aname = staticmethod(func_aname) separate_messages = False def __init__(self, base=ServiceSOAPBinding, prefix='soap', service_class=SOAPService): ''' parameters: base -- either a class definition, or a str representing a qualified class name (eg. module.name.classname) prefix -- method prefix. ''' if inspect.isclass(base): self.base_class_name = base.__name__ self.base_module_name = inspect.getmodule(base).__name__ else: self.base_module_name, self.base_class_name = base.rsplit('.', 1) self.wsdl = None self.method_prefix = prefix self._service_class = SOAPService self.header = None self.imports = None self.messages = [] self._services = None self.types_module_path = None self.types_module_name = None self.messages_module_name = None def reset(self): self.header = StringIO() self.imports = StringIO() self.message = [] self._services = {} def getIndent(self, level=1): '''return indent. ''' assert 0 < level < 10, 'bad indent level %d' %level return self.indent*level def getMethodName(self, method): '''return method name. ''' return '%s_%s' %(self.method_prefix, TextProtect(method)) def getClassName(self, name): '''return class name. ''' return NCName_to_ClassName(name) def setTypesModuleName(self, name): self.types_module_name = name # Backwards compatibility setClientModuleName = setTypesModuleName def getTypesModuleName(self): '''return module name. ''' assert self.wsdl is not None, 'initialize, call fromWSDL' if self.types_module_name is not None: return self.types_module_name wsm = WriteServiceModule(self.wsdl) return wsm.getTypesModuleName() def getServiceModuleName(self): '''return module name. ''' name = GetModuleBaseNameFromWSDL(self.wsdl) if not name: raise WsdlGeneratorError, 'could not determine a service name' if self.server_module_suffix is None: return name return '%s%s' %(name, self.server_module_suffix) def getTypesModulePath(self): return self.types_module_path getClientModulePath = getTypesModulePath def setTypesModulePath(self, path): '''setup module path to where client module before calling fromWSDL. ''' self.types_module_path = path setClientModulePath = setTypesModulePath def setUpClassDef(self, service): '''set class definition and class variables. service -- ServiceDescription instance ''' assert isinstance(service, WSDLTools.Service) is True,\ 'expecting WSDLTools.Service instance.' s = self._services[service.name].classdef print >>s, 'class %s(%s):' %(self.getClassName(service.name), self.base_class_name) print >>s, '%ssoapAction = {}' % self.getIndent(level=1) print >>s, '%sroot = {}' % self.getIndent(level=1) def setUpImports(self): '''set import statements ''' i = self.imports print >>i, 'from ZSI.schema import GED, GTD' print >>i, 'from ZSI.TCcompound import ComplexType, Struct' module = self.getTypesModuleName() package = self.getTypesModulePath() if package: module = '%s.%s' %(package, module) print >>i, 'from %s import *' %(module) print >>i, 'from %s import %s' %(self.base_module_name, self.base_class_name) def setUpInitDef(self, service): '''set __init__ function ''' assert isinstance(service, WSDLTools.Service), \ 'expecting WSDLTools.Service instance.' sd = self._services[service.name] d = sd.initdef if sd.location is not None: scheme,netloc,path,params,query,fragment = urlparse.urlparse(sd.location) print >>d, '%sdef __init__(self, post=\'%s\', **kw):' %(self.getIndent(level=1), path) else: print >>d, '%sdef __init__(self, post, **kw):' %self.getIndent(level=1) # Require POST initialization value for test implementation if self.base_module_name == inspect.getmodule(ServiceSOAPBinding).__name__: print >>d, '%s%s.__init__(self, post)' %(self.getIndent(level=2), self.base_class_name) return # No POST initialization value, obtained from HTTP Request in twisted or wsgi print >>d, '%s%s.__init__(self)' %(self.getIndent(level=2), self.base_class_name) def mangle(self, name): return TextProtect(name) def getAttributeName(self, name): return self.func_aname(name) def setUpMethods(self, port): '''set up all methods representing the port operations. Parameters: port -- Port that defines the operations. ''' assert isinstance(port, WSDLTools.Port), \ 'expecting WSDLTools.Port not: ' %type(port) sd = self._services.get(port.getService().name) assert sd is not None, 'failed to initialize.' binding = port.getBinding() portType = port.getPortType() action_in = '' for bop in binding.operations: try: op = portType.operations[bop.name] except KeyError, ex: raise WsdlGeneratorError,\ 'Port(%s) PortType(%s) missing operation(%s) defined in Binding(%s)' \ %(port.name,portType.name,bop.name,binding.name) for ext in bop.extensions: if isinstance(ext, WSDLTools.SoapOperationBinding): action_in = ext.soapAction break else: warnings.warn('Port(%s) operation(%s) defined in Binding(%s) missing soapAction' \ %(port.name,op.name,binding.name) ) msgin = op.getInputMessage() msgin_name = TextProtect(msgin.name) method_name = self.getMethodName(op.name) m = sd.newMethod() print >>m, '%sdef %s(self, ps, **kw):' %(self.getIndent(level=1), method_name) if msgin is not None: print >>m, '%srequest = ps.Parse(%s.typecode)' %(self.getIndent(level=2), msgin_name) else: print >>m, '%s# NO input' %self.getIndent(level=2) msgout = op.getOutputMessage() if msgout is not None: msgout_name = TextProtect(msgout.name) print >>m, '%sreturn request,%s()' %(self.getIndent(level=2), msgout_name) else: print >>m, '%s# NO output' % self.getIndent(level=2) print >>m, '%sreturn request,None' % self.getIndent(level=2) print >>m, '' print >>m, '%ssoapAction[\'%s\'] = \'%s\'' %(self.getIndent(level=1), action_in, method_name) print >>m, '%sroot[(%s.typecode.nspname,%s.typecode.pname)] = \'%s\'' \ %(self.getIndent(level=1), msgin_name, msgin_name, method_name) return def setUpHeader(self): print >>self.header, '#'*50 print >>self.header, '# file: %s.py' %self.getServiceModuleName() print >>self.header, '#' print >>self.header, '# skeleton generated by "%s"' %self.__class__ print >>self.header, '# %s' %' '.join(sys.argv) print >>self.header, '#' print >>self.header, '#'*50 def write(self, fd=sys.stdout): '''write out to file descriptor, should not need to override. ''' print >>fd, self.header.getvalue() print >>fd, self.imports.getvalue() print >>fd, '# Messages ', for m in self.messages: print >>fd, m print >>fd, '' print >>fd, '' print >>fd, '# Service Skeletons' for k,v in self._services.items(): print >>fd, v.classdef.getvalue() print >>fd, v.initdef.getvalue() for s in v.methods: print >>fd, s.getvalue() def fromWSDL(self, wsdl): '''setup the service description from WSDL, should not need to override. ''' assert isinstance(wsdl, WSDLTools.WSDL), 'expecting WSDL instance' if len(wsdl.services) == 0: raise WsdlGeneratorError, 'No service defined' self.reset() self.wsdl = wsdl self.setUpHeader() self.setUpImports() for service in wsdl.services: sd = self._service_class(service.name) self._services[service.name] = sd for port in service.ports: desc = BindingDescription(wsdl=wsdl) try: desc.setUp(port.getBinding()) except Wsdl2PythonError, ex: continue for soc in desc.operations: if not soc.hasInput(): continue self.messages.append(MessageWriter()) self.messages[-1].setUp(soc, port, input=True) if soc.hasOutput(): self.messages.append(MessageWriter()) self.messages[-1].setUp(soc, port, input=False) for e in port.extensions: if isinstance(e, WSDLTools.SoapAddressBinding): sd.location = e.location self.setUpMethods(port) self.setUpClassDef(service) self.setUpInitDef(service) class WSAServiceModuleWriter(ServiceModuleWriter): '''Creates a skeleton for a WS-Address service instance. ''' def __init__(self, base=WSAResource, prefix='wsa', service_class=SOAPService, strict=True): ''' Parameters: strict -- check that soapAction and input ws-action do not collide. ''' ServiceModuleWriter.__init__(self, base, prefix, service_class) self.strict = strict def createMethodBody(msgInName, msgOutName, **kw): '''return a tuple of strings containing the body of a method. msgInName -- None or a str msgOutName -- None or a str ''' body = [] if msgInName is not None: body.append('request = ps.Parse(%s.typecode)' %msgInName) if msgOutName is not None: body.append('return request,%s()' %msgOutName) else: body.append('return request,None') return tuple(body) createMethodBody = staticmethod(createMethodBody) def setUpClassDef(self, service): '''use soapAction dict for WS-Action input, setup wsAction dict for grabbing WS-Action output values. ''' assert isinstance(service, WSDLTools.Service), \ 'expecting WSDLTools.Service instance' s = self._services[service.name].classdef print >>s, 'class %s(%s):' %(self.getClassName(service.name), self.base_class_name) print >>s, '%ssoapAction = {}' % self.getIndent(level=1) print >>s, '%swsAction = {}' % self.getIndent(level=1) print >>s, '%sroot = {}' % self.getIndent(level=1) def setUpMethods(self, port): '''set up all methods representing the port operations. Parameters: port -- Port that defines the operations. ''' assert isinstance(port, WSDLTools.Port), \ 'expecting WSDLTools.Port not: ' %type(port) binding = port.getBinding() portType = port.getPortType() service = port.getService() s = self._services[service.name] for bop in binding.operations: try: op = portType.operations[bop.name] except KeyError, ex: raise WsdlGeneratorError,\ 'Port(%s) PortType(%s) missing operation(%s) defined in Binding(%s)' \ %(port.name, portType.name, op.name, binding.name) soap_action = wsaction_in = wsaction_out = None if op.input is not None: wsaction_in = op.getInputAction() if op.output is not None: wsaction_out = op.getOutputAction() for ext in bop.extensions: if isinstance(ext, WSDLTools.SoapOperationBinding) is False: continue soap_action = ext.soapAction if not soap_action: break if wsaction_in is None: break if wsaction_in == soap_action: break if self.strict is False: warnings.warn(\ 'Port(%s) operation(%s) in Binding(%s) soapAction(%s) != WS-Action(%s)' \ %(port.name, op.name, binding.name, soap_action, wsaction_in), ) break raise WsdlGeneratorError,\ 'Port(%s) operation(%s) in Binding(%s) soapAction(%s) MUST match WS-Action(%s)' \ %(port.name, op.name, binding.name, soap_action, wsaction_in) method_name = self.getMethodName(op.name) m = s.newMethod() print >>m, '%sdef %s(self, ps, address):' %(self.getIndent(level=1), method_name) msgin_name = msgout_name = None msgin,msgout = op.getInputMessage(),op.getOutputMessage() if msgin is not None: msgin_name = TextProtect(msgin.name) if msgout is not None: msgout_name = TextProtect(msgout.name) indent = self.getIndent(level=2) for l in self.createMethodBody(msgin_name, msgout_name): print >>m, indent + l print >>m, '' print >>m, '%ssoapAction[\'%s\'] = \'%s\'' %(self.getIndent(level=1), wsaction_in, method_name) print >>m, '%swsAction[\'%s\'] = \'%s\'' %(self.getIndent(level=1), method_name, wsaction_out) print >>m, '%sroot[(%s.typecode.nspname,%s.typecode.pname)] = \'%s\'' \ %(self.getIndent(level=1), msgin_name, msgin_name, method_name) ZSI-2.1-a1/ZSI/generate/pyclass.py 0000644 0001751 0001751 00000024713 10513030247 015007 0 ustar zsi zsi ############################################################################ # Joshua R. Boverhof, LBNL # See LBNLCopyright for copyright notice! ########################################################################### import pydoc, sys, warnings from ZSI import TC # If function.__name__ is read-only, fail def _x(): return try: _x.func_name = '_y' except: raise RuntimeError,\ 'use python-2.4 or later, cannot set function names in python "%s"'\ %sys.version del _x #def GetNil(typecode=None): # """returns the nilled element, use to set an element # as nilled for immutable instance. # """ # # nil = TC.Nilled() # if typecode is not None: nil.typecode = typecode # return nil # # #def GetNilAsSelf(cls, typecode=None): # """returns the nilled element with typecode specified, # use returned instance to set this element as nilled. # # Key Word Parameters: # typecode -- use to specify a derived type or wildcard as nilled. # """ # if typecode is not None and not isinstance(typecode, TC.TypeCode): # raise TypeError, "Expecting a TypeCode instance" # # nil = TC.Nilled() # nil.typecode = typecode or cls.typecode # return nil class pyclass_type(type): """Stability: Unstable type for pyclasses used with typecodes. expects the typecode to be available in the classdict. creates python properties for accessing and setting the elements specified in the ofwhat list, and factory methods for constructing the elements. Known Limitations: 1)Uses XML Schema element names directly to create method names, using characters in this set will cause Syntax Errors: (NCNAME)-(letter U digit U "_") """ def __new__(cls, classname, bases, classdict): """ """ #import new typecode = classdict.get('typecode') assert typecode is not None, 'MUST HAVE A TYPECODE.' # Assume this means immutable type. ie. str if len(bases) > 0: #classdict['new_Nill'] = classmethod(GetNilAsSelf) pass # Assume this means mutable type. ie. ofwhat. else: assert hasattr(typecode, 'ofwhat'), 'typecode has no ofwhat list??' assert hasattr(typecode, 'attribute_typecode_dict'),\ 'typecode has no attribute_typecode_dict??' #classdict['new_Nill'] = staticmethod(GetNil) if typecode.mixed: get,set = cls.__create_text_functions_from_what(typecode) if classdict.has_key(get.__name__): raise AttributeError,\ 'attribute %s previously defined.' %get.__name__ if classdict.has_key(set.__name__): raise AttributeError,\ 'attribute %s previously defined.' %set.__name__ classdict[get.__name__] = get classdict[set.__name__] = set for what in typecode.ofwhat: get,set,new_func = cls.__create_functions_from_what(what) if classdict.has_key(get.__name__): raise AttributeError,\ 'attribute %s previously defined.' %get.__name__ classdict[get.__name__] = get if classdict.has_key(set.__name__): raise AttributeError,\ 'attribute %s previously defined.' %set.__name__ classdict[set.__name__] = set if new_func is not None: if classdict.has_key(new_func.__name__): raise AttributeError,\ 'attribute %s previously defined.' %new_func.__name__ classdict[new_func.__name__] = new_func assert not classdict.has_key(what.pname),\ 'collision with pname="%s", bail..' %what.pname pname = what.pname if pname is None and isinstance(what, TC.AnyElement): pname = 'any' assert pname is not None, 'Element with no name: %s' %what # TODO: for pname if keyword just uppercase first letter. #if pydoc.Helper.keywords.has_key(pname): pname = pname[0].upper() + pname[1:] assert not pydoc.Helper.keywords.has_key(pname), 'unexpected keyword: %s' %pname classdict[pname] =\ property(get, set, None, 'property for element (%s,%s), minOccurs="%s" maxOccurs="%s" nillable="%s"'\ %(what.nspname,what.pname,what.minOccurs,what.maxOccurs,what.nillable) ) # # mutable type
-
parents:
simpleType
attributes:
id -- ID
itemType -- QName, required or simpleType child.
contents:
annotation?, simpleType?
"""
attributes = {'id':None,
'itemType':None }
contents = {'xsd':['annotation', 'simpleType']}
tag = 'list'
def __init__(self, parent):
XMLSchemaComponent.__init__(self, parent)
self.annotation = None
self.content = None
def getItemType(self):
return self.attributes.get('itemType')
def getTypeDefinition(self, attribute='itemType'):
"""
return the type refered to by itemType attribute or
the simpleType content. If returns None, then the
type refered to by itemType is primitive.
"""
tp = XMLSchemaComponent.getTypeDefinition(self, attribute)
return tp or self.content
def fromDom(self, node):
self.annotation = None
self.content = None
self.setAttributes(node)
contents = self.getContents(node)
for indx in range(len(contents)):
component = SplitQName(contents[indx].getTagName())[1]
if (component == 'annotation') and (not indx):
self.annotation = Annotation(self)
self.annotation.fromDom(contents[indx])
elif (component == 'simpleType'):
self.content = AnonymousSimpleType(self)
self.content.fromDom(contents[indx])
break
else:
raise SchemaError, 'Unknown component (%s)' %(i.getTagName())
class AnonymousSimpleType(SimpleType,\
SimpleMarker,\
LocalMarker):
"""
- 1. Introduction
- 2. Examples
- 3. Exceptions
- 4. Utilities
- 5. The ParsedSoap module -- basic message handling
- 6. The TypeCode classes -- data conversions
- 7. The SoapWriter module -- serializing data
- 8. The Fault module -- reporting errors
- 9. The resolvers module -- fetching remote data
- 10. Dispatching and Invoking
- 11. Bibliography
- Bibliography
- A. CGI Script Array
- B. CGI Script Struct
- C. Complete Low Level Example
- D. pickler example
- ZSI takes data from an input stream and parses it, generating
a DOM-based parse tree as part of creating a ParsedSoap object.
At this point the major syntactic elements of a SOAP message -- the
Header, theBody, etc. -- are available. - The application does header processing.
More specifically, it does local dispatch and processing based on
the elements in the SOAP
Header. The SOAPactorandmustUnderstandattributes are also handled (or at least recognized) here. - ZSI next parses the
Body, creating local Python objects from the data in the SOAP message. The parsing is often under the control of a list of data descriptions, known as typecodes, defined by the application because it knows what type of data it is expecting. In cases where the SOAP data is known to be completely self-describing, the parsing can be dynamic through the use of the TC.Any class. - The application now dispatches to the appropriate handler in order to do its ``real work.'' As part of its processing it may create output objects
- The application creates a SoapWriter instance and outputs an initial set of namespace entries and header elements.
- Any local data to be sent back to the client is serialized.
As with
Bodyparsing, the datatypes can be described through typecodes or determined dynamically (here, through introspection). - In the event of any processing exceptions, a Fault object can be raised, created, and/or serialized.
- exception ZSIException
- Base class for all ZSI Exceptions, it is a subtype of the Python Exception class.
- exception ParseException
- ZSI can raise this exception while creating a ParsedSoap object. It is a subtype of the ZSIException class. The string form of a ParseException object consists of a line of human-readable text. If the backtrace is available, it will be concatenated as a second line.
- inheader
-
A boolean that indicates if the error was detected in the SOAP
Headerelement. - str
- A text string describing the error.
- trace
-
A text string containing a backtrace to the error.
This may be
Noneif it was not possible, such as when there was a general DOM exception, or when thestrtext is believed to be sufficient. - exception EvaluateException
- This exception is similar to ParseException, except that ZSI may raise it while converting between SOAP and local Python objects.
- str
- A text string describing the error.
- trace
- A text backtrace, as described above for ParseException.
Version( ) - Returns a three-element tuple containing the numbers representing the major, minor, and release identifying the ZSI version. New in version 1.1.
_attrs( element) -
Returns a list of all attributes of the specified
element. _backtrace( elt, dom) -
This function returns a text string that traces a ``path'' from
dom, a DOM root, toelt, an element within that document, in XPath syntax. _child_elements( element) -
Returns a list of all children elements of the specified
element. _children( element) -
Returns a list of all children of the specified
element. _find_arraytype( element) -
The value of the SOAP
arrayTypeattribute. New in version 1.2. _find_attr( element, name) -
The value of the unqualified
nameattribute. _find_attrNS( element, namespaceURI, localName) -
The value of a
nameattribute in a namespacenamespaceURI. _find_attrNodeNS( element, namespaceURI, localName) -
Works just like
_find_attrNS, but this function grabs the attribute Node to distinquish between an unspecified attribute(None) and one set to empty string(""). _find_default_namespace( element) - Returns the value of the default namespace.
_find_encstyle( element) -
The value of the SOAP
encodingStyleattribute. _find_href( element) -
The value of the unqualified
hrefattribute. _find_type( element) -
The value of the XML Schema
typeattribute. _find_xmlns_prefix( element, prefix) -
The value of the xmlns:prefix
typeattribute. _find_xsi_attr( element, attribute) - Find the attribute in any of the XMLSchema namespaces.
_get_element_nsuri_name( element) -
Returns a
(namespace,name)tuple representing the element tag. _get_idstr( obj) - Substitute for id function. Python 2.3.x generates a FutureWarning for negative IDs, so we use a different prefix character to ensure uniqueness, and call abs() to avoid the warning.
_get_postvalue_from_absoluteURI( url) -
Returns POST value from
url, and caches these values. _resolve_prefix( element, prefix) -
resolve
prefixto a namespaceURI. IfNoneor emptystr, return default namespace orNoneif not defined. _valid_encoding( elt) -
Return true if the element
elthas a SOAP encoding that can be handled by ZSI (currently Section 5 of the SOAP 1.1 specification or an empty encoding for XML). class ParsedSoap( input[, **keywords]) -
Creates a ParsedSoap object from the provided input source.
If
inputis not a string, then it must be an object with a read() method that supports the standard Python ``file read'' semantics.The following keyword arguments may be used:
Keyword Default Description envelopeTrueexpect a SOAP Envelope keepdomFalseDo not release the DOM when this object is destroyed. To access the DOM object, use the GetDomAndReader() method. The reader object is necessary to properly free the DOM structure using reader.releaseNode(dom). New in version 1.2. readerclassNoneClass used to create DOM-creating XML readers; described below. New in version 1.2. resolverNoneValue for the resolverattribute; see below.trailersFalseAllow trailing data elements to appear after the Body. - body
-
The root of the SOAP
Bodyelement. Using the GetElementNSdict() method on this attribute can be useful to get a dictionary to be used with the SoapWriter class. - body_root
-
The element that contains the SOAP serialization root; that is,
the element in the SOAP
Bodythat ``starts off'' the data. - data_elements
-
A (possibly empty) list of all child elements of the
Bodyother than the root. - header
-
The root of the SOAP
Headerelement. Using the GetElementNSdict() method on this attribute can be useful to get a dictionary to be used with the SoapWriter class. - header_elements
-
A (possibly empty) list of all elements in the SOAP
Header. - trailer_elements
-
Returns a (possibly empty) list of all elements following the
Body. If thetrailerskeyword was not used when the object was constructed, this attribute will not be instantiated and retrieving it will raise an exception. - resolver
-
If not
None, this attribute can be invoked to handle absolutehref's in the SOAP data. It will be invoked as follows:resolver( uri, tc, ps, **keywords) -
The
uriparameter is the URI to resolve. Thetcparameter is the typecode that needs to resolvehref; this may be needed to properly interpret the content of a MIME bodypart, for example. Thepsparameter is the ParsedSoap object that is invoking the resolution (this allows a single resolver instance to handle multiple SOAP parsers).Failure to resolve the URI should result in an exception being raised. If there is no content, return
None; this is not the same as an empty string. If there is content, the data returned should be in a form understandable by the typecode.
Backtrace( elt) - Returns a human-readable ``trace'' from the document root to the specified element.
FindLocalHREF( href, elt) -
Returns the element that has an
idattribute whose value is specified by thehreffragment identifier. Thehrefmust be a fragment reference -- that is, it must start with a pound sign. This method raises an EvaluateException exception if the element isn't found. It is mainly for use by the parsing methods in the TypeCode module. GetElementNSdict( elt) - Return a dictionary for all the namespace entries active at the current element. Each dictionary key will be the prefix and the value will be the namespace URI.
GetMyHeaderElements( [actorlist=None]) -
Returns a list of all elements in the
Headerthat are intended for this SOAP processor. This includes all elements that either have no SOAPactorattribute, or whose value is either the special ``next actor'' value or in theactorlistlist of URI's. GetDomAndReader( ) -
Returns a tuple containing the dom and reader objects,
(dom, reader). Unless keepdom is true, the dom and reader objects will go out of scope when the ParsedSoap instance is deleted. If keepdom is true, the reader object is needed to properly clean up the dom tree with reader.releaseNode(dom). IsAFault( ) - Returns true if the message is a SOAP fault.
Parse( how) -
Parses the SOAP
Bodyaccording to thehowparameter, and returns a Python object. Ifhowis not a TC.TypeCode object, then it should be a Python class object that has atypecodeattribute. ResolveHREF( uri, tc[, **keywords]) -
This method is invoked to resolve an absolute URI.
If the typecode
tchas aresolverattribute, it will use it to resolve the URI specified in theuriparameter, otherwise it will use its ownresolver, or raise an EvaluateException exception.Any
keywordparameters will be passed to the chosen resolver. If no content is available, it will returnNone. If unable to resolve the URI it will raise an EvaluateException exception. Otherwise, the resolver should return data in a form acceptable to the specified typecode,tc. (This will almost always be a file-like object holding opaque data; for XML, it may be a DOM tree.) WhatActorsArePresent( ) -
Returns a list of the values of all the SOAP
actorattributes found in child elements of the SOAPHeader. WhatMustIUnderstand( ) -
Returns a list of "(uri, localname)" tuples for all elements in the
SOAP
Headerthat have the SOAPmustUnderstandattribute set to a non-zero value. fromString( string) - Return a DOM object from a string.
fromStream( stream) - Return a DOM object from a file-like stream.
releaseNode( dom) - Free the specified DOM object.
class TypeCode( **keywords) -
The following keyword arguments may be used:
Keyword Default Description pnameNoneparameter name of the object anameNoneattribute name of the object minOccurs1schema facet minimum occurances maxOccurs1schema facet maximum occurances nillableFalseschema facet is this nillable ( xsi:nil="true")typedTrueOutput type information (in the xsi:typeattribute) when serializing. By special dispensation, typecodes within a TC.Struct object inherit this from the container.unique0If true, the object is unique and will never be ``aliased'' with another object, so the idattribute need not be output.pyclassNonewhen parsing data, instances of this class can be created to store the data. Default behavior is reflective of specific TypeCode classes. attrs_aname'_attrs'attribute name of the object where attribute values are stored. Used for serialization and parsing. Optional elements are those which do not have to be an incoming message, or which have the XML Schema
nilattribute set. When parsing the message as part of aStruct, then the Python instance attribute will not be set, or the element will not appear as a dictionary key. When being parsed as a simple type, the valueNoneis returned. When serializing an optional element, a non-existent attribute, or a value ofNoneis taken to mean not present, and the element is skipped. - typechecks
- This is a class attribute. If true (the default) then all typecode constructors do more rigorous type-checking on their parameters.
- tag
- This is a class attribute. Specifies the global element declaration this typecode represents, the value is a "(namespace, name)" tuple.
- type
- This is a class attribute. Specifies the global type definition this typecode represents, the value is a "(namespace, name)" tuple.
- attribute_typecode_dict
-
This is a class attribute.
This is a dict of "(URI, NCName)" tuple keys, the values of each is a
typecode. This is how attribute declarations other than SOAP and XMLSchema
attribute declarations (eg.
xsi:type,id,href, etc) are represented. - logger
- This is a class attribute. logger instance for this class.
checkname( elt, ps) -
Checks if the name and type of the element
eltare correct and raises a EvaluateException if not. Returns the element's type as a "(uri, localname)" tuple if so. checktype( elt, ps) - Like checkname() except that the element name is ignored. This method is actually invoked by checkname() to do the second half of its processing, but is useful to invoke directly, such as when resolving multi-reference data.
nilled( elt, ps) -
If the element
elthas data, this returnsFalse. If it has no data, and the typecode is not optional, an EvaluateException is raised; if it is optional, aTrueis returned. simple_value( elt, ps, mixed=False) -
Returns the text content of the element
elt. If no value is present, or the element has non-text children, an EvaluateException is raised. IfmixedisFalseif child elements are discovered an EvaluateException is raised, else join all text nodes and return the result. class Any( name[, **keywords]) -
Used for parsing incoming SOAP data (that is typed), and serializing
outgoing Python data.
The following keyword arguments may be used:
Keyword Default Description aslistFalseIf true, then the data is (recursively) treated as a list of values. The default is a Python dictionary, which preserves parameter names but loses the ordering. New in version 1.1. In addition, if the Python object being serialized with an Any has a
typecodeattribute, then the serialize method of the typecode will be invoked to do the serialization. This allows objects to override the default dynamic serialization. class NEWTYPECODE(TypeCode)( ...) - The new typecode should be derived from the TC.TypeCode class, and TypeCode.__init__() must be invoked in the new class's constructor.
- parselist
-
This is a class attribute, used when parsing incoming SOAP data.
It should be a sequence of "(uri, localname)" tuples to identify
the datatype.
If
uriisNone, it is taken to mean either the XML Schema namespace or the SOAP encoding namespace; this should only be used if adding support for additional primitive types. If this list is empty, then the type of the incoming SOAP data is assumed to be correct; an empty list also means that incoming typed data cannot by dynamically parsed. - errorlist
-
This is a class attribute, used when reporting a parsing error.
It is a text string naming the datatype that was expected.
If not defined, ZSI will create this attribute from the
parselistattribute when it is needed. - seriallist
- This is a class attribute, used when serializing Python objects dynamically. It specifies what types of object instances (or Python types) this typecode can serialize. It should be a sequence, where each element is a Python class object, a string naming the class, or a type object from Python's types module (if the new typecode is serializing a built-in Python type).
parse( elt, ps) -
ZSI invokes this method to
parse the
eltelement and return its Python value. Thepsparameter is the ParsedSoap object, and can be used for dereferencinghref's, calling Backtrace() to report errors, etc. serialize( sw, pyobj[, **keywords]) -
ZSI invokes this method to output a Python object to a SOAP stream.
The
swparameter will be a SoapWriter object, and thepyobjparameter is the Python object to serialize.The following keyword arguments may be used:
Keyword Default Description attrtextNoneText (with leading space) to output as an attribute; this is normally used by the TC.Array class to pass down indexing information. nameNoneName to use for serialization; defaults to the name specified in the typecode, or a generated name. typedper-typecode Whether or not to output type information; the default is to use the value in the typecode. RegisterType( class[, clobber=0[, **keywords]]) -
By default, it is an error to replace an existing type registration, and
an exception will be raised.
The
clobberparameter may be given to allow replacement. A single instance of theclassobject will be created, and thekeywordparameters are passed to the constructor. - empty_content
- This is a class attribute. Value returned when tag or node is present, is not nilled, and without text content.
class String( name[, **keywords]) -
The parent type of all strings.
The following keyword arguments may be used:
Keyword Default Description resolverNoneA function that can resolve an absolute URI and return its content as a string, as described in the ParsedSoap description. stripTrueIf true, leading and trailing whitespace are stripped from the content. class Enumeration( value_list, name[, **keywords]) -
Like TC.String, but the value must be a member of
the
choicessequence of text strings class Base64String( name[, **keywords]) - The value is encoded in Base-64.
class HexBinaryString( name[, **keywords]) - Each byte is encoded as its printable version.
class URI( name[, **keywords]) -
The value is URL quoted (e.g.,
%20for the space character). class XMLString( name[, **keywords]) -
Parses the data as a string, but returns an XML DOM object.
For serialization, takes an XML DOM (or element node), and outputs
it as a string.
The following keyword arguments may be used:
Keyword Default Description readerclassNoneClass used to create DOM-creating XML readers; described in the ParsedSoap chapter. class Integer( [**keywords]) -
The parent type of all integers.
This class handles any of the several types (and ranges) of SOAP integers.
The following keyword arguments may be used:
Keyword Default Description format%dFormat string for serializing. New in version 1.2. class IEnumeration( choices[, **keywords]) -
Like TC.Integer, but the value must be a member of
the
choicessequence. class Ibyte( [**keywords]) - A signed eight-bit value.
class IunsignedByte( [**keywords]) - An unsigned eight-bit value.
class Ishort( [**keywords]) - A signed 16-bit value.
class IunsignedShort( [**keywords]) - An unsigned 16-bit value.
class Iint( [**keywords]) - A signed 32-bit value.
class IunsignedInt( [**keywords]) - An unsigned 32-bit value.
class Ilong( [**keywords]) - An signed 64-bit value.
class IunsignedLong( [**keywords]) - An unsigned 64-bit value.
class IpositiveInteger( [**keywords]) - A value greater than zero.
class InegativeInteger( [**keywords]) - A value less than zero.
class InonPositiveInteger( [**keywords]) - A value less than or equal to zero.
class InonNegativeInteger( [**keywords]) - A value greater than or equal to zero.
class Decimal( [**keywords]) -
The parent type of all floating point numbers.
This class handles any of the several types (and ranges) of SOAP
floating point numbers.
The following keyword arguments may be used:
Keyword Default Description format%fFormat string for serializing. New in version 1.2. class FPEnumeration( value_list, name[, **keywords]) -
Like TC.Decimal, but the value must be a member of
the
value_listsequence. Be careful of round-off errors if using this class. class FPfloat( name[, **keywords]) - An IEEE single-precision 32-bit floating point value.
class FPdouble( name[, **keywords]) - An IEEE double-precision 64-bit floating point value.
- Some date and time formats will be parsed into tuples that are
not valid time values.
For example, 75 minutes is a valid duration, although not a legal value
for the minutes element of a time tuple.
- Fractional parts of a second may be lost when parsing, and may have
extra trailing zero's when serializing.
- Badly-formed time tuples may result in non-sensical values being serialized;
the first six values are taken directly as year, month, day, hour, minute,
second in UTC.
- Although the classes Duration and Gregorian are defined, they
are for internal use only and should not be included in any TypeCode
you define. Instead, use the classes beginning with a lower case g in your
typecodes.
class Duration( [**keywords]) - A relative time period. Negative durations have all values less than zero; this makes it easy to add a duration to a Python time tuple.
class Gregorian( [**keywords]) -
An absolute time period.
This class should not be instantiated directly; use one of the
gXXXclasses instead. class gDateTime( [**keywords]) - A date and time.
class gDate( [**keywords]) - A date.
class gYearMonth( [**keywords]) - A year and month.
class gYear( [**keywords]) - A year.
class gMonthDay( [**keywords]) - A month and day.
class gDay( [**keywords]) - A day.
class gTime( [**keywords]) - A time.
class Boolean( [**keywords]) -
When marshaling zero or the word ``false'' is returned as
0and any non-zero value or the word ``true'' is returned as1. When serializing, the number0or1will be generated. class XML( [**keywords]) -
This typecode represents a portion of an XML document embedded in a SOAP
message.
The value is the element node.
The following keyword arguments may be used:
Keyword Default Description copyitTC.XML.copyit Return a copy of the parsed data. comments0Preserve comments in output. inline0The XML sub-tree is single-reference, so can be output in-place. resolverNoneA function that can resolve an absolute URI and return its content as an element node, as described in the ParsedSoap description. wrapped1If zero, the XML is output directly, and not within a SOAP wrapper element. New in version 1.2. class ComplexType( pyclass, ofwhat[, **keywords]) -
This class defines a compound data structure.
If
pyclassisNone, then the data will be marshaled into a Python dictionary, and each item in theofwhatsequence specifies a (possible) dictionary entry. Otherwise,pyclassmust be a Python class object. The data is then marshaled into the object, and each item in theofwhatsequence specifies an attribute of the instance to set.Note that each typecode in
ofwhatmust have a name.The following keyword arguments may be used:
Keyword Default Description inorderFalseItems within the structure must appear in the order specified in the ofwhatsequence.inlineFalseThe structure is single-reference, so ZSI does not have to use href/idencodings.mutableFalseIf an object is going to be serialized multiple times, and its state may be modified between serializations, then this keyword should be used, otherwise a single instance will be serialized, with multiple references to it. This argument implies the inlineargument. New in version 1.2.typeNoneA "(uri, localname)" tuple that defines the type of the structure. If present, and if the input data has a xsi:typeattribute, then the namespace-qualified value of that attribute must match the value specified by this parameter. By default, type-checking is not done for structures; matching child element names is usually sufficient and senders rarely provide type information.mixedFalseusing a mixed content model, allow text and element content. mixed_aname'_text'if mixed is True, text content is set in this attribute (key). If the
typedkeyword is used, then its value is assigned to all typecodes in theofwhatparameter. If any of the typecodes inofwhatare repeatable, then theinorderkeyword should not be used and thehasextrasparameter must be used.For example, the following C structure:
could be declared as follows:struct foo { int i; char* text; };class foo: def __init__(self, name): self.name = name def __str__(self): return str((self.name, self.i, self.text)) foo.typecode = TC.Struct(foo, ( TC.Integer('i'), TC.String('text') ), 'foo') class Array( atype, ofwhat[, **keywords]) -
The
atypeparameter is a(URI,NCName)tuple representing the SOAP array type. Theofwhatparameter is a typecode describing the array elements. class Apache.Map( name[, **keywords]) - An Apache map. Note that the class name is dotted.
class SoapWriter( optional**keywords) -
The following keyword arguments may be used:
Keyword Default Description encodingStyleNone If not None, then use the specified value as the value for the SOAPencodingStyleattribute. New in version 1.2.envelopeTrueCreate a SOAP Envelope New in version 1.2. nsdict{}Dictionary of namespaces to declare in the SOAP EnvelopeheaderTruecreate a SOAP HeaderelementoutputclassElementProxywrapper around DOM or other XML library. serialize( pyobj[, typecode=None[, root=None[, header_pyobjs=None[, **keywords]]]]) -
This method serializes the
pyobjPython object as directed by thetypecodetypecode object. Iftypecodeis omitted, thenpyobjshould be a Python object instance of a class that has atypecodeattribute. It returnsself, so that serializations can be chained together, or so that the close() method can be invoked. Therootparameter may be used to explicitly indicate the root (main element) of a SOAP encoding, or indicate that the item is not the root. If specified, it should have the numeric value of zero or one. Any other keyword parameters are passed to the typecode'sserializemethod. close( ) - Invokes all the callbacks, if any. The close operations can only happen once, if invoked a second time it will just return. This method will be invoked automatically if the object is deleted.
__str__( ) - Invokes the close method, and returns a string representation of the serialized object. Assumes that serialize has been invoked.
AddCallback( func, arg) -
Used by typecodes when serializing, allows them to add output after
the SOAP
Bodyis written but before the SOAPEnvelopeis closed. The function func() will be called with the SoapWriter object and the specifiedargargument, which may be a tuple. Forget( obj) -
Forget that
objhas been seen before. This is useful when repeatedly serializing a mutable object. Known( obj) -
If
objhas been seen before (based on its Pythonid), return1. Otherwise, rememberobjand return0. ReservedNS( prefix, uri) -
Returns true if the specified namespace
prefixanduricollide with those used by the implementation. writeNSDict( nsdict) -
Outputs
nsdictas a namespace dictionary. It is assumed that an XML start-element is pending on the output stream. class Fault( code, string[, **keywords]) -
The code parameter is a text string identifying the SOAP fault
code, a namespace-qualified name.
The class attribute
Fault.Clientcan be used to indicate a problem with an incoming message,Fault.Servercan be used to indicate a problem occurred while processing the request, orFault.MUcan be used to indicate a problem with the SOAPmustUnderstandattribute. The string parameter is a human-readable text string describing the fault.The following keyword arguments may be used:
Keyword Default Description actor NoneA string identifying the actorattribute that caused the problem (usually because it is unknown).detail NoneA sequence of elements to output in the detailelement; it may also be a text string, in which case it is output as-is, and should therefore be XML text.headerdetail NoneData, treated the same as the detailkeyword, to be output in the SOAP header. See the following paragraph.If the fault occurred in the SOAP
Header, the specification requires that the detail be sent back as an element within the SOAPHeaderelement. Unfortunately, the SOAP specification does not describe how to encode this; ZSI defines and uses aZSI:detailelement, which is analogous to the SOAPdetailelement. - actor
-
A text string holding the value of the SOAP
faultactorelement. - code
-
A text string holding the value of the SOAP
faultcodeelement. - detail
-
A text string or sequence of elements containing holding the value of the
SOAP
detailelement, when available. - headerdetail
- A text string or sequence of elements containing holding the value of the ZSI header detail element, when available.
- string
-
A text string holding the value of the SOAP
faultstringelement. AsSOAP( [, **kw]) - This method serializes the Fault object into a SOAP message. The message is returned as a string. Any keyword arguments are passed to the SoapWriter constructor. New in version 1.1; the old AsSoap() method is still available.
DataForSOAPHeader( ) -
This method returns a text string that can be included as the
headerparameter for constructing a SoapWriter object. serialize( sw) - This method outputs the fault object onto the sw object, which is a SoapWriter instance.
FaultFromActor( uri[, actor]) -
This function could be used when an application receives a message
that has a SOAP
Headerelement directed to an actor that cannot be processed. The uri parameter identifies the actor. The actor parameter can be used to specify a URI that identifies the application, if it is not the ultimate recipient of the SOAP message. FaultFromException( ex, inheader[, tb[, actor]]) -
This function creates a Fault from a general Python exception.
A SOAP ``server'' fault is created.
The ex parameter should be the Python exception.
The inheader parameter should be true if the error was
found on a SOAP
Headerelement. The optional tb parameter may be a Python traceback object, as returned by "sys.exc_info()[2]". The actor parameter can be used to specify a URI that identifies the application, if it is not the ultimate recipient of the SOAP message. FaultFromFaultMessage( ps) - This function creates a Fault from a ParsedSoap object passed in as ps. It should only be used if the IsAFault() method returned true.
FaultFromNotUnderstood( uri, localname,[, actor]) -
This function could be used when an application receives a message with
the SOAP
mustUnderstandattribute that it does not understand. The uri and localname parameters should identify the unknown element. The actor parameter can be used to specify a URI that identifies the application, if it is not the ultimate recipient of the SOAP message. FaultFromZSIException( ex[, actor]) - This function creates a Fault object from a ZSI exception, ParseException or EvaluateException, passed in as ex. A SOAP ``client'' fault is created. The actor parameter can be used to specify a URI that identifies the application, if it is not the ultimate recipient of the SOAP message.
Opaque( uri, tc, ps[, **keywords]) -
This function returns the data contained at the specified
urias a Python string. Base-64 decoding will be done if necessary. Thetcandpsparameters are ignored; thekeywordsare passed to the urlopen method. XML( uri, tc, ps[, **keywords]) -
This function returns a list of the child element nodes of the XML
document at the specified
uri. Thetcandpsparameters are ignored; thekeywordsare passed to the urlopen method. class NetworkResolver( [prefixes=None]) -
The
prefixesparameter is a list of strings defining the allowed prefixes of any URI's. If asked to fetch the content for a URI that does start with one of the prefixes, it will raise an exception.In addition to
OpaqueandXMLmethods, this class provides aResolvemethod that examines the typecode to determine what type of data is desired. class MIMEResolver( ct, f[, **keywords]) -
The
ctparameter is a string that contains the value of the MIMEContent-Typeheader. Thefparameter is the input stream, which should be positioned just after the message headers.The following keyword arguments may be used:
Keyword Default Description seekable0Whether or not the input stream is seekable; passed to the constructor for the internal multifile object. Changed in version 2.0: default had been 1. nextNoneA resolver object that will be asked to resolve the URI if it is not found in the MIME document. New in version 1.1. uribaseNoneThe base URI to be used when resolving relative URI's; this will typically be the value of the Content-Locationheader, if present. New in version 1.1. GetSOAPPart( ) - This method returns a stream containing the SOAP message text.
- parts
- An array of tuples, one for each MIME bodypart found. Each tuple has two elements, a mimetools.Message object which contains the headers for the bodypart, and a StringIO object containing the data.
- id_dict
-
A dictionary whose keys are the values of any
Content-IDheaders, and whose value is the appropriatepartstuple. - loc_dict
-
A dictionary whose keys are the values of any
Content-Locationheaders, and whose value is the appropriatepartstuple. class AUTH( ) -
This class defines constants used to identify how the client
authenticated:
noneif no authentication was provided;httpbasicif HTTP basic authentication was used, orzsibasicif ZSI basic authentication (see below)) was used. AsServer( [**keywords]) -
This creates a HTTPServer object with a request handler that only
supports the ``POST'' method.
Dispatch is based solely on the name of the root element in the
incoming SOAP request;
the request URL is ignored.
The following keyword arguments may be used:
Keyword Default Description port80Port to listen on. addr''Address to listen on. docstyleFalseExhibit the docstyle behavior. rpcFalseExhibit the rpc behavior. modules(__main__,)List of modules containing functions that can be invoked. typesmodule(__main__,)This module is used for parsing, it contains class definitions that specify the typecodeattribute.nsdict{}Namespace dictionary to send in the SOAP Envelope AsCGI( [**keywords]) -
This method parses the CGI input and invokes a function that has the
same name as the top-level SOAP request element.
The following keyword arguments may be used:
Keyword Default Description rpcFalseExhibit the rpc behavior. modules(__main__,)List of modules containing functions that can be invoked. typesmodule(__main__,)This module is used for parsing, it contains class definitions that specify the typecodeattribute.nsdict{}Namespace dictionary to send in the SOAP Envelope AsHandler( request=None[, **keywords]) -
This method is used within a JonPY handler to do dispatch.
The following keyword arguments may be used:
Keyword Default Description requestNonemodpython HTTPRequest instance. modules(__main__,)List of modules containing functions that can be invoked. docstyleFalseExhibit the docstyle behavior. rpcFalseExhibit the rpc behavior. typesmodule(__main__,)This module is used for parsing, it contains class definitions that specify the typecodeattribute.nsdict{}Namespace dictionary to send in the SOAP Envelope AsJonPy( request=None[, **keywords]) -
This method is used within a JonPY handler to do dispatch.
The following keyword arguments may be used:
Keyword Default Description requestNonejonpy Request instance. modules(__main__,)List of modules containing functions that can be invoked. docstyleFalseExhibit the docstyle behavior. rpcFalseExhibit the rpc behavior. typesmodule(__main__,)This module is used for parsing, it contains class definitions that specify the typecodeattribute.nsdict{}Namespace dictionary to send in the SOAP EnvelopeThe following code shows a sample use:
import jon.fcgi from ZSI import dispatch import MyHandler class Handler(cgi.Handler): def process(self, req): dispatch.AsJonPy(modules=(MyHandler,), request=req) jon.fcgi.Server({jon.fcgi.FCGI_RESPONDER: Handler}).run() GetClientBinding( ) -
More sophisticated scripts may want to use access the client binding object,
which encapsulates all information about the client invoking the script.
This function returns
Noneor the binding information, an object of type ClientBinding, described below. class ClientBinding( ...) - This object contains information about the client. It is created internally by ZSI.
GetAuth( ) -
This returns a tuple containing information about the client identity.
The first element will be one of the constants from the
AUTHclass described above. For HTTP or ZSI basic authentication, the next two elements will be the name and password provided by the client. GetNS( ) - Returns the namespace URI that the client is using, or an empty string. This can be useful for versioning.
GetRequest( ) - Returns the ParsedSoap object of the incoming request.
- environ
- A dictionary of the environment variables. This is most useful when AsCGI() is used.
class _Binding( [**keywords]) -
This class encapsulates a connection to a server, known as a binding.
A single binding may be used for multiple RPC calls.
Between calls, modifiers may be used to change the URL being posted to,
etc.
Cookies are also supported; if a response comes back with a
Set-Cookieheader, it will be parsed and used in subsequent interactions.The following keyword arguments may be used:
Keyword Default Description auth(AUTH.none,)A tuple with authentication information; the first value should be one of the constants from the AUTH class. nsdict{}Namespace dictionary to send in the SOAP Envelopesoapaction''Value for the SOAPActionHTTP header.readerclassNoneClass used to create DOM-creating XML readers; see the description in the ParsedSoap class. writerclassNoneElementProxy Class used to create XML writers; see the description in the SoapWriter class. tracefileNoneAn object with a writemethod, where packet traces will be recorded.transportHTTPConnection/HTTPSConnection transport class transdict{} keyword arguments for connection initialization urln/a URL to post to. wsAddressURINone URI, identifies the WS-Address specification to use. By default it's not used. sig_handlerNone XML Signature handler, must sign and verify. If using SSL, the
cert_fileandkey_filekeyword parameters may be passed to the transport's constructor via thetransdict. For details about HTTPSConnection see the documentation for the httplib module. AddHeader( header, value) -
Output the specified
headerandvaluewith the HTTP headers. SetAuth( style, name, password) -
The
styleshould be one of the constants from theAUTHclass described above. The remaining parameters will vary depending on thestyle. Currently only basic authentication data of name and password are supported. SetNS( uri) -
Set the default namespace for the request to the specified
uri. SetURL( url) -
Set the URL where the post is made to
url. ResetHeaders( ) - Remove any headers that were added by AddHeader().
- trace
-
If this attribute is not
None, it should be an object with awritemethod, where packet traces will be recorded. RPC( url, opname, pyobj, replytype=None[, **keywords]) -
This is the highest-level invocation method.
It calls Send() to send
pyobjto the specifiedurlto perform theopnameoperation, and calls Receive() expecting to get a reply of the specifiedreplytype.This method will raise a TypeError if the response does not appear to be a SOAP message, or if is valid SOAP but contains a fault.
Send( url, opname, pyboj[, **keywords]) -
This sends the specified
pyobjto the specifiedurl, invoking theopnamemethod. Theurlcan beNoneif it was specified in the Binding constructor or ifSetURLhas been called. See below for a shortcut version of this method.The following keyword arguments may be used:
Keyword Default Description auth_headerNoneString (containing presumably serialized XML) to output as an authentication header. Envelopensdict{}Namespace dictionary to send in the SOAP Enveloperequesttypecoden/a Typecode specifying how to serialize the data. soapactionObtained from the Binding Value for the SOAPActionHTTP header. IsSOAP( ) - Returns true if the message appears to be a SOAP message. (Some servers return an HTML page under certain error conditions.)
IsAFault( ) - Returns true if the message is a SOAP fault.
ReceiveRaw( ) - Returns the unparsed message body.
ReceiveSoap( ) - Returns a ParsedSOAP object containing the parsed message. Raises a TypeError if the message wasn't SOAP.
ReceiveFault( ) - Returns a Fault object containing the SOAP fault message. Raises a TypeError if the message did not contain a fault.
Receive( replytype=None) -
Parses a SOAP message.
The
replytypespecifies how to parse the data. If it sNone, dynamic parsing will be used, usually resulting in a Python list. Ifreplytypeis a Python class, then the class'stypecodeattribute will be used, otherwisereplytypeis taken to be the typecode to use for parsing the data. - reply_code
- The HTTP reply code, a number.
- reply_headers
- The HTTP headers, as a mimetools object.
- reply_msg
- A text string containing the HTTP reply text.
class Binding( [**keywords]) -
For other keyword arguments see _Binding.
Keyword Default Description typesmoduleNoneSee explanation in Dispatching opname( *args) - Using this shortcut requires that the url attribute is set, either throught the constructor or SetURL().
class NamedParamBinding( [**keywords]) -
For other keyword arguments see _Binding.
Keyword Default Description typesmoduleNoneSee explanation in Dispatching opname( **kwargs) - Using this shortcut requires that the url attribute is set, either throught the constructor or SetURL().
 |
 |
 |
ZSI: The Zolera Soap Infrastructure
Developer's Guide |
 |
|
|
ZSI: The Zolera Soap Infrastructure
Developer's Guide
Rich Salz,
rsalz@datapower.com
blunck@python.org
Christopher Blunck
Release 2.1.0
November 01, 2007
COPYRIGHT
Copyright © 2001, Zolera Systems, Inc.
All Rights Reserved.
Copyright © 2002-2003, Rich Salz.
All Rights Reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, provided that the above copyright notice(s) and this permission notice appear in all copies of the Software and that both the above copyright notice(s) and this permission notice appear in supporting documentation.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization of the copyright holder.
Acknowledgments
We are grateful to the members of the soapbuilders
mailing list (see http://groups.yahoo.com/soapbuilders),
Fredrik Lundh for his soaplib package (see
http://www.secretlabs.com/downloads/index.htm#soap),
Cayce Ullman and Brian Matthews for their SOAP.py package
(see http://sourceforge.net/projects/pywebsvcs).
We are particularly grateful to Brian Lloyd and the Zope Corporation (http://www.zope.com) for letting us incorporate his ZOPE WebServices package and documentation into ZSI.
Abstract:
ZSI, the Zolera SOAP Infrastructure, is a Python package that
provides an implementation of SOAP messaging, as described in
The SOAP 1.1 Specification.
In particular, ZSI parses and generates SOAP messages, and
converts between native Python datatypes and SOAP syntax.
It can also be used to build applications using
SOAP Messages with
Attachments.
ZSI is ``transport neutral'', and provides only a simple
I/O and dispatch framework; a more complete solution is the
responsibility of the application using ZSI.
As usage patterns emerge, and common application frameworks are
more understood, this may change.
ZSI requires Python 2.3 or later.
The ZSI homepage is at http://pywebsvcs.sf.net/.
Contents
1. Introduction
ZSI, the Zolera SOAP Infrastructure, is a Python package that provides an implementation of the SOAP specification, as described in The SOAP 1.1 Specification. In particular, ZSI parses and generates SOAP messages, and converts between native Python datatypes and SOAP syntax.
ZSI requires Python 2.3 or later.
The ZSI project is maintained at SourceForge, at http://pywebsvcs.sf.net. ZSI is discussed on the Python web services mailing list, visit http://lists.sourceforge.net/lists/listinfo/pywebsvcs-talkto subscribe.
For those interested in using the wsdl2py tool see the Users Guide, it contains a detailed example of how to use the code generation facilities in ZSI.
For those interested in a high-level tutorial covering ZSI and why Python was chosen, see the article http://www.xml.com/pub/a/ws/2002/06/12/soap.html, written by Rich Salz for xml.com.
SOAP-based processing typically involves several steps. The following list details the steps of a common processing model naturally supported by ZSI (other models are certainly possible):
Note that ZSI is ``transport neutral'', and provides only a simple I/O and dispatch framework; a more complete solution is available through the use of included WSDL tools (wsdl2py), but otherwise this is the responsibility of the application using ZSI. As usage patterns emerge, and common application frameworks are more understood, this may change.
Within this document, tns is used as the prefix for the
application's target namespace, and the term
element refers to a DOM element node.)
1.1 How to Read this Document
Readers interested in using WSDL and clients to web services, and those intending on implementing web services based on existing WSDL should refer to the Users Guide. Others interested in developing the simplest SOAP applications, or spending the least amount of time on building a web services infrastructure should read chapters 2, 3, and 10 of this document. Readers who are developing complex services, and who are familiar with XML Schema and/or WSDL, should read this manual in order. This will provide them with enough information to implement the processing model described above. They can skip probably skip chapters 2 and 10.
ZSI has the capability to process WSDL definitions and XML Schema documents (described in The Web Services Description Language and XMLSchema 1.0) and generate typecodes automatically. For more information see the Users Guide.
2. Examples
This chapter contains a number of examples to show off some of ZSI's features. It is broken down into client-side and server-side examples, and explores different implementation options ZSI provides.
2.1 Server Side Examples
2.1.1 Simple example
Using the ZSI.dispatch module, it is simple to expose Python functions as web services. Each function is invoked with all the input parameters specified in the client's SOAP request. Any value returned by the function will be serialized back to the client; multiple values can be returned by returning a tuple.The following code shows some simple services:
#!/usr/local/bin/python2.4
# SOAP Array
def hello():
return ["Hello, world"]
def echo(*args):
return args
def sum(*args):
sum = 0
for i in args: sum += i
return [sum]
def average(*args):
return [sum(*args) / len(args)]
from ZSI import dispatch
dispatch.AsCGI(rpc=True)
Each function defines a SOAP request, so if this script is installed
as a CGI script, a SOAP message can be posted to that script's URL with any of
hello, echo, or average as the request element,
and the value returned by the function will be sent back. These functions
expect and return SOAP-ENC:arrayType instances which are marshalled into python
list instances, this script interoperates with the
client.Binding. For more information see Appendix A.
The ZSI CGI dispatcher catches exceptions and sends back a SOAP fault.
For example, a fault will be sent if the hello function is given any
arguments, or if the average function is given a non-integer.
Here is another example but using SOAP-ENC:Struct instances which are marshalled into python dict instances, this script interoperates with the client.NamedParamBinding. For more information see Appendix B.
#!/usr/local/bin/python2.4
# SOAP Struct
def hello():
return {"value":"Hello, world"}
def echo(**kw):
return kw
def sum(**kw):
sum = 0
for i in kw.values(): sum += i
return {"value":sum}
def average(**kw):
d = sum(**kw)
return d["value"] = d["value"]/len(kw)
from ZSI import dispatch
dispatch.AsCGI(rpc=True)
2.1.2 low level soap processing example
We will now show a more complete example of a robust web service implemented at the SOAP layer. It takes as input a player name and array of integers, and returns the average. It is presented in sections, following the steps detailed above. A complete working example of this service is available in Appendix C.
The first section reads in a request, and parses the SOAP header.
from ZSI import *
import sys
IN, OUT = sys.stdin, sys.stdout
try:
ps = ParsedSoap(IN)
except ParseException, e:
OUT.write(FaultFromZSIException(e).AsSOAP())
sys.exit(1)
except Exception, e:
# Faulted while processing; we assume it's in the header.
OUT.write(FaultFromException(e, 1).AsSOAP())
sys.exit(1)
# We are not prepared to handle any actors or mustUnderstand elements,
# so we'll arbitrarily fault back with the first one we found.
a = ps.WhatActorsArePresent()
if len(a):
OUT.write(FaultFromActor(a[0]).AsSOAP())
sys.exit(1)
mu = ps.WhatMustIUnderstand()
if len(mu):
uri, localname = mu[0]
OUT.write(FaultFromNotUnderstood(uri, localname).AsSOAP())
sys.exit(1)
This section defines the mappings between Python objects and the SOAP data being transmitted. Recall that according to the SOAP specification, RPC input and output are modeled as a structure.
class Player:
def __init__(self, *args):
if not len(args): return
self.Name = args[0]
self.Scores = args[1:]
Player.typecode = TC.Struct(Player, [
TC.String('Name'),
TC.Array('Integer', TC.Integer(), 'Scores', undeclared=True),
], 'GetAverage')
class Average:
def __init__(self, average=None):
self.average = average
Average.typecode = TC.Struct(Average, [
TC.Integer('average'),
], 'GetAverageResponse')
This section parses the input, performs the application-level activity, and serializes the response.
try:
player = ps.Parse(Player.typecode)
except EvaluateException, e:
OUT.write(FaultFromZSIException(e).AsSOAP())
sys.exit(1)
try:
total = 0
for value in player.Scores: total = total + value
result = Average(total / len(player.Scores))
sw = SoapWriter()
sw.serialize(result, Average.typecode)
sw.close()
OUT.write(str(sw))
except Exception, e:
OUT.write(FaultFromException(e, 0, sys.exc_info()[2]).AsSOAP())
sys.exit(1)
In the serialize() call above, the second parameter is optional, since
result is an instance of the Average class, and the
Average.typecode attribute is the typecode for class instances.
2.1.3 A mod_python example
The Apache module mod_python (see
http://www.modpython.org) embeds Python within the Apache server.
In order to expose operations within a module via mod_python, use the
dispatch.AsHandler() function. The dispatch.AsHandler()
function will dispatch requests to any operation defined in the module you
pass it, which allows for multiple operations to be defined in a module.
The only trick is to use __import__ to load the XML encodings your service
expects. This is a required workaround to avoid the pitfalls of restricted
execution with respect to XML parsing.
The following is a complete example of a simple handler. The soap operations are implemented in the MyHandler module:
def hello():
return {"value":"Hello, world"}
def echo(**kw):
return kw
def sum(**kw):
sum = 0
for i in kw.values(): sum += i
return {"value":sum}
def average(**kw):
d = sum(**kw)
d["value"] = d["value"]/len(kw)
return d
Dispatching from within mod_python is achieved by passing the aforementined
MyHandler module to dispatch.AsHandler(). The following code exposes
the operations defined in MyHandler via SOAP:
from ZSI import dispatch
from mod_python import apache
import MyHandler
mod = __import__('encodings.utf_8', globals(), locals(), '*')
mod = __import__('encodings.utf_16_be', globals(), locals(), '*')
def handler(req):
dispatch.AsHandler(modules=(MyHandler,), request=req, rpc=True)
return apache.OK
2.2 Client Side Examples
2.2.1 Simple Example
ZSI provides two ways for a client to interactive with a server: the Binding or NamedParamBinding class and the ServiceProxy class. The first is useful when the operations to be invoked are not defined in WSDL or when only simple Python datatypes are used; the ServiceProxy class can be used to parse WSDL definitions in order to determine how to serialize and parse the SOAP messages.
During development, it is often useful to record ``packet traces'' of
the SOAP messages being exchanged. Both the Binding and
ServiceProxy classes provide a tracefile parameter to specify an
output stream (such as a file) to capture messages. It can be particularly
useful when debugging unexpected SOAP faults.
The first example provided below demonstrates how to use the NamedParamBinding class to connect to a remote service and perform an operation.
#!/usr/bin/env python import sys,time from ZSI.client import NamedParamBinding as NPBinding b = NPBinding(url='http://127.0.0.1/cgi-bin/soapstruct', tracefile=sys.stdout) print "Hello: ", b.hello() print "Echo: ", b.echo(name="josh", year=2006, pi=3.14, time=time.gmtime()) print "Sum: ", b.sum(one=1, two=2, three=3) print "Average: ", b.average(one=100, two=200, three=300, four=400)
2.2.2 Complex Example: pickler.py
If the operation invoked returns a ComplexType, typecode information must be provided in order to tell ZSI how to deserialize the response. Here is a sample server-side implementation (for the complete example see Appendix D):
class Person:
def __init__(self, name=None, age=0):
self.name = name
self.age = age
Person.typecode = TC.Struct(Person,
[TC.String('name'),
TC.InonNegativeInteger('age')],
'myApp:Person')
# my web service that returns a complex structure
def getPerson(name):
fp = open('%s.person.pickle', % name, 'r')
return pickle.load(fp)
# my web service that accepts a complex structure
def savePerson(person):
fp = open('%s.person.pickle' % person.name, 'w')
pickle(person, fp)
fp.close()
In order for ZSI to transparently deserialize the returned complex type into a Person instance, a module defining the class and its typecode can be passed into the Binding. It is also possible to explicitly tell ZSI what typecode to use by passing it as a parameter to the Binding.Receive() method.
The following fragment shows both styles:
import sys
from ZSI.client import Binding
from MyComplexTypes import Person
b = Binding(url='http://localhost/test3/pickler.py', tracefile=sys.stdout)
person = Person('christopher', 26)
rsp = b.savePerson(person)
Because the returned complex type is defined in a class present in typesmodule, transparent deserialization is possible. When sending complex types to the server, it is not necessary to list the module in typesmodule:
import sys
import MyComplexTypes
from ZSI.client import NamedParamBinding as NPBinding, Binding
from ZSI import TC
kw = {'url':'http://localhost/test3/pickler.py', 'tracefile':sys.stdout}
b = NPBinding(**kw)
rsp = b.getPerson(name='christopher')
assert type(rsp) is dict, 'expecting a dict'
assert rsp['Person']['name'] == 'christopher', 'wrong person'
b = NPBinding(typesmodule=MyComplexTypes, **kw)
rsp = b.getPerson(name='christopher')
assert isinstance(rsp['Person'], MyComplexTypes.Person), (
'expecting instance of %s' %MyComplexTypes.Person)
b = Binding(typesmodule=MyComplexTypes, **kw)
class Name(str):
typecode = TC.String("name")
rsp = b.getPerson(Name('christopher'))
assert isinstance(rsp['Person'], MyComplexTypes.Person), (
'expecting instance of %s' %MyComplexTypes.Person)
3. Exceptions
The following attributes are read-only:
The following attributes are read-only:
4. Utilities
ZSI defines some utility methods that general applications may want to use.
4.1 Low-Level Utilities
ZSI also defines some low-level utilities for its own use that start with a leading underscore and must be imported explicitly. They are documented here because they can be useful for developing new typecode classes.
These functions are mostly used in in parse methods and the
ParsedSoap class. The serialization routines use the
ElementProxy class to encapsulate common DOM-level operations.
Some lambda's are defined so that some DOM accessors
will return an empty list rather than None.
This means that rather than writing:
if elt.childNodes:
for N in elt.childNodes:
...
for N in _children(elt): ...
Other lambda's return SOAP-related attributes from an element,
or None if not present.
_copyright _empty_nsuri_list
5. The ParsedSoap module -- basic message handling
This class represents an input stream that has been parsed as a SOAP message.
The following attributes of a ParsedSoap are read-only:
The following attribute may be modified:
The following methods are available:
ZSI supports multiple DOM implementations.
The readerclass parameter specifies which one to use.
The default is to use minidom, provided through the DefaultReader class
in the ZSI.parse module.
The specified reader class must support the following methods:
The DOM object must support the standard Python mapping of the DOM Level 2 specification. While only a small subset of specification is used, the particular methods and attributes used by ZSI are available only by inspecting the source.
To use the cDomlette DOM provided by the 4Suite package, use the
NonvalidatingReader class in the Ft.Xml.Domlette module.
Due to name changes in the 1.0 version of 4Suite, a simple adapter class
is required to use this DOM implementation.
from 4Suite.Xml.Domlette import NonvalidatingReaderBase
class 4SuiteAdapterReader(NonvalidatingReaderBase):
def fromString(self, str):
return self.parseString(str)
def fromStream(self, stream):
return self.parseStream(stream)
def releaseNode(self, node):
pass
6. The TypeCode classes -- data conversions
The TypeCode module defines classes used for converting data between SOAP data and local Python objects. Python numeric and string types, and sequences and dictionaries, are supported by ZSI. The TC.TypeCode class is the parent class of all datatypes understood by ZSI.
All typecodes classes have the prefix TC., to avoid name clashes.
ZSI provides fine-grain control over the names used when parsing and
serializing XML into local Python objects, through the use of two
attributes: the pname, the aname. The pname specifies the
name expected on the XML element being parsed and the name to use for the output element
when serializing. The aname is the name to use for the analogous
attribute in the local Python object.
The pname is the parameter name. It specifies the incoming
XML element name and the default values for the Python attribute
and serialized names. All typecodes take the pname argument. This name can be
specified as either a list or a string. When specified as a list, it must have
two elements which are interpreted as a ``(namespace-URI, localname)'' pair.
If specified this way, both the namespace and the local element name
must match for the parse to succeed. For the Python attribute, and
when generating output, only the ``localname'' is used. If a namespace-URI is
specified then the full qualified name is used for output, and it is required
for input; this requires the namespace prefix to be specified.
The aname is the attribute name. This parameter overrides
any value implied by the pname. Typecodes nested in a TC.Struct
or TC.ComplexType can use this parameter to specify
the tag, dictionary key, or instance attribute to set.
The nsdict parameter to the SoapWriter construct can be used to
specify prefix to namespace-URI mappings, these are otherwise handled automatically.
6.1 TC.TypeCode
The TypeCode class is the parent class of all typecodes.
The following methods are useful for defining new typecode classes;
see the section on dynamic typing for more details. In all of the following,
the ps parameter is a ParsedSoap object.
6.2 TC.Any -- the basis of dynamic typing
SOAP provides a flexible set of serialization rules, ranging from
completely self-describing to completely opaque, requiring an external
schema. For example, the following are all possible ways of encoding an
integer element i with a value of 12:
6.2.1 simple data
- requires type information<tns:i xsi:type="SOAP-ENC:integer">12</tns:i> <tns:i xsi:type="xsd:nonNegativeInteger">12</tns:i> <SOAP-ENC:integer>12</SOAP-ENC:integer> <tns:i>12</tns:i>
The first three lines are examples of typed elements. If ZSI is asked to parse any of the above examples, and a TC.Any typecode is given, it will properly create a Python integer for the first three, and raise a EvaluateException for the fourth.
6.2.2 compound data
- Struct or Array Compound data, such as astruct, may also be self-describing (namespace
are omitted for clarity):
<tns:foo>
<tns:i xsi:type="SOAP-ENC:integer">12</tns:i>
<tns:name xsi:type="SOAP-ENC:string">Hello world</tns:name>
</tns:foo>
If this is parsed with a TC.Any typecode, either a Python dict
is created or if aslist is True a list:
ps = ParsedSoap(xml, envelope=False)
print ps.Parse(TC.Any())
{ 'name': u'Hello world', 'i': 12 }
print ps.Parse(TC.Any(aslist=True))
[ 12, u'Hello world' ]
6.2.3 class description
Referring back to the compound XML data above, it is possible to create a new
typecode capable of parsing elements of type mytype.
This class would know that the i element is an integer,
so that the explicit typing becomes optional, rather than required.
6.2.4 Adding new types
Most of the TypeCodes classes in TC are registered with Any, making an instance of itself available for dynamic typing. New TypeCode classes can be created and registered with Any by using RegisterType. In order to override an existing entry in the registry call RegisterType withclobber=True. The serialization entries are mappings between builtin
Python types and a TypeCode instance, it is not possible to have one
Python type map to multiple typecodes. The parsing entries are mappings
between (namespaceURI,name) tuples, representing the xsi:type
attribute, and a TypeCode instance. Thus, only one instance of a
TypeCode class can represent a XML Schema type. So this mechanism is
not appropriate for representing XML Schema element information.
Once the new typecode class has been defined, it should be registered with ZSI's dynamic type system by invoking the following function:
If the class is not registered, then instances of the class cannot be processed as dynamic types. This may be acceptable in some environments.
6.3 TC.SimpleType
Parent class of all simple types.
6.4 Strings
SOAP/XMLSchema Strings are Python strings.
In addition to TC.String, the basic string, several subtypes are provided that transparently handle common encodings. These classes create a temporary string object and pass that to the serialize() method. When doing RPC encoding, and checking for non-unique strings, the TC.String class must have the original Python string, as well as the new output. This is done by adding a parameter to the serialize() method:
| Keyword | Default | Description |
|---|---|---|
orig |
None |
If deriving a new typecode from the string class, and the derivation creates a temporary Python string (such as by Base64String), than this parameter is the original string being serialized. |
It is often the case that a parameter will be typed as a string for transport purposes, but will in fact have special syntax and processing requirements. For example, a string could be used for an XPath expression, but it is more convenient for the Python value to actually be the compiled expression. Here is how to do that:
import xml.xpath.pyxpath
import xml.xpath.pyxpath.Compile as _xpath_compile
class XPathString(TC.String):
def __init__(self, name, **kw):
TC.String.__init__(self, name, **kw)
def parse(self, elt, ps):
val = TC.String.parse(self, elt, ps)
try:
val = _xpath_compile(val)
except:
raise EvaluateException("Invalid XPath expression",
ps.Backtrace(elt))
return val
In particular, it is common to send XML as a string, using entity encoding to protect the ampersand and less-than characters.
6.5 Integers
SOAP/XMLSchema integers are Python integers.
A number of sub-classes are defined to handle smaller-ranged numbers.
6.6 Floating-point Numbers
SOAP/XMLSchema floating point numbers are Python floats.
Two sub-classes are defined to handle smaller-ranged numbers.
6.7 Dates and Times
SOAP dates and times are Python time tuples in UTC (GMT), as documented in the Python time module. Time is tricky, and processing anything other than a simple absolute time can be difficult. (Even then, timezones lie in wait to trip up the unwary.) A few caveats are in order:
In addition, badly-formed values may result in non-sensical serializations.
When serializing, an integral or floating point number is taken as the number of seconds since the epoch, in UTC.
6.8 Boolean
SOAP Booleans are Python integers.
6.9 XML
XML is a Python DOM element node.
If the value to be serialized is a Python string, then an href
is generated, with the value used as the URI.
This can be used, for example, when generating SOAP with attachments.
Otherwise, the XML is typically put inside a wrapper element that sets
the proper SOAP encoding style.
For efficiency, incoming XML is returend as a ``pointer'' into the
DOM tree maintained within the ParsedSoap object.
If that object is going to go out of scope, the data will be destroyed
and any XML objects will become empty elements.
The class instance variable copyit, if non-zero indicates that a
deep copy of the XML subtree will be made and returned as the value.
Note that it is generally more efficient to keep the ParsedSoap
object alive until the XML data is no longerneeded.
When serializing, it may be necessary to specify which namespace prefixes
are ``active'' in the XML.
This is done by using the unsuppressedPrefixes parameter when
calling the serialize() method.
(This will only work when XML is the top-level item being serialized,
such as when using typecodes and document-style interfaces.)
| Keyword | Default | Description |
|---|---|---|
unsuppressedPrefixes |
[] | An array of strings identifying the namespace prefixes that should be output. |
6.10 ComplexType
Represents the XMLSchema ComplexType . New in version 2.0.
6.11 Struct
SOAP Struct is a complex type for accessors identified by name. No element may have the same name as any other, nor may any element have a maxOccurs > 1. SOAP Structs are either Python dictionaries or instances of application-specified classes.
6.12 Arrays
SOAP arrays are Python lists; multi-dimensional arrays are lists of lists and are indistinguishable from a SOAP array of arrays. Arrays may be sparse, in which case each element in the array is a tuple of "(subscript, data)" pairs. If an array is not sparse, a specified fill element will be used for the missing values.
Currently only singly-dimensioned arrays are supported.
The following keyword arguments may be used:
| Keyword | Default | Description |
|---|---|---|
childnames |
None |
Default name to use for the child elements. |
dimensions |
1 |
The number of dimensions in the array. |
fill |
None |
The value to use when an array element is omitted. |
mutable |
False |
If an object is going to be serialized multiple times, and its state may be modified between serializations, then this keyword should be used, otherwise a single instance will be serialized, with multiple references to it. |
nooffset |
0 |
Do not use the SOAP offset
attribute so skip leading elements with the same value as fill. |
sparse |
False |
The array is sparse. |
size |
None |
An integer or list of integers that specifies the maximum array dimensions. |
undeclared |
False |
The SOAP "arrayType" attribute need not appear. |
6.13 Apache Datatype
The Apache SOAP project, urlhttp://xml.apache.org/soap/index.html,
has defined a popular SOAP datatype in the
http://xml.apache.org/xml-soap namespace, a
Map.
The Map type is encoded as a list of item elements.
Each item has a key and value child element; these
children must have SOAP type information.
An Apache Map is either a Python dictionary or a list of two-element
tuples.
The following keyword arguments may be used:
| Keyword | Default | Description |
|---|---|---|
aslist |
0 |
Use a list of tuples rather than a dictionary. |
7. The SoapWriter module -- serializing data
The SoapWriter class is used to output SOAP messages.
Note that its output is encoded as UTF-8; when transporting SOAP over
HTTP it is therefore important to set the charset attribute
of the Content-Type header.
The SoapWriter class reserves some namespace prefixes:
| Prefix | URI |
|---|---|
SOAP-ENV |
http://schemas.xmlsoap.org/soap/envelope/ |
SOAP-ENC |
http://schemas.xmlsoap.org/soap/encoding/ |
ZSI |
http://www.zolera.com/schemas/ZSI/ |
xsd |
http://www.w3.org/2001/XMLSchema |
xsi |
http://www.w3.org/2001/XMLSchema-instance |
Creating a SoapWriter object with envelope set to False
results in an object that can be used for serializing objects into a string.
The following methods are primarily useful for those writing new typecodes.
8. The Fault module -- reporting errors
SOAP defines a fault message as the way for a recipient to indicate it was unable to process a message. The ZSI Fault class encapsulates this.
The following attributes are read-only:
If other data is going to be sent with the fault, the following
two methods can be used.
Because some data might need to be output in the SOAP Header,
serializing a fault is a two-step process.
Some convenience functions are available to create a Fault from common conditions.
9. The resolvers module -- fetching remote data
The resolvers module provides some functions and classes
that can be used as the resolver attribute for TC.String
or TC.XML typecodes.
They process an absolute URL, as described above, and return the
content.
Because the resolvers module can import a number of other
large modules, it must be imported directly, as in
"from ZSI import resolvers".
These first two functions pass the URI directly to the urlopen function in the urllib module. Therefore, if used directly as resolvers, a client could direct the SOAP application to fetch any file on the network or local disk. Needless to say, this could pose a security risks.
The NetworkResolver class provides a simple-minded way to limit the URI's that will be resolved.
If the SOAP application is given a multi-part MIME document, the MIMEResolver class can be used to process SOAP with Attachments.
The MIMEResolver class will read the entire multipart MIME document,
noting any Content-ID or Content-Location headers that appear
on the headers of any of the message parts, and use them to resolve
any href attributes that appear in the SOAP message.
In addition to to the Opaque, Resolve, and XML methods
as described above, the following method is available:
The following attributes are read-only:
10. Dispatching and Invoking
New in version 1.1.
ZSI is focused on parsing and generating SOAP messages, and provides limited facilities for dispatching to the appropriate message handler. This is because ZSI works within many client and server environments, and the dispatching styles for these different environments can be very different.
Nevertheless, ZSI includes some dispatch and invocation functions. To use them, they must be explicitly imported, as shown in the example at the start of this document.
The implementation (and names) of the these classes reflects the orientation of using SOAP for remote procedure calls (RPC).
Both client and server share a class that defines the mechanism a client uses to authenticate itself.
The ZSI schema (see the last chapter of this manual)
defines a SOAP header element, BasicAuth, that
contains a name and password.
This is similar to the HTTP basic authentication header, except
that it can be used independently from an HTTP transport.
10.1 Dispatching
The ZSI.dispatch module allows you to expose Python functions as a web service. The module provides the infrastructure to parse the request, dispatch to the appropriate handler, and then serialize any return value back to the client. The value returned by the function will be serialized back to the client. If an exception occurs, a SOAP fault will be sent back to the client.
10.1.1 Dispatch Behaviors
By default the callback is invoked with the pyobj representation of the body root element, and it is expected to return a self-describing request (w/typecode). Parsing is done via a typecode from typesmodule, or Any. Other keyword options are available in dispatch mechanisms (see below) that result in different behavior.
10.1.1.1 rpc
An rpc service will ignore the body root (RPC Wrapper) of the request, and parse all "parts" of message via individual typecodes. The callback function is expected to return the parts of the message in a dict or a list. The dispatch mechanism will try to serialize it as a Struct but if this is not possible it will be serialized as an Array. Parsing done via a typecode from typesmodule, or Any. Not compatible with docstyle.
10.1.1.2 docstyle
Callback is invoked with a ParsedSoap instance representing the request, and the return value is serialized with an XML typecode (DOM). The result in wrapped as an rpc-style message, with Response appended to the request wrapper. Not compatible with rpc.
10.1.2 Special Modules
These are keyword options available to all dispatch mechansism (see below).
10.1.2.1 modules
Dispatch is based solely on the name of the root element in the incoming SOAP request; the request URL is ignored. These modules will be search for a matching function. If no modules are specified, only the __main__ module will be searched.
10.1.2.2 typesmodule
Used for parsing. This module should contain class definitions with thetypecode attribute set to a TypeCode
instance. By default, a class definition matching the root element name will be
retrieved or the Any typecode will be used. If using rpc, each child of
the root element will be used to retrieve a class definition of the same name.
10.1.3 Dispatch Mechanisms
Three dispatch mechanisms are provided: one supports standard CGI scripts, one runs a dedicated server based on the BaseHTTPServer module, and the third uses the JonPY package, http://jonpy.sourceforge.net, to support FastCGI.
10.1.4 Other Dispatch Stuff
The following attribute is read-only:
10.2 The client module -- sending SOAP messages
ZSI includes a module to connect to a SOAP server over HTTP, send requests, and parse the response. It is built on the standard Python httplib and Cookie modules. It must be explicitly imported, as in "from ZSI.client import AUTH,Binding".
10.2.1 _Binding
Once a _Binding object has been created, the following modifiers are available. All of them return the binding object, so that multiple modifiers can be chained together.
The following attribute may also be modified:
Once the necessary parameters have been specified (at a minimum, the URL
must have been given in the constructor are through SetURL),
invocations can be made.
Methods are available to determine the type of response that came back:
Having determined the type of the message (or, more likely, assuming it was good and catching an exception if not), the following methods are available to actually parse the data. They will continue to return the same value until another message is sent.
Once a reply has been parsed (or its type examined), the following read-only attributes are available. Their values will remain unchanged until another reply is parsed.
10.2.2 Binding
If an attribute is fetched other than one of those described in _Binding, it is taken to be theopname of a remote procedure, and
a callable object is returned. This object dynamically parses its arguments,
receives the reply, and parses that.
10.2.3 NamedParamBinding
If an attribute is fetched other than one of those described in _Binding, it is taken to be theopname of a remote procedure, and a callable
object is returned. This object dynamically parses its arguments, receives the
reply, and parses that.
11. Bibliography
Bibliography
A. CGI Script Array
A.1 Intro
This is an example of a simple web service CGI Script. The service returns and expects SOAP Arrays (python list). A sample soap trace is provided below. In this example the CGI script is dispatched as a rpc service.
A.1.1 rpc wrapper
The wrapper element of the request is the dispatch key to the callback function, the child elements are passes as a list or dict of values to the callback function. The callback function is expected to return a list or dict of values, the response wrapper is by default set to the request wrapper name appended Response.
A.2 CGI Script
#!/usr/local/bin/python2.4
# SOAP Array
def hello():
return ["Hello, world"]
def echo(*args):
return args
def sum(*args):
sum = 0
for i in args: sum += i
return [sum]
def average(*args):
return [sum(*args) / len(args)]
from ZSI import dispatch
dispatch.AsCGI(rpc=True)
A.3 client test script
#!/usr/bin/env python
# client.py
import sys
from ZSI.client import Binding
b = Binding(url='http://127.0.0.1/cgi-bin/simple', tracefile=sys.stdout)
print b.hello()
try:
print b.hello(1)
except Exception, ex:
print "Fault: ", ex
print b.echo("whatever", "hi", 1, 2)
print b.sum(*[2*i for i in range(5)])
print b.average(*[2*i for i in range(5)])
A.4 SOAP Trace
A.4.1 hello
$ ./client.py Hello: _________________________________ Wed Oct 4 17:36:33 2006 REQUEST: <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <hello SOAP-ENC:arrayType="xsd:anyType[0]"></hello> </SOAP-ENV:Body> </SOAP-ENV:Envelope> _________________________________ Wed Oct 4 17:36:34 2006 RESPONSE: 200 <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <helloResponse SOAP-ENC:arrayType="xsd:anyType[1]"> <element id="o671b0" xsi:type="xsd:string">Hello, world</element> </helloResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> [u'Hello, world']
A.4.2 hello fault
_________________________________ Wed Oct 4 17:36:34 2006 REQUEST: <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <hello SOAP-ENC:arrayType="xsd:anyType[1]"> <element id="o1803988" xsi:type="xsd:int">1</element> </hello> </SOAP-ENV:Body> </SOAP-ENV:Envelope> _________________________________ Wed Oct 4 17:36:35 2006 RESPONSE: 500 <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Server</faultcode> <faultstring>Processing Failure</faultstring> <detail> <ZSI:FaultDetail> <ZSI:string>exceptions:TypeError hello() takes no arguments (1 given)</ZSI:string> <ZSI:trace>build/bdist.darwin-8.8.0-Power_Macintosh/egg/ZSI/dispatch.py:86:_Dispatch</ZSI:trace> </ZSI:FaultDetail> </detail> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Fault: Processing Failure exceptions:TypeError hello() takes no arguments (1 given) [trace: build/bdist.darwin-8.8.0-Power_Macintosh/egg/ZSI/dispatch.py:86:_Dispatch]
A.4.3 echo
_________________________________ Wed Oct 4 17:36:35 2006 REQUEST: <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <echo SOAP-ENC:arrayType="xsd:anyType[4]"> <element id="o644c0" xsi:type="xsd:string">whatever</element> <element id="o644e0" xsi:type="xsd:string">hi</element> <element id="o1803988" xsi:type="xsd:int">1</element> <element id="o180397c" xsi:type="xsd:int">2</element> </echo> </SOAP-ENV:Body> </SOAP-ENV:Envelope> _________________________________ Wed Oct 4 17:36:36 2006 RESPONSE: 200 <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <echoResponse SOAP-ENC:arrayType="xsd:anyType[4]"> <element id="o4f4290" xsi:type="xsd:string">whatever</element> <element id="o4f4338" xsi:type="xsd:string">hi</element> <element id="o1803988" xsi:type="xsd:int">1</element> <element id="o180397c" xsi:type="xsd:int">2</element> </echoResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> [u'whatever', u'hi', 1, 2]
A.4.4 sum
_________________________________ Wed Oct 4 17:36:36 2006 REQUEST: <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <sum SOAP-ENC:arrayType="xsd:anyType[5]"> <element id="o1803994" xsi:type="xsd:int">0</element> <element id="o180397c" xsi:type="xsd:int">2</element> <element id="o1803964" xsi:type="xsd:int">4</element> <element id="o180394c" xsi:type="xsd:int">6</element> <element id="o1803934" xsi:type="xsd:int">8</element> </sum> </SOAP-ENV:Body> </SOAP-ENV:Envelope> _________________________________ Wed Oct 4 17:36:37 2006 RESPONSE: 200 <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <sumResponse SOAP-ENC:arrayType="xsd:anyType[1]"> <element id="o18038a4" xsi:type="xsd:int">20</element> </sumResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> [20]
A.4.5 average
_________________________________ Wed Oct 4 17:36:37 2006 REQUEST: <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <average SOAP-ENC:arrayType="xsd:anyType[5]"> <element id="o1803994" xsi:type="xsd:int">0</element> <element id="o180397c" xsi:type="xsd:int">2</element> <element id="o1803964" xsi:type="xsd:int">4</element> <element id="o180394c" xsi:type="xsd:int">6</element> ` <element id="o1803934" xsi:type="xsd:int">8</element> </average> </SOAP-ENV:Body> </SOAP-ENV:Envelope> _________________________________ Wed Oct 4 17:36:38 2006 RESPONSE: 200 <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <averageResponse SOAP-ENC:arrayType="xsd:anyType[1]"> <element id="o1803964" xsi:type="xsd:int">4</element> </averageResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> [4]
B. CGI Script Struct
B.1 Intro
This is an example of a simple web service CGI Script. The service returns and expects SOAP Structs (python dict). A sample soap trace is provided below. In this example the CGI script is dispatched as a rpc service.
B.1.1 rpc wrapper
The wrapper element of the request is the dispatch key to the callback function, the child elements are passes as a list or dict of values to the callback function. The callback function is expected to return a list or dict of values, the response wrapper is by default set to the request wrapper name appended Response.
B.2 CGI Script
#!/usr/local/bin/python2.4
# SOAP Struct
def hello():
return {"value":"Hello, world"}
def echo(**kw):
return kw
def sum(**kw):
sum = 0
for i in kw.values(): sum += i
return {"value":sum}
def average(**kw):
d = sum(**kw)
return d["value"] = d["value"]/len(kw)
from ZSI import dispatch
dispatch.AsCGI(rpc=True)
B.3 client test script
#!/usr/bin/env python import sys,time from ZSI.client import NamedParamBinding as NPBinding b = NPBinding(url='http://127.0.0.1/cgi-bin/soapstruct', tracefile=sys.stdout) print "Hello: ", b.hello() print "Echo: ", b.echo(name="josh", year=2006, pi=3.14, time=time.gmtime()) print "Sum: ", b.sum(one=1, two=2, three=3) print "Average: ", b.average(one=100, two=200, three=300, four=400)
B.4 SOAP Trace
B.4.1 hello
C. Complete Low Level Example
C.1 Intro
This is a complete example of using the low level soap utilities in ZSI to implement a web service.
C.2 code
C.2.1 httpserver script
Minimal http server example, opens up a new process to do the SOAP processing.
#!/usr/bin/env python
# file: httpserver.py
import os
from subprocess import Popen, PIPE
from BaseHTTPServer import BaseHTTPRequestHandler, HTTPServer
class RequestHandler(BaseHTTPRequestHandler):
def do_POST(self):
length = int(self.headers['content-length'])
xml_in = self.rfile.read(length)
p = Popen(os.path.join(os.path.curdir, 'player.py'),
shell=True, stdin=PIPE, stdout=PIPE)
(stdout, stderr) = p.communicate(xml_in)
code = 200
if stdout.find('Fault') >= 0: code = 500
self.send_response(code)
self.send_header('Content-type', 'text/xml; charset="utf-8"')
self.send_header('Content-Length', str(len(stdout)))
self.end_headers()
self.wfile.write(stdout)
self.wfile.flush()
if __name__ == '__main__':
server = HTTPServer(('localhost', 8080), RequestHandler)
server.serve_forever()
C.2.2 typecode module
# file: typecode.py
# CHECK PYTHONPATH: Must be able to import
class Player:
def __init__(self, *args):
if not len(args): return
self.Name = args[0]
self.Scores = args[1:]
Player.typecode = TC.Struct(Player, [
TC.String('Name'),
TC.Array('Integer', TC.Integer(), 'Scores', undeclared=True),
], 'GetAverage')
class Average:
def __init__(self, average=None):
self.average = average
Average.typecode = TC.Struct(Average, [
TC.Integer('average'),
], 'GetAverageResponse')
C.2.3 player script
#!/usr/bin/env python
# file: player.py
from ZSI import *
import sys
IN, OUT = sys.stdin, sys.stdout
try:
ps = ParsedSoap(IN)
except ParseException, e:
OUT.write(FaultFromZSIException(e).AsSOAP())
sys.exit(1)
except Exception, e:
# Faulted while processing; we assume it's in the header.
OUT.write(FaultFromException(e, 1).AsSOAP())
sys.exit(1)
# We are not prepared to handle any actors or mustUnderstand elements,
# so we'll arbitrarily fault back with the first one we found.
a = ps.WhatActorsArePresent()
if len(a):
OUT.write(FaultFromActor(a[0]).AsSOAP())
sys.exit(1)
mu = ps.WhatMustIUnderstand()
if len(mu):
uri, localname = mu[0]
OUT.write(FaultFromNotUnderstood(uri, localname).AsSOAP())
sys.exit(1)
from typecode import Player, Average
try:
player = ps.Parse(Player.typecode)
except EvaluateException, e:
OUT.write(FaultFromZSIException(e).AsSOAP())
sys.exit(1)
try:
total = 0
for value in player.Scores: total = total + value
result = Average(total / len(player.Scores))
sw = SoapWriter()
sw.serialize(result, Average.typecode)
sw.close()
OUT.write(str(sw))
except Exception, e:
OUT.write(FaultFromException(e, 0, sys.exc_info()[2]).AsSOAP())
sys.exit(1)
C.2.4 client test script
#!/usr/bin/env python2.4
#file: client.py
from ZSI import *
from ZSI.wstools.Namespaces import SCHEMA
from typecode import Player, Average
if __name__ == '__main__':
import sys
from ZSI.client import Binding
b = Binding(url='http://localhost:8080', tracefile=sys.stdout)
pyobj = b.RPC(None, None, Player("Josh",10,20,30), replytype=Average)
print pyobj
print pyobj.__dict__
C.3 SOAP Trace
C.3.1 GetAverage
$./client.py
_________________________________ Thu Oct 5 14:57:39 2006 REQUEST:
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ZSI="http://www.zolera.com/schemas/ZSI/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header></SOAP-ENV:Header>
<SOAP-ENV:Body>
<GetAverage>
<Name xsi:type="xsd:string">Josh</Name>
<Scores>
<element>10</element>
<element>20</element>
<element>30</element>
</Scores>
</GetAverage>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
_________________________________ Thu Oct 5 14:57:39 2006 RESPONSE:
200
OK
-------
Server: BaseHTTP/0.3 Python/2.5
Date: Thu, 05 Oct 2006 21:57:39 GMT
Content-type: text/xml; charset="utf-8"
Content-Length: 431
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ZSI="http://www.zolera.com/schemas/ZSI/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header></SOAP-ENV:Header>
<SOAP-ENV:Body>
<GetAverageResponse>
<average>20</average>
</GetAverageResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
<__main__.Average instance at 0x5f9760>
{'average': 20}
C.3.2 fault
Purposely send a incorrect Nae element for the Name.
$./client.py
_________________________________ Thu Oct 5 14:33:25 2006 REQUEST:
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ZSI="http://www.zolera.com/schemas/ZSI/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header></SOAP-ENV:Header>
<SOAP-ENV:Body>
<GetAverage>
<Nae xsi:type="xsd:string">Josh</Nae>
<Scores>
<element>10</element>
<element>20</element>
<element>30</element>
</Scores>
</GetAverage>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
_________________________________ Thu Oct 5 14:33:26 2006 RESPONSE:
500
Internal Server Error
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ZSI="http://www.zolera.com/schemas/ZSI/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header></SOAP-ENV:Header>
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Unparseable message</faultstring>
<detail><Eoe440><ZSI:ParseFaultDetail>
<ZSI:string>Element "Name" missing from complexType</ZSI:string>
<ZSI:trace>/SOAP-ENV:Envelope/SOAP-ENV:Body/GetAverage</ZSI:trace>
</ZSI:ParseFaultDetail></Eoe440></detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Traceback (most recent call last):
File "./player_client.py", line 25, in ?
pyobj = b.RPC(None, None, Player("Josh",10,20,30), replytype=Average)
File "/private/var/www/htdocs/guide/client.py", line 176, in RPC
File "/private/var/www/htdocs/guide/client.py", line 420, in Receive
ZSI.FaultException: Unparseable message
<Element Node at 5f9f58: Name='Eoe440' with 0 attributes and 1 children>
D. pickler example
D.1 Intro
This is an example of a stateful mod_python web service.
D.2 code
D.2.1 typecode module
Module containing complex type typecode.
# Complex type definition
from ZSI import *
class Person:
def __init__(self, name=None, age=0):
self.name = name
self.age = age
Person.typecode = TC.Struct(Person,
[TC.String('name'),
TC.InonNegativeInteger('age')],
pname=('urn:MyApp','Person'))
D.2.2 pickler script
Configure appache to use this script with mod_python PythonHandler.
# pickler.py
import pickle, new
from mod_python import apache
from ZSI import dispatch
import MyComplexTypes
# my web service that returns a complex structure
def getPerson(name=None):
#fp = open('/tmp/%s.person.pickle'%Person.name, 'r')
fp = open('/tmp/%s.person.pickle'%name, 'r')
#return pickle.load(fp)
p = pickle.load(fp)
print "PERSON: ", p
print "typecode: ", p.typecode
return p
# my web service that accepts a complex structure
def savePerson(Person):
print "PERSON: ", Person
fp = open('/tmp/%s.person.pickle'%Person.name, 'w')
pickle.dump(Person, fp)
fp.close()
return {}
mod = __import__('encodings.utf_8', globals(), locals(), '*')
mod = __import__('encodings.utf_16_be', globals(), locals(), '*')
handles = new.module('handles')
handles.getPerson = getPerson
handles.savePerson = savePerson
def handler(req):
dispatch.AsHandler(modules=(handles,), request=req, typesmodule=MyComplexTypes, rpc=True)
return apache.OK
D.2.3 client: invoke savePerson
D.2.3.1 script
import sys
from ZSI.client import Binding
from MyComplexTypes import Person
b = Binding(url='http://localhost/test3/pickler.py', tracefile=sys.stdout)
person = Person('christopher', 26)
b.savePerson(person)
D.2.3.2 SOAP Trace
_________________________________ Wed Oct 11 13:10:05 2006 REQUEST: <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <savePerson xmlns:ns1="urn:MyApp"> <ns1:Person><name xsi:type="xsd:string">christopher</name> <age xsi:type="xsd:nonNegativeInteger">26</age> </ns1:Person> </savePerson> </SOAP-ENV:Body> </SOAP-ENV:Envelope> _________________________________ Wed Oct 11 13:10:05 2006 RESPONSE: Server: Apache/2.0.53-dev (Unix) mod_ruby/1.2.4 Ruby/1.8.2(2004-12-25) mod_python/3.1.4 Python/2.4.1 Transfer-Encoding: chunked Content-Type: text/xml <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <savePersonResponse></savePersonResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
D.2.4 client: invoke getPerson 3 different ways
D.2.4.1 script
import sys
import MyComplexTypes
from ZSI.client import NamedParamBinding as NPBinding, Binding
from ZSI import TC
kw = {'url':'http://localhost/test3/pickler.py', 'tracefile':sys.stdout}
b = NPBinding(**kw)
rsp = b.getPerson(name='christopher')
assert type(rsp) is dict, 'expecting a dict'
assert rsp['Person']['name'] == 'christopher', 'wrong person'
b = NPBinding(typesmodule=MyComplexTypes, **kw)
rsp = b.getPerson(name='christopher')
assert isinstance(rsp['Person'], MyComplexTypes.Person), (
'expecting instance of %s' %MyComplexTypes.Person)
b = Binding(typesmodule=MyComplexTypes, **kw)
class Name(str):
typecode = TC.String("name")
rsp = b.getPerson(Name('christopher'))
assert isinstance(rsp['Person'], MyComplexTypes.Person), (
'expecting instance of %s' %MyComplexTypes.Person)
D.2.4.2 SOAP Trace
All responses are exactly the same, for comparison the three requests are presented first and only the last response is included._________________________________ Wed Oct 11 13:19:00 2006 REQUEST: <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <getPerson> <name id="o6c2a0" xsi:type="xsd:string">christopher</name> </getPerson> </SOAP-ENV:Body> </SOAP-ENV:Envelope> ** OMIT RESPONSE ** _________________________________ Wed Oct 11 13:19:00 2006 REQUEST: <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <getPerson> <name id="o6c2a0" xsi:type="xsd:string">christopher</name> </getPerson> </SOAP-ENV:Body> </SOAP-ENV:Envelope> ** OMIT RESPONSE ** _________________________________ Wed Oct 11 13:19:00 2006 REQUEST: <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <getPerson> <name xsi:type="xsd:string">christopher</name> </getPerson> </SOAP-ENV:Body> </SOAP-ENV:Envelope> _________________________________ Wed Oct 11 13:19:00 2006 RESPONSE: Server: Apache/2.0.53-dev (Unix) mod_ruby/1.2.4 Ruby/1.8.2(2004-12-25) mod_python/3.1.4 Python/2.4.1 Transfer-Encoding: chunked Content-Type: text/xml <SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Header></SOAP-ENV:Header> <SOAP-ENV:Body> <getPersonResponse xmlns:ns1="urn:MyApp"> <ns1:Person> <name xsi:type="xsd:string">christopher</name> <age xsi:type="xsd:nonNegativeInteger">26</age> </ns1:Person> </getPersonResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
About this document ...
ZSI: The Zolera Soap InfrastructureDeveloper's Guide, November 01, 2007, Release 2.1.0
This document was generated using the LaTeX2HTML translator.
LaTeX2HTML is Copyright © 1993, 1994, 1995, 1996, 1997, Nikos Drakos, Computer Based Learning Unit, University of Leeds, and Copyright © 1997, 1998, Ross Moore, Mathematics Department, Macquarie University, Sydney.
The application of LaTeX2HTML to the Python documentation has been heavily tailored by Fred L. Drake, Jr. Original navigation icons were contributed by Christopher Petrilli.
|
|
|
ZSI: The Zolera Soap Infrastructure
Developer's Guide |
|
|
|
Release 2.1.0, documentation updated on November 01, 2007.
elements into headers which * are marked with \label. This little bit of CSS magic ensures that * these elements don't cause spurious whitespace to be added. */ h1>br, h2>br, h3>br, h4>br, h5>br, h6>br { display: none; } code, tt { font-family: "lucida typewriter", lucidatypewriter, monospace; } var { font-family: times, serif; font-style: italic; font-weight: normal; } .Unix { font-variant: small-caps; } .typelabel { font-family: lucida, sans-serif; } .navigation td { background-color: #99ccff; font-weight: bold; font-family: avantgarde, sans-serif; font-size: 110%; } div.warning { background-color: #fffaf0; border: thin solid black; padding: 1em; margin-left: 2em; margin-right: 2em; } div.warning .label { font-family: sans-serif; font-size: 110%; margin-right: 0.5em; } div.note { background-color: #fffaf0; border: thin solid black; padding: 1em; margin-left: 2em; margin-right: 2em; } div.note .label { margin-right: 0.5em; font-family: sans-serif; } address { font-size: 80%; } .release-info { font-style: italic; font-size: 80%; } .titlegraphic { vertical-align: top; } .verbatim pre { color: #00008b; font-family: "lucida typewriter", lucidatypewriter, monospace; font-size: 90%; } .verbatim { margin-left: 2em; } .verbatim .footer { padding: 0.05in; font-size: 85%; background-color: #99ccff; margin-right: 0.5in; } .grammar { background-color: #99ccff; margin-right: 0.5in; padding: 0.05in; } .grammar-footer { padding: 0.05in; font-size: 85%; } .grammartoken { font-family: "lucida typewriter", lucidatypewriter, monospace; } .productions { background-color: #bbeeff; } .productions a:active { color: #ff0000; } .productions a:link:hover { background-color: #99ccff; } .productions a:visited:hover { background-color: #99ccff; } .productions a:visited { color: #551a8b; } .productions a:link { color: #0000bb; } .productions table { vertical-align: baseline; empty-cells: show; } .productions > table td, .productions > table th { padding: 2px; } .productions > table td:first-child, .productions > table td:last-child { font-family: "lucida typewriter", lucidatypewriter, monospace; } /* same as the second selector above, but expressed differently for Opera */ .productions > table td:first-child + td + td { font-family: "lucida typewriter", lucidatypewriter, monospace; vertical-align: baseline; } .productions > table td:first-child + td { padding-left: 1em; padding-right: 1em; } .productions > table tr { vertical-align: baseline; } .email { font-family: avantgarde, sans-serif; } .mailheader { font-family: avantgarde, sans-serif; } .mimetype { font-family: avantgarde, sans-serif; } .newsgroup { font-family: avantgarde, sans-serif; } .url { font-family: avantgarde, sans-serif; } .file { font-family: avantgarde, sans-serif; } .guilabel { font-family: avantgarde, sans-serif; } .realtable { border-collapse: collapse; border-color: black; border-style: solid; border-width: 0px 0px 2px 0px; empty-cells: show; margin-left: auto; margin-right: auto; padding-left: 0.4em; padding-right: 0.4em; } .realtable tbody { vertical-align: baseline; } .realtable tfoot { display: table-footer-group; } .realtable thead { background-color: #99ccff; border-width: 0px 0px 2px 1px; display: table-header-group; font-family: avantgarde, sans-serif; font-weight: bold; vertical-align: baseline; } .realtable thead :first-child { border-width: 0px 0px 2px 0px; } .realtable thead th { border-width: 0px 0px 2px 1px } .realtable td, .realtable th { border-color: black; border-style: solid; border-width: 0px 0px 1px 1px; padding-left: 0.4em; padding-right: 0.4em; } .realtable td:first-child, .realtable th:first-child { border-left-width: 0px; vertical-align: baseline; } .center { text-align: center; } .left { text-align: left; } .right { text-align: right; } .refcount-info { font-style: italic; } .refcount-info .value { font-weight: bold; color: #006600; } /* * Some decoration for the "See also:" blocks, in part inspired by some of * the styling on Lars Marius Garshol's XSA pages. * (The blue in the navigation bars is #99CCFF.) */ .seealso { background-color: #fffaf0; border: thin solid black; padding: 0pt 1em 4pt 1em; } .seealso > .heading { font-size: 110%; font-weight: bold; } /* * Class 'availability' is used for module availability statements at * the top of modules. */ .availability .platform { font-weight: bold; } /* * Additional styles for the distutils package. */ .du-command { font-family: monospace; } .du-option { font-family: avantgarde, sans-serif; } .du-filevar { font-family: avantgarde, sans-serif; font-style: italic; } .du-xxx:before { content: "** "; font-weight: bold; } .du-xxx:after { content: " **"; font-weight: bold; } /* * Some specialization for printed output. */ @media print { .online-navigation { display: none; } } ZSI-2.1-a1/doc/guide.ps 0000644 0001751 0001751 00000204327 10712455101 012730 0 ustar zsi zsi %!PS-Adobe-2.0 %%Creator: dvips(k) 5.95a Copyright 2005 Radical Eye Software %%Title: guide.dvi %%Pages: 28 %%PageOrder: Ascend %%BoundingBox: 0 0 612 792 %%DocumentFonts: Helvetica Helvetica-Oblique Times-Roman Times-Bold %%+ CMSY10 Times-Italic Helvetica-Bold Courier Courier-Oblique %%+ Times-BoldItalic %%DocumentPaperSizes: Letter %%EndComments %DVIPSWebPage: (www.radicaleye.com) %DVIPSCommandLine: dvips -N0 -t letter -o guide.ps guide.dvi %DVIPSParameters: dpi=600 %DVIPSSource: TeX output 2007.11.01:2259 %%BeginProcSet: tex.pro 0 0 %! /TeXDict 300 dict def TeXDict begin/N{def}def/B{bind def}N/S{exch}N/X{S N}B/A{dup}B/TR{translate}N/isls false N/vsize 11 72 mul N/hsize 8.5 72 mul N/landplus90{false}def/@rigin{isls{[0 landplus90{1 -1}{-1 1}ifelse 0 0 0]concat}if 72 Resolution div 72 VResolution div neg scale isls{ landplus90{VResolution 72 div vsize mul 0 exch}{Resolution -72 div hsize mul 0}ifelse TR}if Resolution VResolution vsize -72 div 1 add mul TR[ matrix currentmatrix{A A round sub abs 0.00001 lt{round}if}forall round exch round exch]setmatrix}N/@landscape{/isls true N}B/@manualfeed{ statusdict/manualfeed true put}B/@copies{/#copies X}B/FMat[1 0 0 -1 0 0] N/FBB[0 0 0 0]N/nn 0 N/IEn 0 N/ctr 0 N/df-tail{/nn 8 dict N nn begin /FontType 3 N/FontMatrix fntrx N/FontBBox FBB N string/base X array /BitMaps X/BuildChar{CharBuilder}N/Encoding IEn N end A{/foo setfont}2 array copy cvx N load 0 nn put/ctr 0 N[}B/sf 0 N/df{/sf 1 N/fntrx FMat N df-tail}B/dfs{div/sf X/fntrx[sf 0 0 sf neg 0 0]N df-tail}B/E{pop nn A definefont setfont}B/Cw{Cd A length 5 sub get}B/Ch{Cd A length 4 sub get }B/Cx{128 Cd A length 3 sub get sub}B/Cy{Cd A length 2 sub get 127 sub} B/Cdx{Cd A length 1 sub get}B/Ci{Cd A type/stringtype ne{ctr get/ctr ctr 1 add N}if}B/CharBuilder{save 3 1 roll S A/base get 2 index get S /BitMaps get S get/Cd X pop/ctr 0 N Cdx 0 Cx Cy Ch sub Cx Cw add Cy setcachedevice Cw Ch true[1 0 0 -1 -.1 Cx sub Cy .1 sub]{Ci}imagemask restore}B/D{/cc X A type/stringtype ne{]}if nn/base get cc ctr put nn /BitMaps get S ctr S sf 1 ne{A A length 1 sub A 2 index S get sf div put }if put/ctr ctr 1 add N}B/I{cc 1 add D}B/bop{userdict/bop-hook known{ bop-hook}if/SI save N @rigin 0 0 moveto/V matrix currentmatrix A 1 get A mul exch 0 get A mul add .99 lt{/QV}{/RV}ifelse load def pop pop}N/eop{ SI restore userdict/eop-hook known{eop-hook}if showpage}N/@start{ userdict/start-hook known{start-hook}if pop/VResolution X/Resolution X 1000 div/DVImag X/IEn 256 array N 2 string 0 1 255{IEn S A 360 add 36 4 index cvrs cvn put}for pop 65781.76 div/vsize X 65781.76 div/hsize X}N /p{show}N/RMat[1 0 0 -1 0 0]N/BDot 260 string N/Rx 0 N/Ry 0 N/V{}B/RV/v{ /Ry X/Rx X V}B statusdict begin/product where{pop false[(Display)(NeXT) (LaserWriter 16/600)]{A length product length le{A length product exch 0 exch getinterval eq{pop true exit}if}{pop}ifelse}forall}{false}ifelse end{{gsave TR -.1 .1 TR 1 1 scale Rx Ry false RMat{BDot}imagemask grestore}}{{gsave TR -.1 .1 TR Rx Ry scale 1 1 false RMat{BDot} imagemask grestore}}ifelse B/QV{gsave newpath transform round exch round exch itransform moveto Rx 0 rlineto 0 Ry neg rlineto Rx neg 0 rlineto fill grestore}B/a{moveto}B/delta 0 N/tail{A/delta X 0 rmoveto}B/M{S p delta add tail}B/b{S p tail}B/c{-4 M}B/d{-3 M}B/e{-2 M}B/f{-1 M}B/g{0 M} B/h{1 M}B/i{2 M}B/j{3 M}B/k{4 M}B/w{0 rmoveto}B/l{p -4 w}B/m{p -3 w}B/n{ p -2 w}B/o{p -1 w}B/q{p 1 w}B/r{p 2 w}B/s{p 3 w}B/t{p 4 w}B/x{0 S rmoveto}B/y{3 2 roll p a}B/bos{/SS save N}B/eos{SS restore}B end %%EndProcSet %%BeginProcSet: 8r.enc 0 0 % File 8r.enc TeX Base 1 Encoding Revision 2.0 2002-10-30 % % @@psencodingfile@{ % author = "S. Rahtz, P. MacKay, Alan Jeffrey, B. Horn, K. Berry, % W. Schmidt, P. Lehman", % version = "2.0", % date = "30 October 2002", % filename = "8r.enc", % email = "tex-fonts@@tug.org", % docstring = "This is the encoding vector for Type1 and TrueType % fonts to be used with TeX. This file is part of the % PSNFSS bundle, version 9" % @} % % The idea is to have all the characters normally included in Type 1 fonts % available for typesetting. This is effectively the characters in Adobe % Standard encoding, ISO Latin 1, Windows ANSI including the euro symbol, % MacRoman, and some extra characters from Lucida. % % Character code assignments were made as follows: % % (1) the Windows ANSI characters are almost all in their Windows ANSI % positions, because some Windows users cannot easily reencode the % fonts, and it makes no difference on other systems. The only Windows % ANSI characters not available are those that make no sense for % typesetting -- rubout (127 decimal), nobreakspace (160), softhyphen % (173). quotesingle and grave are moved just because it's such an % irritation not having them in TeX positions. % % (2) Remaining characters are assigned arbitrarily to the lower part % of the range, avoiding 0, 10 and 13 in case we meet dumb software. % % (3) Y&Y Lucida Bright includes some extra text characters; in the % hopes that other PostScript fonts, perhaps created for public % consumption, will include them, they are included starting at 0x12. % These are /dotlessj /ff /ffi /ffl. % % (4) hyphen appears twice for compatibility with both ASCII and Windows. % % (5) /Euro was assigned to 128, as in Windows ANSI % % (6) Missing characters from MacRoman encoding incorporated as follows: % % PostScript MacRoman TeXBase1 % -------------- -------------- -------------- % /notequal 173 0x16 % /infinity 176 0x17 % /lessequal 178 0x18 % /greaterequal 179 0x19 % /partialdiff 182 0x1A % /summation 183 0x1B % /product 184 0x1C % /pi 185 0x1D % /integral 186 0x81 % /Omega 189 0x8D % /radical 195 0x8E % /approxequal 197 0x8F % /Delta 198 0x9D % /lozenge 215 0x9E % /TeXBase1Encoding [ % 0x00 /.notdef /dotaccent /fi /fl /fraction /hungarumlaut /Lslash /lslash /ogonek /ring /.notdef /breve /minus /.notdef /Zcaron /zcaron % 0x10 /caron /dotlessi /dotlessj /ff /ffi /ffl /notequal /infinity /lessequal /greaterequal /partialdiff /summation /product /pi /grave /quotesingle % 0x20 /space /exclam /quotedbl /numbersign /dollar /percent /ampersand /quoteright /parenleft /parenright /asterisk /plus /comma /hyphen /period /slash % 0x30 /zero /one /two /three /four /five /six /seven /eight /nine /colon /semicolon /less /equal /greater /question % 0x40 /at /A /B /C /D /E /F /G /H /I /J /K /L /M /N /O % 0x50 /P /Q /R /S /T /U /V /W /X /Y /Z /bracketleft /backslash /bracketright /asciicircum /underscore % 0x60 /quoteleft /a /b /c /d /e /f /g /h /i /j /k /l /m /n /o % 0x70 /p /q /r /s /t /u /v /w /x /y /z /braceleft /bar /braceright /asciitilde /.notdef % 0x80 /Euro /integral /quotesinglbase /florin /quotedblbase /ellipsis /dagger /daggerdbl /circumflex /perthousand /Scaron /guilsinglleft /OE /Omega /radical /approxequal % 0x90 /.notdef /.notdef /.notdef /quotedblleft /quotedblright /bullet /endash /emdash /tilde /trademark /scaron /guilsinglright /oe /Delta /lozenge /Ydieresis % 0xA0 /.notdef /exclamdown /cent /sterling /currency /yen /brokenbar /section /dieresis /copyright /ordfeminine /guillemotleft /logicalnot /hyphen /registered /macron % 0xD0 /degree /plusminus /twosuperior /threesuperior /acute /mu /paragraph /periodcentered /cedilla /onesuperior /ordmasculine /guillemotright /onequarter /onehalf /threequarters /questiondown % 0xC0 /Agrave /Aacute /Acircumflex /Atilde /Adieresis /Aring /AE /Ccedilla /Egrave /Eacute /Ecircumflex /Edieresis /Igrave /Iacute /Icircumflex /Idieresis % 0xD0 /Eth /Ntilde /Ograve /Oacute /Ocircumflex /Otilde /Odieresis /multiply /Oslash /Ugrave /Uacute /Ucircumflex /Udieresis /Yacute /Thorn /germandbls % 0xE0 /agrave /aacute /acircumflex /atilde /adieresis /aring /ae /ccedilla /egrave /eacute /ecircumflex /edieresis /igrave /iacute /icircumflex /idieresis % 0xF0 /eth /ntilde /ograve /oacute /ocircumflex /otilde /odieresis /divide /oslash /ugrave /uacute /ucircumflex /udieresis /yacute /thorn /ydieresis ] def %%EndProcSet %%BeginProcSet: texps.pro 0 0 %! TeXDict begin/rf{findfont dup length 1 add dict begin{1 index/FID ne 2 index/UniqueID ne and{def}{pop pop}ifelse}forall[1 index 0 6 -1 roll exec 0 exch 5 -1 roll VResolution Resolution div mul neg 0 0]FontType 0 ne{/Metrics exch def dict begin Encoding{exch dup type/integertype ne{ pop pop 1 sub dup 0 le{pop}{[}ifelse}{FontMatrix 0 get div Metrics 0 get div def}ifelse}forall Metrics/Metrics currentdict end def}{{1 index type /nametype eq{exit}if exch pop}loop}ifelse[2 index currentdict end definefont 3 -1 roll makefont/setfont cvx]cvx def}def/ObliqueSlant{dup sin S cos div neg}B/SlantFont{4 index mul add}def/ExtendFont{3 -1 roll mul exch}def/ReEncodeFont{CharStrings rcheck{/Encoding false def dup[ exch{dup CharStrings exch known not{pop/.notdef/Encoding true def}if} forall Encoding{]exch pop}{cleartomark}ifelse}if/Encoding exch def}def end %%EndProcSet %%BeginFont: CMSY10 %!PS-AdobeFont-1.1: CMSY10 1.0 %%CreationDate: 1991 Aug 15 07:20:57 % Copyright (C) 1997 American Mathematical Society. All Rights Reserved. 11 dict begin /FontInfo 7 dict dup begin /version (1.0) readonly def /Notice (Copyright (C) 1997 American Mathematical Society. All Rights Reserved) readonly def /FullName (CMSY10) readonly def /FamilyName (Computer Modern) readonly def /Weight (Medium) readonly def /ItalicAngle -14.035 def /isFixedPitch false def end readonly def /FontName /CMSY10 def /PaintType 0 def /FontType 1 def /FontMatrix [0.001 0 0 0.001 0 0] readonly def /Encoding 256 array 0 1 255 {1 index exch /.notdef put} for dup 13 /circlecopyrt put readonly def /FontBBox{-29 -960 1116 775}readonly def currentdict end currentfile eexec D9D66F633B846A97B686A97E45A3D0AA052F09F9C8ADE9D907C058B87E9B6964 7D53359E51216774A4EAA1E2B58EC3176BD1184A633B951372B4198D4E8C5EF4 A213ACB58AA0A658908035BF2ED8531779838A960DFE2B27EA49C37156989C85 E21B3ABF72E39A89232CD9F4237FC80C9E64E8425AA3BEF7DED60B122A52922A 221A37D9A807DD01161779DDE7D31FF2B87F97C73D63EECDDA4C49501773468A 27D1663E0B62F461F6E40A5D6676D1D12B51E641C1D4E8E2771864FC104F8CBF 5B78EC1D88228725F1C453A678F58A7E1B7BD7CA700717D288EB8DA1F57C4F09 0ABF1D42C5DDD0C384C7E22F8F8047BE1D4C1CC8E33368FB1AC82B4E96146730 DE3302B2E6B819CB6AE455B1AF3187FFE8071AA57EF8A6616B9CB7941D44EC7A 71A7BB3DF755178D7D2E4BB69859EFA4BBC30BD6BB1531133FD4D9438FF99F09 4ECC068A324D75B5F696B8688EEB2F17E5ED34CCD6D047A4E3806D000C199D7C 515DB70A8D4F6146FE068DC1E5DE8BC5703711DA090312BA3FC00A08C453C609 C627A8BFEF75B4DEFAF34B44B356A516B765AFCDD3F5475B1F928731D09D2170 B97E40F12CCEDF4F6BB3756C4734F6E98D74B7E942A954B1BAAB83D4AD727FF6 DF6DC50B2223BCB5568A73A112E4860AD490554E64E780073FF3399CB4688D33 9E8829667CD6EAEF25E0C7D2D44F2BBFA40E999325F9561514844221B50BC8FC 4C7AD68CA7220D69125C2AF06849A3E068D18733276F0C0A6A2936D3C2C87CDE 59CD1AF148C44F85784A5DAD569F5FF53C061056C067CE29AEF1E3BD1FD8B0B8 71A0A638CDAC6AEEDBD5337D4683C084BB60B1859E600F59CB4E19C5FC5C6327 EC544A68134496A9BD0B87D83AF6FDA3CB62FBF0B54FACE1F0E6A2D84B467AFF 0F62DB 0000000000000000000000000000000000000000000000000000000000000000 0000000000000000000000000000000000000000000000000000000000000000 0000000000000000000000000000000000000000000000000000000000000000 0000000000000000000000000000000000000000000000000000000000000000 0000000000000000000000000000000000000000000000000000000000000000 0000000000000000000000000000000000000000000000000000000000000000 0000000000000000000000000000000000000000000000000000000000000000 0000000000000000000000000000000000000000000000000000000000000000 cleartomark %%EndFont TeXDict begin 40258431 52099146 1000 600 600 (guide.dvi) @start /Fa 138[46 23 32 1[42 42 3[23 5[28 37 1[37 16[55 9[65 3[60 22[28 45[{TeXBase1Encoding ReEncodeFont}13 83.022 /Times-BoldItalic rf /Fb 130[45 45 1[45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 1[45 1[45 45 45 45 45 45 45 2[45 45 45 45 45 45 45 45 45 2[45 45 45 45 45 45 45 45 45 2[45 45 45 1[45 1[45 45 45 45 45 45 45 45 45 45 45 45 45 1[45 45 45 45 3[45 45 34[{TeXBase1Encoding ReEncodeFont}77 74.7198 /Courier rf /Fc 107[37 28[44 1[33 18 26 26 1[33 33 33 48 3[18 33 33 1[29 33 29 33 33 8[41 4[33 4[44 55 37 17[22 6[33 33 33 33 18 17 4[22 22 40[{TeXBase1Encoding ReEncodeFont} 32 66.4176 /Times-Italic rf /Fd 134[33 33 48 1[33 18 26 22 1[33 33 33 52 18 33 1[18 33 1[22 29 33 29 1[29 11[48 41 14[41 1[44 22[17 41[37 2[{TeXBase1Encoding ReEncodeFont}26 66.4176 /Times-Roman rf /Fe 205[25 25 49[{TeXBase1Encoding ReEncodeFont} 2 49.8132 /Times-Roman rf /Ff 134[50 1[50 50 50 50 50 50 50 50 50 50 50 50 50 1[50 50 1[50 50 50 50 50 50 1[50 4[50 5[50 50 50 8[50 50 50 1[50 50 50 8[50 1[50 2[50 2[50 50 50 50 50 50 45[{TeXBase1Encoding ReEncodeFont}42 83.022 /Courier-Oblique rf /Fg 133[50 50 50 1[50 55 28 50 33 1[55 55 55 83 22 2[22 55 55 28 55 55 50 55 55 11[72 61 66 5[83 5[78 61 66 72 72 66 66 6[28 5[55 55 55 55 2[28 4[33 33 40[{TeXBase1Encoding ReEncodeFont}41 99.6264 /Helvetica rf /Fh 205[29 29 49[{TeXBase1Encoding ReEncodeFont}2 58.1154 /Times-Roman rf /Fi 133[60 60 1[86 60 66 33 60 40 1[66 66 66 100 27 2[27 66 66 33 66 66 60 1[66 8[80 113 2[73 80 86 1[80 93 86 100 66 3[86 93 73 1[86 86 80 80 12[66 66 66 66 2[33 46[{TeXBase1Encoding ReEncodeFont}43 119.552 /Helvetica rf /Fj 131[50 2[50 50 50 2[50 50 50 1[50 50 50 50 50 2[50 50 50 1[50 1[50 1[50 1[50 4[50 1[50 3[50 50 2[50 50 50 50 50 2[50 3[50 3[50 2[50 50 2[50 6[50 50 50 50 50 50 50 50 2[50 50 40[{ TeXBase1Encoding ReEncodeFont}44 83.022 /Courier rf /Fk 168[113 80 86 73 1[86 2[93 86 4[33 86 1[73 80 2[86 86 65[{TeXBase1Encoding ReEncodeFont}13 119.552 /Helvetica-Bold rf /Fl 64[42 29[32 10[42 1[46 46 24[32 37 37 55 37 42 23 32 32 42 42 42 42 60 23 37 23 23 42 42 23 37 42 37 42 42 6[46 46 51 69 1[60 46 42 51 1[51 60 55 69 46 55 37 28 60 60 51 51 60 55 51 51 1[42 1[56 2[28 4[42 42 42 42 42 42 23 21 28 21 1[42 28 28 28 35[42 42 2[{ TeXBase1Encoding ReEncodeFont}74 83.022 /Times-Italic rf /Fm 134[42 42 60 42 46 23 42 28 46 46 46 46 69 18 42 1[18 46 46 23 46 46 42 46 46 8[55 78 2[51 55 60 1[55 1[60 69 46 2[23 60 65 1[55 60 60 55 55 6[23 46 46 46 46 46 46 46 46 46 46 1[23 43[42 2[{TeXBase1Encoding ReEncodeFont}54 83.022 /Helvetica rf /Fn 242[83 13[{}1 83.022 /CMSY10 rf /Fo 107[37 25[37 42 42 60 42 42 23 32 28 42 42 42 42 65 23 42 23 23 42 42 28 37 42 37 42 37 6[51 60 60 78 60 60 51 46 55 60 46 60 60 74 51 60 1[28 60 60 46 51 60 55 55 60 5[23 23 42 42 2[42 42 42 42 42 42 23 21 28 21 2[28 28 28 36[46 2[{TeXBase1Encoding ReEncodeFont}70 83.022 /Times-Roman rf /Fp 104[83 28[37 42 42 60 1[46 28 32 37 1[46 42 46 69 23 2[23 46 42 28 37 46 37 46 42 7[60 60 83 1[60 55 46 60 1[51 65 60 78 55 2[32 65 65 51 55 60 60 55 60 3[47 2[28 42 1[42 1[42 42 42 42 42 1[23 1[28 21 2[28 28 37[46 2[{TeXBase1Encoding ReEncodeFont}59 83.022 /Times-Bold rf /Fq 137[37 3[25 2[42 2[17 1[17 1[42 42 21 42 2[42 33[76 17[21 46[{TeXBase1Encoding ReEncodeFont}12 74.7198 /Helvetica rf /Fr 137[50 3[33 2[50 1[78 7[44 2[50 19[72 22[50 4[50 50 50 3[25 44[{TeXBase1Encoding ReEncodeFont}12 99.6264 /Times-Roman rf /Fs 137[72 80 1[72 48 2[80 2[32 3[80 1[40 80 80 2[80 19[120 2[72 6[104 96 21[40 44[{ TeXBase1Encoding ReEncodeFont}16 143.462 /Helvetica rf /Ft 140[72 6[32 6[80 3[80 14[104 31[80 80 80 1[40 46[{ TeXBase1Encoding ReEncodeFont}9 143.462 /Helvetica-Oblique rf /Fu 134[103 103 149 1[115 57 103 69 1[115 115 115 172 46 2[46 115 1[57 115 115 103 115 115 6[126 2[195 1[149 126 138 2[138 161 149 4[57 149 161 1[138 1[149 1[138 6[57 7[115 10[46 39[{TeXBase1Encoding ReEncodeFont}37 206.559 /Helvetica rf end %%EndProlog %%BeginSetup %%Feature: *Resolution 600dpi TeXDict begin %%BeginPaperSize: Letter letter %%EndPaperSize end %%EndSetup %%Page: 1 1 TeXDict begin 1 0 bop 0 83 3901 9 v 652 446 a Fu(ZSI:)58 b(The)g(Zoler)n(a)e(Soap)h(Infr)n(astr)s(ucture)2717 695 y(User')-10 b(s)57 b(Guide)3015 925 y Ft(Release)38 b(2.1.0)2794 2068 y Fs(Joshua)g(Bo)n(v)l(erhof)l(,)3005 2250 y(Char)r(les)g(Moad)3109 4240 y Fr(No)o(v)o(ember)23 b(01,)i(2007)3282 5317 y Fq(jrbo)o(v)n(erhof@lb)o(l.go)o(v)p eop end %%Page: 1 2 TeXDict begin 1 1 bop 1694 83 a Fp(COPYRIGHT)0 230 y Fo(Cop)o(yright)380 227 y(c)357 230 y Fn(\015)20 b Fo(2001,)f(Zolera)g (Systems,)i(Inc.)0 330 y(All)g(Rights)f(Reserv)o(ed.)0 476 y(Cop)o(yright)380 473 y(c)357 476 y Fn(\015)g Fo(2002-2003,)d (Rich)j(Salz.)0 576 y(All)h(Rights)f(Reserv)o(ed.)0 723 y(Permission)27 b(is)h(hereby)d(granted,)i(free)g(of)g(char)o(ge,)g(to) g(an)o(y)f(person)g(obtaining)g(a)h(cop)o(y)f(of)h(this)h(softw)o(are)f (and)f(associated)h(docu-)0 823 y(mentation)20 b(\002les)j(\(the)e (\224Softw)o(are\224\),)g(to)g(deal)h(in)f(the)h(Softw)o(are)f(without) g(restriction,)g(including)f(without)g(limitation)i(the)f(rights)g(to)0 922 y(use,)k(cop)o(y)-5 b(,)24 b(modify)-5 b(,)23 b(mer)o(ge,)h (publish,)g(distrib)n(ute,)h(and/or)d(sell)k(copies)e(of)g(the)g(Softw) o(are,)g(and)g(to)h(permit)e(persons)h(to)g(whom)g(the)0 1022 y(Softw)o(are)i(is)i(furnished)c(to)j(do)f(so,)j(pro)o(vided)24 b(that)i(the)h(abo)o(v)o(e)e(cop)o(yright)f(notice\(s\))i(and)g(this)h (permission)f(notice)g(appear)f(in)i(all)0 1121 y(copies)g(of)g(the)g (Softw)o(are)g(and)g(that)g(both)f(the)i(abo)o(v)o(e)d(cop)o(yright)h (notice\(s\))g(and)h(this)g(permission)g(notice)f(appear)g(in)i (supporting)0 1221 y(documentation.)0 1368 y(THE)e(SOFTW)-10 b(ARE)26 b(IS)g(PR)m(O)l(VIDED)g(\224AS)g(IS\224,)h(WITHOUT)e(W)-10 b(ARRANTY)27 b(OF)f(ANY)g(KIND,)g(EXPRESS)g(OR)h(IMPLIED,)0 1468 y(INCLUDING)f(B)o(UT)h(NO)m(T)g(LIMITED)e(T)o(O)h(THE)g(W)-10 b(ARRANTIES)27 b(OF)h(MERCHANT)-8 b(ABILITY)d(,)26 b(FITNESS)g(FOR)i(A) f(P)-8 b(AR-)0 1567 y(TICULAR)29 b(PURPOSE)g(AND)f(NONINFRINGEMENT)g (OF)g(THIRD)h(P)-8 b(AR)j(TY)29 b(RIGHTS.)f(IN)h(NO)f(EVENT)g(SHALL)h (THE)0 1667 y(COPYRIGHT)19 b(HOLDER)g(OR)g(HOLDERS)g(INCLUDED)f(IN)h (THIS)g(NO)m(TICE)f(BE)h(LIABLE)f(FOR)i(ANY)e(CLAIM,)h(OR)g(ANY)0 1766 y(SPECIAL)25 b(INDIRECT)g(OR)h(CONSEQ)o(UENTIAL)f(D)m(AMA)m(GES,)f (OR)i(ANY)f(D)m(AMA)m(GES)f(WHA)-9 b(TSOEVER)25 b(RESUL)-8 b(TING)0 1866 y(FR)m(OM)27 b(LOSS)g(OF)g(USE,)f(D)m(A)-9 b(T)h(A)27 b(OR)g(PR)m(OFITS,)f(WHETHER)h(IN)f(AN)h(A)m(CTION)f(OF)h (CONTRA)m(CT)-6 b(,)27 b(NEGLIGENCE)f(OR)0 1966 y(O)m(THER)20 b(T)o(OR)-5 b(TIOUS)20 b(A)m(CTION,)g(ARISING)h(OUT)f(OF)h(OR)h(IN)e (CONNECTION)h(WITH)f(THE)g(USE)h(OR)g(PERFORMANCE)0 2065 y(OF)g(THIS)f(SOFTW)-10 b(ARE.)0 2212 y(Except)27 b(as)i(contained)d (in)i(this)g(notice,)h(the)f(name)f(of)h(a)g(cop)o(yright)e(holder)g (shall)j(not)e(be)h(used)g(in)g(adv)o(ertising)e(or)h(otherwise)g(to)0 2312 y(promote)18 b(the)j(sale,)f(use)h(or)f(other)f(dealings)g(in)i (this)g(Softw)o(are)e(without)h(prior)f(written)h(authorization)e(of)h (the)i(cop)o(yright)d(holder)-5 b(.)0 2459 y(Cop)o(yright)381 2456 y(c)358 2459 y Fn(\015)21 b Fo(\(c\))g(2003,)f(The)h(Re)o(gents)g (of)f(the)i(Uni)n(v)o(ersity)d(of)i(California,)g(through)e(La)o (wrence)g(Berk)o(ele)o(y)i(National)f(Laboratory)0 2558 y(\(subject)i(to)h(receipt)f(of)g(an)o(y)g(required)f(appro)o(v)n(als)g (from)h(the)g(U.S.)h(Dept.)32 b(of)23 b(Ener)o(gy\).)30 b(All)23 b(rights)f(reserv)o(ed.)31 b(Redistrib)n(ution)22 b(and)0 2658 y(use)e(in)g(source)e(and)h(binary)g(forms,)f(with)i(or)g (without)e(modi\002cation,)g(are)i(permitted)e(pro)o(vided)f(that)j (the)g(follo)n(wing)e(conditions)g(are)0 2758 y(met:)0 2904 y(\(1\))27 b(Redistrib)n(utions)h(of)f(source)h(code)f(must)h (retain)g(the)g(abo)o(v)o(e)e(cop)o(yright)g(notice,)j(this)f(list)i (of)d(conditions)g(and)g(the)h(follo)n(wing)0 3004 y(disclaimer)-5 b(.)37 b(\(2\))23 b(Redistrib)n(utions)h(in)g(binary)f(form)g(must)h (reproduce)e(the)i(abo)o(v)o(e)e(cop)o(yright)g(notice,)j(this)f(list)i (of)d(conditions)g(and)0 3104 y(the)i(follo)n(wing)e(disclaimer)h(in)h (the)g(documentation)c(and/or)j(other)g(materials)g(pro)o(vided)e(with) j(the)g(distrib)n(ution.)37 b(\(3\))24 b(Neither)h(the)0 3203 y(name)19 b(of)h(the)f(Uni)n(v)o(ersity)g(of)h(California,)e(La)o (wrence)h(Berk)o(ele)o(y)g(National)g(Laboratory)-5 b(,)17 b(U.S.)j(Dept.)k(of)c(Ener)o(gy)e(nor)h(the)g(names)h(of)0 3303 y(its)j(contrib)n(utors)c(may)j(be)f(used)h(to)g(endorse)e(or)h (promote)f(products)g(deri)n(v)o(ed)g(from)h(this)h(softw)o(are)f (without)g(speci\002c)h(prior)f(written)0 3403 y(permission.)0 3549 y(THIS)34 b(SOFTW)-10 b(ARE)34 b(IS)g(PR)m(O)l(VIDED)g(BY)g(THE)g (COPYRIGHT)g(HOLDERS)g(AND)g(CONTRIB)o(UT)o(ORS)g(\224AS)g(IS\224)g (AND)0 3649 y(ANY)c(EXPRESS)h(OR)f(IMPLIED)f(W)-10 b(ARRANTIES,)30 b(INCLUDING,)f(B)o(UT)i(NO)m(T)e(LIMITED)g(T)o(O,)g(THE)h(IMPLIED)f(W) -10 b(AR-)0 3749 y(RANTIES)24 b(OF)g(MERCHANT)-8 b(ABILITY)23 b(AND)h(FITNESS)g(FOR)g(A)g(P)-8 b(AR)j(TICULAR)25 b(PURPOSE)f(ARE)h (DISCLAIMED.)d(IN)0 3848 y(NO)g(EVENT)g(SHALL)g(THE)g(COPYRIGHT)h(O)m (WNER)g(OR)g(CONTRIB)o(UT)o(ORS)f(BE)h(LIABLE)f(FOR)h(ANY)f(DIRECT)-6 b(,)22 b(INDI-)0 3948 y(RECT)-6 b(,)26 b(INCIDENT)-8 b(AL,)25 b(SPECIAL,)h(EXEMPLAR)-5 b(Y)-11 b(,)25 b(OR)h(CONSEQ)o (UENTIAL)g(D)m(AMA)m(GES)f(\(INCLUDING,)f(B)o(UT)j(NO)m(T)0 4048 y(LIMITED)15 b(T)o(O,)g(PR)m(OCUREMENT)i(OF)f(SUBSTITUTE)g(GOODS)g (OR)h(SER)-7 b(VICES;)17 b(LOSS)g(OF)f(USE,)h(D)m(A)-9 b(T)h(A,)15 b(OR)i(PR)m(OFITS;)0 4147 y(OR)26 b(B)o(USINESS)g(INTERR)m (UPTION\))e(HO)m(WEVER)i(CA)-5 b(USED)26 b(AND)f(ON)h(ANY)f(THEOR)-5 b(Y)25 b(OF)h(LIABILITY)-11 b(,)24 b(WHETHER)0 4247 y(IN)g(CONTRA)m(CT) -6 b(,)24 b(STRICT)g(LIABILITY)-11 b(,)23 b(OR)i(T)o(OR)-5 b(T)24 b(\(INCLUDING)f(NEGLIGENCE)g(OR)i(O)m(THER)-5 b(WISE\))23 b(ARISING)h(IN)0 4346 y(ANY)k(W)-10 b(A)h(Y)28 b(OUT)g(OF)g(THE)f(USE)h(OF)g(THIS)g(SOFTW)-10 b(ARE,)28 b(EVEN)f(IF)h(AD)m(VISED)f(OF)h(THE)f(POSSIBILITY)h(OF)g(SUCH)0 4446 y(D)m(AMA)m(GE.)0 4593 y(Y)-9 b(ou)24 b(are)h(under)e(no)i (obligation)d(whatsoe)n(v)o(er)h(to)i(pro)o(vide)e(an)o(y)h(b)n(ug)g (\002x)o(es,)i(patches,)f(or)g(upgrades)e(to)i(the)g(features,)g (functionality)0 4693 y(or)c(performance)d(of)i(the)h(source)f(code)h (\(\224Enhancements\224\))c(to)k(an)o(yone;)f(ho)n(we)n(v)o(er)m(,)e (if)k(you)e(choose)g(to)h(mak)o(e)f(your)g(Enhancements)0 4792 y(a)n(v)n(ailable)j(either)g(publicly)-5 b(,)23 b(or)g(directly)g(to)g(La)o(wrence)g(Berk)o(ele)o(y)f(National)h (Laboratory)-5 b(,)22 b(without)g(imposing)h(a)h(separate)f(written)0 4892 y(license)f(agreement)e(for)h(such)h(Enhancements,)d(then)j(you)e (hereby)h(grant)g(the)g(follo)n(wing)g(license:)28 b(a)22 b(non-e)o(xclusi)n(v)o(e,)d(ro)o(yalty-free)0 4991 y(perpetual)d (license)i(to)g(install,)h(use,)f(modify)-5 b(,)16 b(prepare)g(deri)n (v)n(ati)n(v)o(e)g(w)o(orks,)i(incorporate)d(into)j(other)f(computer)f (softw)o(are,)h(distrib)n(ute,)0 5091 y(and)j(sublicense)f(such)h (Enhancements)e(or)i(deri)n(v)n(ati)n(v)o(e)e(w)o(orks)i(thereof,)f(in) h(binary)f(and)h(source)f(code)h(form.)p eop end %%Page: 2 3 TeXDict begin 2 2 bop 0 5549 3901 4 v 0 5649 a Fm(ii)p eop end %%Page: 3 4 TeXDict begin 3 3 bop 2764 747 a Fu(CONTENTS)0 1594 y Fp(1)83 b(Intr)o(oduction)3281 b(1)125 1694 y Fo(1.1)110 b(Acron)o(yms)19 b(and)g(T)-6 b(erminology)51 b(.)42 b(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g (.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.) f(.)g(.)g(.)143 b(1)125 1793 y(1.2)110 b(Ov)o(ervie)n(w)40 b(.)h(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g (.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.) f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)143 b(2)125 1893 y(1.3)110 b(Not)21 b(Co)o(v)o(ered)63 b(.)41 b(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f (.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.) h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)143 b(2)125 1993 y(1.4)110 b(References)58 b(.)41 b(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g (.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.) g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h (.)f(.)g(.)g(.)143 b(3)0 2175 y Fp(2)83 b Fl(wsdl2py)19 b(basics)3233 b(5)125 2275 y Fo(2.1)110 b(Modules)74 b(.)41 b(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.) g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h (.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)143 b(5)125 2374 y(2.2)110 b(Generated)19 b(T)-7 b(ypeCodes)67 b(.)41 b(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.) g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h (.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)143 b(8)0 2557 y Fp(3)83 b(Security)3396 b(13)125 2657 y Fo(3.1)110 b(HTTP)21 b(Basic)g(Authorization)28 b(.)41 b(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h (.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.) g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(13)125 2756 y(3.2)110 b(HTTP)21 b(Digest)f(Authorization)58 b(.)42 b(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.) f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g (.)h(.)f(.)g(.)g(.)102 b(13)125 2856 y(3.3)110 b(Message)21 b(Security)k(.)41 b(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g (.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.) g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(13)0 3039 y Fp(4)83 b(SO)m(AP)19 b(Headers)3158 b(15)0 3221 y(5)83 b(T)-6 b(ype)20 b(Substitution)3064 b(17)0 3404 y(A)65 b(wsdl2py)20 b(scr)o(pt)3202 b(19)125 3504 y Fo(A.1)92 b(Command)19 b(Line)h(Flags)82 b(.)41 b(.)g(.)g(.)h(.)f(.)g (.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.) f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g (.)102 b(19)0 3686 y Fp(B)70 b(Example:)25 b(W)-6 b(olframSear)o(ch) 2763 b(21)125 3786 y Fo(B.1)97 b(Code)20 b(Generation)f(from)g(WSDL)i (and)f(XML)g(Schema)39 b(.)j(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.) g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(21)p 0 5549 3901 4 v 3845 5649 a Fm(iii)p eop end %%Page: 4 5 TeXDict begin 4 4 bop 0 5549 3901 4 v 0 5649 a Fm(iv)p eop end %%Page: 1 6 TeXDict begin 1 5 bop 0 83 3901 9 v 3503 230 a Fm(CHAPTER)3641 427 y Fk(ONE)p 0 515 V 2821 978 a Fu(Introduction)0 1457 y Fj(ZSI)p Fo(,)18 b(the)g(Zolera)g(SO)m(AP)h(Infrastructure,)d(is)j(a) f(Python)f(package)g(that)i(pro)o(vides)d(an)i(implementation)e(of)i (the)g(SO)m(AP)i(speci\002cation,)0 1556 y(as)h(described)e(in)h Fl(SO)-5 b(AP)20 b(1.1)g(Speci\002cation)p Fo(.)0 1703 y(This)k(guide)f(demonstrates)g(ho)n(w)g(to)h(use)g(ZSI)g(to)g(de)n(v)o (elop)e Fl(W)-8 b(eb)25 b(Service)e Fo(applications)g(from)g(a)h Fl(W)-8 b(eb)25 b(Services)f(Description)f(Lan-)0 1803 y(gua)o(g)o(e)c Fo(document.)0 1950 y(This)g(document)f(is)i(primarily) d(concerned)g(with)j(demonstrating)c(and)j(documenting)d(ho)n(w)j(to)g (use)h(a)f Fl(W)-8 b(eb)20 b(Service)f Fo(by)g(creating)f(and)0 2049 y(accessing)27 b(Python)f(data)g(for)h(the)g(purposes)f(of)g (sending)g(and)h(recei)n(ving)e(SO)m(AP)j(messages.)46 b(T)-7 b(ypecodes)25 b(are)i(used)g(to)g(marshall)0 2149 y(Python)19 b(datatypes)g(into)h(XML,)g(which)g(can)g(be)g(included)e (in)i(a)h(SO)m(AP)g(En)m(v)o(elope.)i(The)c(typecodes)g(are)h (generated)e(from)i(informa-)0 2249 y(tion)25 b(pro)o(vided)d(in)k(the) f(WSDL)h(document,)e(and)g(generally)g(describe)g(SO)m(AP)i(and)f(XML)g (Schema)f(data)h(types.)40 b(F)o(or)24 b(a)i(lo)n(w-le)n(v)o(el)0 2348 y(treatment)19 b(of)h(typecodes,)f(and)g(a)i(description)e(of)h (SO)m(AP-based)f(processing)g(see)i(the)f(ZSI)g(manual.)0 2676 y Fi(1.1)121 b(Acron)n(yms)33 b(and)h(T)-14 b(er)s(minology)42 2894 y Fo(SO)m(AP)208 2994 y(Usually)16 b(refering)g(to)h(the)g (content)f(and)h(format)e(of)i(a)h(message)f(ultimately)f(sent)h(and)g (recei)n(v)o(ed)e(by)i(a)g Fl(W)-8 b(eb)18 b(Service)p Fo(,)f(see)h Fl(SO)-5 b(AP)208 3094 y(1.1)19 b(Speci\002cation)42 3260 y Fo(WSDL)208 3359 y(A)h(document)e(describing)h(a)i Fl(W)-8 b(eb)20 b(Service)p Fo(')-5 b(s)21 b(interf)o(ace,)e(see)i Fl(W)-8 b(eb)20 b(Services)h(Description)e(Langua)o(g)o(e)42 3525 y Fo(XMLSchema)208 3625 y(Standard)f(for)i(modeling)e(XML)j (document)d(structure.)24 b(See)c Fl(XML)h(Sc)o(hema)e(Speci\002cation) 42 3791 y Fo(schema)g(document)208 3891 y(a)h(\002le)h(containing)d(a)j (schema)f(de\002nition.)42 4057 y(schema)f(\(instance\))208 4156 y(The)g(set)i(of)f(rules)g(or)g(components)e(contained)h(in)h(the) g(assemblage)g(of)g(one)f(or)h(more)g(schema)g(documents.)42 4322 y(Element)f(Declaration)208 4422 y(A)e(schema)g(component)e(that)j (associates)g(a)g(name)e(with)i(a)g(type)f(de\002nition.)23 b(e)o(g.)g Fl(\241element)18 b(name=\224a)o(g)o(e\224)e (type=\224xsd:int\224\277,)42 4588 y Fo(GED)208 4688 y Fl(Global)j(Element)h(Declar)o(ation,)e(an)i(element)g(declar)m(ed)f (at)i(the)f(top-le)o(vel)f(of)h(a)g(sc)o(hema.)42 4854 y Fo(Comple)o(xT)-7 b(ype)208 4953 y(The)19 b(parent)h(of)g(all)g(type) g(de\002nitions)f(that)i(can)f(specify)f(attrib)n(utes)h(and)g (children.)42 5119 y(SimpleT)-7 b(ype)208 5219 y(A)20 b(simple)g(data)g(type)g(lik)o(e)h(a)f(string)g(or)g(inte)o(ger)-5 b(.)24 b(The)c Fl(XML)h(Sc)o(hema)e(Speci\002cation)e Fo(de\002nes)j(man)o(y)f(b)n(uilt-in)h(types.)p 0 5549 3901 4 v 3854 5649 a Fm(1)p eop end %%Page: 2 7 TeXDict begin 2 6 bop 42 83 a Fo(The)19 b(XML)i(Schema)e(type)h (library)208 183 y(The)c Fj(http://www.w3.org/2001/XMLSchema)c Fo(namespace,)k(which)h(contains)f(de\002nitions)g(of)h(v)n(arious)f (primiti)n(v)o(e)208 282 y(types)21 b(lik)o(e)g(string)g(and)f(inte)o (ger)m(,)g(as)i(well)g(as)g(a)f(compound)e(type)h Fl(comple)n(xT)-6 b(ype)20 b(used)h(to)h(cr)m(eate)f(a)o(g)o(gr)m(e)m(gate)e(types.)28 b(Con)m(ven-)208 382 y(tionally)19 b(the)h Fo(xsd)g Fl(pr)m(e\002x)g (is)h(used)f(to)g(map)g(to)g(this)h(sc)o(hema.)42 548 y(doc/liter)o(al)208 648 y(document)d(style)j(with)g(liter)o(al)f (encoding)42 814 y(rpc/enc)208 913 y(rpc)g(style)h(with)g(speci\002ed)e (encoding)o(,)f(not)i(compatible)f(with)h Fo(Basic)i(Pro\002le)e (\(WS-Interop\))42 1079 y Fl(rpc/liter)o(al)208 1179 y(rpc)g(style)h(with)g(liter)o(al)f(encoding)o(.)0 1506 y Fi(1.2)121 b(Ov)m(er)t(vie)n(w)0 1739 y Fo(The)24 b(ZSI)g Fl(W)-8 b(eb)25 b(Service)p Fo(tools)f(are)g(for)g(top-Do)n(wn)e Fl(W)-8 b(eb)25 b(Service)p Fo(de)n(v)o(elopment,)c(using)j(an)g(e)o (xisting)g(WSDL)h(Document)d(to)j(create)0 1839 y(client)d(and)g(serv)o (er)f(applications)f(\(see)j(1.3\).)29 b(A)23 b Fl(W)-8 b(eb)22 b(Service)p Fo(,)g(in)g(the)g(conte)o(xt)f(of)h(this)g (document,)f(e)o(xposes)g(a)h(WSDL)h(Document)0 1938 y(describing)28 b(the)i(service')-5 b(s)30 b(interf)o(ace,)g(this)h (document)c(is)k(typically)e(a)n(v)n(ailable)g(at)h(a)g(published)e (URL)j(\(see)f Fl(Uniform)f(Resour)m(ce)0 2038 y(Locator)p Fo(\).)h(The)21 b(WSDL)i(document)d(de\002nes)i(SO)m(AP)h(bindings)d (for)i(communicating)d(with)j(the)g(service.)30 b(These)22 b(bindings)f(will)i(be)0 2138 y(used)d(to)g(e)o(xchange)e(SO)m(AP)j (messages,)f(the)g(contents)f(of)h(these)g(messages)h(must)f(adhere)f (to)h(the)g(document)e(structure)h(speci\002ed)h(by)0 2237 y(the)25 b(schema.)38 b(The)24 b(schema)g(is)i(either)e(included)f (in)i(the)g(WSDL)g(Document,)f(imported)f(by)i(it,)h(or)e(represented)f (by)h(the)h(a)n(v)n(ailable)0 2337 y(b)n(uilt-in)20 b(types)g(\(such)f (as)i Fl(xsd:int,)f(xsd:string)o(,)f(etc)p Fo(\).)1536 2307 y Fh(1)0 2622 y Fg(1.2.1)100 b(soap)29 b(bindings)0 2825 y Fo(The)h(tw)o(o)g(styles)g(of)g(SO)m(AP)g(bindings)f(are)h Fl(rpc)g Fo(and)f Fl(document)p Fo(.)52 b(The)30 b(use)g(of)f Fl(liter)o(al)i(encoding)c(is)k(encour)o(a)o(g)o(ed)d(and)h(the)g(r)m (ec-)0 2924 y(ommended)23 b(way)i(to)f(de)o(velop)f(ne)o(w)i Fo(W)-7 b(eb)25 b(Service)p Fl(applications)d(\(see)j Fo(Basic)g(Pro\002le)g(\(WS-Interop\))p Fl(\).)35 b(The)25 b(SO)-5 b(AP)24 b(encoded)f(sup-)0 3024 y(port)32 b(is)g(maintained)e (for)i(use)g(with)g(older)g(applications,)g(and)f(other)h(SO)-5 b(AP)31 b(toolkits)h(r)m(estricted)g(to)g(rpc/encde)o(velopment.)56 b(A)0 3124 y(doc/liter)o(alservice)22 b(is)i(typically)e(described)g (as)h(an)f(e)n(xc)o(hang)o(e)f(of)i(documents,)e(while)i(a)g(rpc/encor) f(rpc/liter)o(alservice)h(is)g(thought)0 3223 y(of)33 b(in)g(terms)g(of)g(r)m(emote)g(pr)l(ocedur)m(e)f(calls.)62 b(Whether)33 b(this)g(distinction)f(of)h(purpose)e(is)j(meaningful)d (or)i(useful)f(is)i(debatable)o(.)0 3323 y Ff(ZSI)p Fl(supports)19 b(all)i(thr)m(ee)f(types,)g(b)n(ut)g(rpc/liter)o(aland)f(doc/liter)o (alar)m(e)g(the)h(focus)g(of)h(ongoing)d(de)o(velopment.)0 3605 y Fg(1.2.2)100 b(p)m(ython)29 b(tools)0 3807 y Fm(wsdl2p)n(y)0 4009 y Fl(The)22 b Fp(wsdl2py)g Fl(script)g(g)o(ener)o(ates)f(python)f (code)h(r)m(epr)m(esenting)g(the)g(various)h(components)d(de\002ned)h (in)i(a)g(WSDL)g(Document.)28 b(Most)0 4109 y(of)20 b(the)h(r)m (emaining)e(guide)g(focuses)h(on)g(how)g(to)g(use)h(this)f(tool)g(and)g (under)o(stand)e(its)j(output.)0 4433 y Fi(1.3)121 b(Not)34 b(Co)n(v)m(ered)104 4664 y Fl(1.)41 b(How)20 b(to)g(cr)m(eate)h(a)f (WSDL)g(document)104 4830 y(2.)41 b(How)20 b(to)g(write)i(XML)f(Sc)o (hema)104 4997 y(3.)41 b(Inter)l(oper)o(ability)104 5163 y(4.)g(How)20 b(to)g(use)h(W)-8 b(eb)21 b(Services)f(without)g(WSDL)p 0 5217 1560 4 v 90 5273 a Fe(1)120 5296 y Fd(The)c(xsd)h(pre\002x)h (refers)g(to)f(namespace)i Fc(\224http://www)-5 b(.w3.or)n (g/2001/XMLSc)o(hema\224)p 0 5549 3901 4 v 0 5649 a Fm(2)2981 b(Chapter)23 b(1.)52 b(Introduction)p eop end %%Page: 3 8 TeXDict begin 3 7 bop 0 87 a Fi(1.4)121 b(Ref)l(erences)104 304 y Fl(1.)41 b(W)-8 b(eb)49 b(services)h(de)o(velopment)d(patterns)h Ff(http://www-)t(128.ibm.com/developerworks/websph)o(ere/)208 404 y(library/techarticles/0511)p 1463 404 25 4 v 25 w(flurry/0511)p 2038 404 V 29 w(flurry.html)p 0 5549 3901 4 v 0 5649 a Fm(1.4.)k(Ref)n(erences)3241 b(3)p eop end %%Page: 4 9 TeXDict begin 4 8 bop 0 5549 3901 4 v 0 5649 a Fm(4)p eop end %%Page: 5 10 TeXDict begin 5 9 bop 0 83 3901 9 v 3503 230 a Fm(CHAPTER)3623 427 y Fk(TW)n(O)p 0 515 V 2517 978 a Fu(wsdl2p)-6 b(y)58 b(basics)0 1467 y Fl(The)32 b Fp(wsdl2py)h Fl(script)g(is)g(used)f(to)g (g)o(ener)o(ate)f(all)i(the)f(code)f(needed)g(to)i(access)f(a)g(W)-8 b(eb)33 b(Service)f(thr)l(ough)f(an)h(e)n(xposed)f(WSDL)0 1566 y(document,)18 b(usually)i(this)h(description)e(is)i(available)e (at)h(a)g(URL)h(whic)o(h)f(is)h(pr)l(o)o(vided)e(to)i(the)f(script.)0 1713 y Fp(wsdl2py)g Fl(will)i(g)o(ener)o(ate)d(a)h(client,)g(types,)g (and)g(service)h(module)o(.)i(F)-5 b(r)l(om)21 b(the)f(the)h(WSDL)f(SO) -5 b(AP)20 b(Bindings,)f(the)h(client)h(and)e(service)0 1813 y(modules)g(ar)m(e)i(cr)m(eated.)j(The)d(types)f(module)f (contains)g(typecodes)g(for)i(the)f(sc)o(hema)g(de\002ned)e(by)i(the)g (WSDL.)0 2138 y Fi(2.1)121 b(Modules)0 2385 y Fg(2.1.1)100 b(client)28 b(stub)g(module)0 2587 y Fm(classes)0 2789 y Fl(The)20 b(service)h(item)g(in)f(the)g Fo(W)-7 b(eb)21 b(Services)f(Description)f(Language)g Fl(de\002nition)f(contains)h(one) h(or)g(mor)m(e)h(port)f(items.)0 3055 y Fm(locator)83 b Fl(De\002nes)22 b(a)g(factory)g(method)g(for)g(eac)o(h)g(port)g (item,)h(and)e(stor)m(es)i(the)g(service')m(s)f(addr)m(ess.)31 b(Use)23 b(to)g(gr)o(ab)e(a)h(client\(port\))f(to)0 3154 y(the)f Fo(W)-7 b(eb)21 b(Service)p Fl(.)236 3393 y Fb(#)45 b(Example)f(Locator)236 3484 y(class)g (WhiteMesaSoapRpcLitTestSvcLocator:)416 3575 y (SoapTestPortTypeRpc_address)c(=)45 b ("http://www.whitemesa.net/test-rpc-l)o(it")416 3667 y(def)f(getSoapTestPortTypeRpcAddress\(self\):)595 3758 y(return)g(WhiteMesaSoapRpcLitTestSvcLocator.Soa)o(pTestP)o(ortTyp)o (eRpc_a)o(ddress)416 3849 y(def)g(getSoapTestPortTypeRpc\(self,)c (url=None,)2343 3862 y(**)2433 3849 y(kw\):)595 3941 y(return)k(Soap11TestRpcLitBindingSOAP\(url)39 b(or)45 b(WhiteMesaSoapRpcLitTestSvcLocator.Soap)o(TestPo)o(rtType)o(Rpc_ad)o (dress,)5302 3954 y(**)5392 3941 y(kw\))236 4032 y(})0 4438 y Fm(por)s(t)83 b Fl(Eac)o(h)20 b(port)g(item)h(will)h(be)e(r)m (epr)m(esented)g(by)h(a)f(single)h(class)g(de\002nition,)d(gr)o(ab)i(a) g(port)h(thr)l(ough)e(one)h(of)h(the)f(locator')m(s)g(factory)0 4537 y(methods.)236 4775 y Fb(loc)45 b(=)f (WhiteMesaSoapRpcLitTestSvcLocator\(\))236 4867 y(port)g(=)h (loc.getSoapTestPortTypeRpc\(tracefile=sy)o(s.stdo)o(ut\))0 5272 y Fm(message)83 b Fl(classes)20 b(that)f(r)m(epr)m(esent)h(the)f (SO)-5 b(AP)20 b(and)e(XML)i(Sc)o(hema)e(data)h(types.)25 b(A)20 b(Messa)o(g)o(e)f(instance)g(is)i(serialized)f(as)f(a)h(XML)0 5372 y(instance)o(.)j(A)c(Messa)o(g)o(e)g(passed)g(as)g(an)f(ar)m (gument)f(to)i(a)g(port)f(method)g(is)h(then)g(serialized)g(into)f(a)h (SO)-5 b(AP)18 b(En)m(velope)f(and)h(tr)o(ansported)p 0 5549 3901 4 v 3854 5649 a Fm(5)p eop end %%Page: 6 11 TeXDict begin 6 10 bop 0 83 a Fl(to)25 b(the)g Fo(W)-7 b(eb)25 b(Service)p Fl(,)h(the)e(client)h(will)h(then)f(wait)g(for)g (an)g(e)n(xpected)f(r)m(esponse)o(,)i(and)d(\002nally)h(the)h(SO)-5 b(AP)25 b(r)m(esponse)f(is)i(mar)o(shalled)0 183 y(bac)n(k)20 b(into)g(the)g(Messa)o(g)o(e)h(r)m(eturned)e(to)i(the)f(user)-9 b(.)236 421 y Fb(msg)45 b(=)f(echoBooleanRequest\(\))236 512 y(msg.InputBoolean)e(=)j(True)236 603 y(rsp)g(=)f (port.echoBoolean\(msg\))0 1024 y Fg(2.1.2)100 b(types)28 b(module)0 1226 y Fl(De\002nes)e(typecodes)f(for)i(all)f(components)f (of)h(all)h(sc)o(hema)e(speci\002ed)h(by)g(the)g(tar)m(g)o(et)g(WSDL)h (Document)e(\(not)h(including)e(b)n(uilt-in)0 1326 y(types\).)46 b(Eac)o(h)26 b(sc)o(hema)g(component)f(declar)m(ed)h(at)h(the)h(top-le) o(vel,)f(the)g(immediate)g(c)o(hildr)m(en)f(of)h(the)g(sc)o(hema)g(ta)o (g)o(,)h(ar)m(e)g(global)d(in)0 1425 y(scope)c(and)f(by)i(importing)e (the)i(\224types\224)f(module)g(an)g(application)e(has)i(access)h(to)f (the)h(GEDs)g(and)e(global)g(type)h(de\002nitions)f(either)0 1525 y(dir)m(ectly)g(or)h(with)g(the)f(unique)f(\(namespace)o(,name\))d (combination)i(thru)i(con)m(venience)e(functions.)0 1791 y Fm(classes)0 1993 y(Global)h(T)-10 b(ype)17 b(De\002nition)879 2084 y Fb(class)44 b(ns1:)1058 2175 y(..)1058 2267 y(..)1058 2358 y(class)g(HelpRequest_Def\(ZSI.TCcompound.ComplexTy)o(pe,)39 b(TypeDefinition\):)1237 2449 y(schema)44 b(=)h ("http://webservices.amazon.com/AWSEComm)o(erceSe)o(rvice/)o(2006-1)o (1-14")1237 2541 y(type)g(=)f(\(schema,)g("HelpRequest"\))1237 2632 y(def)h(__init__\(self,)d(pname,)i(ofwhat=\(\),)f (attributes=None,)f(extend=False,)h(restrict=False,)5003 2645 y(**)5093 2632 y(kw\):)1417 2723 y(..)0 3133 y Fm(Global)19 b(Element)g(Declar)o(ation)1082 3225 y Fb(class)44 b(ns1:)1261 3316 y(..)1261 3407 y(..)1261 3499 y(class)g (Help_Dec\(ZSI.TCcompound.ComplexType,)39 b(ElementDeclaration\):)1440 3590 y(literal)44 b(=)h("Help")1440 3681 y(schema)f(=)h ("http://webservices.amazon.com/AWSECom)o(merceS)o(ervice)o(/2006-)o (11-14")1440 3773 y(def)g(__init__\(self,)2292 3786 y(**)2382 3773 y(kw\):)1620 3864 y(..)0 4273 y Fm(helper)24 b(functions)0 4475 y(Global)19 b(T)-10 b(ype)17 b(De\002nition)1058 4567 y Fb(klass)44 b(=)h(ZSI.schema.GTD\(\\)1237 4658 y("http://webservices.amazon.com/AWSECommerc)o(eServi)o(ce/200)o (6-11-1)o(4",)1237 4749 y("HelpRequest"\))1058 4841 y(typecode)f(=)g (klass\("Help"\))p 0 5549 3901 4 v 0 5649 a Fm(6)2914 b(Chapter)24 b(2.)52 b Fl(wsdl2py)19 b(basics)p eop end %%Page: 7 12 TeXDict begin 7 11 bop 0 83 a Fm(Global)19 b(Element)g(Declar)o(ation) 1261 174 y Fb(typecode)43 b(=)i(ZSI.schema.GED\(\\)1440 266 y("http://webservices.amazon.com/AWSECommer)o(ceServ)o(ice/20)o (06-11-)o(14",)1440 357 y("Help"\))0 644 y Fl(Eac)o(h)20 b(module)f(le)o(vel)i(class)h(de\002ntion)d(r)m(epr)m(esents)i(a)g (unique)e(namespace)o(,)g(the)n(y')n(r)m(e)h(simply)h(wr)o(apper)o(s)g (of)g(individual)e(namespaces.)0 743 y(In)k(the)g(e)n(xample)g(abo)o (ve)o(,)g(the)g(two)h(inner)f(classes)h(of)g Ff(ns1)f Fl(ar)m(e)h(the)f(typecode)f(r)m(epr)m(esentations)g(of)i(a)f(global)f (type)h(de\002nition)f Fa(Hel-)0 843 y(pRequest)p 319 843 25 4 v 30 w(Def)p Fl(,)g(and)f(a)h(global)e(element)i(declar)o (ation)e Fa(Help)p 1814 843 V 29 w(Dec)p Fl(.)30 b(In)22 b(most)g(cases)g(a)g Ff(TypeCode)f Fl(instance)g(r)m(epr)m(esents)h (either)g(a)0 943 y(global)d(or)i(local)e(element)h(declar)o(ation.)0 1089 y(In)e(the)g(e)n(xample)g Ff(GED)g Fl(r)m(eturns)h(a)f Ff(Help_Dec)g Fl(instance)f(while)i Ff(GTD)f Fl(r)m(eturns)h(the)f (class)h(de\002nition)d Ff(HelpRequest_Def)p Fl(.)22 b(Why)0 1189 y(this)e(asymmetry?)25 b(The)19 b(element)h(name)e(is)j (serialized)f(as)g(the)f(XML)h(ta)o(g)g(name)o(,)f(while)h(the)f(type)g (de\002nition)f(describes)i(the)f(contents)0 1289 y(\(c)o(hildr)m(en,)g (te)n(xt)i(node\).)0 1436 y(In)j(the)g(g)o(ener)o(ated)e(code)i(an)f (element)h(declar)o(ation)e(either)j(de\002nes)e(all)h(its)h(content)e (in)h(its)h(contructor)e(or)i(it)g(subclasses)f(a)g(global)0 1535 y(type)c(de\002nition,)e(whic)o(h)i(is)h(another)e(g)o(ener)o (ated)g(class.)0 1818 y Fg(2.1.3)100 b(ser)s(vice)28 b(module)0 2019 y Fl(sk)o(eleton)22 b(class,)g(normally)f(subclassed)g (and)g(in)m(vok)o(ed)g(by)g(implementation)f(code)o(.)29 b(The)22 b(sk)o(eleton)g(de\002nes)f(a)g(callbac)n(k)g(method)g(for)0 2119 y(eac)o(h)e(oper)o(ation)g(de\002ned)f(in)j(the)f(SO)-5 b(AP)20 b(Binding.)j(These)e(methods)e(mar)o(shal/unmar)o(shall)g(XML)h (into)g(python)f(types.)0 2385 y Fm(e)n(xample:)29 b(DateSer)r(vice)0 2587 y(ser)r(v)n(er)17 b(sk)n(eleton)h(code)837 2678 y Fb(class)44 b(simple_Date_Service\(ServiceSOAPBinding)o(\):)1016 2769 y(..)1016 2861 y(..)1016 2952 y(def)g(soap_getCurrentDate\(self,)d (ps\):)1195 3043 y(self.request)i(=)i (ps.Parse\(getCurrentDateRequest.typecode)o(\))1195 3135 y(return)f(getCurrentDateResponse\(\))1016 3317 y (soapAction['urn:DateService.wsdl#getCurr)o(entDat)o(e'])39 b(=)44 b('soap_getCurrentDate')1016 3409 y (root[\(getCurrentDateRequest.typecode.nsp)o(name,g)o(etCurr)o(entDat)o (eReque)o(st.ty)o(pecode)o(.pname)o(\)])39 b(=)45 b ('soap_getCurrentDate')p 0 5549 3901 4 v 0 5649 a Fm(2.1.)52 b(Modules)3351 b(7)p eop end %%Page: 8 13 TeXDict begin 8 12 bop 0 83 a Fm(ser)r(v)n(er)17 b(implementation)j (code)1092 174 y Fb(DS)45 b(=)f(simple_Date_Service)1092 266 y(class)g(Service\(DS\):)1271 357 y(def)h (soap_getCurrentDate\(self,)40 b(ps\):)1451 448 y(response)j(=)i (DS.soap_getCurrentDate\(self,)40 b(ps\))1451 540 y(response.Today)i(=) j(today)f(=)h(response.new_today\(\))1451 631 y(self.request.Input)1451 722 y(dt)f(=)h(time.localtime\(time.time\(\)\))1451 814 y(today.Year)e(=)i(dt[0])1451 905 y(today.Month)e(=)h(dt[1])1451 996 y(today.Day)f(=)i(dt[2])1451 1088 y(today.Hour)e(=)i(dt[3])1451 1179 y(today.Minute)e(=)h(dt[4])1451 1270 y(today.Second)f(=)h(dt[5]) 1451 1362 y(today.Weekday)e(=)j(dt[6])1451 1453 y(today.DayOfYear)d(=)j (dt[7])1451 1544 y(today.Dst)e(=)i(dt[8])1451 1636 y(return)f(response) 0 2082 y Fi(2.2)121 b(Gener)o(ated)36 b(T)-14 b(ypeCodes)0 2313 y Fl(The)18 b(g)o(ener)o(ated)f(inner)h(typecode)e(classes)j(come) f(in)g(two)h(\003avor)o(s,)f(as)g(mentioned)e(abo)o(ve)o(.)23 b(element)18 b(declar)o(ations)f(can)g(be)h(serialized)0 2412 y(into)h(XML,)h(g)o(ener)o(ally)e(type)h(de\002nitions)f(cannot.) 1460 2382 y Fh(1)1516 2412 y Fl(Basically)-5 b(,)19 b(the)h(name)e (attrib)n(ute)h(of)h(an)f(element)g(declar)o(ation)e(is)j(serialized)g (into)0 2512 y(an)g(XML)h(ta)o(g)o(,)f(b)n(ut)g(type)g(de\002nitions)e (lac)n(k)j(this)g(information)d(so)j(the)n(y)f(cannot)e(be)i(dir)m (ectly)h(serialized)f(into)g(an)g(XML)h(instance)o(.)0 2659 y(Most)33 b(element)f(declar)o(ations)f(declar)m(e)g(a)i(type)f (attrib)n(ute)o(,)j(this)d(must)h(r)m(efer)m(ence)f(a)h(type)f (de\002nition.)59 b(Considering)31 b(the)i(abo)o(ve)0 2759 y(scenario,)h(a)d(g)o(ener)o(ated)g(T)-6 b(ypeCode)30 b(class)i(r)m(epr)m(esenting)f(an)g(element)h(declar)o(ation)d(will)k (subclass)f(the)f(g)o(ener)o(ated)f(T)-6 b(ypeCode)0 2858 y(class)21 b(r)m(epr)m(esenting)e(the)h(type)g(de\002nition.)0 3141 y Fg(2.2.1)100 b(special)29 b(handling)h(of)e(instance)h(attr)q (ib)n(utes)0 3342 y Fl(The)23 b(attrib)n(utes)f(discussed)h(below)f(ar) m(e)h(common)e(to)h(all)h(T)-6 b(ypeCodes,)22 b(for)h(mor)m(e)g (information)e(see)i(the)g(ZSI)f(manual.)30 b(I'm)23 b(r)m(eintr)l(o-)0 3442 y(ducing)i(them)i(to)g(point)f(out)g(certain)h (con)m(ventions)d(adher)m(ed)h(to)i(in)g(the)g(g)o(ener)o(ated)e(code)o (,)i(necessary)g(for)g(r)m(eliably)g(dealing)e(with)0 3542 y(WSDL)c(and)e(various)h(messa)o(ging)f(patterns)h(and)f(usa)o(g)o (es.)0 3807 y Fm(p)n(yclass)0 4009 y Fl(All)24 b(instances)f(of)h(g)o (ener)o(ated)e(T)-6 b(ypeCode)22 b(classes)j(will)f(have)f(a)h(pyclass) f(attrib)n(ute)o(,)h(instances)f(of)h(the)g(pyclass)f(can)g(be)g(cr)m (eated)g(to)0 4109 y(stor)m(e)f(the)g(data)f(r)m(epr)m(esenting)g(an)g (element)h(declar)o(ation.)1706 4079 y Fh(2)1737 4109 y Fl(.)30 b(The)22 b(pyclass)g(itself)g(has)g(a)g(typecode)e(attrib)n (ute)o(,)j(whic)o(h)e(is)i(a)f(r)m(efer)m(ence)0 4209 y(to)e(the)h(T)-6 b(ypeCode)19 b(instance)g(describing)h(the)g(data,)f (thus)h(making)f(pyclass)h(instances)g(self-describing)o(.)0 4355 y(When)k(par)o(sing)g(an)g(XML)i(instance)e(the)g(data)g(will)i (be)e(mar)o(shalled)g(into)h(an)f(instance)g(of)g(the)h(class)g (speci\002ed)f(in)h(the)f(typecode')m(s)0 4455 y(pyclass)c(attrib)n (ute)o(.)416 4693 y Fb(typecode)43 b(=)i(ZSI.schema.GED\(\\)595 4785 y("http://webservices.amazon.com/AWSECom)o(merceS)o(ervice)o (/2006-)o(11-14")o(,)595 4876 y("Help"\))416 4967 y(msg)f(=)h (typecode.pyclass\(\))p 0 5195 1560 4 v 90 5250 a Fe(1)120 5274 y Fd(The)16 b Fc(pname)i(can)g(be)f(set)g(to)h(None)f(when)h(a)f (XML)f(ta)o(g)i(name)g(is)f(not)g(needed)i(\(e)m(g)o(.)i(attrib)o (utes\).)90 5331 y Fe(2)120 5355 y Fd(Exceptions)d(include)h(the)f (Union)g(T)-5 b(ypeCode,)17 b(may)g(need)h(multiple)h(p)o(yclasses)g (to)f(mak)o(e)f(it)h(w)o(ork)p 0 5549 3901 4 v 0 5649 a Fm(8)2914 b(Chapter)24 b(2.)52 b Fl(wsdl2py)19 b(basics)p eop end %%Page: 9 14 TeXDict begin 9 13 bop 0 83 a Fm(aname)0 285 y Fl(The)18 b(aname)e(is)j(a)e(T)-6 b(ypeCode)17 b(instance)g(attrib)n(ute)o(,)h (its)h(value)e(is)h(a)g(string)g(r)m(epr)m(esenting)f(the)g(attrib)n (ute)h(name)f(used)g(to)h(r)m(efer)m(ence)f(data)0 384 y(r)m(epr)m(esenting)k(an)g(element)g(declartion.)28 b(The)21 b(set)i(of)e(XMLSc)o(hema)f(element)i(names)f(is)h(NCName,)h (this)f(is)g(a)g(super)o(set)g(of)f(or)m(dinary)0 484 y(identi\002er)o(s)f(in)g(python.)k(K)m(e)n(ywor)m(ds)c(lik)o(e)h(r)m (eturn)f(and)g(class)g(ar)m(e)h(le)m(gal)e(NCNames.)0 631 y Fo(Namespaces)h(in)g(XML)236 869 y Fb(From)44 b(Namespaces)g(in)g (XML)236 960 y(NCName)89 b(::=)44 b(\(Letter)g(|)h('_'\))f (\(NCNameChar\))1987 973 y(*)236 1052 y(NCNameChar)88 b(::=)45 b(Letter)e(|)i(Digit)f(|)h('.')f(|)h('-')f(|)h('_')f(|)h (CombiningChar)d(|)j(Extender)236 1234 y(From)f(Python)g(Reference)g (Manual)f(\(2.3)i(Identifiers)d(and)j(keywords\))236 1326 y(identifier)e(::=)i(\(letter|"_"\))e(\(letter)g(|)i(digit)f(|)g ("_"\))2478 1339 y(*)236 1508 y(Default)g(set)g(of)h(anames)236 1600 y(ANAME)f(::=)h(\("_"\))f(\(letter)f(|)i(digit)f(|)h("_"\))1941 1613 y(*)0 2008 y Fm(tr)o(ansf)n(or)r(m)82 b Fl(NCName)22 b(into)e(an)f(AN)n(AME)104 2213 y(1.)41 b(pr)m(epr)m(end)19 b(\224)p 578 2213 25 4 v 30 w(\224)104 2375 y(2.)41 b(c)o(har)o(acter) 19 b(not)g(in)i(set)g(\(letter)f Fj(|)h Fl(digit)f Fj(|)h Fl(\224)p 1463 2375 V 30 w(\224\))f(c)o(hang)o(e)f(to)h(\224)p 1977 2375 V 30 w(\224)0 2640 y Fm(Attr)q(ib)n(ute)25 b(Declar)o(ations:)k(attrs)p 1011 2640 V 29 w(aname)0 2841 y Fl(The)36 b(attr)o(s)p 317 2841 V 30 w(aname)f(is)h(a)g(T)-6 b(ypeCode)35 b(instance)g(attrib)n(ute)o(,)k(its)e(value)e(is)h(a)g (string)g(r)m(epr)m(esenting)f(the)g(attrib)n(ute)h(name)f(used)g(to)0 2941 y(r)m(efer)m(ence)h(a)h(dictionary)-5 b(,)39 b(containing)c(data)g (r)m(epr)m(esenting)h(attrib)n(ute)g(declar)o(ations.)72 b(The)37 b(k)o(e)n(ys)f(of)h(this)g(dictionary)e(ar)m(e)i(the)0 3041 y Fj(\(namespace,name\))18 b Fl(tuples,)i(the)g(value)f(of)i(eac)o (h)e(k)o(e)n(y)h(r)m(epr)m(esents)g(the)h(value)e(of)i(the)f(attrib)n (ute)o(.)0 3305 y Fm(Mix)n(ed)j(T)-10 b(e)n(xt)22 b(Content:)29 b(mix)n(ed)p 980 3305 V 30 w(aname)0 3507 y Fl(Its)21 b(value)e(r)m(epr)m(esents)i(the)f(attrib)n(ute)g(name)g(used)g(to)g (stor)m(e)h(te)n(xt)g(content)e(that)h(some)g(Comple)n(xT)-6 b(ype)20 b(de\002nitions)e(allow)-6 b(.)0 3787 y Fg(2.2.2)100 b(Metaclass)28 b(Magic:)35 b(p)m(yclass)p 1460 3787 30 4 v 36 w(type)0 3989 y Fl(The)21 b(\226comple)n(xT)-6 b(ype)19 b(\003a)o(g)i(pr)l(o)o(vides)g(many)f(con)m(veniences)f(to)i (the)g(pr)l(o)o(gr)o(ammer)-9 b(.)27 b(This)21 b(option)f(is)i(tested)f (and)f(r)m(eliable)o(,)h(and)f(highly)0 4089 y(r)m(ecommended)e(by)i (the)h(author)o(s.)0 4236 y(When)e(\226comple)n(xT)-6 b(ype)18 b(is)i(enabled)e(the)h Fj(__metaclass__)f Fl(attrib)n(ute)h (will)i(be)e(set)i(on)e(all)g(g)o(ener)o(ated)f(pyclasses.)25 b(The)20 b(metaclass)0 4335 y(will)28 b(intr)l(ospect)f(the)h(typecode) d(attrib)n(ute)i(of)h(pyclass,)g(and)f(cr)m(eate)g(a)g(set)h(of)f (helper)g(methods)g(for)g(eac)o(h)f(element)h(and)g(attrib)n(ute)0 4435 y(declar)m(ed)21 b(in)h(the)h(comple)n(xT)-6 b(ype)21 b(de\002nition.)29 b(This)23 b(option)d(simply)j(adds)f(wr)o(apper)o(s) g(for)g(dealing)f(with)i(content,)e(it)i(doesn')n(t)e(modify)0 4535 y(the)f(g)o(ener)o(ation)f(sc)o(heme)o(.)0 4681 y(Use)k(help)f(in)g(a)h(python)e(interpr)m(eter)h(to)h(vie)o(w)g(all)f (the)g(pr)l(operties)h(and)e(methods)h(of)g(these)h(typecodes.)30 b(Looking)21 b(at)i(the)f(g)o(ener)o(ated)0 4781 y(code)e(is)h(not)e (very)i(helpful.)0 5001 y Fp(Getters/Setters)40 b Fl(A)22 b(g)o(etter)h(and)f(setter)h(function)f(is)h(de\002ned)e(for)i(eac)o(h) e(element)h(of)h(a)g(comple)n(x)f(type)o(.)31 b(The)23 b(functions)e(ar)m(e)i(named)208 5101 y Fj(get_element_ANAME)g Fl(and)i Fj(set_element_ANAME)f Fl(r)m(espectively)-5 b(.)42 b(In)26 b(this)h(e)n(xample)o(,)g(variable)e(msg)h(has)g(func-) 208 5201 y(tions)d(named)f Fj(get_element__Options)e Fl(and)i Fj(set_element__Options)p Fl(.)31 b(In)23 b(addition)f(to)h (elements,)h(g)o(etter)o(s)208 5300 y(and)g(setter)o(s)i(ar)m(e)f(g)o (ener)o(ated)f(for)h(the)g(attrib)n(utes)g(of)g(a)g(comple)n(x)g(type)o (.)39 b(F)-9 b(or)25 b(attrib)n(utes,)h(just)f(the)g(name)g(of)g(the)g (attrib)n(ute)g(is)208 5400 y(used)19 b(in)i(determining)e(the)h (method)f(names,)h(so)g(g)o(et)p 1729 5400 25 4 v 30 w(attrib)n(ute)p 2044 5400 V 29 w(N)n(AME)h(and)e(set)p 2555 5400 V 30 w(attrib)n(ute)p 2870 5400 V 29 w(N)n(AME)i(ar)m(e)f(cr) m(eated.)p 0 5549 3901 4 v 0 5649 a Fm(2.2.)52 b(Gener)o(ated)24 b(T)-10 b(ypeCodes)2834 b(9)p eop end %%Page: 10 15 TeXDict begin 10 14 bop 0 83 a Fp(F)n(actory)18 b(Methods)42 b Fl(If)17 b(an)g(element)g(of)g(a)h(comple)n(x)e(type)i(is)g(a)f (comple)n(x)g(type)g(itself)o(,)i(then)d(a)i(con)m(veniece)d(factory)i (method)f(is)i(cr)m(eated)208 183 y(to)i(g)o(et)g(an)g(instance)g(of)g (that)g(types)g(holder)g(class.)25 b(The)c(factory)e(method)h(is)h (named,)e Fj(newANAME)p Fl(.)0 349 y Fp(Pr)o(operties)40 b Fo(Python)26 b(class)h(properties)f Fl(ar)m(e)h(cr)m(eated)f(for)h (eac)o(h)f(element)h(of)g(the)g(comple)n(x)f(type)o(.)44 b(The)n(y)27 b(ar)m(e)g(initialized)f(with)i(the)208 448 y(corr)m(esponding)21 b(g)o(etter)k(and)e(setter)i(for)g(that)e (element.)37 b(T)-8 b(o)24 b(avoid)g(name)f(collisions)h(the)g(pr)l (operties)g(ar)m(e)g(named,)g Fj(PNAME)p Fl(,)208 548 y(wher)m(e)17 b(the)g(\002r)o(st)h(letter)g(of)f(the)g(type')m(s)g (pname)f(attrib)n(ute)h(is)h(capitalized.)k(In)17 b(our)g(running)f(e)n (xample)o(,)h(msg)g(has)g(class)h(pr)l(operty)-5 b(,)208 648 y Fj(Options)p Fl(,)32 b(whic)o(h)e(calls)h(functions)f Fj(get_element__Options)d Fl(and)j Fj(set_element__Options)e Fl(under)i(the)208 747 y(hood.)0 1013 y Fm(e)n(xample)0 1215 y(schema)83 b Fl(T)-8 b(ak)o(en)20 b(fr)l(om)h(the)f(W)-8 b(olfr)o(amSear)m(c)o(h)19 b(WSDL.)236 1453 y Fb(