Detailed Description
Object that represents a binding (connection) to a SOAP server.
Once the binding is created, various ways of sending and
receiving SOAP messages are available.
Definition at line 87 of file client.py.
Constructor & Destructor Documentation
| def __init__ |
( |
|
self, |
|
|
|
nsdict = None, |
|
|
|
transport = None, |
|
|
|
url = None, |
|
|
|
tracefile = None, |
|
|
|
readerclass = None, |
|
|
|
writerclass = None, |
|
|
|
soapaction = '', |
|
|
|
wsAddressURI = None, |
|
|
|
sig_handler = None, |
|
|
|
transdict = None, |
|
|
|
kw |
|
) |
| |
Initialize.
Keyword arguments include:
transport -- default use HTTPConnection.
transdict -- dict of values to pass to transport.
url -- URL of resource, POST is path
soapaction -- value of SOAPAction header
auth -- (type, name, password) triplet; default is unauth
nsdict -- namespace entries to add
tracefile -- file to dump packet traces
cert_file, key_file -- SSL data (q.v.)
readerclass -- DOM reader class
writerclass -- DOM writer class, implements MessageInterface
wsAddressURI -- namespaceURI of WS-Address to use. By default
it's not used.
sig_handler -- XML Signature handler, must sign and verify.
endPointReference -- optional Endpoint Reference.
Definition at line 96 of file client.py.
| def __init__ |
( |
|
self, |
|
|
|
nsdict = None, |
|
|
|
transport = None, |
|
|
|
url = None, |
|
|
|
tracefile = None, |
|
|
|
readerclass = None, |
|
|
|
writerclass = None, |
|
|
|
soapaction = '', |
|
|
|
wsAddressURI = None, |
|
|
|
sig_handler = None, |
|
|
|
transdict = None, |
|
|
|
kw |
|
) |
| |
Initialize.
Keyword arguments include:
transport -- default use HTTPConnection.
transdict -- dict of values to pass to transport.
url -- URL of resource, POST is path
soapaction -- value of SOAPAction header
auth -- (type, name, password) triplet; default is unauth
nsdict -- namespace entries to add
tracefile -- file to dump packet traces
cert_file, key_file -- SSL data (q.v.)
readerclass -- DOM reader class
writerclass -- DOM writer class, implements MessageInterface
wsAddressURI -- namespaceURI of WS-Address to use. By default
it's not used.
sig_handler -- XML Signature handler, must sign and verify.
endPointReference -- optional Endpoint Reference.
Definition at line 96 of file client.py.
Member Function Documentation
| def AddHeader |
( |
|
self, |
|
|
|
header, |
|
|
|
value |
|
) |
| |
| def AddHeader |
( |
|
self, |
|
|
|
header, |
|
|
|
value |
|
) |
| |
Get a SOAP message, see if it has a fault.
Definition at line 429 of file client.py.
Get a SOAP message, see if it has a fault.
Definition at line 429 of file client.py.
| def Receive |
( |
|
self, |
|
|
|
replytype, |
|
|
|
kw |
|
) |
| |
Parse message, create Python object.
KeyWord data:
faults -- list of WSDL operation.fault typecodes
wsaction -- If using WS-Address, must specify Action value we expect to
receive.
Reimplemented in Binding, and Binding.
Definition at line 444 of file client.py.
| def Receive |
( |
|
self, |
|
|
|
replytype, |
|
|
|
kw |
|
) |
| |
Parse message, create Python object.
KeyWord data:
faults -- list of WSDL operation.fault typecodes
wsaction -- If using WS-Address, must specify Action value we expect to
receive.
Reimplemented in Binding, and Binding.
Definition at line 444 of file client.py.
| def ReceiveFault |
( |
|
self, |
|
|
|
kw |
|
) |
| |
Parse incoming message as a fault. Raise TypeError if no
fault found.
Definition at line 435 of file client.py.
| def ReceiveFault |
( |
|
self, |
|
|
|
kw |
|
) |
| |
Parse incoming message as a fault. Raise TypeError if no
fault found.
Definition at line 435 of file client.py.
| def ReceiveRaw |
( |
|
self, |
|
|
|
kw |
|
) |
| |
Read a server reply, unconverted to any format and return it.
Definition at line 367 of file client.py.
| def ReceiveRaw |
( |
|
self, |
|
|
|
kw |
|
) |
| |
Read a server reply, unconverted to any format and return it.
Definition at line 367 of file client.py.
| def ReceiveSOAP |
( |
|
self, |
|
|
|
readerclass = None, |
|
|
|
kw |
|
) |
| |
| def ReceiveSOAP |
( |
|
self, |
|
|
|
readerclass = None, |
|
|
|
kw |
|
) |
| |
| def ResetCookies |
( |
|
self ) |
|
Empty the list of cookies.
Definition at line 158 of file client.py.
| def ResetCookies |
( |
|
self ) |
|
Empty the list of cookies.
Definition at line 158 of file client.py.
| def ResetHeaders |
( |
|
self ) |
|
Empty the list of additional headers.
Definition at line 152 of file client.py.
| def ResetHeaders |
( |
|
self ) |
|
Empty the list of additional headers.
Definition at line 152 of file client.py.
| def RPC |
( |
|
self, |
|
|
|
url, |
|
|
|
opname, |
|
|
|
obj, |
|
|
|
replytype = None, |
|
|
|
kw |
|
) |
| |
Send a request, return the reply. See Send() and Recieve()
docstrings for details.
Definition at line 186 of file client.py.
| def RPC |
( |
|
self, |
|
|
|
url, |
|
|
|
opname, |
|
|
|
obj, |
|
|
|
replytype = None, |
|
|
|
kw |
|
) |
| |
Send a request, return the reply. See Send() and Recieve()
docstrings for details.
Definition at line 186 of file client.py.
| def Send |
( |
|
self, |
|
|
|
url, |
|
|
|
opname, |
|
|
|
obj, |
|
|
|
nsdict = {}, |
|
|
|
soapaction = None, |
|
|
|
wsaction = None, |
|
|
|
endPointReference = None, |
|
|
|
soapheaders = (), |
|
|
|
kw |
|
) |
| |
Send a message. If url is None, use the value from the
constructor (else error). obj is the object (data) to send.
Data may be described with a requesttypecode keyword, the default
is the class's typecode (if there is one), else Any.
Try to serialize as a Struct, if this is not possible serialize an Array. If
data is a sequence of built-in python data types, it will be serialized as an
Array, unless requesttypecode is specified.
arguments:
url --
opname -- struct wrapper
obj -- python instance
key word arguments:
nsdict --
soapaction --
wsaction -- WS-Address Action, goes in SOAP Header.
endPointReference -- set by calling party, must be an
EndPointReference type instance.
soapheaders -- list of pyobj, typically w/typecode attribute.
serialized in the SOAP:Header.
requesttypecode --
Definition at line 193 of file client.py.
| def Send |
( |
|
self, |
|
|
|
url, |
|
|
|
opname, |
|
|
|
obj, |
|
|
|
nsdict = {}, |
|
|
|
soapaction = None, |
|
|
|
wsaction = None, |
|
|
|
endPointReference = None, |
|
|
|
soapheaders = (), |
|
|
|
kw |
|
) |
| |
Send a message. If url is None, use the value from the
constructor (else error). obj is the object (data) to send.
Data may be described with a requesttypecode keyword, the default
is the class's typecode (if there is one), else Any.
Try to serialize as a Struct, if this is not possible serialize an Array. If
data is a sequence of built-in python data types, it will be serialized as an
Array, unless requesttypecode is specified.
arguments:
url --
opname -- struct wrapper
obj -- python instance
key word arguments:
nsdict --
soapaction --
wsaction -- WS-Address Action, goes in SOAP Header.
endPointReference -- set by calling party, must be an
EndPointReference type instance.
soapheaders -- list of pyobj, typically w/typecode attribute.
serialized in the SOAP:Header.
requesttypecode --
Definition at line 193 of file client.py.
| def SendSOAPDataHTTPDigestAuth |
( |
|
self, |
|
|
|
response, |
|
|
|
soapdata, |
|
|
|
url, |
|
|
|
request_uri, |
|
|
|
soapaction, |
|
|
|
kw |
|
) |
| |
Resend the initial request w/http digest authorization headers.
The SOAP server has requested authorization. Fetch the challenge,
generate the authdict for building a response.
Definition at line 331 of file client.py.
| def SendSOAPDataHTTPDigestAuth |
( |
|
self, |
|
|
|
response, |
|
|
|
soapdata, |
|
|
|
url, |
|
|
|
request_uri, |
|
|
|
soapaction, |
|
|
|
kw |
|
) |
| |
Resend the initial request w/http digest authorization headers.
The SOAP server has requested authorization. Fetch the challenge,
generate the authdict for building a response.
Definition at line 331 of file client.py.
| def SetAuth |
( |
|
self, |
|
|
|
style, |
|
|
|
user = None, |
|
|
|
password = None |
|
) |
| |
Change auth style, return object to user.
Definition at line 139 of file client.py.
| def SetAuth |
( |
|
self, |
|
|
|
style, |
|
|
|
user = None, |
|
|
|
password = None |
|
) |
| |
Change auth style, return object to user.
Definition at line 139 of file client.py.
The documentation for this class was generated from the following files: