Utils Class
Properties Methods Events Configuration Settings Errors
The Utils class provides base functionality.
Syntax
Utils
Remarks
TBD
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| MultipartPartCount | The number of records in the MultipartPart arrays. |
| MultipartPartContentDescription | Provides a description for the part ( Content-Description header property). |
| MultipartPartContentDisposition | Specifies the disposition of the part ( Content-Disposition header property). |
| MultipartPartContentID | Specifies the ID of the part ( Content-ID header property). |
| MultipartPartContentTransferEncoding | Specifies the transfer encoding for the part ( Content-Transfer-Encoding header property). |
| MultipartPartContentType | Specifies the content type of the part ( Content-Type header property). |
| MultipartPartCustomHeaders | Assign any custom HTTP headers to be added to the part header. |
| MultipartPartFieldName | Specifies the property name of the form part ( name parameter in Content-Disposition header property). |
| MultipartPartFieldValue | Specifies the property value of the form part (the part's content). |
| MultipartPartFilename | Specifies the filename for the form part ( filename parameter in Content-Disposition header property). |
| NameValuePairCount | The number of records in the NameValuePair arrays. |
| NameValuePairName | The name element in a (name, value) pair. |
| NameValuePairValue | The value element in a (name, value) pair. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| AddMultipartFile | Adds a new part to MultipartMessage from the specified file. |
| Base64Decode | TBD. |
| Base64Encode | TBD. |
| Base64EncodeLines | TBD. |
| Base64UrlDecode | TBD. |
| Base64UrlEncode | TBD. |
| BytesToString | TBD. |
| Config | Sets or retrieves a configuration setting. |
| DateToString | TBD. |
| DoAction | Performs an additional action. |
| GetLocalDNSName | TBD. |
| GetLocalIP | TBD. |
| GetLocalIPs | TBD. |
| GetRemoteIP | TBD. |
| GetRemoteIPs | TBD. |
| GetValueByName | TBD. |
| HexDecode | TBD. |
| HexEncode | TBD. |
| IndexOfName | TBD. |
| LoadNameValuePairs | TBD. |
| OidToString | TBD. |
| RemoveNameValuePair | TBD. |
| SaveMultipartContentType | Returns the value for Content-Type field. |
| SaveMultipartToBytes | Saves the parts contained in MultipartMessage to a byte array. |
| SaveMultipartToFile | Saves the parts contained in MultipartMessage to the file. |
| SaveNameValuePairs | TBD. |
| SetValueByName | TBD. |
| StringToBytes | TBD. |
| StringToDate | TBD. |
| StringToOid | TBD. |
| UrlDecode | TBD. |
| UrlEncode | TBD. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Error | Informs about errors during cryptographic operations. |
| Notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| MultipartCharset | Specifies the charset to be used to encode the field names and the filenames of the multipart message. |
| RelatedStart | Identifies the starting body part or root. |
| RelatedStartInfo | Contains additional information required for unpacking or processing of the content. |
| RelatedType | Contains media type/subtype of message's content. |
| 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 class (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. |
| Tag | Allows to store any custom data. |
| 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. |
MultipartPartCount Property (Utils Class)
The number of records in the MultipartPart arrays.
Syntax
int GetMultipartPartCount();
int SetMultipartPartCount(int iMultipartPartCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- MultipartPartContentDescription
- MultipartPartContentDisposition
- MultipartPartContentID
- MultipartPartContentTransferEncoding
- MultipartPartContentType
- MultipartPartCustomHeaders
- MultipartPartFieldName
- MultipartPartFieldValue
- MultipartPartFilename
This property is not available at design time.
Data Type
Integer
MultipartPartContentDescription Property (Utils Class)
Provides a description for the part ( Content-Description header property).
Syntax
QString GetMultipartPartContentDescription(int iMultipartPartIndex);
int SetMultipartPartContentDescription(int iMultipartPartIndex, QString qsMultipartPartContentDescription);
Default Value
""
Remarks
Provides a description for the part (Content-Description header field)
The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.
This property is not available at design time.
Data Type
String
MultipartPartContentDisposition Property (Utils Class)
Specifies the disposition of the part ( Content-Disposition header property).
Syntax
QString GetMultipartPartContentDisposition(int iMultipartPartIndex);
int SetMultipartPartContentDisposition(int iMultipartPartIndex, QString qsMultipartPartContentDisposition);
Default Value
""
Remarks
Specifies the disposition of the part (Content-Disposition header field)
The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.
This property is not available at design time.
Data Type
String
MultipartPartContentID Property (Utils Class)
Specifies the ID of the part ( Content-ID header property).
Syntax
QString GetMultipartPartContentID(int iMultipartPartIndex);
int SetMultipartPartContentID(int iMultipartPartIndex, QString qsMultipartPartContentID);
Default Value
""
Remarks
Specifies the ID of the part (Content-ID header field)
The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.
This property is not available at design time.
Data Type
String
MultipartPartContentTransferEncoding Property (Utils Class)
Specifies the transfer encoding for the part ( Content-Transfer-Encoding header property).
Syntax
QString GetMultipartPartContentTransferEncoding(int iMultipartPartIndex);
int SetMultipartPartContentTransferEncoding(int iMultipartPartIndex, QString qsMultipartPartContentTransferEncoding);
Default Value
""
Remarks
Specifies the transfer encoding for the part (Content-Transfer-Encoding header field)
The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.
This property is not available at design time.
Data Type
String
MultipartPartContentType Property (Utils Class)
Specifies the content type of the part ( Content-Type header property).
Syntax
QString GetMultipartPartContentType(int iMultipartPartIndex);
int SetMultipartPartContentType(int iMultipartPartIndex, QString qsMultipartPartContentType);
Default Value
""
Remarks
Specifies the content type of the part (Content-Type header field)
The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.
This property is not available at design time.
Data Type
String
MultipartPartCustomHeaders Property (Utils Class)
Assign any custom HTTP headers to be added to the part header.
Syntax
QString GetMultipartPartCustomHeaders(int iMultipartPartIndex);
int SetMultipartPartCustomHeaders(int iMultipartPartIndex, QString qsMultipartPartCustomHeaders);
Default Value
""
Remarks
Assign any custom HTTP headers to be added to the part header.
The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.
This property is not available at design time.
Data Type
String
MultipartPartFieldName Property (Utils Class)
Specifies the property name of the form part ( name parameter in Content-Disposition header property).
Syntax
QString GetMultipartPartFieldName(int iMultipartPartIndex);
int SetMultipartPartFieldName(int iMultipartPartIndex, QString qsMultipartPartFieldName);
Default Value
""
Remarks
Specifies the field name of the form part (name parameter in Content-Disposition header field).
The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.
This property is not available at design time.
Data Type
String
MultipartPartFieldValue Property (Utils Class)
Specifies the property value of the form part (the part's content).
Syntax
QString GetMultipartPartFieldValue(int iMultipartPartIndex);
int SetMultipartPartFieldValue(int iMultipartPartIndex, QString qsMultipartPartFieldValue);
Default Value
""
Remarks
Specifies the field value of the form part (the part's content).
The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.
This property is not available at design time.
Data Type
String
MultipartPartFilename Property (Utils Class)
Specifies the filename for the form part ( filename parameter in Content-Disposition header property).
Syntax
QString GetMultipartPartFilename(int iMultipartPartIndex);
int SetMultipartPartFilename(int iMultipartPartIndex, QString qsMultipartPartFilename);
Default Value
""
Remarks
Specifies the filename for the form part (filename parameter in Content-Disposition header field).
The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.
This property is not available at design time.
Data Type
String
NameValuePairCount Property (Utils Class)
The number of records in the NameValuePair arrays.
Syntax
int GetNameValuePairCount();
int SetNameValuePairCount(int iNameValuePairCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at NameValuePairCount - 1.This property is not available at design time.
Data Type
Integer
NameValuePairName Property (Utils Class)
The name element in a (name, value) pair.
Syntax
QString GetNameValuePairName(int iNameValuePairIndex);
int SetNameValuePairName(int iNameValuePairIndex, QString qsNameValuePairName);
Default Value
""
Remarks
The name element in a (name, value) pair.
The NameValuePairIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NameValuePairCount property.
This property is not available at design time.
Data Type
String
NameValuePairValue Property (Utils Class)
The value element in a (name, value) pair.
Syntax
QString GetNameValuePairValue(int iNameValuePairIndex);
int SetNameValuePairValue(int iNameValuePairIndex, QString qsNameValuePairValue);
Default Value
""
Remarks
The value element in a (name, value) pair.
The NameValuePairIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NameValuePairCount property.
This property is not available at design time.
Data Type
String
AddMultipartFile Method (Utils Class)
Adds a new part to MultipartMessage from the specified file.
Syntax
int AddMultipartFile(const QString& qsFilename);
Remarks
The method adds a new part to MultipartMessage list with the specified file data as the part's content.
Returns the index of the added part.
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Base64Decode Method (Utils Class)
TBD.
Syntax
QByteArray Base64Decode(const QString& qsValue);
Remarks
TBD
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Base64Encode Method (Utils Class)
TBD.
Syntax
QString Base64Encode(QByteArray qbaBytes);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Base64EncodeLines Method (Utils Class)
TBD.
Syntax
QString Base64EncodeLines(QByteArray qbaBytes, int iLineLen);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Base64UrlDecode Method (Utils Class)
TBD.
Syntax
QByteArray Base64UrlDecode(const QString& qsValue);
Remarks
TBD
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Base64UrlEncode Method (Utils Class)
TBD.
Syntax
QString Base64UrlEncode(QByteArray qbaBytes);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
BytesToString Method (Utils Class)
TBD.
Syntax
QString BytesToString(QByteArray qbaBytes);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Config Method (Utils Class)
Sets or retrieves a configuration setting.
Syntax
QString Config(const QString& qsConfigurationString);
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.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DateToString Method (Utils Class)
TBD.
Syntax
QString DateToString(QDateTime qdtValue);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (Utils Class)
Performs an additional action.
Syntax
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
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;....
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetLocalDNSName Method (Utils Class)
TBD.
Syntax
QString GetLocalDNSName();
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetLocalIP Method (Utils Class)
TBD.
Syntax
QString GetLocalIP(bool bIPv6);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetLocalIPs Method (Utils Class)
TBD.
Syntax
QString GetLocalIPs(bool bIPv4, bool bIPv6);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetRemoteIP Method (Utils Class)
TBD.
Syntax
QString GetRemoteIP(const QString& qsHostName, bool bIPv6);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetRemoteIPs Method (Utils Class)
TBD.
Syntax
QString GetRemoteIPs(const QString& qsHostName, bool bIPv4, bool bIPv6);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetValueByName Method (Utils Class)
TBD.
Syntax
QString GetValueByName(const QString& qsName);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
HexDecode Method (Utils Class)
TBD.
Syntax
QByteArray HexDecode(const QString& qsValue);
Remarks
TBD
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
HexEncode Method (Utils Class)
TBD.
Syntax
QString HexEncode(QByteArray qbaBytes);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
IndexOfName Method (Utils Class)
TBD.
Syntax
int IndexOfName(const QString& qsName);
Remarks
TBD
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
LoadNameValuePairs Method (Utils Class)
TBD.
Syntax
int LoadNameValuePairs(const QString& qsData, const QString& qsNameValueSeparators, const QString& qsPairSeparators, bool bTrimValues);
Remarks
TBD
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
OidToString Method (Utils Class)
TBD.
Syntax
QString OidToString(QByteArray qbaBytes);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
RemoveNameValuePair Method (Utils Class)
TBD.
Syntax
bool RemoveNameValuePair(const QString& qsName);
Remarks
TBD
Error Handling
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SaveMultipartContentType Method (Utils Class)
Returns the value for Content-Type field.
Syntax
QString SaveMultipartContentType();
Remarks
Call this method to get a value for Content-Type field after calling SaveMultipartToBytes or SaveMultipartToFile or SaveMultipartToStream.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SaveMultipartToBytes Method (Utils Class)
Saves the parts contained in MultipartMessage to a byte array.
Syntax
QByteArray SaveMultipartToBytes(int iMultipartMode);
Remarks
Use this method to store MultipartMessage to a temporary byte array.
Supported values for MultipartMode are:
| hmmFormData | 0 | The multipart message contains form data (content type is multipart/form-data) |
| hmmRelated | 1 | The multipart message contains related parts (content type is multipart/related) |
To send the stored data to an HTTP server, follow the steps below:
- Call SaveMultipartContentType method and assign the returned value to ContentType field of RequestParameters> property
- Call PostBytes> method and pass the array to it
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SaveMultipartToFile Method (Utils Class)
Saves the parts contained in MultipartMessage to the file.
Syntax
int SaveMultipartToFile(int iMultipartMode, const QString& qsFilename);
Remarks
Use this method to store MultipartMessage to a temporary file.
Supported values for MultipartMode are:
| hmmFormData | 0 | The multipart message contains form data (content type is multipart/form-data) |
| hmmRelated | 1 | The multipart message contains related parts (content type is multipart/related) |
To send the stored data to an HTTP server, follow the steps below:
- Call SaveMultipartContentType method and assign the returned value to ContentType field of RequestParameters> property
- Call PostFile> method and pass the filename to it
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SaveNameValuePairs Method (Utils Class)
TBD.
Syntax
QString SaveNameValuePairs(const QString& qsNameValueSeparator, const QString& qsPairSeparator);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SetValueByName Method (Utils Class)
TBD.
Syntax
int SetValueByName(const QString& qsName, const QString& qsValue);
Remarks
TBD
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
StringToBytes Method (Utils Class)
TBD.
Syntax
QByteArray StringToBytes(const QString& qsValue);
Remarks
TBD
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
StringToDate Method (Utils Class)
TBD.
Syntax
QDateTime StringToDate(const QString& qsValue);
Remarks
TBD
Error Handling
This method returns a Long64 value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
StringToOid Method (Utils Class)
TBD.
Syntax
QByteArray StringToOid(const QString& qsValue);
Remarks
TBD
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
UrlDecode Method (Utils Class)
TBD.
Syntax
QString UrlDecode(const QString& qsValue);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
UrlEncode Method (Utils Class)
TBD.
Syntax
QString UrlEncode(const QString& qsValue);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Error Event (Utils Class)
Informs about errors during cryptographic operations.
Syntax
class UtilsErrorEventParams {
public:
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(UtilsErrorEventParams *e);
// Or, subclass Utils and override this emitter function.
virtual int FireError(UtilsErrorEventParams *e) {...}
Remarks
Class fires this event if an error happens during a cryptographic operation.
ErrorCode contains an error code and Description contains a textual description of the error that happened.
Notification Event (Utils Class)
This event notifies the application about an underlying control flow event.
Syntax
class UtilsNotificationEventParams {
public:
const QString &EventID();
const QString &EventParam();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Notification(UtilsNotificationEventParams *e);
// Or, subclass Utils and override this emitter function.
virtual int FireNotification(UtilsNotificationEventParams *e) {...}
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.
Configuration Settings (Utils Class)
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.Utils Configuration Settings | ||||||||||||||||||||||||||||||
| MultipartCharset: Specifies the charset to be used to encode the field names and the filenames of the multipart message. | ||||||||||||||||||||||||||||||
| RelatedStart: Identifies the starting body part or root.Provides the starting body part or root for multipart messages transferred over HTTP. | ||||||||||||||||||||||||||||||
| RelatedStartInfo: Contains additional information required for unpacking or processing of the content.Provides additional information for unpacking or processing of the content in multipart messages transferred over HTTP. | ||||||||||||||||||||||||||||||
| RelatedType: Contains media type/subtype of message's content.Provides the media type/subtype of message's content in multipart messages transferred over HTTP. | ||||||||||||||||||||||||||||||
Base Configuration 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. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| 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 (Utils Class)
Utils 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) |