Public Member Functions | Data Fields | Static Public Attributes

ParsedSoap Class Reference

Public Member Functions

def __init__
def __del__
def Backtrace
def FindLocalHREF
def ResolveHREF
def GetMyHeaderElements
def GetElementNSdict
def GetDomAndReader
def IsAFault
def Parse
def WhatMustIUnderstand
def WhatActorsArePresent
def ParseHeaderElements
def __init__
def __del__
def Backtrace
def FindLocalHREF
def ResolveHREF
def GetMyHeaderElements
def GetElementNSdict
def GetDomAndReader
def IsAFault
def Parse
def WhatMustIUnderstand
def WhatActorsArePresent
def ParseHeaderElements

Data Fields

 readerclass
 keepdom
 reader
 dom
 ns_cache
 id_cache
 body_root
 envelope
 header
 header_elements
 body
 trailer_elements
 data_elements

Static Public Attributes

 defaultReaderClass = DefaultReader

Detailed Description

A Parsed SOAP object.
    Convert the text to a DOM tree and parse SOAP elements.
    Instance data:
        reader -- the DOM reader
        dom -- the DOM object
        ns_cache -- dictionary (by id(node)) of namespace dictionaries
        id_cache -- dictionary (by XML ID attr) of elements
        envelope -- the node holding the SOAP Envelope
        header -- the node holding the SOAP Header (or None)
        body -- the node holding the SOAP Body
        body_root -- the serialization root in the SOAP Body
        data_elements -- list of non-root elements in the SOAP Body
        trailer_elements -- list of elements following the SOAP body

Definition at line 26 of file parse.py.


Constructor & Destructor Documentation

def __init__ (   self,
  input,
  readerclass = None,
  keepdom = False,
  trailers = False,
  resolver = None,
  envelope = True,
  kw 
)
Initialize.
Keyword arguments:
    trailers -- allow trailer elments (default is zero)
    resolver -- function (bound method) to resolve URI's
    readerclass -- factory class to create a reader
    keepdom -- do not release the DOM
    envelope -- look for a SOAP envelope.

Definition at line 43 of file parse.py.

def __init__ (   self,
  input,
  readerclass = None,
  keepdom = False,
  trailers = False,
  resolver = None,
  envelope = True,
  kw 
)
Initialize.
Keyword arguments:
    trailers -- allow trailer elments (default is zero)
    resolver -- function (bound method) to resolve URI's
    readerclass -- factory class to create a reader
    keepdom -- do not release the DOM
    envelope -- look for a SOAP envelope.

Definition at line 43 of file parse.py.


Member Function Documentation

def Backtrace (   self,
  elt 
)
Return a human-readable "backtrace" from the document root to
the specified element.

Definition at line 235 of file parse.py.

def Backtrace (   self,
  elt 
)
Return a human-readable "backtrace" from the document root to
the specified element.

Definition at line 235 of file parse.py.

def FindLocalHREF (   self,
  href,
  elt,
  headers = 1 
)
Find a local HREF in the data elements.

Definition at line 241 of file parse.py.

def FindLocalHREF (   self,
  href,
  elt,
  headers = 1 
)
Find a local HREF in the data elements.

Definition at line 241 of file parse.py.

def GetDomAndReader (   self )
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).

Definition at line 306 of file parse.py.

def GetDomAndReader (   self )
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).

Definition at line 306 of file parse.py.

def GetElementNSdict (   self,
  elt 
)
Get a dictionary of all the namespace attributes for the indicated
element.  The dictionaries are cached, and we recurse up the tree
as necessary.

Definition at line 289 of file parse.py.

def GetElementNSdict (   self,
  elt 
)
Get a dictionary of all the namespace attributes for the indicated
element.  The dictionaries are cached, and we recurse up the tree
as necessary.

Definition at line 289 of file parse.py.

def GetMyHeaderElements (   self,
  actorlist = None 
)
Return a list of all elements intended for these actor(s).

Definition at line 279 of file parse.py.

def GetMyHeaderElements (   self,
  actorlist = None 
)
Return a list of all elements intended for these actor(s).

Definition at line 279 of file parse.py.

def IsAFault (   self )
Is this a fault message?

Definition at line 315 of file parse.py.

def IsAFault (   self )
Is this a fault message?

Definition at line 315 of file parse.py.

def Parse (   self,
  how 
)
Parse the message.

Definition at line 322 of file parse.py.

def Parse (   self,
  how 
)
Parse the message.

Definition at line 322 of file parse.py.

def ParseHeaderElements (   self,
  ofwhat 
)
Returns a dictionary of pyobjs.
ofhow -- list of typecodes w/matching nspname/pname to the header_elements.

Definition at line 345 of file parse.py.

def ParseHeaderElements (   self,
  ofwhat 
)
Returns a dictionary of pyobjs.
ofhow -- list of typecodes w/matching nspname/pname to the header_elements.

Definition at line 345 of file parse.py.

def WhatActorsArePresent (   self )
Return a list of URI's of all the actor attributes found in
the header.  The special actor "next" is ignored.

Definition at line 335 of file parse.py.

def WhatActorsArePresent (   self )
Return a list of URI's of all the actor attributes found in
the header.  The special actor "next" is ignored.

Definition at line 335 of file parse.py.

def WhatMustIUnderstand (   self )
Return a list of (uri,localname) tuples for all elements in the
header that have mustUnderstand set.

Definition at line 328 of file parse.py.

def WhatMustIUnderstand (   self )
Return a list of (uri,localname) tuples for all elements in the
header that have mustUnderstand set.

Definition at line 328 of file parse.py.


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