SOAP Class
Properties Methods Events Configuration Settings Errors
The SOAP Component is a generic SOAP client supporting SOAP 1.1 that is used to communicate with SOAP servers.
Syntax
ipworks.soap()
Remarks
The SOAP Class implements a standard SOAP client as specified in the SOAP 1.1 specification.
The class uses HTTP to communicate with SOAP servers, and an internal XML parser to process the results. The SOAP requests are specified by first setting the SOAP Method and MethodURI, as well as optional parameters in the Params properties. Then set the target URL and call the SendRequest method.
The results will be provided through the ReturnValue property and the Params properties (for output parameters). Additionally, properties such as XPath, XElement, XText, etc. allow for more granular traversal of the SOAP response.
If the server returns an error, the FaultCode, FaultString, and FaultActor properties will provide information about the error condition.
The class may also be used in offline mode. This is supported by methods such as BuildPacket and EvalPacket. The corresponding SOAP packet will be stored in the SOAPPacket property. Offline mode is important in cases where the underlying SOAP transport is not HTTP, but another mechanism (e.g. SMTP and POP for email).
By providing direct access to the SOAP packet in offline mode, the class allows for possible extension and full control over the SOAPPacket. The SendPacket method may then be used to send the custom-created SOAPPacket to the destination URL.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| Accept | A list of acceptable MIME types for the request. |
| ActionURI | The value of the SOAP-Action header. |
| Authorization | The Authorization string to be sent to the server. |
| AuthScheme | The authentication scheme to use when server authorization is required. |
| Connected | Shows whether the component is connected. |
| ContentType | Content type for SOAP request data. |
| CookieCount | The number of records in the Cookie arrays. |
| CookieDomain | The domain of a received cookie. |
| CookieExpiration | This property contains an expiration time for the cookie (if provided by the server). |
| CookieName | The name of the cookie. |
| CookiePath | This property contains a path name to limit the cookie to (if provided by the server). |
| CookieSecure | This property contains the security flag of the received cookie. |
| CookieValue | This property contains the value of the cookie. |
| FaultActor | Actor of any faults returned by the SOAP server. |
| FaultCode | Code of any faults returned by the SOAP server. |
| FaultString | Textual description of any faults returned by the SOAP server. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| Idle | The current status of the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| LocalFile | The path to a local file for downloading. If the file exists, it is overwritten. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| Method | The remote Method . |
| MethodURI | The URI corresponding to the SOAP Method . |
| NamespaceCount | The number of records in the Namespace arrays. |
| NamespacePrefix | The Prefix for the Namespace . |
| NamespaceURI | Namespace URI associated with the corresponding Prefix . |
| OtherHeaders | Other headers as determined by the user (optional). |
| ParamCount | The number of records in the Param arrays. |
| ParamAttrs | Extra attributes for the parameter. |
| ParamName | The name of the Method parameter. |
| ParamValue | The value of the Method parameter. |
| ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
| ParsedHeaderField | This property contains the name of the HTTP header (same case as it is delivered). |
| ParsedHeaderValue | This property contains the header contents. |
| Password | A password if authentication is to be used. |
| Pragma | A browser/server specific header line (optional). |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| Referer | Referer URL/document (optional). |
| ReturnValue | Value returned by the SOAP Method . |
| SOAPEncoding | The type of SOAP Encoding used for SOAP requests. |
| SOAPHeader | Contents of the optional SOAP header sent to the server. |
| SOAPPacket | Full contents of the SOAP packet. |
| StatusLine | The first line of the last server response. |
| Timeout | A timeout for the component. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum of data to be transferred. |
| TransferredHeaders | The full set of headers as received from the server. |
| URL | The URL to fetch. |
| User | A user name if authentication is to be used. |
| ValueFormat | Format of data returned or set. |
| AttrCount | The number of records in the Attr arrays. |
| AttrName | The Name provides the local name (without prefix) of the attribute. |
| AttrNamespace | Attribute namespace. |
| AttrPrefix | Attribute prefix (if any). |
| AttrValue | Attribute value. |
| XChildren | The number of children of the element pointed to by XPath . |
| XElement | The name of the element pointed to by XPath . |
| XNamespace | The namespace of the element pointed to by XPath . |
| XParent | The parent of the element pointed to by XPath . |
| XPath | A path into the SOAPPacket received by the server. |
| XPrefix | The prefix of the element pointed to by XPath . |
| XText | The text of the element pointed to by XPath . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| AddCookie | Adds a cookie and the corresponding value to the outgoing request headers. |
| AddNamespace | Adds a namespace to the Namespaces properties. |
| AddParam | Adds a parameter-value pair. |
| Attr | Returns the value of the specified attribute. |
| BuildPacket | Build the request packet. |
| Config | Sets or retrieves a configuration setting . |
| DoEvents | Processes events from the internal message queue. |
| EvalPacket | Evaluate the packet in SOAPPacket . |
| HasXPath | Determines whether a specific element exists in the document. |
| Interrupt | Interrupt the current method. |
| Reset | Reset the component. |
| SendPacket | Send the packet. |
| SendRequest | Send the request. |
| Value | Returns the value of a parameter. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | Fired to indicate changes in connection state. |
| Disconnected | Fired when a connection is closed. |
| EndTransfer | Fired when a document finishes transferring. |
| Error | Information about errors during data delivery. |
| Header | Fired every time a header line comes in. |
| Redirect | Fired when a redirection is received from the server. |
| SetCookie | Fired for every cookie set by the server. |
| StartTransfer | Fired when a document starts transferring (after the headers). |
| Status | Fired when the HTTP status line is received from the server. |
| Transfer | Fired while the response transfers. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| EncodingStyleNamespacePrefix | The prefix to be used for the Encoding namespace. |
| MethodNamespacePrefix | The prefix to be used for the Method namespace. |
| MethodAttributes | The attributes to include in the method element. |
| RequestPacket | The SOAP packet that was sent to the server during the last request. |
| XSubTree | A snapshot of the current element in the document. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| IgnoreBadAttributePrefixes | If true, bad (unknown) attribute prefixes are ignored. |
| IgnoreBadElementPrefixes | If true, bad (unknown) element prefixes are ignored. |
| CacheContent | If true, the original XML is saved in a buffer. |
| ErrorOnEmptyAttr | If true, passing an invalid attribute to the Attr method will throw an exception. |
| PreserveWhitespace | If true, leading and trailing whitespace in element text is preserved. |
| CodePage | The system code page used for Unicode to Multibyte translations. |