SecureBlackbox 2020 macOS Edition

Questions / Feedback?

SOAPClient Module

Properties   Methods   Events   Configuration Settings   Errors  

The SOAPClient component sends SOAP messages.




The SOAPClient class 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 module with short descriptions. Click on the links for further details.

AttachmentBytesUse this property to pass an attachment to component in the byte array form.
AttachmentFileSpecifies the attachment file to be sent with the request.
BlockedCertificatesThe certificates that must be rejected as trust anchors.
ClientChainThe TLS client certificate chain.
ConnectionInfoReturns the details of the underlying network connection.
EncodingSpecifies SOAP message encoding.
ExternalCryptoProvides access to external signing and DC parameters.
FaultActorSpecifies the entity that caused the fault.
FaultCodeSpecifies the error code.
FaultDetailContains application-specific error information.
FaultStringSpecifies a human-readable description of the fault.
InputBytesUse this property to pass the input to component in the byte array form.
InputFileA path to the file containing the SOAP message to be sent.
KeepAlivePolicyDefines the keep-alive handling policy.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
MimeTypeSpecifies the SOAP message MIME type.
OperationNameSpecifies the SOAP operation name.
OperationNamespaceURISpecifies the SOAP message operation namespace URI.
OperationResponseNameSpecifies the operation name of the response message.
OperationResponseNamespaceURISpecifies the response SOAP message operation namespace URI.
OperationResponseTextContentReturns the text content of the response message.
OperationResponseXMLReturns the XML content of the response SOAP message.
OutputAttachmentBytesUse this property to read the attachment received from the service.
OutputAttachmentFileA path to a file where to save the attachment data.
OutputBytesUse this property to read the output the component object has produced.
OutputFileA file where the response will be saved.
ProxyThe proxy server settings.
ReasonPhraseContains the Reason Phrase element of the server's response.
RequestHeadersContains HTTP request headers.
RequestParametersProvides access to common HTTP request properties.
ResponseHeadersContains the HTTP server's response headers.
ResponseParametersContains the HTTP server's response parameters.
ServerChainThe TLS server's certificate chain.
SOAPActionSpecifies the SOAP action.
SOAPResponseTypeThe type of the response.
SOAPVersionSpecifies SOAP version.
SocketSettingsManages network connection settings.
StatusCodeContains the Status Code element of the server's response.
TLSSettingsManages TLS layer settings.
TrustedCertificatesA list of trusted certificates for chain validation.
UseDigestAuthEnables or disables the HTTP Digest authentication.
UseNTLMAuthEnables or disables NTLM authentication.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
SendMessageSends a SOAP message to the server.
SendMessageWithAttachmentsSends a SOAP message with attachment(s) to the server.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

BeforeReceiveAttachmentMarks the start of receiving an attachment.
BeforeSendAttachmentMarks the start of sending an attachment.
CertificateValidateFires when the server's TLS certificate has to be validated.
CookieFired to report a received cookie.
DocumentBeginMarks the start of the incoming HTML document or file.
DocumentEndMarks the successful receipt of the incoming HTML document or file.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
HeadersPreparedFires when the request headers have been formed and are about to be sent to the server.
HeadersReceivedFires when the HTTP response headers have just been received from the server.
NotificationThis event notifies the application about an underlying control flow event.
ProgressFires periodically during the data transfer.
RedirectionFires when the server suggests a redirect.

Configuration Settings

The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.

AttachmentContentDescriptionSpecifies attachment content description.
AttachmentContentIdSpecifies attachment content Id.
AttachmentContentTypeSpecifies attachment content type.
AttachmentFilenameSpecifies attachment filename.
CacheStreamOutputTells 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.
FaultCountThe 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.
ForceNTLMAuthActivates and enforces NTLM authentication.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
IgnoreUnknownTransferEncodingsAll incoming responses with unknown transfer encodings are ignored if this property is true.
MaxRedirectionsThe maximum number of HTTP redirects.
PersistentAuthHeaderWhether to resend NTLM negotiation on every request.
RelatedStartInfoSpecifies Start-Info parameter.
RelatedTypeSpecifies media type/subtype.
RequestCompressionGZipAsk server to use GZip compression.
RequestCompressionLevelAsk server to use the specified compression level.
SendBufferSizeSize of send buffer in bytes.
SkipInputProcessingWhether to skip input processing.
SkipOutputParsingWhether to skip output parsing.
SOAPPrefixSpecifies the signature prefix.
SuppressRedirectionContentWhether to suppress the redirection content.
TempPathPath for storing temporary files.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
Use100ContinueWhether to use 100-continue for POST and PUT commands.
UseCompressionWhether to use GZip compression.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseSOAPActionWhether to use SOAP Action.
UseSystemCertificatesEnables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8166]