IRISLIB database
ItemSetWS Class Reference
Inheritance diagram for ItemSetWS:
Collaboration diagram for ItemSetWS:

Public Member Functions

_.Library.String CalcLocation ()
 Handles fetching the override Location if it exists.
 
def __init__ (self)
 Deprecated. More...
 
- Public Member Functions inherited from WebClient
_.Library.Status CancelSecureConversation ()
 Cancel the this client's current WS-SecureConversation token specified by the SecurityContextToken property. More...
 
_.Library.Status ResetHttpHeaders ()
 Clear all previously set Http headers.
 
_.Library.Status SendSOAPRequest (_.Library.String action, _.Library.Boolean oneWay, _.SOAP.RequestMessage request, _.Library.String methodName)
 Send a SOAP.RequestMessage subclass instance as a request message. More...
 
_.Library.Status SetHttpHeader (_.Library.String name, _.Library.String value)
 Add HTTP header to the SOAP request. More...
 
_.Library.Status StartSecureConversation (_.SOAP.WST.RequestSecurityToken RST)
 Start a WS-SecureConversation session by sending the specified RequestSecurityToken body. More...
 
_.Library.Boolean WSCheckSignatureConfirmation ()
 Test for valid WS-Security 1.1 SignatureConfirmation elements in response message. More...
 
_.Library.Status WSSecurityLogin (_.Library.String Username, _.Library.String Password)
 The WSSecurityLogin method adds the WS-Security Security header with /UsernameToken. More...
 

Static Public Attributes

 LOCATION = None
 This is the URL used to access the web service.
 
 NAMESPACE = None
 This is the namespace used by the Service.
 
 OUTPUTTYPEATTRIBUTE = None
 Use xsi:type attribute for literal types.
 
 SERVICENAME = None
 This is the name of the Service.
 
 SrcVer = None
 This Parameter should be updated when synced from Perforce.
 
 USEPPGHANDLER = None
 Use PPG Memory as opposed to process memory for XML reader.
 
 Version = None
 Revision number of this class when compiled as part of the //custom_ccrs/_common/config/... More...
 
- Static Public Attributes inherited from WebClient
 SOAPACTIONQUOTED = None
 If the web client has the parameter SOAPACTIONQUOTED=1, then the web client will. More...
 
 SOAPBINARYCHARSET = None
 Default charset for remote SOAP binary server. More...
 
 SOAPVERSION = None
 The SOAPVERSION parameter specified the version of SOAP which is supported. More...
 
 URLESCAPESOAPACTION = None
 If the web client has the parameter URLESCAPESOAPACTION=1, then the web client will. More...
 

Private Member Functions

 OnSOAPRequest (_.Library.String mode, _.SOAP.WebClient client, _.Library.String action, _.Library.Boolean oneWay, _.Library.String method, _.Library.BinaryStream requestStream)
 This method is a callback which will be invoked before invoking transport.DoSOAPRequest() method. More...
 

Private Attributes

 __APIKey
   More...
 
 __APISecret
   More...
 

Additional Inherited Members

- Public Attributes inherited from WebClient
 ContentType
 Content-Type to be used for transport class. More...
 
 GzipOutput
 If the GzipOutput property is set to true (1), then the output request. More...
 
 HTTPVersion
 The HTTP version we should report to the server when making the request. More...
 
 HttpAccept202
 If HttpAccept202=0 (default) we follow the WS-I Basic Profile which calls for HTTP response. More...
 
 HttpFollowRedirect
 If true then automatically follow redirection requests from the web server. More...
 
 HttpInitiateAuthentication
 A client may initiate a connection to the server with an "Authorization" header containing. More...
 
 HttpPassword
 If the <property>Username</property> and Password are defined then this information. More...
 
 HttpProxyAuthorization
 Sets/get the 'Proxy-Authorization:' header field in the Http request. More...
 
 HttpProxyHTTPS
 HttpProxyHTTPS property is ignored since the use of SSL to the end point. More...
 
 HttpProxyPort
 The port to connect to the proxy web server on. More...
 
 HttpProxySSLConnect
 SSL connection to the proxy server will be used if the HttpProxySSLConnect property = 1. More...
 
 HttpProxyServer
 If you need to make SOAP request through a proxy server you specify the. More...
 
 HttpProxyTunnel
 If true then use the HTTP CONNECT command to establish a tunnel through the proxy. More...
 
 HttpRequest
 If specified, the caller assigned Net.HttpRequest instance is used for. More...
 
 HttpRequestHeaderCharset
 The character set to send the HTTP request header in. More...
 
 HttpRequester
 
 HttpResponse
 The HttpResponse property is set to the Net.HttpResponse instance for the response to the. More...
 
 HttpUsername
 If the Username and <property>Password</property> are defined then this information. More...
 
 HttpWriteTimeout
 Set this to the timeout the HttpRequest object will use when writing to the remote HTTP server. More...
 
 OpenTimeout
 If specified is the amount of time we will wait for the TCP/IP connection to open. More...
 
 PolicyConfiguration
 Property to allow override of policy to be used for the web client. More...
 
 SSLCheckServerIdentity
 When making an SSL connection check the server identity in the certificate matches the name of the system we are connecting to. More...
 
 SSLConfiguration
 The name of the activated TLS/SSL configuration to use for https requests. More...
 
 SSLError
 If request uses an SSL connection and a SSL handshake error has occurred,. More...
 
 SoapBinary
 If SoapBinary is 1, then the web client will use proprietary binary SOAP protocol. More...
 
 SoapBinaryCharset
 Property to allow override of charset for remote SOAP binary server. More...
 
 SoapVersion
 The SoapVersion property is either "1.1" or "1.2" and indicates the SOAP. More...
 
 UsePPGHandler
 If UsePPGHandler is true (1), then force SOAP response parsing to use PPG memory. More...
 
 WSANamespace
 Property to allow the WS-Addressing namespace to be specified for requests. More...
 

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self)

Deprecated.

Net.HttpRequester will always be used as the network access layer

 

Reimplemented from WebClient.

Member Function Documentation

◆ OnSOAPRequest()

OnSOAPRequest ( _.Library.String  mode,
_.SOAP.WebClient  client,
_.Library.String  action,
_.Library.Boolean  oneWay,
_.Library.String  method,
_.Library.BinaryStream  requestStream 
)
private

This method is a callback which will be invoked before invoking transport.DoSOAPRequest() method.

to make the actual SOAP request. This method may be override by the user's web client class. DoSOAPRequest is the transport method which is responsible for sending the SOAP request and receiving the response. The default DoSOAPRequest is included in SOAP.WebClient and uses HTTP for request/response.

The mode argument specifies the type of SOAP request "SOAP" or "binary".
The client argument is the oref of the web client class.
The action argument contains the value of the SOAPAction.
The oneWay argument is true if no body is to be sent. The method argument is the name of the WebMethod that is being invoked
The requestStream argument contains the SOAP request message in a stream. requestStream may =0 as an optimization to improve SOAP performance. requestStream=0 means that the stream is kept in memory as much as possible with overflow to a global. requestStream may be accessed by using $$$XMLRewind and $$$XMLRead macros.

Member Data Documentation

◆ Version

Version = None
static

Revision number of this class when compiled as part of the //custom_ccrs/_common/config/...

branch.

This version will not be updated (by design) when the class is integrated to other branches. This allows the user to tell what version of the Studio client tools are in use.

◆ __APIKey

__APIKey
private

 

 

◆ __APISecret

__APISecret
private