SOAPClient Module
Properties Methods Events Config Settings Errors
The SOAPClient module sends SOAP messages.
Syntax
SecureBlackbox.Soapclient
Remarks
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.
AttachmentBytes | Use this property to pass an attachment to module 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. |
FIPSMode | Reserved. |
InputBytes | Use this property to pass the input to module 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 module 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. |
UseKerberosAuth | Enables Kerberos authentication mechanism. |
UseNTLMAuth | Enables 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.
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
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 module 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. |
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. |
TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
TLSPSK | Notifies the application about the PSK key exchange. |
TLSShutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the module 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 module whether to cache stream- and file-bound responses in the module. |
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 module (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. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
UseOwnDNSResolver | Specifies whether the client modules 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. |
AttachmentBytes Property (SOAPClient Module)
Use this property to pass an attachment to module in the byte array form.
Syntax
public var attachmentBytes: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=attachmentBytes,setter=setAttachmentBytes:) NSData* attachmentBytes; - (NSData*)attachmentBytes; - (void)setAttachmentBytes :(NSData*)newAttachmentBytes;
Remarks
Assign a byte array containing the data to be processed to this property.
AttachmentFile Property (SOAPClient Module)
Specifies the attachment file to be sent with the request.
Syntax
public var attachmentFile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=attachmentFile,setter=setAttachmentFile:) NSString* attachmentFile; - (NSString*)attachmentFile; - (void)setAttachmentFile :(NSString*)newAttachmentFile;
Default Value
""
Remarks
Provide a full path to the attachment file to be sent with the SOAP request. Use SendMessageWithAttachments method to send the request.
Subscribe to BeforeSendAttachment to pass more than one attachment.
BlockedCertificates Property (SOAPClient Module)
The certificates that must be rejected as trust anchors.
Syntax
public var blockedCertificates: Array<Certificate> { get {...} }
@property (nonatomic,readwrite,assign,getter=blockedCertCount,setter=setBlockedCertCount:) int blockedCertCount; - (int)blockedCertCount; - (void)setBlockedCertCount :(int)newBlockedCertCount; - (NSData*)blockedCertBytes:(int)blockedCertIndex; - (long long)blockedCertHandle:(int)blockedCertIndex; - (void)setBlockedCertHandle:(int)blockedCertIndex :(long long)newBlockedCertHandle;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
ClientChain Property (SOAPClient Module)
The TLS client certificate chain.
Syntax
public var clientChain: Array<Certificate> { get {...} }
@property (nonatomic,readwrite,assign,getter=clientCertCount,setter=setClientCertCount:) int clientCertCount; - (int)clientCertCount; - (void)setClientCertCount :(int)newClientCertCount; - (NSData*)clientCertBytes:(int)clientCertIndex; - (long long)clientCertHandle:(int)clientCertIndex; - (void)setClientCertHandle:(int)clientCertIndex :(long long)newClientCertHandle;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
ConnectionInfo Property (SOAPClient Module)
Returns the details of the underlying network connection.
Syntax
public var connectionInfo: ConnectionInfo { get {...} }
@property (nonatomic,readonly,assign,getter=connInfoAEADCipher) BOOL connInfoAEADCipher; - (BOOL)connInfoAEADCipher; @property (nonatomic,readonly,assign,getter=connInfoChainValidationDetails) int connInfoChainValidationDetails; - (int)connInfoChainValidationDetails; @property (nonatomic,readonly,assign,getter=connInfoChainValidationResult) int connInfoChainValidationResult; - (int)connInfoChainValidationResult; @property (nonatomic,readonly,assign,getter=connInfoCiphersuite) NSString* connInfoCiphersuite; - (NSString*)connInfoCiphersuite; @property (nonatomic,readonly,assign,getter=connInfoClientAuthenticated) BOOL connInfoClientAuthenticated; - (BOOL)connInfoClientAuthenticated; @property (nonatomic,readonly,assign,getter=connInfoClientAuthRequested) BOOL connInfoClientAuthRequested; - (BOOL)connInfoClientAuthRequested; @property (nonatomic,readonly,assign,getter=connInfoConnectionEstablished) BOOL connInfoConnectionEstablished; - (BOOL)connInfoConnectionEstablished; @property (nonatomic,readonly,assign,getter=connInfoConnectionID) NSData* connInfoConnectionID; - (NSData*)connInfoConnectionID; @property (nonatomic,readonly,assign,getter=connInfoDigestAlgorithm) NSString* connInfoDigestAlgorithm; - (NSString*)connInfoDigestAlgorithm; @property (nonatomic,readonly,assign,getter=connInfoEncryptionAlgorithm) NSString* connInfoEncryptionAlgorithm; - (NSString*)connInfoEncryptionAlgorithm; @property (nonatomic,readonly,assign,getter=connInfoExportable) BOOL connInfoExportable; - (BOOL)connInfoExportable; @property (nonatomic,readonly,assign,getter=connInfoKeyExchangeAlgorithm) NSString* connInfoKeyExchangeAlgorithm; - (NSString*)connInfoKeyExchangeAlgorithm; @property (nonatomic,readonly,assign,getter=connInfoKeyExchangeKeyBits) int connInfoKeyExchangeKeyBits; - (int)connInfoKeyExchangeKeyBits; @property (nonatomic,readonly,assign,getter=connInfoNamedECCurve) NSString* connInfoNamedECCurve; - (NSString*)connInfoNamedECCurve; @property (nonatomic,readonly,assign,getter=connInfoPFSCipher) BOOL connInfoPFSCipher; - (BOOL)connInfoPFSCipher; @property (nonatomic,readonly,assign,getter=connInfoPreSharedIdentityHint) NSString* connInfoPreSharedIdentityHint; - (NSString*)connInfoPreSharedIdentityHint; @property (nonatomic,readonly,assign,getter=connInfoPublicKeyBits) int connInfoPublicKeyBits; - (int)connInfoPublicKeyBits; @property (nonatomic,readonly,assign,getter=connInfoResumedSession) BOOL connInfoResumedSession; - (BOOL)connInfoResumedSession; @property (nonatomic,readonly,assign,getter=connInfoSecureConnection) BOOL connInfoSecureConnection; - (BOOL)connInfoSecureConnection; @property (nonatomic,readonly,assign,getter=connInfoServerAuthenticated) BOOL connInfoServerAuthenticated; - (BOOL)connInfoServerAuthenticated; @property (nonatomic,readonly,assign,getter=connInfoSignatureAlgorithm) NSString* connInfoSignatureAlgorithm; - (NSString*)connInfoSignatureAlgorithm; @property (nonatomic,readonly,assign,getter=connInfoSymmetricBlockSize) int connInfoSymmetricBlockSize; - (int)connInfoSymmetricBlockSize; @property (nonatomic,readonly,assign,getter=connInfoSymmetricKeyBits) int connInfoSymmetricKeyBits; - (int)connInfoSymmetricKeyBits; @property (nonatomic,readonly,assign,getter=connInfoTotalBytesReceived) long long connInfoTotalBytesReceived; - (long long)connInfoTotalBytesReceived; @property (nonatomic,readonly,assign,getter=connInfoTotalBytesSent) long long connInfoTotalBytesSent; - (long long)connInfoTotalBytesSent; @property (nonatomic,readonly,assign,getter=connInfoValidationLog) NSString* connInfoValidationLog; - (NSString*)connInfoValidationLog; @property (nonatomic,readonly,assign,getter=connInfoVersion) NSString* connInfoVersion; - (NSString*)connInfoVersion;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
Encoding Property (SOAPClient Module)
Specifies SOAP message encoding.
Syntax
public var encoding: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=encoding,setter=setEncoding:) NSString* encoding; - (NSString*)encoding; - (void)setEncoding :(NSString*)newEncoding;
Default Value
""
Remarks
Use this property to specify the encoding to apply to the SOAP message.
ExternalCrypto Property (SOAPClient Module)
Provides access to external signing and DC parameters.
Syntax
public var externalCrypto: ExternalCrypto { get {...} }
@property (nonatomic,readwrite,assign,getter=externalCryptoAsyncDocumentID,setter=setExternalCryptoAsyncDocumentID:) NSString* externalCryptoAsyncDocumentID; - (NSString*)externalCryptoAsyncDocumentID; - (void)setExternalCryptoAsyncDocumentID :(NSString*)newExternalCryptoAsyncDocumentID; @property (nonatomic,readwrite,assign,getter=externalCryptoCustomParams,setter=setExternalCryptoCustomParams:) NSString* externalCryptoCustomParams; - (NSString*)externalCryptoCustomParams; - (void)setExternalCryptoCustomParams :(NSString*)newExternalCryptoCustomParams; @property (nonatomic,readwrite,assign,getter=externalCryptoData,setter=setExternalCryptoData:) NSString* externalCryptoData; - (NSString*)externalCryptoData; - (void)setExternalCryptoData :(NSString*)newExternalCryptoData; @property (nonatomic,readwrite,assign,getter=externalCryptoExternalHashCalculation,setter=setExternalCryptoExternalHashCalculation:) BOOL externalCryptoExternalHashCalculation; - (BOOL)externalCryptoExternalHashCalculation; - (void)setExternalCryptoExternalHashCalculation :(BOOL)newExternalCryptoExternalHashCalculation; @property (nonatomic,readwrite,assign,getter=externalCryptoHashAlgorithm,setter=setExternalCryptoHashAlgorithm:) NSString* externalCryptoHashAlgorithm; - (NSString*)externalCryptoHashAlgorithm; - (void)setExternalCryptoHashAlgorithm :(NSString*)newExternalCryptoHashAlgorithm; @property (nonatomic,readwrite,assign,getter=externalCryptoKeyID,setter=setExternalCryptoKeyID:) NSString* externalCryptoKeyID; - (NSString*)externalCryptoKeyID; - (void)setExternalCryptoKeyID :(NSString*)newExternalCryptoKeyID; @property (nonatomic,readwrite,assign,getter=externalCryptoKeySecret,setter=setExternalCryptoKeySecret:) NSString* externalCryptoKeySecret; - (NSString*)externalCryptoKeySecret; - (void)setExternalCryptoKeySecret :(NSString*)newExternalCryptoKeySecret; @property (nonatomic,readwrite,assign,getter=externalCryptoMethod,setter=setExternalCryptoMethod:) int externalCryptoMethod; - (int)externalCryptoMethod; - (void)setExternalCryptoMethod :(int)newExternalCryptoMethod; @property (nonatomic,readwrite,assign,getter=externalCryptoMode,setter=setExternalCryptoMode:) int externalCryptoMode; - (int)externalCryptoMode; - (void)setExternalCryptoMode :(int)newExternalCryptoMode; @property (nonatomic,readwrite,assign,getter=externalCryptoPublicKeyAlgorithm,setter=setExternalCryptoPublicKeyAlgorithm:) NSString* externalCryptoPublicKeyAlgorithm; - (NSString*)externalCryptoPublicKeyAlgorithm; - (void)setExternalCryptoPublicKeyAlgorithm :(NSString*)newExternalCryptoPublicKeyAlgorithm;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
FaultActor Property (SOAPClient Module)
Specifies the entity that caused the fault.
Syntax
public var faultActor: String { get {...} }
@property (nonatomic,readonly,assign,getter=faultActor) NSString* faultActor; - (NSString*)faultActor;
Default Value
""
Remarks
Use this property to get the URI associated with the actor (SOAP node) that caused the fault. In RPC-style messaging, the actor is the URI of the Web service.
This property is read-only.
FaultCode Property (SOAPClient Module)
Specifies the error code.
Syntax
public var faultCode: String { get {...} }
@property (nonatomic,readonly,assign,getter=faultCode) NSString* faultCode; - (NSString*)faultCode;
Default Value
""
Remarks
Use this property to get the standard code that provides more information about the fault. A set of code values is predefined by the SOAP specification. This set of fault code values can be extended by the application.
This property is read-only.
FaultDetail Property (SOAPClient Module)
Contains application-specific error information.
Syntax
public var faultDetail: String { get {...} }
@property (nonatomic,readonly,assign,getter=faultDetail) NSString* faultDetail; - (NSString*)faultDetail;
Default Value
""
Remarks
Use this property to get the application-specific information, such as the exception that was thrown. This element can be an XML structure or plain text.
This property is read-only.
FaultString Property (SOAPClient Module)
Specifies a human-readable description of the fault.
Syntax
public var faultString: String { get {...} }
@property (nonatomic,readonly,assign,getter=faultString) NSString* faultString; - (NSString*)faultString;
Default Value
""
Remarks
Use this property to get the human-readable description of the error that happened.
This property is read-only.
FIPSMode Property (SOAPClient Module)
Reserved.
Syntax
public var fipsMode: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode; - (BOOL)FIPSMode; - (void)setFIPSMode :(BOOL)newFIPSMode;
Default Value
False
Remarks
This property is reserved for future use.
InputBytes Property (SOAPClient Module)
Use this property to pass the input to module in the byte array form.
Syntax
public var inputBytes: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=inputBytes,setter=setInputBytes:) NSData* inputBytes; - (NSData*)inputBytes; - (void)setInputBytes :(NSData*)newInputBytes;
Remarks
Assign a byte array containing the data to be processed to this property.
InputFile Property (SOAPClient Module)
A path to the file containing the SOAP message to be sent.
Syntax
public var inputFile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile; - (NSString*)inputFile; - (void)setInputFile :(NSString*)newInputFile;
Default Value
""
Remarks
Use this property to provide a full path to the file containing the SOAP message to be sent to the server.
KeepAlivePolicy Property (SOAPClient Module)
Defines the keep-alive handling policy.
Syntax
public var keepAlivePolicy: SoapclientKeepAlivePolicies { get {...} set {...} }
public enum SoapclientKeepAlivePolicies: Int32 { case ckapStandardDefined = 0 case ckapPreferKeepAlive = 1 case ckapRelyOnServer = 2 case ckapKeepAlivesDisabled = 3 }
@property (nonatomic,readwrite,assign,getter=keepAlivePolicy,setter=setKeepAlivePolicy:) int keepAlivePolicy; - (int)keepAlivePolicy; - (void)setKeepAlivePolicy :(int)newKeepAlivePolicy;
Default Value
0
Remarks
Use this property to tune-up the keep-alive mechanism as per the needs of your application.
ckapStandardDefined | 0 | Follow the standard |
ckapPreferKeepAlive | 1 | Always request a keep-alive connection |
ckapRelyOnServer | 2 | Not include the "Connection" header, allowing the server to choose the keep-alive mode |
ckapKeepAlivesDisabled | 3 | Disable keep-alives by including the "Connection: Close" header |
KnownCertificates Property (SOAPClient Module)
Additional certificates for chain validation.
Syntax
public var knownCertificates: Array<Certificate> { get {...} }
@property (nonatomic,readwrite,assign,getter=knownCertCount,setter=setKnownCertCount:) int knownCertCount; - (int)knownCertCount; - (void)setKnownCertCount :(int)newKnownCertCount; - (NSData*)knownCertBytes:(int)knownCertIndex; - (long long)knownCertHandle:(int)knownCertIndex; - (void)setKnownCertHandle:(int)knownCertIndex :(long long)newKnownCertHandle;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
KnownCRLs Property (SOAPClient Module)
Additional CRLs for chain validation.
Syntax
public var knownCRLs: Array<CRL> { get {...} }
@property (nonatomic,readwrite,assign,getter=knownCRLCount,setter=setKnownCRLCount:) int knownCRLCount; - (int)knownCRLCount; - (void)setKnownCRLCount :(int)newKnownCRLCount; - (NSData*)knownCRLBytes:(int)knownCRLIndex; - (long long)knownCRLHandle:(int)knownCRLIndex; - (void)setKnownCRLHandle:(int)knownCRLIndex :(long long)newKnownCRLHandle;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
KnownOCSPs Property (SOAPClient Module)
Additional OCSP responses for chain validation.
Syntax
public var knownOCSPs: Array<OCSPResponse> { get {...} }
@property (nonatomic,readwrite,assign,getter=knownOCSPCount,setter=setKnownOCSPCount:) int knownOCSPCount; - (int)knownOCSPCount; - (void)setKnownOCSPCount :(int)newKnownOCSPCount; - (NSData*)knownOCSPBytes:(int)knownOCSPIndex; - (long long)knownOCSPHandle:(int)knownOCSPIndex; - (void)setKnownOCSPHandle:(int)knownOCSPIndex :(long long)newKnownOCSPHandle;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
MimeType Property (SOAPClient Module)
Specifies the SOAP message MIME type.
Syntax
public var mimeType: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=mimeType,setter=setMimeType:) NSString* mimeType; - (NSString*)mimeType; - (void)setMimeType :(NSString*)newMimeType;
Default Value
""
Remarks
Use this property to specify the MIME type attribute of the SOAP message.
OperationName Property (SOAPClient Module)
Specifies the SOAP operation name.
Syntax
public var operationName: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=operationName,setter=setOperationName:) NSString* operationName; - (NSString*)operationName; - (void)setOperationName :(NSString*)newOperationName;
Default Value
""
Remarks
Use this property to specify the name of the operation that the SOAP message corresponds to.
Set this property if InputFile, InputBytes or InputStream only contains the parameters of the operation in XML format. In this case, a new SOAP message will be created and sent to the service.
If one of the Input properties contains a valid SOAP message or an operation request in XML format, this property can be left empty.
OperationNamespaceURI Property (SOAPClient Module)
Specifies the SOAP message operation namespace URI.
Syntax
public var operationNamespaceURI: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=operationNamespaceURI,setter=setOperationNamespaceURI:) NSString* operationNamespaceURI; - (NSString*)operationNamespaceURI; - (void)setOperationNamespaceURI :(NSString*)newOperationNamespaceURI;
Default Value
""
Remarks
This property specifies the operation namespace URI of the SOAP message.
OperationResponseName Property (SOAPClient Module)
Specifies the operation name of the response message.
Syntax
public var operationResponseName: String { get {...} }
@property (nonatomic,readonly,assign,getter=operationResponseName) NSString* operationResponseName; - (NSString*)operationResponseName;
Default Value
""
Remarks
Use this property to get the operation name from the response message received from the SOAP service.
This property is read-only.
OperationResponseNamespaceURI Property (SOAPClient Module)
Specifies the response SOAP message operation namespace URI.
Syntax
public var operationResponseNamespaceURI: String { get {...} }
@property (nonatomic,readonly,assign,getter=operationResponseNamespaceURI) NSString* operationResponseNamespaceURI; - (NSString*)operationResponseNamespaceURI;
Default Value
""
Remarks
Use this property to get the operation namespace URI from the response SOAP message.
This property is read-only.
OperationResponseTextContent Property (SOAPClient Module)
Returns the text content of the response message.
Syntax
public var operationResponseTextContent: String { get {...} }
@property (nonatomic,readonly,assign,getter=operationResponseTextContent) NSString* operationResponseTextContent; - (NSString*)operationResponseTextContent;
Default Value
""
Remarks
Use this property to get the text content of the operation of the response SOAP message.
This property is read-only.
OperationResponseXML Property (SOAPClient Module)
Returns the XML content of the response SOAP message.
Syntax
public var operationResponseXML: String { get {...} }
@property (nonatomic,readonly,assign,getter=operationResponseXML) NSString* operationResponseXML; - (NSString*)operationResponseXML;
Default Value
""
Remarks
Use this property to get the XML content of the response message.
This property is read-only.
OutputAttachmentBytes Property (SOAPClient Module)
Use this property to read the attachment received from the service.
Syntax
public var outputAttachmentBytes: Data { get {...} }
@property (nonatomic,readonly,assign,getter=outputAttachmentBytes) NSData* outputAttachmentBytes; - (NSData*)outputAttachmentBytes;
Remarks
Check the content of this property after the operation has completed to read the received attachment data.
This property will only be set if OutputAttachmentFile and OutputAttachmentStream properties had not been assigned.
This property is read-only.
OutputAttachmentFile Property (SOAPClient Module)
A path to a file where to save the attachment data.
Syntax
public var outputAttachmentFile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=outputAttachmentFile,setter=setOutputAttachmentFile:) NSString* outputAttachmentFile; - (NSString*)outputAttachmentFile; - (void)setOutputAttachmentFile :(NSString*)newOutputAttachmentFile;
Default Value
""
Remarks
Provide a full path to the file where the attachment should be saved.
OutputBytes Property (SOAPClient Module)
Use this property to read the output the module object has produced.
Syntax
public var outputBytes: Data { get {...} }
@property (nonatomic,readonly,assign,getter=outputBytes) NSData* outputBytes; - (NSData*)outputBytes;
Remarks
Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.
This property is read-only.
OutputFile Property (SOAPClient Module)
A file where the response will be saved.
Syntax
public var outputFile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile; - (NSString*)outputFile; - (void)setOutputFile :(NSString*)newOutputFile;
Default Value
""
Remarks
Provide a full path to the file where the service response should be saved.
Proxy Property (SOAPClient Module)
The proxy server settings.
Syntax
public var proxy: ProxySettings { get {...} }
@property (nonatomic,readwrite,assign,getter=proxyAddress,setter=setProxyAddress:) NSString* proxyAddress; - (NSString*)proxyAddress; - (void)setProxyAddress :(NSString*)newProxyAddress; @property (nonatomic,readwrite,assign,getter=proxyAuthentication,setter=setProxyAuthentication:) int proxyAuthentication; - (int)proxyAuthentication; - (void)setProxyAuthentication :(int)newProxyAuthentication; @property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword; - (NSString*)proxyPassword; - (void)setProxyPassword :(NSString*)newProxyPassword; @property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort; - (int)proxyPort; - (void)setProxyPort :(int)newProxyPort; @property (nonatomic,readwrite,assign,getter=proxyProxyType,setter=setProxyProxyType:) int proxyProxyType; - (int)proxyProxyType; - (void)setProxyProxyType :(int)newProxyProxyType; @property (nonatomic,readwrite,assign,getter=proxyRequestHeaders,setter=setProxyRequestHeaders:) NSString* proxyRequestHeaders; - (NSString*)proxyRequestHeaders; - (void)setProxyRequestHeaders :(NSString*)newProxyRequestHeaders; @property (nonatomic,readwrite,assign,getter=proxyResponseBody,setter=setProxyResponseBody:) NSString* proxyResponseBody; - (NSString*)proxyResponseBody; - (void)setProxyResponseBody :(NSString*)newProxyResponseBody; @property (nonatomic,readwrite,assign,getter=proxyResponseHeaders,setter=setProxyResponseHeaders:) NSString* proxyResponseHeaders; - (NSString*)proxyResponseHeaders; - (void)setProxyResponseHeaders :(NSString*)newProxyResponseHeaders; @property (nonatomic,readwrite,assign,getter=proxyUseIPv6,setter=setProxyUseIPv6:) BOOL proxyUseIPv6; - (BOOL)proxyUseIPv6; - (void)setProxyUseIPv6 :(BOOL)newProxyUseIPv6; @property (nonatomic,readwrite,assign,getter=proxyUseProxy,setter=setProxyUseProxy:) BOOL proxyUseProxy; - (BOOL)proxyUseProxy; - (void)setProxyUseProxy :(BOOL)newProxyUseProxy; @property (nonatomic,readwrite,assign,getter=proxyUsername,setter=setProxyUsername:) NSString* proxyUsername; - (NSString*)proxyUsername; - (void)setProxyUsername :(NSString*)newProxyUsername;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
ReasonPhrase Property (SOAPClient Module)
Contains the Reason Phrase element of the server's response.
Syntax
public var reasonPhrase: String { get {...} }
@property (nonatomic,readonly,assign,getter=reasonPhrase) NSString* reasonPhrase; - (NSString*)reasonPhrase;
Default Value
""
Remarks
Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK).
This property is read-only.
RequestHeaders Property (SOAPClient Module)
Contains HTTP request headers.
Syntax
public var requestHeaders: Array<StringNameValuePair> { get {...} }
@property (nonatomic,readwrite,assign,getter=reqHeaderCount,setter=setReqHeaderCount:) int reqHeaderCount; - (int)reqHeaderCount; - (void)setReqHeaderCount :(int)newReqHeaderCount; - (NSString*)reqHeaderCategory:(int)reqHeaderIndex; - (void)setReqHeaderCategory:(int)reqHeaderIndex :(NSString*)newReqHeaderCategory; - (int)reqHeaderFormat:(int)reqHeaderIndex; - (void)setReqHeaderFormat:(int)reqHeaderIndex :(int)newReqHeaderFormat; - (NSString*)reqHeaderName:(int)reqHeaderIndex; - (void)setReqHeaderName:(int)reqHeaderIndex :(NSString*)newReqHeaderName; - (NSString*)reqHeaderValue:(int)reqHeaderIndex; - (void)setReqHeaderValue:(int)reqHeaderIndex :(NSString*)newReqHeaderValue;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
RequestParameters Property (SOAPClient Module)
Provides access to common HTTP request properties.
Syntax
public var requestParameters: HTTPRequestParameters { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=reqParamsAccept,setter=setReqParamsAccept:) NSString* reqParamsAccept; - (NSString*)reqParamsAccept; - (void)setReqParamsAccept :(NSString*)newReqParamsAccept; @property (nonatomic,readwrite,assign,getter=reqParamsAcceptCharset,setter=setReqParamsAcceptCharset:) NSString* reqParamsAcceptCharset; - (NSString*)reqParamsAcceptCharset; - (void)setReqParamsAcceptCharset :(NSString*)newReqParamsAcceptCharset; @property (nonatomic,readwrite,assign,getter=reqParamsAcceptLanguage,setter=setReqParamsAcceptLanguage:) NSString* reqParamsAcceptLanguage; - (NSString*)reqParamsAcceptLanguage; - (void)setReqParamsAcceptLanguage :(NSString*)newReqParamsAcceptLanguage; @property (nonatomic,readwrite,assign,getter=reqParamsAcceptRangeEnd,setter=setReqParamsAcceptRangeEnd:) long long reqParamsAcceptRangeEnd; - (long long)reqParamsAcceptRangeEnd; - (void)setReqParamsAcceptRangeEnd :(long long)newReqParamsAcceptRangeEnd; @property (nonatomic,readwrite,assign,getter=reqParamsAcceptRangeStart,setter=setReqParamsAcceptRangeStart:) long long reqParamsAcceptRangeStart; - (long long)reqParamsAcceptRangeStart; - (void)setReqParamsAcceptRangeStart :(long long)newReqParamsAcceptRangeStart; @property (nonatomic,readwrite,assign,getter=reqParamsAuthorization,setter=setReqParamsAuthorization:) NSString* reqParamsAuthorization; - (NSString*)reqParamsAuthorization; - (void)setReqParamsAuthorization :(NSString*)newReqParamsAuthorization; @property (nonatomic,readwrite,assign,getter=reqParamsConnection,setter=setReqParamsConnection:) NSString* reqParamsConnection; - (NSString*)reqParamsConnection; - (void)setReqParamsConnection :(NSString*)newReqParamsConnection; @property (nonatomic,readwrite,assign,getter=reqParamsContentLength,setter=setReqParamsContentLength:) long long reqParamsContentLength; - (long long)reqParamsContentLength; - (void)setReqParamsContentLength :(long long)newReqParamsContentLength; @property (nonatomic,readwrite,assign,getter=reqParamsContentRangeEnd,setter=setReqParamsContentRangeEnd:) long long reqParamsContentRangeEnd; - (long long)reqParamsContentRangeEnd; - (void)setReqParamsContentRangeEnd :(long long)newReqParamsContentRangeEnd; @property (nonatomic,readwrite,assign,getter=reqParamsContentRangeFullSize,setter=setReqParamsContentRangeFullSize:) long long reqParamsContentRangeFullSize; - (long long)reqParamsContentRangeFullSize; - (void)setReqParamsContentRangeFullSize :(long long)newReqParamsContentRangeFullSize; @property (nonatomic,readwrite,assign,getter=reqParamsContentRangeStart,setter=setReqParamsContentRangeStart:) long long reqParamsContentRangeStart; - (long long)reqParamsContentRangeStart; - (void)setReqParamsContentRangeStart :(long long)newReqParamsContentRangeStart; @property (nonatomic,readwrite,assign,getter=reqParamsContentType,setter=setReqParamsContentType:) NSString* reqParamsContentType; - (NSString*)reqParamsContentType; - (void)setReqParamsContentType :(NSString*)newReqParamsContentType; @property (nonatomic,readwrite,assign,getter=reqParamsCookie,setter=setReqParamsCookie:) NSString* reqParamsCookie; - (NSString*)reqParamsCookie; - (void)setReqParamsCookie :(NSString*)newReqParamsCookie; @property (nonatomic,readwrite,assign,getter=reqParamsCustomHeaders,setter=setReqParamsCustomHeaders:) NSString* reqParamsCustomHeaders; - (NSString*)reqParamsCustomHeaders; - (void)setReqParamsCustomHeaders :(NSString*)newReqParamsCustomHeaders; @property (nonatomic,readwrite,assign,getter=reqParamsDate,setter=setReqParamsDate:) NSString* reqParamsDate; - (NSString*)reqParamsDate; - (void)setReqParamsDate :(NSString*)newReqParamsDate; @property (nonatomic,readwrite,assign,getter=reqParamsFrom,setter=setReqParamsFrom:) NSString* reqParamsFrom; - (NSString*)reqParamsFrom; - (void)setReqParamsFrom :(NSString*)newReqParamsFrom; @property (nonatomic,readwrite,assign,getter=reqParamsHost,setter=setReqParamsHost:) NSString* reqParamsHost; - (NSString*)reqParamsHost; - (void)setReqParamsHost :(NSString*)newReqParamsHost; @property (nonatomic,readwrite,assign,getter=reqParamsHTTPVersion,setter=setReqParamsHTTPVersion:) int reqParamsHTTPVersion; - (int)reqParamsHTTPVersion; - (void)setReqParamsHTTPVersion :(int)newReqParamsHTTPVersion; @property (nonatomic,readwrite,assign,getter=reqParamsIfMatch,setter=setReqParamsIfMatch:) NSString* reqParamsIfMatch; - (NSString*)reqParamsIfMatch; - (void)setReqParamsIfMatch :(NSString*)newReqParamsIfMatch; @property (nonatomic,readwrite,assign,getter=reqParamsIfModifiedSince,setter=setReqParamsIfModifiedSince:) NSString* reqParamsIfModifiedSince; - (NSString*)reqParamsIfModifiedSince; - (void)setReqParamsIfModifiedSince :(NSString*)newReqParamsIfModifiedSince; @property (nonatomic,readwrite,assign,getter=reqParamsIfNoneMatch,setter=setReqParamsIfNoneMatch:) NSString* reqParamsIfNoneMatch; - (NSString*)reqParamsIfNoneMatch; - (void)setReqParamsIfNoneMatch :(NSString*)newReqParamsIfNoneMatch; @property (nonatomic,readwrite,assign,getter=reqParamsIfUnmodifiedSince,setter=setReqParamsIfUnmodifiedSince:) NSString* reqParamsIfUnmodifiedSince; - (NSString*)reqParamsIfUnmodifiedSince; - (void)setReqParamsIfUnmodifiedSince :(NSString*)newReqParamsIfUnmodifiedSince; @property (nonatomic,readwrite,assign,getter=reqParamsPassword,setter=setReqParamsPassword:) NSString* reqParamsPassword; - (NSString*)reqParamsPassword; - (void)setReqParamsPassword :(NSString*)newReqParamsPassword; @property (nonatomic,readwrite,assign,getter=reqParamsReferer,setter=setReqParamsReferer:) NSString* reqParamsReferer; - (NSString*)reqParamsReferer; - (void)setReqParamsReferer :(NSString*)newReqParamsReferer; @property (nonatomic,readwrite,assign,getter=reqParamsUserAgent,setter=setReqParamsUserAgent:) NSString* reqParamsUserAgent; - (NSString*)reqParamsUserAgent; - (void)setReqParamsUserAgent :(NSString*)newReqParamsUserAgent; @property (nonatomic,readwrite,assign,getter=reqParamsUsername,setter=setReqParamsUsername:) NSString* reqParamsUsername; - (NSString*)reqParamsUsername; - (void)setReqParamsUsername :(NSString*)newReqParamsUsername;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
ResponseHeaders Property (SOAPClient Module)
Contains the HTTP server's response headers.
Syntax
public var responseHeaders: Array<StringNameValuePair> { get {...} }
@property (nonatomic,readonly,assign,getter=respHeaderCount) int respHeaderCount; - (int)respHeaderCount; - (NSString*)respHeaderCategory:(int)respHeaderIndex; - (int)respHeaderFormat:(int)respHeaderIndex; - (NSString*)respHeaderName:(int)respHeaderIndex; - (NSString*)respHeaderValue:(int)respHeaderIndex;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
ResponseParameters Property (SOAPClient Module)
Contains the HTTP server's response parameters.
Syntax
public var responseParameters: HTTPResponseParameters { get {...} }
@property (nonatomic,readonly,assign,getter=respParamsContentLength) long long respParamsContentLength; - (long long)respParamsContentLength; @property (nonatomic,readonly,assign,getter=respParamsDate) NSString* respParamsDate; - (NSString*)respParamsDate; @property (nonatomic,readonly,assign,getter=respParamsReasonPhrase) NSString* respParamsReasonPhrase; - (NSString*)respParamsReasonPhrase; @property (nonatomic,readonly,assign,getter=respParamsStatusCode) int respParamsStatusCode; - (int)respParamsStatusCode;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
ServerChain Property (SOAPClient Module)
The TLS server's certificate chain.
Syntax
public var serverChain: Array<Certificate> { get {...} }
@property (nonatomic,readonly,assign,getter=serverCertCount) int serverCertCount; - (int)serverCertCount; - (NSData*)serverCertBytes:(int)serverCertIndex; - (NSData*)serverCertCAKeyID:(int)serverCertIndex; - (NSData*)serverCertFingerprint:(int)serverCertIndex; - (long long)serverCertHandle:(int)serverCertIndex; - (NSString*)serverCertIssuer:(int)serverCertIndex; - (NSString*)serverCertIssuerRDN:(int)serverCertIndex; - (NSString*)serverCertKeyAlgorithm:(int)serverCertIndex; - (int)serverCertKeyBits:(int)serverCertIndex; - (NSData*)serverCertKeyFingerprint:(int)serverCertIndex; - (int)serverCertKeyUsage:(int)serverCertIndex; - (NSData*)serverCertPublicKeyBytes:(int)serverCertIndex; - (BOOL)serverCertSelfSigned:(int)serverCertIndex; - (NSData*)serverCertSerialNumber:(int)serverCertIndex; - (NSString*)serverCertSigAlgorithm:(int)serverCertIndex; - (NSString*)serverCertSubject:(int)serverCertIndex; - (NSData*)serverCertSubjectKeyID:(int)serverCertIndex; - (NSString*)serverCertSubjectRDN:(int)serverCertIndex; - (NSString*)serverCertValidFrom:(int)serverCertIndex; - (NSString*)serverCertValidTo:(int)serverCertIndex;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
SOAPAction Property (SOAPClient Module)
Specifies the SOAP action.
Syntax
public var soapAction: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SOAPAction,setter=setSOAPAction:) NSString* SOAPAction; - (NSString*)SOAPAction; - (void)setSOAPAction :(NSString*)newSOAPAction;
Default Value
""
Remarks
Use this property to specify the value for the SOAPAction/action HTTP request header field. This field is normally used to indicate the intent of the SOAP request.
SOAPResponseType Property (SOAPClient Module)
The type of the response.
Syntax
public var soapResponseType: SoapclientSOAPResponseTypes { get {...} }
public enum SoapclientSOAPResponseTypes: Int32 { case srtUnknown = 0 case srtBinary = 1 case srtXMLDocument = 2 case srtSOAPMessage = 3 }
@property (nonatomic,readonly,assign,getter=SOAPResponseType) int SOAPResponseType; - (int)SOAPResponseType;
Default Value
0
Remarks
Use this property to learn about the type (format) of the response provided by the SOAP service.
srtUnknown | 0 | It was not possible to identify the response type. Either connection error has occurred or the service returned an unexpected HTTP status code. |
srtBinary | 1 | The SOAP service has returned binary data. |
srtXMLDocument | 2 | The SOAP service has returned an XML document. |
srtSOAPMessage | 3 | The SOAP service has returned a SOAP message. |
This property is read-only.
SOAPVersion Property (SOAPClient Module)
Specifies SOAP version.
Syntax
public var soapVersion: SoapclientSOAPVersions { get {...} set {...} }
public enum SoapclientSOAPVersions: Int32 { case spvAuto = 0 case spv11 = 1 case spv12 = 2 }
@property (nonatomic,readwrite,assign,getter=SOAPVersion,setter=setSOAPVersion:) int SOAPVersion; - (int)SOAPVersion; - (void)setSOAPVersion :(int)newSOAPVersion;
Default Value
0
Remarks
This property specifies the version of the SOAP protocol. This SOAP version will be used to create a SOAP message (if needed) and to communicate with the service.
spvAuto | 0 | The SOAP version is detected from the SOAP message provided. If the input does not consitute a SOAP message, version 1.2 will be used. |
spv11 | 1 | SOAP version 1.1 |
spv12 | 2 | SOAP version 1.2 |
SocketSettings Property (SOAPClient Module)
Manages network connection settings.
Syntax
public var socketSettings: SocketSettings { get {...} }
@property (nonatomic,readwrite,assign,getter=socketDNSMode,setter=setSocketDNSMode:) int socketDNSMode; - (int)socketDNSMode; - (void)setSocketDNSMode :(int)newSocketDNSMode; @property (nonatomic,readwrite,assign,getter=socketDNSPort,setter=setSocketDNSPort:) int socketDNSPort; - (int)socketDNSPort; - (void)setSocketDNSPort :(int)newSocketDNSPort; @property (nonatomic,readwrite,assign,getter=socketDNSQueryTimeout,setter=setSocketDNSQueryTimeout:) int socketDNSQueryTimeout; - (int)socketDNSQueryTimeout; - (void)setSocketDNSQueryTimeout :(int)newSocketDNSQueryTimeout; @property (nonatomic,readwrite,assign,getter=socketDNSServers,setter=setSocketDNSServers:) NSString* socketDNSServers; - (NSString*)socketDNSServers; - (void)setSocketDNSServers :(NSString*)newSocketDNSServers; @property (nonatomic,readwrite,assign,getter=socketDNSTotalTimeout,setter=setSocketDNSTotalTimeout:) int socketDNSTotalTimeout; - (int)socketDNSTotalTimeout; - (void)setSocketDNSTotalTimeout :(int)newSocketDNSTotalTimeout; @property (nonatomic,readwrite,assign,getter=socketIncomingSpeedLimit,setter=setSocketIncomingSpeedLimit:) int socketIncomingSpeedLimit; - (int)socketIncomingSpeedLimit; - (void)setSocketIncomingSpeedLimit :(int)newSocketIncomingSpeedLimit; @property (nonatomic,readwrite,assign,getter=socketLocalAddress,setter=setSocketLocalAddress:) NSString* socketLocalAddress; - (NSString*)socketLocalAddress; - (void)setSocketLocalAddress :(NSString*)newSocketLocalAddress; @property (nonatomic,readwrite,assign,getter=socketLocalPort,setter=setSocketLocalPort:) int socketLocalPort; - (int)socketLocalPort; - (void)setSocketLocalPort :(int)newSocketLocalPort; @property (nonatomic,readwrite,assign,getter=socketOutgoingSpeedLimit,setter=setSocketOutgoingSpeedLimit:) int socketOutgoingSpeedLimit; - (int)socketOutgoingSpeedLimit; - (void)setSocketOutgoingSpeedLimit :(int)newSocketOutgoingSpeedLimit; @property (nonatomic,readwrite,assign,getter=socketTimeout,setter=setSocketTimeout:) int socketTimeout; - (int)socketTimeout; - (void)setSocketTimeout :(int)newSocketTimeout; @property (nonatomic,readwrite,assign,getter=socketUseIPv6,setter=setSocketUseIPv6:) BOOL socketUseIPv6; - (BOOL)socketUseIPv6; - (void)setSocketUseIPv6 :(BOOL)newSocketUseIPv6;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
StatusCode Property (SOAPClient Module)
Contains the Status Code element of the server's response.
Syntax
public var statusCode: Int32 { get {...} }
@property (nonatomic,readonly,assign,getter=statusCode) int statusCode; - (int)statusCode;
Default Value
0
Remarks
Use this property to access the status code supplied by the server in its response (such as 200 in HTTP 200 OK).
This property is read-only.
TLSSettings Property (SOAPClient Module)
Manages TLS layer settings.
Syntax
public var tlsSettings: TLSSettings { get {...} }
@property (nonatomic,readwrite,assign,getter=TLSAutoValidateCertificates,setter=setTLSAutoValidateCertificates:) BOOL TLSAutoValidateCertificates; - (BOOL)TLSAutoValidateCertificates; - (void)setTLSAutoValidateCertificates :(BOOL)newTLSAutoValidateCertificates; @property (nonatomic,readwrite,assign,getter=TLSBaseConfiguration,setter=setTLSBaseConfiguration:) int TLSBaseConfiguration; - (int)TLSBaseConfiguration; - (void)setTLSBaseConfiguration :(int)newTLSBaseConfiguration; @property (nonatomic,readwrite,assign,getter=TLSCiphersuites,setter=setTLSCiphersuites:) NSString* TLSCiphersuites; - (NSString*)TLSCiphersuites; - (void)setTLSCiphersuites :(NSString*)newTLSCiphersuites; @property (nonatomic,readwrite,assign,getter=TLSECCurves,setter=setTLSECCurves:) NSString* TLSECCurves; - (NSString*)TLSECCurves; - (void)setTLSECCurves :(NSString*)newTLSECCurves; @property (nonatomic,readwrite,assign,getter=TLSExtensions,setter=setTLSExtensions:) NSString* TLSExtensions; - (NSString*)TLSExtensions; - (void)setTLSExtensions :(NSString*)newTLSExtensions; @property (nonatomic,readwrite,assign,getter=TLSForceResumeIfDestinationChanges,setter=setTLSForceResumeIfDestinationChanges:) BOOL TLSForceResumeIfDestinationChanges; - (BOOL)TLSForceResumeIfDestinationChanges; - (void)setTLSForceResumeIfDestinationChanges :(BOOL)newTLSForceResumeIfDestinationChanges; @property (nonatomic,readwrite,assign,getter=TLSPreSharedIdentity,setter=setTLSPreSharedIdentity:) NSString* TLSPreSharedIdentity; - (NSString*)TLSPreSharedIdentity; - (void)setTLSPreSharedIdentity :(NSString*)newTLSPreSharedIdentity; @property (nonatomic,readwrite,assign,getter=TLSPreSharedKey,setter=setTLSPreSharedKey:) NSString* TLSPreSharedKey; - (NSString*)TLSPreSharedKey; - (void)setTLSPreSharedKey :(NSString*)newTLSPreSharedKey; @property (nonatomic,readwrite,assign,getter=TLSPreSharedKeyCiphersuite,setter=setTLSPreSharedKeyCiphersuite:) NSString* TLSPreSharedKeyCiphersuite; - (NSString*)TLSPreSharedKeyCiphersuite; - (void)setTLSPreSharedKeyCiphersuite :(NSString*)newTLSPreSharedKeyCiphersuite; @property (nonatomic,readwrite,assign,getter=TLSRenegotiationAttackPreventionMode,setter=setTLSRenegotiationAttackPreventionMode:) int TLSRenegotiationAttackPreventionMode; - (int)TLSRenegotiationAttackPreventionMode; - (void)setTLSRenegotiationAttackPreventionMode :(int)newTLSRenegotiationAttackPreventionMode; @property (nonatomic,readwrite,assign,getter=TLSRevocationCheck,setter=setTLSRevocationCheck:) int TLSRevocationCheck; - (int)TLSRevocationCheck; - (void)setTLSRevocationCheck :(int)newTLSRevocationCheck; @property (nonatomic,readwrite,assign,getter=TLSSSLOptions,setter=setTLSSSLOptions:) int TLSSSLOptions; - (int)TLSSSLOptions; - (void)setTLSSSLOptions :(int)newTLSSSLOptions; @property (nonatomic,readwrite,assign,getter=TLSTLSMode,setter=setTLSTLSMode:) int TLSTLSMode; - (int)TLSTLSMode; - (void)setTLSTLSMode :(int)newTLSTLSMode; @property (nonatomic,readwrite,assign,getter=TLSUseExtendedMasterSecret,setter=setTLSUseExtendedMasterSecret:) BOOL TLSUseExtendedMasterSecret; - (BOOL)TLSUseExtendedMasterSecret; - (void)setTLSUseExtendedMasterSecret :(BOOL)newTLSUseExtendedMasterSecret; @property (nonatomic,readwrite,assign,getter=TLSUseSessionResumption,setter=setTLSUseSessionResumption:) BOOL TLSUseSessionResumption; - (BOOL)TLSUseSessionResumption; - (void)setTLSUseSessionResumption :(BOOL)newTLSUseSessionResumption; @property (nonatomic,readwrite,assign,getter=TLSVersions,setter=setTLSVersions:) int TLSVersions; - (int)TLSVersions; - (void)setTLSVersions :(int)newTLSVersions;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
TrustedCertificates Property (SOAPClient Module)
A list of trusted certificates for chain validation.
Syntax
public var trustedCertificates: Array<Certificate> { get {...} }
@property (nonatomic,readwrite,assign,getter=trustedCertCount,setter=setTrustedCertCount:) int trustedCertCount; - (int)trustedCertCount; - (void)setTrustedCertCount :(int)newTrustedCertCount; - (NSData*)trustedCertBytes:(int)trustedCertIndex; - (long long)trustedCertHandle:(int)trustedCertIndex; - (void)setTrustedCertHandle:(int)trustedCertIndex :(long long)newTrustedCertHandle;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
UseDigestAuth Property (SOAPClient Module)
Enables or disables the HTTP Digest authentication.
Syntax
public var useDigestAuth: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=useDigestAuth,setter=setUseDigestAuth:) BOOL useDigestAuth; - (BOOL)useDigestAuth; - (void)setUseDigestAuth :(BOOL)newUseDigestAuth;
Default Value
False
Remarks
Digest authentication is more advanced than the Basic scheme, as it does not send the username and password in plain text and is immune to replay attacks.
Digest authentication is standardized in RFC 2617.
UseKerberosAuth Property (SOAPClient Module)
Enables Kerberos authentication mechanism.
Syntax
public var useKerberosAuth: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=useKerberosAuth,setter=setUseKerberosAuth:) BOOL useKerberosAuth; - (BOOL)useKerberosAuth; - (void)setUseKerberosAuth :(BOOL)newUseKerberosAuth;
Default Value
False
Remarks
Set this property to true to enable Kerberos (Negotiate) authentication mechanism.
UseNTLMAuth Property (SOAPClient Module)
Enables or disables NTLM authentication.
Syntax
public var useNTLMAuth: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=useNTLMAuth,setter=setUseNTLMAuth:) BOOL useNTLMAuth; - (BOOL)useNTLMAuth; - (void)setUseNTLMAuth :(BOOL)newUseNTLMAuth;
Default Value
False
Remarks
NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.
Config Method (SOAPClient Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DoAction Method (SOAPClient Module)
Performs an additional action.
Syntax
- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
SendMessage Method (SOAPClient Module)
Sends a SOAP message to the server.
Syntax
Remarks
The SendMessage() does the following:
- Loads the data from InputBytes, InputFile or InputStream properties.
If the data contains a SOAP message, no pre-send processing is performed.
If the data contains XML content, then basing on OperationName, OperationNamespaceURI and SOAPVersion properties new SOAP envelope will be created. The XML content will be used either as either the operation itself or the operation parameters, depending on OperationName value.
- Sends the SOAP message to the service Url.
Use SOAPAction, Encoding and MimeType properties to set SOAP HTTP request parameters.
- If the request is successful, the received content is saved in either OutputBytes, OutputFile or OutputStream.
If the response contains attachment(s) then BeforeReceiveAttachment event will be fired for each attachment, following which the attachment will be saved to either OutputAttachmentBytes, OutputAttachmentFile or OutputAttachmentStream.
Use SOAPResponseType to get the type of the received content. If the received content is recognized as a SOAP message, then OperationResponseName, OperationResponseNamespaceURI OperationResponseTextContent and OperationResponseXML properties will be populated.
- If an error happens during the request, an exception is thrown.
Use SOAPResponseType to identify the received content. The type set to Unknown means that either a connection error has occurred or the service has returned an unexpected HTTP status code. In this case, the error details are published in StatusCode and ReasonPhrase properties.
If SOAPResponseType set to a different value indicates that the service has returned HTTP status code in the range 500 - 599, indicating a service error.
If the type of received content is SOAP message, then FaultActor, FaultCode, FaultDetail and FaultString properties will contain error details returned by the service.
If the request has succeeded then the received content will also be available in either OutputBytes, OutputFile or OutputStream properties.
SendMessageWithAttachments Method (SOAPClient Module)
Sends a SOAP message with attachment(s) to the server.
Syntax
- (void)sendMessageWithAttachments:(NSString*)url :(NSString*)primaryMessageId;
Remarks
This method follows the general pattern used by SendMessage method. It also lets you pass a selection of attachments to the service.
Assign the attachment content to AttachmentBytes, AttachmentFile, or AttachmentStream property. Subscribe to BeforeSendAttachment to pass more than one attachment.
BeforeReceiveAttachment Event (SOAPClient Module)
Marks the start of receiving an attachment.
Syntax
func onBeforeReceiveAttachment()
- (void)onBeforeReceiveAttachment;
Remarks
This event fires for every new attachment being received from the service.
Tune up OutputAttachmentBytes, OutputAttachmentFile or OutputAttachmentStream properties inside the event handler to indicate where the attachment content should be saved.
BeforeSendAttachment Event (SOAPClient Module)
Marks the start of sending an attachment.
Syntax
func onBeforeSendAttachment(lastAttachment: inout Bool)
- (void)onBeforeSendAttachment:(int*)lastAttachment;
Remarks
Use either AttachmentBytes, AttachmentFile or AttachmentStream properties to pass attachment to the class.
Set LastAttachment parameter to False to indicate that you have more than one attachment to pass.
Cookie Event (SOAPClient Module)
Fired to report a received cookie.
Syntax
func onCookie(cookieText: String)
- (void)onCookie:(NSString*)cookieText;
Remarks
The CookieText parameter contains the text of the cookie.
DocumentBegin Event (SOAPClient Module)
Marks the start of the incoming HTML document or file.
Syntax
func onDocumentBegin()
- (void)onDocumentBegin;
Remarks
This event is followed by one or more Progress calls. When the document has been received in full, the DocumentEnd event is fired.
DocumentEnd Event (SOAPClient Module)
Marks the successful receipt of the incoming HTML document or file.
Syntax
func onDocumentEnd()
- (void)onDocumentEnd;
Remarks
This event fires when the document has been received in full.
Error Event (SOAPClient Module)
Information about errors during data delivery.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.
ExternalSign Event (SOAPClient Module)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
func onExternalSign(operationId: String, hashAlgorithm: String, pars: String, data: String, signedData: inout String)
- (void)onExternalSign:(NSString*)operationId :(NSString*)hashAlgorithm :(NSString*)pars :(NSString*)data :(NSString**)signedData;
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
HeadersPrepared Event (SOAPClient Module)
Fires when the request headers have been formed and are about to be sent to the server.
Syntax
func onHeadersPrepared()
- (void)onHeadersPrepared;
Remarks
The prepared headers are available in RequestHeaders property. This event provides you the last chance to review/alter them.
HeadersReceived Event (SOAPClient Module)
Fires when the HTTP response headers have just been received from the server.
Syntax
func onHeadersReceived()
- (void)onHeadersReceived;
Remarks
The received headers are available via the ResponseHeaders property.
Notification Event (SOAPClient Module)
This event notifies the application about an underlying control flow event.
Syntax
- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
Progress Event (SOAPClient Module)
Fires periodically during the data transfer.
Syntax
func onProgress(total: Int64, current: Int64, cancel: inout Bool)
- (void)onProgress:(long long)total :(long long)current :(int*)cancel;
Remarks
Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.
Redirection Event (SOAPClient Module)
Fires when the server suggests a redirect.
Syntax
func onRedirection(oldURL: String, newURL: inout String, allowRedirection: inout Bool)
- (void)onRedirection:(NSString*)oldURL :(NSString**)newURL :(int*)allowRedirection;
Remarks
This event is fired when the server suggests a redirection request (typically via a 301 or 302 response). OldURL indicates the 'from' page, and NewURL indicates the 'to' one. The destination page can be altered by the application if needed. Use AllowRedirection to block undesirable redirects.
Generally, this is a notification event: the component handles redirections automatically. Use the MaxRedirections config property to limit the number of redirection hops.
TLSCertNeeded Event (SOAPClient Module)
Fires when a remote TLS party requests a client certificate.
Syntax
- (void)onTLSCertNeeded:(NSString*)host :(NSString*)CANames;
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.
TLSCertValidate Event (SOAPClient Module)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
func onTLSCertValidate(serverHost: String, serverIP: String, accept: inout Bool)
- (void)onTLSCertValidate:(NSString*)serverHost :(NSString*)serverIP :(int*)accept;
Remarks
This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.
TLSEstablished Event (SOAPClient Module)
Fires when a TLS handshake with Host successfully completes.
Syntax
func onTLSEstablished(host: String, version: String, ciphersuite: String, connectionId: Data, abort: inout Bool)
- (void)onTLSEstablished:(NSString*)host :(NSString*)version :(NSString*)ciphersuite :(NSData*)connectionId :(int*)abort;
Remarks
The class uses this event to notify the application about successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
TLSHandshake Event (SOAPClient Module)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
func onTLSHandshake(host: String, abort: inout Bool)
- (void)onTLSHandshake:(NSString*)host :(int*)abort;
Remarks
The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.
TLSPSK Event (SOAPClient Module)
Notifies the application about the PSK key exchange.
Syntax
Remarks
The class fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.
TLSShutdown Event (SOAPClient Module)
Reports the graceful closure of a TLS connection.
Syntax
func onTLSShutdown(host: String)
- (void)onTLSShutdown:(NSString*)host;
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
bytes Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
crlDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fingerprint Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyUsage Int32 |
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ocspLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ocspNoCheck Bool |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
origin Int32 |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
qualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serialNumber Data |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subjectKeyID Data |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
validFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
validTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public init(stream: )
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public init()
Creates a new object with default field values.
ConnectionInfo Type
Contains information about a network connection.
Remarks
Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.
Fields
aeadCipher Bool |
Indicates whether the encryption algorithm used is an AEAD cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
chainValidationDetails Int32 |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||
chainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||
ciphersuite String |
The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
clientAuthenticated Bool |
Specifies whether client authentication was performed during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
clientAuthRequested Bool |
Specifies whether client authentication was requested during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
connectionEstablished Bool |
Indicates whether the connection has been established fully. |
||||||||||||||||||||||||||||||||||||||||||||||||
connectionID Data |
The unique identifier assigned to this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
digestAlgorithm String |
The digest algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
encryptionAlgorithm String |
The symmetric encryption algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
exportable Bool |
Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
keyExchangeAlgorithm String |
The key exchange algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
keyExchangeKeyBits Int32 |
The length of the key exchange key of a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
namedECCurve String |
The elliptic curve used in this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
pfsCipher Bool |
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
||||||||||||||||||||||||||||||||||||||||||||||||
preSharedIdentityHint String |
A hint professed by the server to help the client select the PSK identity to use. |
||||||||||||||||||||||||||||||||||||||||||||||||
publicKeyBits Int32 |
The length of the public key. |
||||||||||||||||||||||||||||||||||||||||||||||||
resumedSession Bool |
Indicates whether a TLS-enabled connection was spawned from another TLS connection |
||||||||||||||||||||||||||||||||||||||||||||||||
secureConnection Bool |
Indicates whether TLS or SSL is enabled for this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
serverAuthenticated Bool |
Indicates whether server authentication was performed during a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
signatureAlgorithm String |
The signature algorithm used in a TLS handshake. |
||||||||||||||||||||||||||||||||||||||||||||||||
symmetricBlockSize Int32 |
The block size of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
symmetricKeyBits Int32 |
The key length of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
totalBytesReceived Int64 |
The total number of bytes received over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
totalBytesSent Int64 |
The total number of bytes sent over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
validationLog String |
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
||||||||||||||||||||||||||||||||||||||||||||||||
version String |
Indicates the version of SSL/TLS protocol negotiated during this connection. |
Constructors
public init()
Creates a new ConnectionInfo object.
CRL Type
Represents a Certificate Revocation List.
Remarks
CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.
Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.
Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.
Fields
bytes Data |
Returns raw CRL data in DER format. |
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
entryCount Int32 |
Returns the number of certificate status entries in the CRL. |
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
issuer String |
The common name of the CRL issuer (CA), typically a company name. |
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
location String |
The URL that the CRL was downloaded from. |
nextUpdate String |
The planned time and date of the next version of this CRL to be published. |
sigAlgorithm String |
The public key algorithm that was used by the CA to sign this CRL. |
tbs Data |
The to-be-signed part of the CRL (the CRL without the signature part). |
thisUpdate String |
The date and time at which this version of the CRL was published. |
Constructors
public init()
Creates an empty CRL object.
ExternalCrypto Type
Specifies the parameters of external cryptographic calls.
Remarks
External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.
Fields
asyncDocumentID String |
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customParams String |
Custom parameters to be passed to the signing service (uninterpreted). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data String |
Additional data to be included in the async state and mirrored back by the requestor |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
externalHashCalculation Bool |
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hashAlgorithm String |
Specifies the request's signature hash algorithm.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyID String |
The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keySecret String |
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
method AsyncSignMethods |
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mode ExternalCryptoModes |
Specifies the external cryptography mode. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
publicKeyAlgorithm String |
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
|
Constructors
public init()
Creates a new ExternalCrypto object with default field values.
HTTPRequestParameters Type
Represents the headers of the HTTP request to make.
Remarks
If a header is not assigned but required for a successful request (such as Connection or Host), it will be generated automatically by the class.
Fields
accept String |
Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response. |
||||
acceptCharset String |
Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand. |
||||
acceptLanguage String |
Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand. |
||||
acceptRangeEnd Int64 |
This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request. |
||||
acceptRangeStart Int64 |
This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request. |
||||
authorization String |
Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server. |
||||
connection String |
Specifies the value to pass to the Connection header field of HTTP request. |
||||
contentLength Int64 |
Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the class calculate it automatically. |
||||
contentRangeEnd Int64 |
Specifies the upper bound used in the Content-Range header of the HTTP request. |
||||
contentRangeFullSize Int64 |
Specifies the total length of the full entity-body of the HTTP request. |
||||
contentRangeStart Int64 |
Specifies the lower bound used in the Content-Range header of the HTTP request. |
||||
contentType String |
The Content-Type header field of the HTTP request. |
||||
cookie String |
This header is expected to be assigned with cookies previously received from the server and stored by the client. |
||||
customHeaders String |
Assign any custom HTTP headers to be passed to the server to this property. |
||||
date String |
The date and time of the request. |
||||
from String |
Contains the From header field of the HTTP request. It specifies the e-mail address for the human user who controls the requesting user agent. |
||||
host String |
This property contains the Host header field of the HTTP request. It specifies the host and port number of the resource being requested. |
||||
httpVersion HTTPVersions |
Specifies the version of HTTP protocol to use: 1.0 or 1.1.
|
||||
ifMatch String |
Contains the If-Match request header field. This property makes the requested method conditional: when If-Match field is set, only the entities matching the included entity tags will be returned by the server. |
||||
ifModifiedSince String |
Contains the If-Modified-Since request header field. This property makes the requested method conditional: when If-Modified-Since field is set, only the modified entities will be returned by the server. |
||||
ifNoneMatch String |
Contains the If-None-Match request header field. This property makes the requested method conditional: when If-None-Match field is set, only the entities which doesn't match the included entity tags will be returned by the server. |
||||
ifUnmodifiedSince String |
Contains the If-Unmodified-Since request header field. This property makes the requested method conditional: when If-Unmodified-Since field is set, only the unmodified entities will be returned by the server. |
||||
password String |
Assign this property with the user's password. |
||||
referer String |
The Referer field of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer). |
||||
userAgent String |
The User-Agent field of the HTTP request provides information about the software that initiates the request. |
||||
username String |
Assign this property with the user's login name. |
Constructors
public init()
Creates a new HTTPRequestParameters object.
HTTPResponseParameters Type
This object is a container for HTTP server response details.
Remarks
An HTTP response is sent by the server when it has processed the client's request. The response consists of the status code (perhaps, the most annoying and widely known one is 404), the reason phrase, the response headers, and the body (the actual data) of the response.
Fields
contentLength Int64 |
Indicates the length of the response content in bytes. |
||||||||||
date String |
The date and time at which the response was generated, in server time, in UTC. |
||||||||||
reasonPhrase String |
Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code. |
||||||||||
statusCode Int32 |
The server-generated status code of the request processing status. The code is a 3-digit integer where the first digit defines the class of the response:
Common examples are 200 (page served succesfully), 404 (page not found), 302 (redirect), and 500 (internal server error). |
Constructors
public init()
Creates a new HTTPResponseParameters object.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Remarks
OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRL).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
bytes Data |
Buffer containing raw OCSP response data. |
entryCount Int32 |
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. |
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
issuer String |
Indicates the issuer of this response (a CA or its authorized representative). |
issuerRDN String |
Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
location String |
Location of the OCSP responder. |
producedAt String |
Specifies the time when the response was produced, in UTC. |
Constructors
public init()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
address String |
The IP address of the proxy server. |
||||||||||
authentication ProxyAuthTypes |
The authentication type used by the proxy server.
|
||||||||||
password String |
The password to authenticate to the proxy server. |
||||||||||
port Int32 |
The port on the proxy server to connect to. |
||||||||||
proxyType ProxyTypes |
The type of the proxy server. The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
|
||||||||||
requestHeaders String |
Contains HTTP request headers for WebTunnel and HTTP proxy. |
||||||||||
responseBody String |
Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
||||||||||
responseHeaders String |
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
||||||||||
useIPv6 Bool |
Specifies whether IPv6 should be used when connecting through the proxy. |
||||||||||
useProxy Bool |
Enables or disables proxy-driven connection. |
||||||||||
username String |
Specifies the username credential for proxy authentication. |
Constructors
public init()
Creates a new ProxySettings object.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
dnsMode DNSResolveModes |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
dnsPort Int32 |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
dnsQueryTimeout Int32 |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
dnsServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
dnsTotalTimeout Int32 |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
incomingSpeedLimit Int32 |
The maximum number of bytes to read from the socket, per second. |
||||||||
localAddress String |
The local network interface to bind the socket to. |
||||||||
localPort Int32 |
The local port number to bind the socket to. |
||||||||
outgoingSpeedLimit Int32 |
The maximum number of bytes to write to the socket, per second. |
||||||||
timeout Int32 |
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). |
||||||||
useIPv6 Bool |
Enables or disables IP protocol version 6. |
Constructors
public init()
Creates a new SocketSettings object.
StringNameValuePair Type
A simple name-value pair object.
Remarks
The class represents a name-value string pair used in a variety of network components.
Fields
category String |
Specifies the string category of the contained value. This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used. For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used. |
||||||
format Int32 |
Specifies the format (encoding) of the value contained in the property. Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate
format that matches this setting:
The following formats are currently supported:
|
||||||
name String |
The name element in a (name, value) pair. |
||||||
value String |
The value element in a (name, value) pair. |
Constructors
public init(name: , value: )
Creates a name-value pair from a name and a value.
public init()
Creates an empty name-value object.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
autoValidateCertificates Bool |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
baseConfiguration SecureTransportPredefinedConfigurations |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
ciphersuites String |
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
|
|||||||||||||||||||||||||||||||||
ecCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
forceResumeIfDestinationChanges Bool |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
preSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
preSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
preSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
renegotiationAttackPreventionMode RenegotiationAttackPreventionModes |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
revocationCheck RevocationCheckKinds |
Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
sslOptions Int32 |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
tlsMode SSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
useExtendedMasterSecret Bool |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
useSessionResumption Bool |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
versions Int32 |
Th SSL/TLS versions to enable by default.
|
Constructors
public init()
Creates a new TLSSettings object.
Config Settings (SOAPClient Module)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.HTTPClient Config Settings | ||||||||||||||||||||||||||||||
AttachmentContentDescription: Specifies attachment content description.Specifies content description for the attachment. | ||||||||||||||||||||||||||||||
AttachmentContentId: Specifies attachment content Id.Specifies content Id for the attachment. | ||||||||||||||||||||||||||||||
AttachmentContentType: Specifies attachment content type.Specifies content type for the attachment. | ||||||||||||||||||||||||||||||
AttachmentFilename: Specifies attachment filename.Specifies filename for the attachment. | ||||||||||||||||||||||||||||||
CacheStreamOutput: Tells the component whether to cache stream- and file-bound responses in the component.Set this property to true to enable caching of potentially long responses obtained with GetFile and GetStream methods. If the response is cached, it will be available via OutputBytes and OutputString properties after the request is completed, but may occupy extra memory resources. | ||||||||||||||||||||||||||||||
FaultActor[Index]: Specifies who caused the fault.Use this property to get the URI associated with the actor (SOAP node) that caused the fault. In RPC-style messaging, the actor is the URI of the Web service. | ||||||||||||||||||||||||||||||
FaultCode[Index]: Specifies the error code.Use this property to get the standard code that provides more information about the fault. A set of code values is predefined by the SOAP specification. This set of fault code values can be extended by the application. | ||||||||||||||||||||||||||||||
FaultCount: The number of faults.Returns the number of the faults obtained. | ||||||||||||||||||||||||||||||
FaultDetail[Index]: Contains application-specific error information.Use this property to get the application-specific information, such as the exception that was thrown. This element can be an XML structure or plain text. | ||||||||||||||||||||||||||||||
FaultString[Index]: Specifies a human-readable description of fault.Use this property to get the human-readable description of the error. | ||||||||||||||||||||||||||||||
FaultXML[Index]: Specifies the XML content of the fault.Use this property to get the XML content of the fault. | ||||||||||||||||||||||||||||||
ForceNTLMAuth: Activates and enforces NTLM authentication.Set this property to True to force NTLM (Windows Integrated) authentication. | ||||||||||||||||||||||||||||||
IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
IgnoreUnknownTransferEncodings: All incoming responses with unknown transfer encodings are ignored if this property is true.All incoming responses with unknown transfer encodings are ignored if this property is true. | ||||||||||||||||||||||||||||||
MaxRedirections: The maximum number of HTTP redirects.Specifies the maximum number of HTTP redirects. Value 0 prevents any redirections, and -1 allows unlimited redirections. | ||||||||||||||||||||||||||||||
PersistentAuthHeader: Whether to resend NTLM negotiation on every request.Specifies whether to resend NTLM negotiation on every request. | ||||||||||||||||||||||||||||||
RelatedStartInfo: Specifies Start-Info parameter.Specifies additional information required for unpacking or processing of the content. It is optional Start-Info parameter of the Multipart/Related media type. | ||||||||||||||||||||||||||||||
RelatedType: Specifies media type/subtype.Specifies media type/subtype of message's content. Use this property to override default media type. It is Type parameter of the Multipart/Related media type. | ||||||||||||||||||||||||||||||
RequestCompressionGZip: Ask server to use GZip compression.Ask server to use GZip compression. | ||||||||||||||||||||||||||||||
RequestCompressionLevel: Ask server to use the specified compression level.Ask server to use the specified compression level. | ||||||||||||||||||||||||||||||
SendBufferSize: Size of send buffer in bytes.The size of blocks used to send data to the server. | ||||||||||||||||||||||||||||||
SkipInputProcessing: Whether to skip input processing.Set this property to True to enforce the class to send input data as-is. | ||||||||||||||||||||||||||||||
SkipOutputParsing: Whether to skip output parsing.Set this property to True to enforce the class to not to parse the output. In this case, SOAPResponseType property value will be either srtUnknown or srtBinary, and OperationResponse* and Fault* properties will not be set. | ||||||||||||||||||||||||||||||
SOAPPrefix:
Specifies the signature prefix.Specifies the prefix for the SOAPMessage elements.
Default value is "". In this case no prefix will be used. Special values:
|
||||||||||||||||||||||||||||||
SuppressRedirectionContent: Whether to suppress the redirection content.If this property is set to True, the redirection content will be silently suppressed by the class. Otherwise the message containing a redirection code will be processed as usual, the Redirection event will be fired, and the data will be written to OutputString or OutputBytes. | ||||||||||||||||||||||||||||||
TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
TolerateMinorChainIssues:
Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:
|
||||||||||||||||||||||||||||||
Use100Continue: Whether to use 100-continue for POST and PUT commands.Set this property to True to use the 100-continue approach for POST and PUT commands. In this approach, prior to sending the request body, the client sends a request message asking the server whether it is willing to accept the request body. The request body is sent only if the server accepts it. | ||||||||||||||||||||||||||||||
UseCompression: Whether to use GZip compression.Use this property to tell the server that it can transfer GZIPped data (if the server supports it). | ||||||||||||||||||||||||||||||
UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | ||||||||||||||||||||||||||||||
UseSOAPAction: Whether to use SOAP Action.Set this property to False to disable adding SOAPAction/action header field. | ||||||||||||||||||||||||||||||
UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. | ||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||
CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
StaticDNS:
Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.
Supported values are:
|
||||||||||||||||||||||||||||||
StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character. | ||||||||||||||||||||||||||||||
StaticIPAddresses: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. | ||||||||||||||||||||||||||||||
Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | ||||||||||||||||||||||||||||||
UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (SOAPClient Module)
SOAPClient Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
19922945 Unsupported keep-alive policy (SB_ERROR_HTTP_UNSUPPORTED_KEEPALIVEPOLICY) | |
33554689 Unexpected HTTP status code (SB_ERROR_SOAP_CLIENT_UNEXPECTED_HTTP_STATUS_CODE) | |
33554690 SOAP service failed (SB_ERROR_SOAP_CLIENT_SERVICE_FAILED) |