RESTClient Component

Properties   Methods   Events   Config Settings   Errors  

The RESTClient component implements client-side functionality for the REST protocol.

Syntax

TsbxRESTClient

Remarks

RESTClient allows you to send requests to a REST server and receive server responses. It supports both plain (HTTP) and secure (HTTPS) modes.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

BlockedCertCount Property (RESTClient Component)

The number of records in the BlockedCert arrays.

Syntax

__property int BlockedCertCount = { read=FBlockedCertCount, write=FSetBlockedCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

The array indices start at 0 and end at BlockedCertCount - 1.

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (RESTClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray BlockedCertBytes[int BlockedCertIndex] = { read=FBlockedCertBytes };

Remarks

Returns the raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

BlockedCertHandle Property (RESTClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 BlockedCertHandle[int BlockedCertIndex] = { read=FBlockedCertHandle, write=FSetBlockedCertHandle };

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is not available at design time.

Data Type

Long64

ClientCertCount Property (RESTClient Component)

The number of records in the ClientCert arrays.

Syntax

__property int ClientCertCount = { read=FClientCertCount, write=FSetClientCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientCertBytes
• ClientCertHandle

The array indices start at 0 and end at ClientCertCount - 1.

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (RESTClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray ClientCertBytes[int ClientCertIndex] = { read=FClientCertBytes };

Remarks

Returns the raw certificate data in DER format.

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ClientCertHandle Property (RESTClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 ClientCertHandle[int ClientCertIndex] = { read=FClientCertHandle, write=FSetClientCertHandle };

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

This property is not available at design time.

Data Type

Long64

ConnInfoAEADCipher Property (RESTClient Component)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

__property bool ConnInfoAEADCipher = { read=FConnInfoAEADCipher };

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoChainValidationDetails Property (RESTClient Component)

The details of a certificate chain validation outcome.

Syntax

__property int ConnInfoChainValidationDetails = { read=FConnInfoChainValidationDetails };

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoChainValidationResult Property (RESTClient Component)

The outcome of a certificate chain validation routine.

Syntax

__property TsbxRESTClientConnInfoChainValidationResults ConnInfoChainValidationResult = { read=FConnInfoChainValidationResult };

enum TsbxRESTClientConnInfoChainValidationResults {
  cvtValid=0,
  cvtValidButUntrusted=1,
  cvtInvalid=2,
  cvtCantBeEstablished=3
};

Default Value

cvtValid

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoCiphersuite Property (RESTClient Component)

The cipher suite employed by this connection.

Syntax

__property String ConnInfoCiphersuite = { read=FConnInfoCiphersuite };

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoClientAuthenticated Property (RESTClient Component)

Specifies whether client authentication was performed during this connection.

Syntax

__property bool ConnInfoClientAuthenticated = { read=FConnInfoClientAuthenticated };

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoClientAuthRequested Property (RESTClient Component)

Specifies whether client authentication was requested during this connection.

Syntax

__property bool ConnInfoClientAuthRequested = { read=FConnInfoClientAuthRequested };

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoConnectionEstablished Property (RESTClient Component)

Indicates whether the connection has been established fully.

Syntax

__property bool ConnInfoConnectionEstablished = { read=FConnInfoConnectionEstablished };

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoConnectionID Property (RESTClient Component)

The unique identifier assigned to this connection.

Syntax

__property DynamicArray ConnInfoConnectionID = { read=FConnInfoConnectionID };

Remarks

The unique identifier assigned to this connection.

This property is read-only and not available at design time.

Data Type

Byte Array

ConnInfoDigestAlgorithm Property (RESTClient Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

__property String ConnInfoDigestAlgorithm = { read=FConnInfoDigestAlgorithm };

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoEncryptionAlgorithm Property (RESTClient Component)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

__property String ConnInfoEncryptionAlgorithm = { read=FConnInfoEncryptionAlgorithm };

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoExportable Property (RESTClient Component)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

__property bool ConnInfoExportable = { read=FConnInfoExportable };

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoKeyExchangeAlgorithm Property (RESTClient Component)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

__property String ConnInfoKeyExchangeAlgorithm = { read=FConnInfoKeyExchangeAlgorithm };

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoKeyExchangeKeyBits Property (RESTClient Component)

The length of the key exchange key of a TLS-enabled connection.

Syntax

__property int ConnInfoKeyExchangeKeyBits = { read=FConnInfoKeyExchangeKeyBits };

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoNamedECCurve Property (RESTClient Component)

The elliptic curve used in this connection.

Syntax

__property String ConnInfoNamedECCurve = { read=FConnInfoNamedECCurve };

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only and not available at design time.

Data Type

String

ConnInfoPFSCipher Property (RESTClient Component)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

__property bool ConnInfoPFSCipher = { read=FConnInfoPFSCipher };

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoPreSharedIdentityHint Property (RESTClient Component)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

__property String ConnInfoPreSharedIdentityHint = { read=FConnInfoPreSharedIdentityHint };

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only and not available at design time.

Data Type

String

ConnInfoPublicKeyBits Property (RESTClient Component)

The length of the public key.

Syntax

__property int ConnInfoPublicKeyBits = { read=FConnInfoPublicKeyBits };

Default Value

0

Remarks

The length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoResumedSession Property (RESTClient Component)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

__property bool ConnInfoResumedSession = { read=FConnInfoResumedSession };

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoSecureConnection Property (RESTClient Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

__property bool ConnInfoSecureConnection = { read=FConnInfoSecureConnection };

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoServerAuthenticated Property (RESTClient Component)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

__property bool ConnInfoServerAuthenticated = { read=FConnInfoServerAuthenticated };

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Boolean

ConnInfoSignatureAlgorithm Property (RESTClient Component)

The signature algorithm used in a TLS handshake.

Syntax

__property String ConnInfoSignatureAlgorithm = { read=FConnInfoSignatureAlgorithm };

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only and not available at design time.

Data Type

String

ConnInfoSymmetricBlockSize Property (RESTClient Component)

The block size of the symmetric algorithm used.

Syntax

__property int ConnInfoSymmetricBlockSize = { read=FConnInfoSymmetricBlockSize };

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoSymmetricKeyBits Property (RESTClient Component)

The key length of the symmetric algorithm used.

Syntax

__property int ConnInfoSymmetricKeyBits = { read=FConnInfoSymmetricKeyBits };

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

ConnInfoTotalBytesReceived Property (RESTClient Component)

The total number of bytes received over this connection.

Syntax

__property __int64 ConnInfoTotalBytesReceived = { read=FConnInfoTotalBytesReceived };

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only and not available at design time.

Data Type

Long64

ConnInfoTotalBytesSent Property (RESTClient Component)

The total number of bytes sent over this connection.

Syntax

__property __int64 ConnInfoTotalBytesSent = { read=FConnInfoTotalBytesSent };

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only and not available at design time.

Data Type

Long64

ConnInfoValidationLog Property (RESTClient Component)

Contains the server certificate's chain validation log.

Syntax

__property String ConnInfoValidationLog = { read=FConnInfoValidationLog };

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only and not available at design time.

Data Type

String

ConnInfoVersion Property (RESTClient Component)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

__property String ConnInfoVersion = { read=FConnInfoVersion };

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only and not available at design time.

Data Type

String

CustomRequest Property (RESTClient Component)

Specifies a custom request verb.

Syntax

__property String CustomRequest = { read=FCustomRequest, write=FSetCustomRequest };

Default Value

""

Remarks

Use this property to specify a custom HTTP method verb to use instead of the original method. PATCH is one of the commonly used custom verbs.

This property is not available at design time.

Data Type

String

DynamicData Property (RESTClient Component)

Takes a piece of data to be sent to the server within a dynamic POST or PUT request.

Syntax

__property DynamicArray DynamicData = { read=FDynamicData, write=FSetDynamicData };

Remarks

Assign the next chunk of data to this property from your DynamicDataNeeded event handler to pass it to the server. Leave it empty to tell the component that no more data is available.

This property is not available at design time.

Data Type

Byte Array

ExternalCryptoAsyncDocumentID Property (RESTClient Component)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

Default Value

""

Remarks

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 the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (RESTClient Component)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (RESTClient Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (RESTClient Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth component.

If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (RESTClient Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (RESTClient Component)

The ID of the pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

Default Value

""

Remarks

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 an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret 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: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (RESTClient Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

Default Value

""

Remarks

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.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (RESTClient Component)

Specifies the asynchronous signing method.

Syntax

__property TsbxRESTClientExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxRESTClientExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (RESTClient Component)

Specifies the external cryptography mode.

Syntax

__property TsbxRESTClientExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxRESTClientExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (RESTClient Component)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (RESTClient Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeepAlivePolicy Property (RESTClient Component)

Defines the keep-alive handling policy.

Syntax

__property TsbxRESTClientKeepAlivePolicies KeepAlivePolicy = { read=FKeepAlivePolicy, write=FSetKeepAlivePolicy };

enum TsbxRESTClientKeepAlivePolicies {
  ckapStandardDefined=0,
  ckapPreferKeepAlive=1,
  ckapRelyOnServer=2,
  ckapKeepAlivesDisabled=3
};

Default Value

ckapStandardDefined

Remarks

Use this property to tune-up the keep-alive mechanism as per the needs of your application.

Data Type

Integer

KnownCertCount Property (RESTClient Component)

The number of records in the KnownCert arrays.

Syntax

__property int KnownCertCount = { read=FKnownCertCount, write=FSetKnownCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

The array indices start at 0 and end at KnownCertCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (RESTClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray KnownCertBytes[int KnownCertIndex] = { read=FKnownCertBytes };

Remarks

Returns the raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCertHandle Property (RESTClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KnownCertHandle[int KnownCertIndex] = { read=FKnownCertHandle, write=FSetKnownCertHandle };

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (RESTClient Component)

The number of records in the KnownCRL arrays.

Syntax

__property int KnownCRLCount = { read=FKnownCRLCount, write=FSetKnownCRLCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

The array indices start at 0 and end at KnownCRLCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (RESTClient Component)

Returns the raw CRL data in DER format.

Syntax

__property DynamicArray KnownCRLBytes[int KnownCRLIndex] = { read=FKnownCRLBytes };

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCRLHandle Property (RESTClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KnownCRLHandle[int KnownCRLIndex] = { read=FKnownCRLHandle, write=FSetKnownCRLHandle };

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (RESTClient Component)

The number of records in the KnownOCSP arrays.

Syntax

__property int KnownOCSPCount = { read=FKnownOCSPCount, write=FSetKnownOCSPCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

The array indices start at 0 and end at KnownOCSPCount - 1.

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (RESTClient Component)

A buffer containing the raw OCSP response data.

Syntax

__property DynamicArray KnownOCSPBytes[int KnownOCSPIndex] = { read=FKnownOCSPBytes };

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownOCSPHandle Property (RESTClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KnownOCSPHandle[int KnownOCSPIndex] = { read=FKnownOCSPHandle, write=FSetKnownOCSPHandle };

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is not available at design time.

Data Type

Long64

OutputBytes Property (RESTClient Component)

Contains the response content.

Syntax

__property DynamicArray OutputBytes = { read=FOutputBytes };

Remarks

Use this property to access the content received from the server in response to a prior request.

This property is read-only and not available at design time.

Data Type

Byte Array

OutputString Property (RESTClient Component)

Contains the response content.

Syntax

__property String OutputString = { read=FOutputString };

Default Value

""

Remarks

Use this property to access the content received from the server in response to a prior request, as a string.

This property is read-only and not available at design time.

Data Type

String

ProxyAddress Property (RESTClient Component)

The IP address of the proxy server.

Syntax

__property String ProxyAddress = { read=FProxyAddress, write=FSetProxyAddress };

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (RESTClient Component)

The authentication type used by the proxy server.

Syntax

__property TsbxRESTClientProxyAuthentications ProxyAuthentication = { read=FProxyAuthentication, write=FSetProxyAuthentication };

enum TsbxRESTClientProxyAuthentications {
  patNoAuthentication=0,
  patBasic=1,
  patDigest=2,
  patNTLM=3
};

Default Value

patNoAuthentication

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (RESTClient Component)

The password to authenticate to the proxy server.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (RESTClient Component)

The port on the proxy server to connect to.

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (RESTClient Component)

The type of the proxy server.

Syntax

__property TsbxRESTClientProxyProxyTypes ProxyProxyType = { read=FProxyProxyType, write=FSetProxyProxyType };

enum TsbxRESTClientProxyProxyTypes {
  cptNone=0,
  cptSocks4=1,
  cptSocks5=2,
  cptWebTunnel=3,
  cptHTTP=4
};

Default Value

cptNone

Remarks

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.

Data Type

Integer

ProxyRequestHeaders Property (RESTClient Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

__property String ProxyRequestHeaders = { read=FProxyRequestHeaders, write=FSetProxyRequestHeaders };

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (RESTClient Component)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

__property String ProxyResponseBody = { read=FProxyResponseBody, write=FSetProxyResponseBody };

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (RESTClient Component)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

__property String ProxyResponseHeaders = { read=FProxyResponseHeaders, write=FSetProxyResponseHeaders };

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (RESTClient Component)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

__property bool ProxyUseIPv6 = { read=FProxyUseIPv6, write=FSetProxyUseIPv6 };

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUseProxy Property (RESTClient Component)

Enables or disables proxy-driven connection.

Syntax

__property bool ProxyUseProxy = { read=FProxyUseProxy, write=FSetProxyUseProxy };

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (RESTClient Component)

Specifies the username credential for proxy authentication.

Syntax

__property String ProxyUsername = { read=FProxyUsername, write=FSetProxyUsername };

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ReasonPhrase Property (RESTClient Component)

Contains the Reason Phrase element of the server's response.

Syntax

__property String ReasonPhrase = { read=FReasonPhrase };

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 and not available at design time.

Data Type

String

ReqHeaderCount Property (RESTClient Component)

The number of records in the ReqHeader arrays.

Syntax

__property int ReqHeaderCount = { read=FReqHeaderCount, write=FSetReqHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReqHeaderCategory
• ReqHeaderFormat
• ReqHeaderName
• ReqHeaderValue

The array indices start at 0 and end at ReqHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

ReqHeaderCategory Property (RESTClient Component)

Specifies the string category of the contained value.

Syntax

__property String ReqHeaderCategory[int ReqHeaderIndex] = { read=FReqHeaderCategory, write=FSetReqHeaderCategory };

Default Value

""

Remarks

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.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

String

ReqHeaderFormat Property (RESTClient Component)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

__property int ReqHeaderFormat[int ReqHeaderIndex] = { read=FReqHeaderFormat, write=FSetReqHeaderFormat };

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the ReqHeaderValue 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: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

Integer

ReqHeaderName Property (RESTClient Component)

The name element in a (name, value) pair.

Syntax

__property String ReqHeaderName[int ReqHeaderIndex] = { read=FReqHeaderName, write=FSetReqHeaderName };

Default Value

""

Remarks

The name element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

String

ReqHeaderValue Property (RESTClient Component)

The value element in a (name, value) pair.

Syntax

__property String ReqHeaderValue[int ReqHeaderIndex] = { read=FReqHeaderValue, write=FSetReqHeaderValue };

Default Value

""

Remarks

The value element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

String

ReqParamsAccept Property (RESTClient Component)

Specifies the Accept header property of the HTTP request.

Syntax

__property String ReqParamsAccept = { read=FReqParamsAccept, write=FSetReqParamsAccept };

Default Value

""

Remarks

Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response.

This property is not available at design time.

Data Type

String

ReqParamsAcceptCharset Property (RESTClient Component)

Specifies the Accept-Charset header property of the HTTP request.

Syntax

__property String ReqParamsAcceptCharset = { read=FReqParamsAcceptCharset, write=FSetReqParamsAcceptCharset };

Default Value

""

Remarks

Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand.

This property is not available at design time.

Data Type

String

ReqParamsAcceptLanguage Property (RESTClient Component)

Specifies the Accept-Language header property of the HTTP request.

Syntax

__property String ReqParamsAcceptLanguage = { read=FReqParamsAcceptLanguage, write=FSetReqParamsAcceptLanguage };

Default Value

""

Remarks

Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand.

This property is not available at design time.

Data Type

String

ReqParamsAcceptRangeEnd Property (RESTClient Component)

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

Syntax

__property __int64 ReqParamsAcceptRangeEnd = { read=FReqParamsAcceptRangeEnd, write=FSetReqParamsAcceptRangeEnd };

Default Value

0

Remarks

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsAcceptRangeStart Property (RESTClient Component)

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

Syntax

__property __int64 ReqParamsAcceptRangeStart = { read=FReqParamsAcceptRangeStart, write=FSetReqParamsAcceptRangeStart };

Default Value

0

Remarks

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsAuthorization Property (RESTClient Component)

Specifies the Authorization header of the HTTP request.

Syntax

__property String ReqParamsAuthorization = { read=FReqParamsAuthorization, write=FSetReqParamsAuthorization };

Default Value

""

Remarks

Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server.

This property is not available at design time.

Data Type

String

ReqParamsConnection Property (RESTClient Component)

Specifies the value to pass to the Connection header property of HTTP request.

Syntax

__property String ReqParamsConnection = { read=FReqParamsConnection, write=FSetReqParamsConnection };

Default Value

""

Remarks

Specifies the value to pass to the Connection header field of HTTP request.

This property is not available at design time.

Data Type

String

ReqParamsContentLength Property (RESTClient Component)

Specifies the size of the entity-body of the HTTP request.

Syntax

__property __int64 ReqParamsContentLength = { read=FReqParamsContentLength, write=FSetReqParamsContentLength };

Default Value

0

Remarks

Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the component calculate it automatically.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeEnd Property (RESTClient Component)

Specifies the upper bound used in the Content-Range header of the HTTP request.

Syntax

__property __int64 ReqParamsContentRangeEnd = { read=FReqParamsContentRangeEnd, write=FSetReqParamsContentRangeEnd };

Default Value

0

Remarks

Specifies the upper bound used in the Content-Range header of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeFullSize Property (RESTClient Component)

Specifies the total length of the full entity-body of the HTTP request.

Syntax

__property __int64 ReqParamsContentRangeFullSize = { read=FReqParamsContentRangeFullSize, write=FSetReqParamsContentRangeFullSize };

Default Value

0

Remarks

Specifies the total length of the full entity-body of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeStart Property (RESTClient Component)

Specifies the lower bound used in the Content-Range header of the HTTP request.

Syntax

__property __int64 ReqParamsContentRangeStart = { read=FReqParamsContentRangeStart, write=FSetReqParamsContentRangeStart };

Default Value

0

Remarks

Specifies the lower bound used in the Content-Range header of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentType Property (RESTClient Component)

The Content-Type header property of the HTTP request.

Syntax

__property String ReqParamsContentType = { read=FReqParamsContentType, write=FSetReqParamsContentType };

Default Value

""

Remarks

The Content-Type header field of the HTTP request.

This property is not available at design time.

Data Type

String

ReqParamsCookie Property (RESTClient Component)

This header is expected to be assigned with cookies previously received from the server and stored by the client.

Syntax

__property String ReqParamsCookie = { read=FReqParamsCookie, write=FSetReqParamsCookie };

Default Value

""

Remarks

This header is expected to be assigned with cookies previously received from the server and stored by the client.

This property is not available at design time.

Data Type

String

ReqParamsCustomHeaders Property (RESTClient Component)

Assign any custom HTTP headers to be passed to the server to this property.

Syntax

__property String ReqParamsCustomHeaders = { read=FReqParamsCustomHeaders, write=FSetReqParamsCustomHeaders };

Default Value

""

Remarks

Assign any custom HTTP headers to be passed to the server to this property.

This property is not available at design time.

Data Type

String

ReqParamsDate Property (RESTClient Component)

The date and time of the request.

Syntax

__property String ReqParamsDate = { read=FReqParamsDate, write=FSetReqParamsDate };

Default Value

""

Remarks

The date and time of the request.

This property is not available at design time.

Data Type

String

ReqParamsFrom Property (RESTClient Component)

Contains the From header property of the HTTP request.

Syntax

__property String ReqParamsFrom = { read=FReqParamsFrom, write=FSetReqParamsFrom };

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

ReqParamsHost Property (RESTClient Component)

This property contains the Host header property of the HTTP request.

Syntax

__property String ReqParamsHost = { read=FReqParamsHost, write=FSetReqParamsHost };

Default Value

""

Remarks

This property contains the Host header field of the HTTP request. It specifies the host and port number of the resource being requested.

This property is not available at design time.

Data Type

String

ReqParamsHTTPVersion Property (RESTClient Component)

Specifies the version of HTTP protocol to use: 1.

Syntax

__property TsbxRESTClientReqParamsHTTPVersions ReqParamsHTTPVersion = { read=FReqParamsHTTPVersion, write=FSetReqParamsHTTPVersion };

enum TsbxRESTClientReqParamsHTTPVersions {
  chvHTTP10=0,
  chvHTTP11=1
};

Default Value

chvHTTP11

Remarks

Specifies the version of HTTP protocol to use: 1.0 or 1.1.

This property is not available at design time.

Data Type

Integer

ReqParamsIfMatch Property (RESTClient Component)

Contains the If-Match request header property.

Syntax

__property String ReqParamsIfMatch = { read=FReqParamsIfMatch, write=FSetReqParamsIfMatch };

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

ReqParamsIfModifiedSince Property (RESTClient Component)

Contains the If-Modified-Since request header property.

Syntax

__property String ReqParamsIfModifiedSince = { read=FReqParamsIfModifiedSince, write=FSetReqParamsIfModifiedSince };

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

ReqParamsIfNoneMatch Property (RESTClient Component)

Contains the If-None-Match request header property.

Syntax

__property String ReqParamsIfNoneMatch = { read=FReqParamsIfNoneMatch, write=FSetReqParamsIfNoneMatch };

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

ReqParamsIfUnmodifiedSince Property (RESTClient Component)

Contains the If-Unmodified-Since request header property.

Syntax

__property String ReqParamsIfUnmodifiedSince = { read=FReqParamsIfUnmodifiedSince, write=FSetReqParamsIfUnmodifiedSince };

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

ReqParamsPassword Property (RESTClient Component)

Assign this property with the user's password.

Syntax

__property String ReqParamsPassword = { read=FReqParamsPassword, write=FSetReqParamsPassword };

Default Value

""

Remarks

Assign this property with the user's password.

This property is not available at design time.

Data Type

String

ReqParamsReferer Property (RESTClient Component)

The Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

Syntax

__property String ReqParamsReferer = { read=FReqParamsReferer, write=FSetReqParamsReferer };

Default Value

""

Remarks

The Referer field of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

This property is not available at design time.

Data Type

String

ReqParamsUserAgent Property (RESTClient Component)

The User-Agent property of the HTTP request provides information about the software that initiates the request.

Syntax

__property String ReqParamsUserAgent = { read=FReqParamsUserAgent, write=FSetReqParamsUserAgent };

Default Value

""

Remarks

The User-Agent field of the HTTP request provides information about the software that initiates the request.

This property is not available at design time.

Data Type

String

ReqParamsUsername Property (RESTClient Component)

Assign this property with the user's login name.

Syntax

__property String ReqParamsUsername = { read=FReqParamsUsername, write=FSetReqParamsUsername };

Default Value

""

Remarks

Assign this property with the user's login name.

This property is not available at design time.

Data Type

String

RespHeaderCount Property (RESTClient Component)

The number of records in the RespHeader arrays.

Syntax

__property int RespHeaderCount = { read=FRespHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• RespHeaderCategory
• RespHeaderFormat
• RespHeaderName
• RespHeaderValue

The array indices start at 0 and end at RespHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

RespHeaderCategory Property (RESTClient Component)

Specifies the string category of the contained value.

Syntax

__property String RespHeaderCategory[int RespHeaderIndex] = { read=FRespHeaderCategory };

Default Value

""

Remarks

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.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

RespHeaderFormat Property (RESTClient Component)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

__property int RespHeaderFormat[int RespHeaderIndex] = { read=FRespHeaderFormat };

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the RespHeaderValue 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: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only and not available at design time.

Data Type

Integer

RespHeaderName Property (RESTClient Component)

The name element in a (name, value) pair.

Syntax

__property String RespHeaderName[int RespHeaderIndex] = { read=FRespHeaderName };

Default Value

""

Remarks

The name element in a (name, value) pair.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

RespHeaderValue Property (RESTClient Component)

The value element in a (name, value) pair.

Syntax

__property String RespHeaderValue[int RespHeaderIndex] = { read=FRespHeaderValue };

Default Value

""

Remarks

The value element in a (name, value) pair.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

RespParamsContentLength Property (RESTClient Component)

Indicates the length of the response content in bytes.

Syntax

__property __int64 RespParamsContentLength = { read=FRespParamsContentLength };

Default Value

0

Remarks

Indicates the length of the response content in bytes.

This property is read-only and not available at design time.

Data Type

Long64

RespParamsDate Property (RESTClient Component)

The date and time at which the response was generated, in server time, in UTC.

Syntax

__property String RespParamsDate = { read=FRespParamsDate };

Default Value

""

Remarks

The date and time at which the response was generated, in server time, in UTC.

This property is read-only and not available at design time.

Data Type

String

RespParamsReasonPhrase Property (RESTClient Component)

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.

Syntax

__property String RespParamsReasonPhrase = { read=FRespParamsReasonPhrase };

Default Value

""

Remarks

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.

This property is read-only and not available at design time.

Data Type

String

RespParamsStatusCode Property (RESTClient Component)

The server-generated status code of the request processing status.

Syntax

__property int RespParamsStatusCode = { read=FRespParamsStatusCode };

Default Value

0

Remarks

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).

This property is read-only and not available at design time.

Data Type

Integer

ServerCertCount Property (RESTClient Component)

The number of records in the ServerCert arrays.

Syntax

__property int ServerCertCount = { read=FServerCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerCertBytes
• ServerCertCAKeyID
• ServerCertFingerprint
• ServerCertHandle
• ServerCertIssuer
• ServerCertIssuerRDN
• ServerCertKeyAlgorithm
• ServerCertKeyBits
• ServerCertKeyFingerprint
• ServerCertKeyUsage
• ServerCertPublicKeyBytes
• ServerCertSelfSigned
• ServerCertSerialNumber
• ServerCertSigAlgorithm
• ServerCertSubject
• ServerCertSubjectKeyID
• ServerCertSubjectRDN
• ServerCertValidFrom
• ServerCertValidTo

The array indices start at 0 and end at ServerCertCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ServerCertBytes Property (RESTClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray ServerCertBytes[int ServerCertIndex] = { read=FServerCertBytes };

Remarks

Returns the raw certificate data in DER format.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertCAKeyID Property (RESTClient Component)

A unique identifier (fingerprint) of the CA certificate's private key.

Syntax

__property DynamicArray ServerCertCAKeyID[int ServerCertIndex] = { read=FServerCertCAKeyID };

Remarks

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.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertFingerprint Property (RESTClient Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

__property DynamicArray ServerCertFingerprint[int ServerCertIndex] = { read=FServerCertFingerprint };

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertHandle Property (RESTClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 ServerCertHandle[int ServerCertIndex] = { read=FServerCertHandle };

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Long64

ServerCertIssuer Property (RESTClient Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String ServerCertIssuer[int ServerCertIndex] = { read=FServerCertIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertIssuerRDN Property (RESTClient Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

__property String ServerCertIssuerRDN[int ServerCertIndex] = { read=FServerCertIssuerRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertKeyAlgorithm Property (RESTClient Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String ServerCertKeyAlgorithm[int ServerCertIndex] = { read=FServerCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertKeyBits Property (RESTClient Component)

Returns the length of the public key.

Syntax

__property int ServerCertKeyBits[int ServerCertIndex] = { read=FServerCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

ServerCertKeyFingerprint Property (RESTClient Component)

Returns a fingerprint of the public key contained in the certificate.

Syntax

__property DynamicArray ServerCertKeyFingerprint[int ServerCertIndex] = { read=FServerCertKeyFingerprint };

Remarks

Returns a fingerprint of the public key contained in the certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertKeyUsage Property (RESTClient Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int ServerCertKeyUsage[int ServerCertIndex] = { read=FServerCertKeyUsage };

Default Value

0

Remarks

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:

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

ServerCertPublicKeyBytes Property (RESTClient Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray ServerCertPublicKeyBytes[int ServerCertIndex] = { read=FServerCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertSelfSigned Property (RESTClient Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

__property bool ServerCertSelfSigned[int ServerCertIndex] = { read=FServerCertSelfSigned };

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ServerCertSerialNumber Property (RESTClient Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray ServerCertSerialNumber[int ServerCertIndex] = { read=FServerCertSerialNumber };

Remarks

Returns the certificate's serial number.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertSigAlgorithm Property (RESTClient Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

__property String ServerCertSigAlgorithm[int ServerCertIndex] = { read=FServerCertSigAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertSubject Property (RESTClient Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

__property String ServerCertSubject[int ServerCertIndex] = { read=FServerCertSubject };

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertSubjectKeyID Property (RESTClient Component)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

__property DynamicArray ServerCertSubjectKeyID[int ServerCertIndex] = { read=FServerCertSubjectKeyID };

Remarks

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.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ServerCertSubjectRDN Property (RESTClient Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

__property String ServerCertSubjectRDN[int ServerCertIndex] = { read=FServerCertSubjectRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertValidFrom Property (RESTClient Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

__property String ServerCertValidFrom[int ServerCertIndex] = { read=FServerCertValidFrom };

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

ServerCertValidTo Property (RESTClient Component)

The time point at which the certificate expires, in UTC.

Syntax

__property String ServerCertValidTo[int ServerCertIndex] = { read=FServerCertValidTo };

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is read-only and not available at design time.

Data Type

String

SocketDNSMode Property (RESTClient Component)

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Syntax

__property TsbxRESTClientSocketDNSModes SocketDNSMode = { read=FSocketDNSMode, write=FSetSocketDNSMode };

enum TsbxRESTClientSocketDNSModes {
  dmAuto=0,
  dmPlatform=1,
  dmOwn=2,
  dmOwnSecure=3
};

Default Value

dmAuto

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

Integer

SocketDNSPort Property (RESTClient Component)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

__property int SocketDNSPort = { read=FSocketDNSPort, write=FSetSocketDNSPort };

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (RESTClient Component)

The timeout (in milliseconds) for each DNS query.

Syntax

__property int SocketDNSQueryTimeout = { read=FSocketDNSQueryTimeout, write=FSetSocketDNSQueryTimeout };

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketDNSServers Property (RESTClient Component)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

__property String SocketDNSServers = { read=FSocketDNSServers, write=FSetSocketDNSServers };

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (RESTClient Component)

The timeout (in milliseconds) for the whole resolution process.

Syntax

__property int SocketDNSTotalTimeout = { read=FSocketDNSTotalTimeout, write=FSetSocketDNSTotalTimeout };

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (RESTClient Component)

The maximum number of bytes to read from the socket, per second.

Syntax

__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (RESTClient Component)

The local network interface to bind the socket to.

Syntax

__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (RESTClient Component)

The local port number to bind the socket to.

Syntax

__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (RESTClient Component)

The maximum number of bytes to write to the socket, per second.

Syntax

__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (RESTClient Component)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };

Default Value

60000

Remarks

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).

Data Type

Integer

SocketUseIPv6 Property (RESTClient Component)

Enables or disables IP protocol version 6.

Syntax

__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

StatusCode Property (RESTClient Component)

Contains the Status Code element of the server's response.

Syntax

__property int StatusCode = { read=FStatusCode };

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 and not available at design time.

Data Type

Integer

TLSAutoValidateCertificates Property (RESTClient Component)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (RESTClient Component)

Selects the base configuration for the TLS settings.

Syntax

__property TsbxRESTClientTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };

enum TsbxRESTClientTLSBaseConfigurations {
  stpcDefault=0,
  stpcCompatible=1,
  stpcComprehensiveInsecure=2,
  stpcHighlySecure=3
};

Default Value

stpcDefault

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (RESTClient Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };

Default Value

""

Remarks

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, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. 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:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSECCurves Property (RESTClient Component)

Defines the elliptic curves to enable.

Syntax

__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (RESTClient Component)

Provides access to TLS extensions.

Syntax

__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (RESTClient Component)

Whether to force TLS session resumption when the destination address changes.

Syntax

__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (RESTClient Component)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (RESTClient Component)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };

Default Value

""

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (RESTClient Component)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (RESTClient Component)

Selects the renegotiation attack prevention mechanism.

Syntax

__property TsbxRESTClientTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };

enum TsbxRESTClientTLSRenegotiationAttackPreventionModes {
  crapmCompatible=0,
  crapmStrict=1,
  crapmAuto=2
};

Default Value

crapmCompatible

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (RESTClient Component)

Specifies the kind(s) of revocation check to perform.

Syntax

__property TsbxRESTClientTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };

enum TsbxRESTClientTLSRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

Remarks

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 for every certificate in the chain. 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 the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (RESTClient Component)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (RESTClient Component)

Specifies the TLS mode to use.

Syntax

__property TsbxRESTClientTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };

enum TsbxRESTClientTLSTLSModes {
  smDefault=0,
  smNoTLS=1,
  smExplicitTLS=2,
  smImplicitTLS=3,
  smMixedTLS=4
};

Default Value

smDefault

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (RESTClient Component)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };

Default Value

false

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (RESTClient Component)

Enables or disables the TLS session resumption capability.

Syntax

__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (RESTClient Component)

The SSL/TLS versions to enable by default.

Syntax

__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (RESTClient Component)

The number of records in the TrustedCert arrays.

Syntax

__property int TrustedCertCount = { read=FTrustedCertCount, write=FSetTrustedCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertBytes
• TrustedCertHandle

The array indices start at 0 and end at TrustedCertCount - 1.

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (RESTClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TrustedCertBytes[int TrustedCertIndex] = { read=FTrustedCertBytes };

Remarks

Returns the raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

TrustedCertHandle Property (RESTClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 TrustedCertHandle[int TrustedCertIndex] = { read=FTrustedCertHandle, write=FSetTrustedCertHandle };

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Long64

UseDigestAuth Property (RESTClient Component)

Enables or disables the HTTP Digest authentication.

Syntax

__property bool UseDigestAuth = { read=FUseDigestAuth, write=FSetUseDigestAuth };

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.

Data Type

Boolean

UseNTLMAuth Property (RESTClient Component)

Enables or disables NTLM authentication.

Syntax

__property bool UseNTLMAuth = { read=FUseNTLMAuth, write=FSetUseNTLMAuth };

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.

Data Type

Boolean

Config Method (RESTClient Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

Delete Method (RESTClient Component)

Sends a DELETE request to the server.

Syntax

void __fastcall Delete(String Url);

Remarks

Use this method to send a DELETE request to server. In response to this request, the server may (without any guarantees) delete the resource specified in Url. Most of the servers disable DELETE requests.

If this request fails, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

DoAction Method (RESTClient Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. 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 (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Get Method (RESTClient Component)

Sends a GET request to the server.

Syntax

void __fastcall Get(String Url);

Remarks

GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.

If the request is successful, the received content will be available in OutputBytes and OutputString properties. Otherwise an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

GetBytes Method (RESTClient Component)

Sends a GET request to the server and returns the output.

Syntax

DynamicArray<Byte> __fastcall GetBytes(String Url);

Remarks

GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.

If the request is successful, the method returns the received content. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

GetFile Method (RESTClient Component)

Sends a GET request to the server and saves the output to a file.

Syntax

void __fastcall GetFile(String Url, String Filename);

Remarks

GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.

If the request is successful, the received content will be saved to Filename. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Head Method (RESTClient Component)

Sends a HEAD request to the server.

Syntax

void __fastcall Head(String Url);

Remarks

HEAD is very similar to GET, with the only difference being that only the headers (but not the content) is returned.

HEAD is often use to retrieve the parameters of the resource, such as its size and modification date. If the request is successful, those details will be available via ResponseParameters and ResponseHeaders properties. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Options Method (RESTClient Component)

Sends an OPTIONS request to the server.

Syntax

void __fastcall Options(String Url);

Remarks

This request gets various information about the server such as supported HTTP methods. No content is included in the response.

Post Method (RESTClient Component)

Sends a POST request to the server.

Syntax

void __fastcall Post(String Url, String Content);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostBytes Method (RESTClient Component)

Sends a POST request to the server.

Syntax

void __fastcall PostBytes(String Url, DynamicArray<Byte> ContentBytes);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the data you need to send via the ContentBytes parameter. If content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostFile Method (RESTClient Component)

Sends a file to the server using a POST request.

Syntax

void __fastcall PostFile(String Url, String Filename);

Remarks

POST is used to send data to the remote HTTP endpoint/script. The content to send will be taken from Filename.

To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostJSON Method (RESTClient Component)

Sends a JSON POST request to the server.

Syntax

void __fastcall PostJSON(String Url, String Content);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the JSON data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a regular (non-JSON) data, use Post method. To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostWebForm Method (RESTClient Component)

Posts a web form data to the server.

Syntax

void __fastcall PostWebForm(String Url, String Fields, String FileField, String FileName, String ContentType);

Remarks

This variant of the POST method provides means to submit a form (as in a web browser) with an optional file attachment. Fields are expected to contain a list of field names and values in "Name=Value" format separated with EOLs. This list can be empty.

If including a file with your request, use the FileField and FileName properties to specify the file field name and the local filename for the uploaded file. Use ContentType to override the default content type chosen by the client, e.g., "application/x-www-form-urlencoded".

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostXML Method (RESTClient Component)

Posts an XML request to the server.

Syntax

void __fastcall PostXML(String Url, String Content);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the XML data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a regular (non-XML) data, use Post method. To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Put Method (RESTClient Component)

Sends a PUT request to the server.

Syntax

void __fastcall Put(String Url, String Content);

Remarks

PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.

If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutBytes Method (RESTClient Component)

Sends a PUT request to the server.

Syntax

void __fastcall PutBytes(String Url, DynamicArray<Byte> ContentBytes);

Remarks

PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.

If ContentBytes is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutFile Method (RESTClient Component)

Sends a file to the server using a PUT request.

Syntax

void __fastcall PutFile(String Url, String Filename);

Remarks

PUT is an alternative to POST and is used to send data to the remote HTTP endpoint/script. Many servers have this method switched off. The content to send will be taken from Filename.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutJSON Method (RESTClient Component)

PUTs a JSON to the server.

Syntax

void __fastcall PutJSON(String Url, String Content);

Remarks

PUT method is used to write data to the server.

If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

To PUT a regular (non-JSON) data, use Put method. To post JSON data, use PostJSON method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutXML Method (RESTClient Component)

PUTs an XML to the server.

Syntax

void __fastcall PutXML(String Url, String Content);

Remarks

PUT method is used to write data to the server.

If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

To PUT a regular (non-XML) data, use Put method. To post XML data, use PostXML method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Trace Method (RESTClient Component)

Sends a TRACE request to the server.

Syntax

void __fastcall Trace(String Url);

Remarks

TRACE is a debug command and is typically switched off and/or not supported by web servers.

Cookie Event (RESTClient Component)

Fired to report a received cookie.

Syntax

typedef struct {
  String CookieText;
} TsbxRESTClientCookieEventParams;
typedef void __fastcall (__closure *TsbxRESTClientCookieEvent)(System::TObject* Sender, TsbxRESTClientCookieEventParams *e);
__property TsbxRESTClientCookieEvent OnCookie = { read=FOnCookie, write=FOnCookie };

Remarks

The CookieText parameter contains the text of the cookie.

DocumentBegin Event (RESTClient Component)

Marks the start of the incoming HTML document or file.

Syntax

typedef struct {
} TsbxRESTClientDocumentBeginEventParams;
typedef void __fastcall (__closure *TsbxRESTClientDocumentBeginEvent)(System::TObject* Sender, TsbxRESTClientDocumentBeginEventParams *e);
__property TsbxRESTClientDocumentBeginEvent OnDocumentBegin = { read=FOnDocumentBegin, write=FOnDocumentBegin };

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 (RESTClient Component)

Marks the successful receipt of the incoming HTML document or file.

Syntax

typedef struct {
} TsbxRESTClientDocumentEndEventParams;
typedef void __fastcall (__closure *TsbxRESTClientDocumentEndEvent)(System::TObject* Sender, TsbxRESTClientDocumentEndEventParams *e);
__property TsbxRESTClientDocumentEndEvent OnDocumentEnd = { read=FOnDocumentEnd, write=FOnDocumentEnd };

Remarks

This event fires when the document has been received in full.

DynamicDataNeeded Event (RESTClient Component)

Requests a portion of data to be uploaded from the application.

Syntax

typedef struct {
  int BytesNeeded;
} TsbxRESTClientDynamicDataNeededEventParams;
typedef void __fastcall (__closure *TsbxRESTClientDynamicDataNeededEvent)(System::TObject* Sender, TsbxRESTClientDynamicDataNeededEventParams *e);
__property TsbxRESTClientDynamicDataNeededEvent OnDynamicDataNeeded = { read=FOnDynamicDataNeeded, write=FOnDynamicDataNeeded };

Remarks

If dynamic ('streaming') variants of PUT or POST methods are used, this event is fired periodically to request portions of data to be sent to the server.

When handling this event, assign the next portion of data of BytesNeeded length (or less) to DynamicData. If no more data is available to upload (the whole document has been sent), leave DynamicData empty.

Error Event (RESTClient Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxRESTClientErrorEventParams;
typedef void __fastcall (__closure *TsbxRESTClientErrorEvent)(System::TObject* Sender, TsbxRESTClientErrorEventParams *e);
__property TsbxRESTClientErrorEvent OnError = { read=FOnError, write=FOnError };

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 (RESTClient Component)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

typedef struct {
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxRESTClientExternalSignEventParams;
typedef void __fastcall (__closure *TsbxRESTClientExternalSignEvent)(System::TObject* Sender, TsbxRESTClientExternalSignEventParams *e);
__property TsbxRESTClientExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign };

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 the 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 contains algorithm-dependent parameters.

The component uses base16 (hex) encoding for the 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 the .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 (RESTClient Component)

Fires when the request headers have been formed and are about to be sent to the server.

Syntax

typedef struct {
} TsbxRESTClientHeadersPreparedEventParams;
typedef void __fastcall (__closure *TsbxRESTClientHeadersPreparedEvent)(System::TObject* Sender, TsbxRESTClientHeadersPreparedEventParams *e);
__property TsbxRESTClientHeadersPreparedEvent OnHeadersPrepared = { read=FOnHeadersPrepared, write=FOnHeadersPrepared };

Remarks

The prepared headers are available in RequestHeaders property. This event provides you the last chance to review/alter them.

HeadersReceived Event (RESTClient Component)

Fires when the HTTP response headers have just been received from the server.

Syntax

typedef struct {
} TsbxRESTClientHeadersReceivedEventParams;
typedef void __fastcall (__closure *TsbxRESTClientHeadersReceivedEvent)(System::TObject* Sender, TsbxRESTClientHeadersReceivedEventParams *e);
__property TsbxRESTClientHeadersReceivedEvent OnHeadersReceived = { read=FOnHeadersReceived, write=FOnHeadersReceived };

Remarks

The received headers are available via the ResponseHeaders property.

Notification Event (RESTClient Component)

This event notifies the application about an underlying control flow event.

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxRESTClientNotificationEventParams;
typedef void __fastcall (__closure *TsbxRESTClientNotificationEvent)(System::TObject* Sender, TsbxRESTClientNotificationEventParams *e);
__property TsbxRESTClientNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component 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 the 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 (RESTClient Component)

Fires periodically during the data transfer.

Syntax

typedef struct {
  __int64 Total;
  __int64 Current;
  bool Cancel;
} TsbxRESTClientProgressEventParams;
typedef void __fastcall (__closure *TsbxRESTClientProgressEvent)(System::TObject* Sender, TsbxRESTClientProgressEventParams *e);
__property TsbxRESTClientProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

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 (RESTClient Component)

Fires when the server suggests a redirect.

Syntax

typedef struct {
  String OldURL;
  String NewURL;
  bool AllowRedirection;
} TsbxRESTClientRedirectionEventParams;
typedef void __fastcall (__closure *TsbxRESTClientRedirectionEvent)(System::TObject* Sender, TsbxRESTClientRedirectionEventParams *e);
__property TsbxRESTClientRedirectionEvent OnRedirection = { read=FOnRedirection, write=FOnRedirection };

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 (RESTClient Component)

Fires when a remote TLS party requests a client certificate.

Syntax

typedef struct {
  String Host;
  String CANames;
} TsbxRESTClientTLSCertNeededEventParams;
typedef void __fastcall (__closure *TsbxRESTClientTLSCertNeededEvent)(System::TObject* Sender, TsbxRESTClientTLSCertNeededEventParams *e);
__property TsbxRESTClientTLSCertNeededEvent OnTLSCertNeeded = { read=FOnTLSCertNeeded, write=FOnTLSCertNeeded };

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 parameter (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 (RESTClient Component)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

typedef struct {
  String ServerHost;
  String ServerIP;
  bool Accept;
} TsbxRESTClientTLSCertValidateEventParams;
typedef void __fastcall (__closure *TsbxRESTClientTLSCertValidateEvent)(System::TObject* Sender, TsbxRESTClientTLSCertValidateEventParams *e);
__property TsbxRESTClientTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate };

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, 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 (RESTClient Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

typedef struct {
  String Host;
  String Version;
  String Ciphersuite;
  DynamicArray ConnectionId;
  bool Abort;
} TsbxRESTClientTLSEstablishedEventParams;
typedef void __fastcall (__closure *TsbxRESTClientTLSEstablishedEvent)(System::TObject* Sender, TsbxRESTClientTLSEstablishedEventParams *e);
__property TsbxRESTClientTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished };

Remarks

The component uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (RESTClient Component)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

typedef struct {
  String Host;
  bool Abort;
} TsbxRESTClientTLSHandshakeEventParams;
typedef void __fastcall (__closure *TsbxRESTClientTLSHandshakeEvent)(System::TObject* Sender, TsbxRESTClientTLSHandshakeEventParams *e);
__property TsbxRESTClientTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake };

Remarks

The component 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 by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (RESTClient Component)

Notifies the application about the PSK key exchange.

Syntax

typedef struct {
  String Host;
  String Hint;
} TsbxRESTClientTLSPSKEventParams;
typedef void __fastcall (__closure *TsbxRESTClientTLSPSKEvent)(System::TObject* Sender, TsbxRESTClientTLSPSKEventParams *e);
__property TsbxRESTClientTLSPSKEvent OnTLSPSK = { read=FOnTLSPSK, write=FOnTLSPSK };

Remarks

The component 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 (RESTClient Component)

Reports the graceful closure of a TLS connection.

Syntax

typedef struct {
  String Host;
} TsbxRESTClientTLSShutdownEventParams;
typedef void __fastcall (__closure *TsbxRESTClientTLSShutdownEvent)(System::TObject* Sender, TsbxRESTClientTLSShutdownEventParams *e);
__property TsbxRESTClientTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown };

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config Settings (RESTClient Component)

The component 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 component, access to these internal properties is provided through the Config method.

RESTClient Config Settings

Base Config Settings

Trappable Errors (RESTClient Component)

HTTPClient Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component 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)