SOAPClient Component
Properties Methods Events Configuration Settings Errors
The SOAPClient component sends SOAP messages.
Syntax
TsbxSOAPClient
Remarks
The SOAPClient component implements client-side functionality of the SOAP version 1.1 and 1.2 protocols over HTTP/HTTPS.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AttachmentBytes | Use this property to pass an attachment to component in the byte array form. |
| AttachmentFile | Specifies the attachment file to be sent with the request. |
| BlockedCertificates | The certificates that must be rejected as trust anchors. |
| ClientChain | The TLS client certificate chain. |
| ConnectionInfo | Returns the details of the underlying network connection. |
| Encoding | Specifies SOAP message encoding. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| FaultActor | Specifies the entity that caused the fault. |
| FaultCode | Specifies the error code. |
| FaultDetail | Contains application-specific error information. |
| FaultString | Specifies a human-readable description of the fault. |
| InputBytes | Use this property to pass the input to component in the byte array form. |
| InputFile | A path to the file containing the SOAP message to be sent. |
| KeepAlivePolicy | Defines the keep-alive handling policy. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| MimeType | Specifies the SOAP message MIME type. |
| OperationName | Specifies the SOAP operation name. |
| OperationNamespaceURI | Specifies the SOAP message operation namespace URI. |
| OperationResponseName | Specifies the operation name of the response message. |
| OperationResponseNamespaceURI | Specifies the response SOAP message operation namespace URI. |
| OperationResponseTextContent | Returns the text content of the response message. |
| OperationResponseXML | Returns the XML content of the response SOAP message. |
| OutputAttachmentBytes | Use this property to read the attachment received from the service. |
| OutputAttachmentFile | A path to a file where to save the attachment data. |
| OutputBytes | Use this property to read the output the component object has produced. |
| OutputFile | A file where the response will be saved. |
| Proxy | The proxy server settings. |
| ReasonPhrase | Contains the Reason Phrase element of the server's response. |
| RequestHeaders | Contains HTTP request headers. |
| RequestParameters | Provides access to common HTTP request properties. |
| ResponseHeaders | Contains the HTTP server's response headers. |
| ResponseParameters | Contains the HTTP server's response parameters. |
| ServerChain | The TLS server's certificate chain. |
| SOAPAction | Specifies the SOAP action. |
| SOAPResponseType | The type of the response. |
| SOAPVersion | Specifies SOAP version. |
| SocketSettings | Manages network connection settings. |
| StatusCode | Contains the Status Code element of the server's response. |
| TLSSettings | Manages TLS layer settings. |
| TrustedCertificates | A list of trusted certificates for chain validation. |
| UseDigestAuth | Enables or disables the HTTP Digest authentication. |
| UseNTLMAuth | Enables or disables NTLM authentication. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| SendMessage | Sends a SOAP message to the server. |
| SendMessageWithAttachments | Sends a SOAP message with attachment(s) to the server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| BeforeReceiveAttachment | Marks the start of receiving an attachment. |
| BeforeSendAttachment | Marks the start of sending an attachment. |
| CertificateValidate | Fires when the server's TLS certificate has to be validated. |
| Cookie | Fired to report a received cookie. |
| DocumentBegin | Marks the start of the incoming HTML document or file. |
| DocumentEnd | Marks the successful receipt of the incoming HTML document or file. |
| Error | Information about errors during data delivery. |
| ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| HeadersPrepared | Fires when the request headers have been formed and are about to be sent to the server. |
| HeadersReceived | Fires when the HTTP response headers have just been received from the server. |
| Notification | This event notifies the application about an underlying control flow event. |
| Progress | Fires periodically during the data transfer. |
| Redirection | Fires when the server suggests a redirect. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| AttachmentContentDescription | Specifies attachment content description. |
| AttachmentContentId | Specifies attachment content Id. |
| AttachmentContentType | Specifies attachment content type. |
| AttachmentFilename | Specifies attachment filename. |
| CacheStreamOutput | Tells the component whether to cache stream- and file-bound responses in the component. |
| FaultActor[Index] | Specifies who caused the fault. |
| FaultCode[Index] | Specifies the error code. |
| FaultCount | The number of faults. |
| FaultDetail[Index] | Contains application-specific error information. |
| FaultString[Index] | Specifies a human-readable description of fault. |
| FaultXML[Index] | Specifies the XML content of the fault. |
| ForceNTLMAuth | Activates and enforces NTLM authentication. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| IgnoreUnknownTransferEncodings | All incoming responses with unknown transfer encodings are ignored if this property is true. |
| MaxRedirections | The maximum number of HTTP redirects. |
| PersistentAuthHeader | Whether to resend NTLM negotiation on every request. |
| RelatedStartInfo | Specifies Start-Info parameter. |
| RelatedType | Specifies media type/subtype. |
| RequestCompressionGZip | Ask server to use GZip compression. |
| RequestCompressionLevel | Ask server to use the specified compression level. |
| SendBufferSize | Size of send buffer in bytes. |
| SkipInputProcessing | Whether to skip input processing. |
| SkipOutputParsing | Whether to skip output parsing. |
| SOAPPrefix | Specifies the signature prefix. |
| SuppressRedirectionContent | Whether to suppress the redirection content. |
| TempPath | Path for storing temporary files. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| Use100Continue | Whether to use 100-continue for POST and PUT commands. |
| UseCompression | Whether to use GZip compression. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSOAPAction | Whether to use SOAP Action. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |