WebDAVServer Component

Properties   Methods   Events   Config Settings   Errors  

The WebDAVServer component offers server-side functionality for the WebDAV protocol.

Syntax

TsbxWebDAVServer

Remarks

Both plain (HTTP) and secure (HTTPS) connection types are supported.

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.

Active Property (WebDAVServer Component)

Indicates whether the server is active and is listening to new connections.

Syntax

__property bool Active = { read=FActive };

Default Value

false

Remarks

This read-only property returns True if the server is listening to incoming connections.

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

Data Type

Boolean

AuthRealm Property (WebDAVServer Component)

Specifies authentication realm for digest and NTLM authentication.

Syntax

__property String AuthRealm = { read=FAuthRealm, write=FSetAuthRealm };

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

Data Type

String

AuthTypes Property (WebDAVServer Component)

Defines allowed HTTP authentication types.

Syntax

__property int AuthTypes = { read=FAuthTypes, write=FSetAuthTypes };

Default Value

0

Remarks

Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags:

Data Type

Integer

BoundPort Property (WebDAVServer Component)

Indicates the bound listening port.

Syntax

__property int BoundPort = { read=FBoundPort };

Default Value

0

Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals Port if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.

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

Data Type

Integer

ClientFileEntryATime Property (WebDAVServer Component)

Contains the last access time for this object, in UTC.

Syntax

__property String ClientFileEntryATime = { read=FClientFileEntryATime, write=FSetClientFileEntryATime };

Default Value

""

Remarks

Contains the last access time for this object, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryContentType Property (WebDAVServer Component)

The object's content type.

Syntax

__property String ClientFileEntryContentType = { read=FClientFileEntryContentType, write=FSetClientFileEntryContentType };

Default Value

""

Remarks

The object's content type.

This property is not available at design time.

Data Type

String

ClientFileEntryCTime Property (WebDAVServer Component)

Contains this object's creation time, in UTC.

Syntax

__property String ClientFileEntryCTime = { read=FClientFileEntryCTime, write=FSetClientFileEntryCTime };

Default Value

""

Remarks

Contains this object's creation time, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryDirectory Property (WebDAVServer Component)

Specifies whether this object is a directory.

Syntax

__property bool ClientFileEntryDirectory = { read=FClientFileEntryDirectory, write=FSetClientFileEntryDirectory };

Default Value

false

Remarks

Specifies whether this object is a directory.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryDisplayName Property (WebDAVServer Component)

Contains the display name of the object.

Syntax

__property String ClientFileEntryDisplayName = { read=FClientFileEntryDisplayName, write=FSetClientFileEntryDisplayName };

Default Value

""

Remarks

Contains the display name of the object.

This property is not available at design time.

Data Type

String

ClientFileEntryETag Property (WebDAVServer Component)

An e-tag of the object.

Syntax

__property String ClientFileEntryETag = { read=FClientFileEntryETag, write=FSetClientFileEntryETag };

Default Value

""

Remarks

An e-tag of the object.

This property is not available at design time.

Data Type

String

ClientFileEntryFullURL Property (WebDAVServer Component)

A full path to the object.

Syntax

__property String ClientFileEntryFullURL = { read=FClientFileEntryFullURL, write=FSetClientFileEntryFullURL };

Default Value

""

Remarks

A full path to the object.

This property is not available at design time.

Data Type

String

ClientFileEntryMTime Property (WebDAVServer Component)

The last modification time of the object, in UTC.

Syntax

__property String ClientFileEntryMTime = { read=FClientFileEntryMTime, write=FSetClientFileEntryMTime };

Default Value

""

Remarks

The last modification time of the object, in UTC.

This property is not available at design time.

Data Type

String

ClientFileEntryParentURL Property (WebDAVServer Component)

Specifies the object's parent URL.

Syntax

__property String ClientFileEntryParentURL = { read=FClientFileEntryParentURL, write=FSetClientFileEntryParentURL };

Default Value

""

Remarks

Specifies the object's parent URL.

This property is not available at design time.

Data Type

String

ClientFileEntrySize Property (WebDAVServer Component)

The size of the object in bytes.

Syntax

__property __int64 ClientFileEntrySize = { read=FClientFileEntrySize, write=FSetClientFileEntrySize };

Default Value

0

Remarks

The size of the object in bytes.

This property is not available at design time.

Data Type

Long64

ClientFileEntrySupportsExclusiveLock Property (WebDAVServer Component)

Indicates whether the entry supports exclusive locking.

Syntax

__property bool ClientFileEntrySupportsExclusiveLock = { read=FClientFileEntrySupportsExclusiveLock, write=FSetClientFileEntrySupportsExclusiveLock };

Default Value

false

Remarks

Indicates whether the entry supports exclusive locking.

This property is not available at design time.

Data Type

Boolean

ClientFileEntrySupportsSharedLock Property (WebDAVServer Component)

Indicates whether the entry supports shared lock.

Syntax

__property bool ClientFileEntrySupportsSharedLock = { read=FClientFileEntrySupportsSharedLock, write=FSetClientFileEntrySupportsSharedLock };

Default Value

false

Remarks

Indicates whether the entry supports shared lock.

This property is not available at design time.

Data Type

Boolean

ClientFileEntryURL Property (WebDAVServer Component)

A URL of the object.

Syntax

__property String ClientFileEntryURL = { read=FClientFileEntryURL, write=FSetClientFileEntryURL };

Default Value

""

Remarks

A URL of the object.

This property is not available at design time.

Data Type

String

DocumentRoot Property (WebDAVServer Component)

The document root of the server.

Syntax

__property String DocumentRoot = { read=FDocumentRoot, write=FSetDocumentRoot };

Default Value

""

Remarks

Use this property to specify a local folder which is going to be the server's document root (the mount point of the virtual home directory).

Data Type

String

ExternalCryptoAsyncDocumentID Property (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer Component)

Specifies the asynchronous signing method.

Syntax

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

enum TsbxWebDAVServerExternalCryptoMethods {
  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 (WebDAVServer Component)

Specifies the external cryptography mode.

Syntax

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

enum TsbxWebDAVServerExternalCryptoModes {
  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 (WebDAVServer 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 (WebDAVServer Component)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Host Property (WebDAVServer Component)

The host to bind the listening port to.

Syntax

__property String Host = { read=FHost, write=FSetHost };

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

Data Type

String

MetadataFlushTimeout Property (WebDAVServer Component)

Specifies metadata flush timeout.

Syntax

__property int MetadataFlushTimeout = { read=FMetadataFlushTimeout, write=FSetMetadataFlushTimeout };

Default Value

600

Remarks

Use this property to specify metadata flush timeout in seconds.

Data Type

Integer

MetadataRoot Property (WebDAVServer Component)

The metadata directory root.

Syntax

__property String MetadataRoot = { read=FMetadataRoot, write=FSetMetadataRoot };

Default Value

""

Remarks

The metadata directory is a dedicated location for storing properties of the files served by the WebDAVServer.

Data Type

String

PinnedClientAEADCipher Property (WebDAVServer Component)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

__property bool PinnedClientAEADCipher = { read=FPinnedClientAEADCipher };

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

PinnedClientChainValidationDetails Property (WebDAVServer Component)

The details of a certificate chain validation outcome.

Syntax

__property int PinnedClientChainValidationDetails = { read=FPinnedClientChainValidationDetails };

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

PinnedClientChainValidationResult Property (WebDAVServer Component)

The outcome of a certificate chain validation routine.

Syntax

__property TsbxWebDAVServerPinnedClientChainValidationResults PinnedClientChainValidationResult = { read=FPinnedClientChainValidationResult };

enum TsbxWebDAVServerPinnedClientChainValidationResults {
  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

PinnedClientCiphersuite Property (WebDAVServer Component)

The cipher suite employed by this connection.

Syntax

__property String PinnedClientCiphersuite = { read=FPinnedClientCiphersuite };

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

PinnedClientClientAuthenticated Property (WebDAVServer Component)

Specifies whether client authentication was performed during this connection.

Syntax

__property bool PinnedClientClientAuthenticated = { read=FPinnedClientClientAuthenticated };

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

PinnedClientClientAuthRequested Property (WebDAVServer Component)

Specifies whether client authentication was requested during this connection.

Syntax

__property bool PinnedClientClientAuthRequested = { read=FPinnedClientClientAuthRequested };

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

PinnedClientConnectionEstablished Property (WebDAVServer Component)

Indicates whether the connection has been established fully.

Syntax

__property bool PinnedClientConnectionEstablished = { read=FPinnedClientConnectionEstablished };

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

PinnedClientConnectionID Property (WebDAVServer Component)

The unique identifier assigned to this connection.

Syntax

__property DynamicArray PinnedClientConnectionID = { read=FPinnedClientConnectionID };

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

PinnedClientDigestAlgorithm Property (WebDAVServer Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

__property String PinnedClientDigestAlgorithm = { read=FPinnedClientDigestAlgorithm };

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

PinnedClientEncryptionAlgorithm Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientEncryptionAlgorithm = { read=FPinnedClientEncryptionAlgorithm };

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

PinnedClientExportable Property (WebDAVServer Component)

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

Syntax

__property bool PinnedClientExportable = { read=FPinnedClientExportable };

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

PinnedClientID Property (WebDAVServer Component)

The client connection's unique identifier.

Syntax

__property __int64 PinnedClientID = { read=FPinnedClientID };

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

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

Data Type

Long64

PinnedClientKeyExchangeAlgorithm Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientKeyExchangeAlgorithm = { read=FPinnedClientKeyExchangeAlgorithm };

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

PinnedClientKeyExchangeKeyBits Property (WebDAVServer Component)

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

Syntax

__property int PinnedClientKeyExchangeKeyBits = { read=FPinnedClientKeyExchangeKeyBits };

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

PinnedClientNamedECCurve Property (WebDAVServer Component)

The elliptic curve used in this connection.

Syntax

__property String PinnedClientNamedECCurve = { read=FPinnedClientNamedECCurve };

Default Value

""

Remarks

The elliptic curve used in this connection.

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

Data Type

String

PinnedClientPFSCipher Property (WebDAVServer Component)

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

Syntax

__property bool PinnedClientPFSCipher = { read=FPinnedClientPFSCipher };

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

PinnedClientPreSharedIdentity Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientPreSharedIdentity = { read=FPinnedClientPreSharedIdentity };

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientPreSharedIdentityHint Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientPreSharedIdentityHint = { read=FPinnedClientPreSharedIdentityHint };

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

PinnedClientPublicKeyBits Property (WebDAVServer Component)

The length of the public key.

Syntax

__property int PinnedClientPublicKeyBits = { read=FPinnedClientPublicKeyBits };

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

PinnedClientRemoteAddress Property (WebDAVServer Component)

The client's IP address.

Syntax

__property String PinnedClientRemoteAddress = { read=FPinnedClientRemoteAddress };

Default Value

""

Remarks

The client's IP address.

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

Data Type

String

PinnedClientRemotePort Property (WebDAVServer Component)

The remote port of the client connection.

Syntax

__property int PinnedClientRemotePort = { read=FPinnedClientRemotePort };

Default Value

0

Remarks

The remote port of the client connection.

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

Data Type

Integer

PinnedClientResumedSession Property (WebDAVServer Component)

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

Syntax

__property bool PinnedClientResumedSession = { read=FPinnedClientResumedSession };

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

PinnedClientSecureConnection Property (WebDAVServer Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

__property bool PinnedClientSecureConnection = { read=FPinnedClientSecureConnection };

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

PinnedClientServerAuthenticated Property (WebDAVServer Component)

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

Syntax

__property bool PinnedClientServerAuthenticated = { read=FPinnedClientServerAuthenticated };

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

PinnedClientSignatureAlgorithm Property (WebDAVServer Component)

The signature algorithm used in a TLS handshake.

Syntax

__property String PinnedClientSignatureAlgorithm = { read=FPinnedClientSignatureAlgorithm };

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

PinnedClientSymmetricBlockSize Property (WebDAVServer Component)

The block size of the symmetric algorithm used.

Syntax

__property int PinnedClientSymmetricBlockSize = { read=FPinnedClientSymmetricBlockSize };

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

PinnedClientSymmetricKeyBits Property (WebDAVServer Component)

The key length of the symmetric algorithm used.

Syntax

__property int PinnedClientSymmetricKeyBits = { read=FPinnedClientSymmetricKeyBits };

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

PinnedClientTotalBytesReceived Property (WebDAVServer Component)

The total number of bytes received over this connection.

Syntax

__property __int64 PinnedClientTotalBytesReceived = { read=FPinnedClientTotalBytesReceived };

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

PinnedClientTotalBytesSent Property (WebDAVServer Component)

The total number of bytes sent over this connection.

Syntax

__property __int64 PinnedClientTotalBytesSent = { read=FPinnedClientTotalBytesSent };

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

PinnedClientValidationLog Property (WebDAVServer Component)

Contains the server certificate's chain validation log.

Syntax

__property String PinnedClientValidationLog = { read=FPinnedClientValidationLog };

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

PinnedClientVersion Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientVersion = { read=FPinnedClientVersion };

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

PinnedClientCertCount Property (WebDAVServer Component)

The number of records in the PinnedClientCert arrays.

Syntax

__property int PinnedClientCertCount = { read=FPinnedClientCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedClientCertBytes
• PinnedClientCertCA
• PinnedClientCertCAKeyID
• PinnedClientCertCertType
• PinnedClientCertCRLDistributionPoints
• PinnedClientCertCurve
• PinnedClientCertFingerprint
• PinnedClientCertFriendlyName
• PinnedClientCertHandle
• PinnedClientCertHashAlgorithm
• PinnedClientCertIssuer
• PinnedClientCertIssuerRDN
• PinnedClientCertKeyAlgorithm
• PinnedClientCertKeyBits
• PinnedClientCertKeyFingerprint
• PinnedClientCertKeyUsage
• PinnedClientCertKeyValid
• PinnedClientCertOCSPLocations
• PinnedClientCertOCSPNoCheck
• PinnedClientCertOrigin
• PinnedClientCertPolicyIDs
• PinnedClientCertPrivateKeyBytes
• PinnedClientCertPrivateKeyExists
• PinnedClientCertPrivateKeyExtractable
• PinnedClientCertPublicKeyBytes
• PinnedClientCertQualified
• PinnedClientCertQualifiedStatements
• PinnedClientCertQualifiers
• PinnedClientCertSelfSigned
• PinnedClientCertSerialNumber
• PinnedClientCertSigAlgorithm
• PinnedClientCertSource
• PinnedClientCertSubject
• PinnedClientCertSubjectAlternativeName
• PinnedClientCertSubjectKeyID
• PinnedClientCertSubjectRDN
• PinnedClientCertValid
• PinnedClientCertValidFrom
• PinnedClientCertValidTo

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

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

Data Type

Integer

PinnedClientCertBytes Property (WebDAVServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray PinnedClientCertBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertBytes };

Remarks

Returns the raw certificate data in DER format.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertCA Property (WebDAVServer Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool PinnedClientCertCA[int PinnedClientCertIndex] = { read=FPinnedClientCertCA };

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertCAKeyID Property (WebDAVServer Component)

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

Syntax

__property DynamicArray PinnedClientCertCAKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertCAKeyID };

Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the PinnedClientCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertCertType Property (WebDAVServer Component)

Returns the type of the entity contained in the Certificate object.

Syntax

__property TsbxWebDAVServerPinnedClientCertCertTypes PinnedClientCertCertType[int PinnedClientCertIndex] = { read=FPinnedClientCertCertType };

enum TsbxWebDAVServerPinnedClientCertCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager component to load or create new certificate and certificate requests objects.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertCRLDistributionPoints Property (WebDAVServer Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

__property String PinnedClientCertCRLDistributionPoints[int PinnedClientCertIndex] = { read=FPinnedClientCertCRLDistributionPoints };

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertCurve Property (WebDAVServer Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

__property String PinnedClientCertCurve[int PinnedClientCertIndex] = { read=FPinnedClientCertCurve };

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertFingerprint Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientCertFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertFingerprint };

Default Value

""

Remarks

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertFriendlyName Property (WebDAVServer Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

__property String PinnedClientCertFriendlyName[int PinnedClientCertIndex] = { read=FPinnedClientCertFriendlyName };

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertHandle Property (WebDAVServer Component)

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

Syntax

__property __int64 PinnedClientCertHandle[int PinnedClientCertIndex] = { read=FPinnedClientCertHandle };

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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Long64

PinnedClientCertHashAlgorithm Property (WebDAVServer Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

__property String PinnedClientCertHashAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertHashAlgorithm };

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use PinnedClientCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertIssuer Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientCertIssuer[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via PinnedClientCertIssuerRDN.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertIssuerRDN Property (WebDAVServer Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

__property String PinnedClientCertIssuerRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuerRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyAlgorithm Property (WebDAVServer Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String PinnedClientCertKeyAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the PinnedClientCertKeyBits, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes properties to get more details about the key the certificate contains.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyBits Property (WebDAVServer Component)

Returns the length of the public key in bits.

Syntax

__property int PinnedClientCertKeyBits[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PinnedClientCertPublicKeyBytes or PinnedClientCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertKeyFingerprint Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientCertKeyFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyFingerprint };

Default Value

""

Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the PinnedClientCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyUsage Property (WebDAVServer Component)

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

Syntax

__property int PinnedClientCertKeyUsage[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyUsage };

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:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertKeyValid Property (WebDAVServer Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

__property bool PinnedClientCertKeyValid[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyValid };

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertOCSPLocations Property (WebDAVServer Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

__property String PinnedClientCertOCSPLocations[int PinnedClientCertIndex] = { read=FPinnedClientCertOCSPLocations };

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertOCSPNoCheck Property (WebDAVServer Component)

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

__property bool PinnedClientCertOCSPNoCheck[int PinnedClientCertIndex] = { read=FPinnedClientCertOCSPNoCheck };

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertOrigin Property (WebDAVServer Component)

Returns the location that the certificate was taken or loaded from.

Syntax

__property int PinnedClientCertOrigin[int PinnedClientCertIndex] = { read=FPinnedClientCertOrigin };

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertPolicyIDs Property (WebDAVServer Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String PinnedClientCertPolicyIDs[int PinnedClientCertIndex] = { read=FPinnedClientCertPolicyIDs };

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertPrivateKeyBytes Property (WebDAVServer Component)

Returns the certificate's private key in DER-encoded format.

Syntax

__property DynamicArray PinnedClientCertPrivateKeyBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertPrivateKeyBytes };

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertPrivateKeyExists Property (WebDAVServer Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

__property bool PinnedClientCertPrivateKeyExists[int PinnedClientCertIndex] = { read=FPinnedClientCertPrivateKeyExists };

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from PinnedClientCertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertPrivateKeyExtractable Property (WebDAVServer Component)

Indicates whether the private key is extractable (exportable).

Syntax

__property bool PinnedClientCertPrivateKeyExtractable[int PinnedClientCertIndex] = { read=FPinnedClientCertPrivateKeyExtractable };

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertPublicKeyBytes Property (WebDAVServer Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray PinnedClientCertPublicKeyBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertQualified Property (WebDAVServer Component)

Indicates whether the certificate is qualified.

Syntax

__property bool PinnedClientCertQualified[int PinnedClientCertIndex] = { read=FPinnedClientCertQualified };

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertQualifiedStatements Property (WebDAVServer Component)

Returns a simplified qualified status of the certificate.

Syntax

__property TsbxWebDAVServerPinnedClientCertQualifiedStatements PinnedClientCertQualifiedStatements[int PinnedClientCertIndex] = { read=FPinnedClientCertQualifiedStatements };

enum TsbxWebDAVServerPinnedClientCertQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

Remarks

Returns a simplified qualified status of the certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertQualifiers Property (WebDAVServer Component)

A list of qualifiers.

Syntax

__property String PinnedClientCertQualifiers[int PinnedClientCertIndex] = { read=FPinnedClientCertQualifiers };

Default Value

""

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertSelfSigned Property (WebDAVServer Component)

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

Syntax

__property bool PinnedClientCertSelfSigned[int PinnedClientCertIndex] = { read=FPinnedClientCertSelfSigned };

Default Value

false

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertSerialNumber Property (WebDAVServer Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray PinnedClientCertSerialNumber[int PinnedClientCertIndex] = { read=FPinnedClientCertSerialNumber };

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertSigAlgorithm Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientCertSigAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertSigAlgorithm };

Default Value

""

Remarks

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertSource Property (WebDAVServer Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

__property TsbxWebDAVServerPinnedClientCertSources PinnedClientCertSource[int PinnedClientCertIndex] = { read=FPinnedClientCertSource };

enum TsbxWebDAVServerPinnedClientCertSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertSubject Property (WebDAVServer 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 PinnedClientCertSubject[int PinnedClientCertIndex] = { read=FPinnedClientCertSubject };

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. This is part of a larger set of credentials available via PinnedClientCertSubjectRDN.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertSubjectAlternativeName Property (WebDAVServer Component)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

__property String PinnedClientCertSubjectAlternativeName[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectAlternativeName };

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main PinnedClientCertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertSubjectKeyID Property (WebDAVServer Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

__property DynamicArray PinnedClientCertSubjectKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectKeyID };

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The PinnedClientCertSubjectKeyID and PinnedClientCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertSubjectRDN Property (WebDAVServer Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

__property String PinnedClientCertSubjectRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertValid Property (WebDAVServer Component)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

__property bool PinnedClientCertValid[int PinnedClientCertIndex] = { read=FPinnedClientCertValid };

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertValidFrom Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientCertValidFrom[int PinnedClientCertIndex] = { read=FPinnedClientCertValidFrom };

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertValidTo Property (WebDAVServer Component)

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

Syntax

__property String PinnedClientCertValidTo[int PinnedClientCertIndex] = { read=FPinnedClientCertValidTo };

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

Port Property (WebDAVServer Component)

Specifies the port number to listen for connections on.

Syntax

__property int Port = { read=FPort, write=FSetPort };

Default Value

80

Remarks

Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.

Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and repored in BoundPort.

Data Type

Integer

PortRangeFrom Property (WebDAVServer Component)

Specifies the lower limit of the listening port range for incoming connections.

Syntax

__property int PortRangeFrom = { read=FPortRangeFrom, write=FSetPortRangeFrom };

Default Value

0

Remarks

Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and repored in BoundPort.

Data Type

Integer

PortRangeTo Property (WebDAVServer Component)

Specifies the upper limit of the listening port range for incoming connections.

Syntax

__property int PortRangeTo = { read=FPortRangeTo, write=FSetPortRangeTo };

Default Value

0

Remarks

Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and repored in BoundPort.

Data Type

Integer

SocketIncomingSpeedLimit Property (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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

TLSServerCertCount Property (WebDAVServer Component)

The number of records in the TLSServerCert arrays.

Syntax

__property int TLSServerCertCount = { read=FTLSServerCertCount, write=FSetTLSServerCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSServerCertBytes Property (WebDAVServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes };

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertHandle Property (WebDAVServer Component)

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

Syntax

__property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle, write=FSetTLSServerCertHandle };

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 TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is not available at design time.

Data Type

Long64

TLSAutoValidateCertificates Property (WebDAVServer 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 (WebDAVServer Component)

Selects the base configuration for the TLS settings.

Syntax

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

enum TsbxWebDAVServerTLSBaseConfigurations {
  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 (WebDAVServer 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

TLSClientAuth Property (WebDAVServer Component)

Enables or disables certificate-based client authentication.

Syntax

__property TsbxWebDAVServerTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth };

enum TsbxWebDAVServerTLSClientAuths {
  ccatNoAuth=0,
  ccatRequestCert=1,
  ccatRequireCert=2
};

Default Value

ccatNoAuth

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

Integer

TLSECCurves Property (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer Component)

Selects the renegotiation attack prevention mechanism.

Syntax

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

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

Default Value

crapmAuto

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (WebDAVServer Component)

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

Syntax

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

enum TsbxWebDAVServerTLSRevocationChecks {
  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 (WebDAVServer 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 (WebDAVServer Component)

Specifies the TLS mode to use.

Syntax

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

enum TsbxWebDAVServerTLSTLSModes {
  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 (WebDAVServer 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 (WebDAVServer 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 (WebDAVServer 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

UserCount Property (WebDAVServer Component)

The number of records in the User arrays.

Syntax

__property int UserCount = { read=FUserCount, write=FSetUserCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCertificate
• UserData
• UserEmail
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOtpAlgorithm
• UserOTPLen
• UserOtpValue
• UserOutgoingSpeedLimit
• UserPassword
• UserSharedSecret
• UserSSHKey
• UserUsername

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (WebDAVServer Component)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

__property DynamicArray UserAssociatedData[int UserIndex] = { read=FUserAssociatedData, write=FSetUserAssociatedData };

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (WebDAVServer Component)

Base path for this user in the server's file system.

Syntax

__property String UserBasePath[int UserIndex] = { read=FUserBasePath, write=FSetUserBasePath };

Default Value

""

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserCertificate Property (WebDAVServer Component)

Contains the user's certificate.

Syntax

__property DynamicArray UserCertificate[int UserIndex] = { read=FUserCertificate, write=FSetUserCertificate };

Remarks

Contains the user's certificate.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserData Property (WebDAVServer Component)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

__property String UserData[int UserIndex] = { read=FUserData, write=FSetUserData };

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserEmail Property (WebDAVServer Component)

The user's email address.

Syntax

__property String UserEmail[int UserIndex] = { read=FUserEmail, write=FSetUserEmail };

Default Value

""

Remarks

The user's email address.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserHandle Property (WebDAVServer Component)

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

Syntax

__property __int64 UserHandle[int UserIndex] = { read=FUserHandle, write=FSetUserHandle };

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 UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (WebDAVServer Component)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

__property String UserHashAlgorithm[int UserIndex] = { read=FUserHashAlgorithm, write=FSetUserHashAlgorithm };

Default Value

""

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (WebDAVServer Component)

Specifies the incoming speed limit for this user.

Syntax

__property int UserIncomingSpeedLimit[int UserIndex] = { read=FUserIncomingSpeedLimit, write=FSetUserIncomingSpeedLimit };

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOtpAlgorithm Property (WebDAVServer Component)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Syntax

__property TsbxWebDAVServerUserOtpAlgorithms UserOtpAlgorithm[int UserIndex] = { read=FUserOtpAlgorithm, write=FSetUserOtpAlgorithm };

enum TsbxWebDAVServerUserOtpAlgorithms {
  oaNone=0,
  oaHmac=1,
  oaTime=2
};

Default Value

oaNone

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOTPLen Property (WebDAVServer Component)

Specifies the length of the user's OTP password.

Syntax

__property int UserOTPLen[int UserIndex] = { read=FUserOTPLen, write=FSetUserOTPLen };

Default Value

0

Remarks

Specifies the length of the user's OTP password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOtpValue Property (WebDAVServer Component)

The user's time interval (TOTP) or Counter (HOTP).

Syntax

__property int UserOtpValue[int UserIndex] = { read=FUserOtpValue, write=FSetUserOtpValue };

Default Value

0

Remarks

The user's time interval (TOTP) or Counter (HOTP).

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (WebDAVServer Component)

Specifies the outgoing speed limit for this user.

Syntax

__property int UserOutgoingSpeedLimit[int UserIndex] = { read=FUserOutgoingSpeedLimit, write=FSetUserOutgoingSpeedLimit };

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserPassword Property (WebDAVServer Component)

The user's authentication password.

Syntax

__property String UserPassword[int UserIndex] = { read=FUserPassword, write=FSetUserPassword };

Default Value

""

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserSharedSecret Property (WebDAVServer Component)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

__property DynamicArray UserSharedSecret[int UserIndex] = { read=FUserSharedSecret, write=FSetUserSharedSecret };

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserSSHKey Property (WebDAVServer Component)

Contains the user's SSH key.

Syntax

__property DynamicArray UserSSHKey[int UserIndex] = { read=FUserSSHKey, write=FSetUserSSHKey };

Remarks

Contains the user's SSH key.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (WebDAVServer Component)

The registered name (login) of the user.

Syntax

__property String UserUsername[int UserIndex] = { read=FUserUsername, write=FSetUserUsername };

Default Value

""

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

WebsiteName Property (WebDAVServer Component)

Specifies the web site name to use in the certificate.

Syntax

__property String WebsiteName = { read=FWebsiteName, write=FSetWebsiteName };

Default Value

"SecureBlackbox"

Remarks

If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.

Data Type

String

Cleanup Method (WebDAVServer Component)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

void __fastcall Cleanup();

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

Config Method (WebDAVServer 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.

DoAction Method (WebDAVServer 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;....

Common ActionIDs:

DropClient Method (WebDAVServer Component)

Terminates a client connection.

Syntax

void __fastcall DropClient(__int64 ConnectionId, bool Forced);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetClientBuffer Method (WebDAVServer Component)

Obtains a pending connection buffer.

Syntax

DynamicArray<Byte> __fastcall GetClientBuffer(__int64 ConnectionID);

Remarks

Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.

GetRequestBytes Method (WebDAVServer Component)

Returns the contents of the client's HTTP request.

Syntax

DynamicArray<Byte> __fastcall GetRequestBytes(__int64 ConnectionId, String RequestFilter);

Remarks

Use this method to get the body of the client's HTTP request in your CustomRequest event handler. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

The RequestFilter parameter allows you to select the element(s) that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestHeader Method (WebDAVServer Component)

Returns a request header value.

Syntax

String __fastcall GetRequestHeader(__int64 ConnectionId, String HeaderName);

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as BeforeLockObject or CustomRequest.

GetRequestString Method (WebDAVServer Component)

Returns the contents of the client's HTTP request.

Syntax

String __fastcall GetRequestString(__int64 ConnectionId, String RequestFilter);

Remarks

Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty.

The RequestFilter parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestUsername Method (WebDAVServer Component)

Returns the username for a connection.

Syntax

String __fastcall GetRequestUsername(__int64 ConnectionId);

Remarks

Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the connection.

GetResponseHeader Method (WebDAVServer Component)

Returns a response header value.

Syntax

String __fastcall GetResponseHeader(__int64 ConnectionId, String HeaderName);

Remarks

Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.

ListClients Method (WebDAVServer Component)

Enumerates the connected clients.

Syntax

String __fastcall ListClients();

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (WebDAVServer Component)

Takes a snapshot of the connection's properties.

Syntax

void __fastcall PinClient(__int64 ConnectionId);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

ProcessGenericRequest Method (WebDAVServer Component)

Processes a generic HTTP request.

Syntax

DynamicArray<Byte> __fastcall ProcessGenericRequest(__int64 ConnectionId, DynamicArray<Byte> RequestBytes);

Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. ConnectionId allows to identify the request in the events.

The method returns the complete HTTP response including HTTP headers.

Reset Method (WebDAVServer Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

SetClientBuffer Method (WebDAVServer Component)

Commits a data buffer to the connection.

Syntax

void __fastcall SetClientBuffer(__int64 ConnectionID, DynamicArray<Byte> Value);

Remarks

Use this method from your ReadFile event handler to commit a chunk of file data to the server component.

SetClientFileEntry Method (WebDAVServer Component)

Commits a file entry to the connection.

Syntax

void __fastcall SetClientFileEntry(__int64 ConnectionID);

Remarks

Use this method to commit a file details entry provided in ClientFileEntry property to ConnectionID connection. This method is supposed to be used from a FindNext event handler.

Please note that events like FindNext may be invoked concurrently for several connection threads. Please make sure you use a locking mechanism to avoid mixing up details in ClientFileEntry.

SetResponseBytes Method (WebDAVServer Component)

Sets a byte array to be served as a response.

Syntax

void __fastcall SetResponseBytes(__int64 ConnectionId, DynamicArray<Byte> Bytes, String ContentType, String ResponseFilter);

Remarks

Use this property to provide the response content in a byte array when serving custom requests in your CustomRequest handler. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseFile Method (WebDAVServer Component)

Sets a file to be served as a response.

Syntax

void __fastcall SetResponseFile(__int64 ConnectionId, String FileName, String ContentType, String ResponseFilter);

Remarks

Use this property to provide the response content in a file. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseHeader Method (WebDAVServer Component)

Sets a response header.

Syntax

void __fastcall SetResponseHeader(__int64 ConnectionId, String HeaderName, String Value);

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as LockObject or CustomRequest.

SetResponseStatus Method (WebDAVServer Component)

Sets an HTTP status to be sent with the response.

Syntax

void __fastcall SetResponseStatus(__int64 ConnectionId, int StatusCode);

Remarks

Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as CustomRequest.

SetResponseString Method (WebDAVServer Component)

Sets a string to be served as a response.

Syntax

void __fastcall SetResponseString(__int64 ConnectionId, String DataStr, String ContentType, String ResponseFilter);

Remarks

Use this property to provide the response content in a string. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

Start Method (WebDAVServer Component)

Starts the server.

Syntax

void __fastcall Start();

Remarks

Use this method to activate the server and start listening to incoming connections.

Stop Method (WebDAVServer Component)

Stops the server.

Syntax

void __fastcall Stop();

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

Accept Event (WebDAVServer Component)

Reports an incoming connection.

Syntax

typedef struct {
  String RemoteAddress;
  int RemotePort;
  bool Accept;
} TsbxWebDAVServerAcceptEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAcceptEvent)(System::TObject* Sender, TsbxWebDAVServerAcceptEventParams *e);
__property TsbxWebDAVServerAcceptEvent OnAccept = { read=FOnAccept, write=FOnAccept };

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

AfterBrowse Event (WebDAVServer Component)

WebDAVServer uses this event to notify the application about the completion of the browsing operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerAfterBrowseEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterBrowseEvent)(System::TObject* Sender, TsbxWebDAVServerAfterBrowseEventParams *e);
__property TsbxWebDAVServerAfterBrowseEvent OnAfterBrowse = { read=FOnAfterBrowse, write=FOnAfterBrowse };

Remarks

The ConnectionID parameter identifies the client connection, and the Path parameter specifies the browsing path.

This event is typically fired after the BeforeBrowse event.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCopyObject Event (WebDAVServer Component)

This event notifies the application about the completion of the copy operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OldPath;
  String NewPath;
  int OperationStatus;
} TsbxWebDAVServerAfterCopyObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterCopyObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterCopyObjectEventParams *e);
__property TsbxWebDAVServerAfterCopyObjectEvent OnAfterCopyObject = { read=FOnAfterCopyObject, write=FOnAfterCopyObject };

Remarks

AfterCopyObject is typically preceded by BeforeCopyObject and CopyObject events. The OldPath and NewPath parameters contain the origin and destination names of the copied object.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCreateCalendar Event (WebDAVServer Component)

This event reports the completion of calendar creation request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerAfterCreateCalendarEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterCreateCalendarEvent)(System::TObject* Sender, TsbxWebDAVServerAfterCreateCalendarEventParams *e);
__property TsbxWebDAVServerAfterCreateCalendarEvent OnAfterCreateCalendar = { read=FOnAfterCreateCalendar, write=FOnAfterCreateCalendar };

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCreateCollection Event (WebDAVServer Component)

WebDAVServer uses this event to report completion of the collection creation operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerAfterCreateCollectionEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterCreateCollectionEvent)(System::TObject* Sender, TsbxWebDAVServerAfterCreateCollectionEventParams *e);
__property TsbxWebDAVServerAfterCreateCollectionEvent OnAfterCreateCollection = { read=FOnAfterCreateCollection, write=FOnAfterCreateCollection };

Remarks

This event is preceded by BeforeCreateCollection and CreateCollection events. It lets you alter the operation status passed back to the client.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCustomRequest Event (WebDAVServer Component)

This event reports the completion of the custom request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String RequestMethod;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerAfterCustomRequestEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterCustomRequestEvent)(System::TObject* Sender, TsbxWebDAVServerAfterCustomRequestEventParams *e);
__property TsbxWebDAVServerAfterCustomRequestEvent OnAfterCustomRequest = { read=FOnAfterCustomRequest, write=FOnAfterCustomRequest };

Remarks

Use this event to track the completion of an earlier reported custom request and adjust the operation status through the OperationStatus parameter as required.

AfterLockObject Event (WebDAVServer Component)

Reports the completion of the object locking operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerAfterLockObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterLockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterLockObjectEventParams *e);
__property TsbxWebDAVServerAfterLockObjectEvent OnAfterLockObject = { read=FOnAfterLockObject, write=FOnAfterLockObject };

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRefreshLock Event (WebDAVServer Component)

Reports the completion of the lock refresh operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerAfterRefreshLockEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterRefreshLockEvent)(System::TObject* Sender, TsbxWebDAVServerAfterRefreshLockEventParams *e);
__property TsbxWebDAVServerAfterRefreshLockEvent OnAfterRefreshLock = { read=FOnAfterRefreshLock, write=FOnAfterRefreshLock };

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveObject Event (WebDAVServer Component)

This event notifies the application about the completion of object deletion operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerAfterRemoveObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterRemoveObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterRemoveObjectEventParams *e);
__property TsbxWebDAVServerAfterRemoveObjectEvent OnAfterRemoveObject = { read=FOnAfterRemoveObject, write=FOnAfterRemoveObject };

Remarks

This event follows BeforeRemoveObject and RemoveObject events. It is fired upon completion of the operation and lets you adjust the operation status if required:

AfterRenameObject Event (WebDAVServer Component)

The component uses this event to notify the application about the completion of the object rename operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OldPath;
  String NewPath;
  int OperationStatus;
} TsbxWebDAVServerAfterRenameObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterRenameObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterRenameObjectEventParams *e);
__property TsbxWebDAVServerAfterRenameObjectEvent OnAfterRenameObject = { read=FOnAfterRenameObject, write=FOnAfterRenameObject };

Remarks

The OldPath and NewPath provide the old and new path of the renamed object respectively.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterSetAttributes Event (WebDAVServer Component)

WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerAfterSetAttributesEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterSetAttributesEvent)(System::TObject* Sender, TsbxWebDAVServerAfterSetAttributesEventParams *e);
__property TsbxWebDAVServerAfterSetAttributesEvent OnAfterSetAttributes = { read=FOnAfterSetAttributes, write=FOnAfterSetAttributes };

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterUnlockObject Event (WebDAVServer Component)

Notifies the application about the completion of the object unlocking operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerAfterUnlockObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAfterUnlockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterUnlockObjectEventParams *e);
__property TsbxWebDAVServerAfterUnlockObjectEvent OnAfterUnlockObject = { read=FOnAfterUnlockObject, write=FOnAfterUnlockObject };

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AuthAttempt Event (WebDAVServer Component)

Fires when a connected client makes an authentication attempt.

Syntax

typedef struct {
  __int64 ConnectionID;
  String HTTPMethod;
  String URI;
  String AuthMethod;
  String Username;
  String Password;
  bool Allow;
} TsbxWebDAVServerAuthAttemptEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerAuthAttemptEvent)(System::TObject* Sender, TsbxWebDAVServerAuthAttemptEventParams *e);
__property TsbxWebDAVServerAuthAttemptEvent OnAuthAttempt = { read=FOnAuthAttempt, write=FOnAuthAttempt };

Remarks

The component fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.

ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.

BeforeBrowse Event (WebDAVServer Component)

Fires when a Browse request is received.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeBrowseEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeBrowseEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeBrowseEventParams *e);
__property TsbxWebDAVServerBeforeBrowseEvent OnBeforeBrowse = { read=FOnBeforeBrowse, write=FOnBeforeBrowse };

Remarks

The component uses this event to notify the application that a Browse request has been received from the client. The Path parameter contains the path parameter from the request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a series of events that request the details of the object residing at Path: ListAttributes, ListSubObjects, and ReadAttribute.

BeforeCopyObject Event (WebDAVServer Component)

Fires when a Copy Object request is received.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OldPath;
  String NewPath;
  int Action;
} TsbxWebDAVServerBeforeCopyObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeCopyObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeCopyObjectEventParams *e);
__property TsbxWebDAVServerBeforeCopyObjectEvent OnBeforeCopyObject = { read=FOnBeforeCopyObject, write=FOnBeforeCopyObject };

Remarks

The component fires this event to notify the application that a Copy Object request was received. The OldPath and NewPath parameters specify the source and destination paths for the object to be copied. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a CopyObject call, allowing you to virtualize the copy operation.

BeforeCreateCalendar Event (WebDAVServer Component)

Fires when a Create Calendar request is received from a client.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeCreateCalendarEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeCreateCalendarEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeCreateCalendarEventParams *e);
__property TsbxWebDAVServerBeforeCreateCalendarEvent OnBeforeCreateCalendar = { read=FOnBeforeCreateCalendar, write=FOnBeforeCreateCalendar };

Remarks

The component fires this event to notify the application about a received Create Calendar request. The Path parameter specifies the location of the new calendar. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a CreateCalendar call, allowing you to virtualize the calendar creation operation.

BeforeCreateCollection Event (WebDAVServer Component)

Fires when a Create Collection request is received from a client.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeCreateCollectionEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeCreateCollectionEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeCreateCollectionEventParams *e);
__property TsbxWebDAVServerBeforeCreateCollectionEvent OnBeforeCreateCollection = { read=FOnBeforeCreateCollection, write=FOnBeforeCreateCollection };

Remarks

The component uses this event to notify the application about an incoming collection creation request. The Path parameter advises on the location of the new collection. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a CreateCollection call.

BeforeCustomRequest Event (WebDAVServer Component)

Notifies the application about an incoming custom request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String RequestMethod;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeCustomRequestEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeCustomRequestEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeCustomRequestEventParams *e);
__property TsbxWebDAVServerBeforeCustomRequestEvent OnBeforeCustomRequest = { read=FOnBeforeCustomRequest, write=FOnBeforeCustomRequest };

Remarks

The component uses this event to notify the user code about an incoming custom request (a generic request, unknown to the server, and not covered by the other handlers). The RequestMethod parameter specifies the HTTP request method used (GET, POST, PUT, ...), and Path indicates the requested path. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a CustomRequest call, allowing you to respond to the request.

BeforeDownloadObject Event (WebDAVServer Component)

Fires when an object download request is received.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeDownloadObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeDownloadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeDownloadObjectEventParams *e);
__property TsbxWebDAVServerBeforeDownloadObjectEvent OnBeforeDownloadObject = { read=FOnBeforeDownloadObject, write=FOnBeforeDownloadObject };

Remarks

The component fires this event to notify the application about an incoming object download request. The Path parameter contains the path of the requested object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by DownloadObject, ReadObject, and DownloadObjectCompleted calls, allowing you to supply the object data to the client.

BeforeLockObject Event (WebDAVServer Component)

Fires when a lock request is received.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeLockObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeLockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeLockObjectEventParams *e);
__property TsbxWebDAVServerBeforeLockObjectEvent OnBeforeLockObject = { read=FOnBeforeLockObject, write=FOnBeforeLockObject };

Remarks

The component uses this event to notify the application that an object lock request was received. The Path parameter contains the path to be locked. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a LockObject call which expects you to perform the locking as required.

BeforeRefreshLock Event (WebDAVServer Component)

Reports the receipt of lock refresh request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeRefreshLockEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeRefreshLockEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeRefreshLockEventParams *e);
__property TsbxWebDAVServerBeforeRefreshLockEvent OnBeforeRefreshLock = { read=FOnBeforeRefreshLock, write=FOnBeforeRefreshLock };

Remarks

Use this event to be notified about refresh requests for existing locks. The Path parameter contains the path on which to refresh the lock. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a RefreshLock call, allowing you to virtualize the operation.

BeforeRemoveObject Event (WebDAVServer Component)

Fires when an object deletion request is received.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeRemoveObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeRemoveObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeRemoveObjectEventParams *e);
__property TsbxWebDAVServerBeforeRemoveObjectEvent OnBeforeRemoveObject = { read=FOnBeforeRemoveObject, write=FOnBeforeRemoveObject };

Remarks

Use this event to track object deletion requests. The Path parameter contains the path of the object to be deleted. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a RemoveObject call, allowing you to virtualize the deletion operation.

BeforeRenameObject Event (WebDAVServer Component)

Reports object renaming requests.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OldPath;
  String NewPath;
  int Action;
} TsbxWebDAVServerBeforeRenameObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeRenameObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeRenameObjectEventParams *e);
__property TsbxWebDAVServerBeforeRenameObjectEvent OnBeforeRenameObject = { read=FOnBeforeRenameObject, write=FOnBeforeRenameObject };

Remarks

The server uses this event to notify the application about incoming object rename requests. OldPath and NewPath contain the existing and the new path for the object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a RenameObject call, where your code is expected to perform the renaming operation.

BeforeRequest Event (WebDAVServer Component)

Fires before a DAV request is processed.

Syntax

typedef struct {
  __int64 ConnectionID;
  String HTTPMethod;
  String URL;
  bool Accept;
} TsbxWebDAVServerBeforeRequestEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeRequestEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeRequestEventParams *e);
__property TsbxWebDAVServerBeforeRequestEvent OnBeforeRequest = { read=FOnBeforeRequest, write=FOnBeforeRequest };

Remarks

This event fires before an incoming request is processed. ConnectionID indicates the client's unique connection ID; HTTPMethod specifies the HTTP method being used to submit the request, and URL signifies the object's URL.

Use Accept parameter to accept or reject the request.

BeforeSetAttributes Event (WebDAVServer Component)

Notifies the application about attribute change request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeSetAttributesEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeSetAttributesEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeSetAttributesEventParams *e);
__property TsbxWebDAVServerBeforeSetAttributesEvent OnBeforeSetAttributes = { read=FOnBeforeSetAttributes, write=FOnBeforeSetAttributes };

Remarks

Use this event to react to object attributes change requests. The Path parameter contains the object path. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a series of SetAttribute and/or ClearAttribute calls, for each attribute to be set or cleared.

BeforeUnlockObject Event (WebDAVServer Component)

Fires when an unlock request is received.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeUnlockObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeUnlockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeUnlockObjectEventParams *e);
__property TsbxWebDAVServerBeforeUnlockObjectEvent OnBeforeUnlockObject = { read=FOnBeforeUnlockObject, write=FOnBeforeUnlockObject };

Remarks

The component uses this event to notify the application about the received unlock request. The Path parameter contains the path to be unlocked. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by a UnlockObject call.

BeforeUploadObject Event (WebDAVServer Component)

Fires when an object upload request is received.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int Action;
} TsbxWebDAVServerBeforeUploadObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerBeforeUploadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeUploadObjectEventParams *e);
__property TsbxWebDAVServerBeforeUploadObjectEvent OnBeforeUploadObject = { read=FOnBeforeUploadObject, write=FOnBeforeUploadObject };

Remarks

The component fires this event to notify the application about an incoming object upload request. The Path parameter contains the path of the requested object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

If fraCustom Action is chosen, this event will be followed by UploadObject, WriteObject, and UploadObjectCompleted calls, allowing your code to process/store the object data.

ClearAttribute Event (WebDAVServer Component)

Reports an attribute clearance request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  String NS;
  String Name;
  int OperationStatus;
} TsbxWebDAVServerClearAttributeEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerClearAttributeEvent)(System::TObject* Sender, TsbxWebDAVServerClearAttributeEventParams *e);
__property TsbxWebDAVServerClearAttributeEvent OnClearAttribute = { read=FOnClearAttribute, write=FOnClearAttribute };

Remarks

This event fires to notify the application about an attribute clearance (removal) request. Use this handler to respond to this request by making the necessary changes to the locally stored resource attributes. The ConnectionID specifies the unique client ID, Path contains the resource path, and the NS:Name pair specifies the attribute to be cleared.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

Connect Event (WebDAVServer Component)

Reports an accepted connection.

Syntax

typedef struct {
  __int64 ConnectionID;
  String RemoteAddress;
  int RemotePort;
} TsbxWebDAVServerConnectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerConnectEvent)(System::TObject* Sender, TsbxWebDAVServerConnectEventParams *e);
__property TsbxWebDAVServerConnectEvent OnConnect = { read=FOnConnect, write=FOnConnect };

Remarks

component fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as GetRequest or AuthAttempt.

CopyObject Event (WebDAVServer Component)

Lets the application handle the Copy Object request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OldPath;
  String NewPath;
  bool Overwrite;
  int Depth;
  int OperationStatus;
} TsbxWebDAVServerCopyObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerCopyObjectEvent)(System::TObject* Sender, TsbxWebDAVServerCopyObjectEventParams *e);
__property TsbxWebDAVServerCopyObjectEvent OnCopyObject = { read=FOnCopyObject, write=FOnCopyObject };

Remarks

Use this event handler to respond to the received Copy Object request by creating a copy of OldPath resource at NewPath.

ConnectionID specifies the unique client connection identifier, Overwrite indicates whether any existing resource(s) should be overwritten, and Depth specifies the depth of the resource tree to be copied.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

CreateCalendar Event (WebDAVServer Component)

Lets the application handle a calendar creation request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerCreateCalendarEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerCreateCalendarEvent)(System::TObject* Sender, TsbxWebDAVServerCreateCalendarEventParams *e);
__property TsbxWebDAVServerCreateCalendarEvent OnCreateCalendar = { read=FOnCreateCalendar, write=FOnCreateCalendar };

Remarks

Use this method to respond to a calendar creation request with a custom action. This event fires if fraCustom action was returned from the preceding BeforeCreateCalendar call.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

CreateCollection Event (WebDAVServer Component)

Lets the application respond to collection creation request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerCreateCollectionEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerCreateCollectionEvent)(System::TObject* Sender, TsbxWebDAVServerCreateCollectionEventParams *e);
__property TsbxWebDAVServerCreateCollectionEvent OnCreateCollection = { read=FOnCreateCollection, write=FOnCreateCollection };

Remarks

The component uses this event to let the application respond to collection creation requests. This event fires if fraCustom action was returned from the preceding BeforeCreateCollection call. The handler of this event is expected to create a new collection at Path.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

CustomRequest Event (WebDAVServer Component)

Use this event to respond to non-standard DAV requests.

Syntax

typedef struct {
  __int64 ConnectionID;
  String RequestMethod;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerCustomRequestEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerCustomRequestEvent)(System::TObject* Sender, TsbxWebDAVServerCustomRequestEventParams *e);
__property TsbxWebDAVServerCustomRequestEvent OnCustomRequest = { read=FOnCustomRequest, write=FOnCustomRequest };

Remarks

This event allows the application to respond in a virtualized manner to non-standard DAV requests. It will fire if fraCustom action was selected in the earlier BeforeCustomRequest call.

The RequestMethod specifies the HTTP method used for this request (GET, PUT, POST etc.), and the Path contains the requested path.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

Data Event (WebDAVServer Component)

Supplies a data chunk received from a client.

Syntax

typedef struct {
  __int64 ConnectionID;
  DynamicArray Buffer;
} TsbxWebDAVServerDataEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerDataEvent)(System::TObject* Sender, TsbxWebDAVServerDataEventParams *e);
__property TsbxWebDAVServerDataEvent OnData = { read=FOnData, write=FOnData };

Remarks

This event is fired to supply another piece of data received from a client. This event may fire multiple times.

Disconnect Event (WebDAVServer Component)

Fires to report a disconnected client.

Syntax

typedef struct {
  __int64 ConnectionID;
} TsbxWebDAVServerDisconnectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerDisconnectEvent)(System::TObject* Sender, TsbxWebDAVServerDisconnectEventParams *e);
__property TsbxWebDAVServerDisconnectEvent OnDisconnect = { read=FOnDisconnect, write=FOnDisconnect };

Remarks

component fires this event when a connected client disconnects.

DownloadObject Event (WebDAVServer Component)

Allows the application respond to Download Object request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  __int64 RestartAt;
  int OperationStatus;
} TsbxWebDAVServerDownloadObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerDownloadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerDownloadObjectEventParams *e);
__property TsbxWebDAVServerDownloadObjectEvent OnDownloadObject = { read=FOnDownloadObject, write=FOnDownloadObject };

Remarks

Use this event to implement custom handler of the Download operation. This event is followed by a series of ReadObject calls, which are then followed by DownloadObjectCompleted that signifies completion of the transfer operation.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

DownloadObjectCompleted Event (WebDAVServer Component)

This event is fired when a download operation completes.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerDownloadObjectCompletedEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerDownloadObjectCompletedEvent)(System::TObject* Sender, TsbxWebDAVServerDownloadObjectCompletedEventParams *e);
__property TsbxWebDAVServerDownloadObjectCompletedEvent OnDownloadObjectCompleted = { read=FOnDownloadObjectCompleted, write=FOnDownloadObjectCompleted };

Remarks

This event is fired when a download operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeDownloadFile event, and with Action parameter set to fraCustom.

The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.

Error Event (WebDAVServer Component)

Information about errors during data delivery.

Syntax

typedef struct {
  __int64 ConnectionID;
  int ErrorCode;
  bool Fatal;
  bool Remote;
  String Description;
} TsbxWebDAVServerErrorEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerErrorEvent)(System::TObject* Sender, TsbxWebDAVServerErrorEventParams *e);
__property TsbxWebDAVServerErrorEvent 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 (WebDAVServer Component)

Handles remote or external signing initiated by the server protocol.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxWebDAVServerExternalSignEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerExternalSignEvent)(System::TObject* Sender, TsbxWebDAVServerExternalSignEventParams *e);
__property TsbxWebDAVServerExternalSignEvent 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(); };

FileError Event (WebDAVServer Component)

Reports a file access error to the application.

Syntax

typedef struct {
  __int64 ConnectionID;
  String FileName;
  int ErrorCode;
} TsbxWebDAVServerFileErrorEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerFileErrorEvent)(System::TObject* Sender, TsbxWebDAVServerFileErrorEventParams *e);
__property TsbxWebDAVServerFileErrorEvent OnFileError = { read=FOnFileError, write=FOnFileError };

Remarks

component uses this event to report a file access errors. FileName and ErrorCode contain the file path and the error code respectively.

HeadersPrepared Event (WebDAVServer Component)

Fires when the response headers have been formed and are ready to be sent to the server.

Syntax

typedef struct {
  __int64 ConnectionID;
} TsbxWebDAVServerHeadersPreparedEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerHeadersPreparedEvent)(System::TObject* Sender, TsbxWebDAVServerHeadersPreparedEventParams *e);
__property TsbxWebDAVServerHeadersPreparedEvent OnHeadersPrepared = { read=FOnHeadersPrepared, write=FOnHeadersPrepared };

Remarks

The component fires this event when the response headers are ready to be sent to the server. ConnectionID indicates the connection that processed the request.

Use GetResponseHeader method with an empty header name to get the whole response header.

ListAttributes Event (WebDAVServer Component)

Requests object attributes from the application in fraCustom handling mode.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  String Attributes;
} TsbxWebDAVServerListAttributesEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerListAttributesEvent)(System::TObject* Sender, TsbxWebDAVServerListAttributesEventParams *e);
__property TsbxWebDAVServerListAttributesEvent OnListAttributes = { read=FOnListAttributes, write=FOnListAttributes };

Remarks

The component uses this event to request a set of attributes supported/kept for the object at Path. Return the list via the Attributes parameter as a string of CRLF-separated attribute names.

After firing this event, the component may request values for individual attributes via a series of ReadAttribute calls.

This event only fires if fraCustom action type was returned from the preceding BeforeBrowse event call.

ListSubObjects Event (WebDAVServer Component)

Requests a list of sub-objects of an object. The component uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  bool Recursive;
  String Objects;
  int OperationStatus;
} TsbxWebDAVServerListSubObjectsEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerListSubObjectsEvent)(System::TObject* Sender, TsbxWebDAVServerListSubObjectsEventParams *e);
__property TsbxWebDAVServerListSubObjectsEvent OnListSubObjects = { read=FOnListSubObjects, write=FOnListSubObjects };

Remarks

Set the status of the operation through the OperationStatus parameter as required:

LockObject Event (WebDAVServer Component)

Virtualizes the object locking operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  String Owner;
  bool Exclusive;
  int Depth;
  __int64 Timeout;
  String Token;
} TsbxWebDAVServerLockObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerLockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerLockObjectEventParams *e);
__property TsbxWebDAVServerLockObjectEvent OnLockObject = { read=FOnLockObject, write=FOnLockObject };

Remarks

The component uses this event to request a lock on the object at Path from the application. This event is only fired if fraCustom action was returned from the preceding BeforeLockObject call.

The Owner, Exclusive, Depth, and Timeout parameters specify the respective parameters of the requested lock. In response to this event, generate a lock token and return it via the Token parameter.

Notification Event (WebDAVServer Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxWebDAVServerNotificationEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerNotificationEvent)(System::TObject* Sender, TsbxWebDAVServerNotificationEventParams *e);
__property TsbxWebDAVServerNotificationEvent 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.

QueryQuota Event (WebDAVServer Component)

Reflects a quota enquiry by a client.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Username;
  __int64 Available;
  __int64 Used;
} TsbxWebDAVServerQueryQuotaEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerQueryQuotaEvent)(System::TObject* Sender, TsbxWebDAVServerQueryQuotaEventParams *e);
__property TsbxWebDAVServerQueryQuotaEvent OnQueryQuota = { read=FOnQueryQuota, write=FOnQueryQuota };

Remarks

This event fires in response to a client's enquire about their quota status. Subscribe to this event to react to such enquiries in a customized manner. Use Available and Used properties to report the respective amounts back to the client.

ReadAttribute Event (WebDAVServer Component)

Requests value of an attribute from the application in fraCustom mode.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  String NS;
  String Name;
  String Value;
  int OperationStatus;
} TsbxWebDAVServerReadAttributeEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerReadAttributeEvent)(System::TObject* Sender, TsbxWebDAVServerReadAttributeEventParams *e);
__property TsbxWebDAVServerReadAttributeEvent OnReadAttribute = { read=FOnReadAttribute, write=FOnReadAttribute };

Remarks

The component fires this event to request value of the NS:Name attribute of the object residing at Path. In the event handler, pass the attribute value via the Value parameter and set OperationStatus as required.

This event only fires if fraCustom action type was returned from the preceding BeforeBrowse event call.

ReadObject Event (WebDAVServer Component)

Requests a piece of object data from the application.

Syntax

typedef struct {
  __int64 ConnectionID;
  int Size;
  int OperationStatus;
} TsbxWebDAVServerReadObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerReadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerReadObjectEventParams *e);
__property TsbxWebDAVServerReadObjectEvent OnReadObject = { read=FOnReadObject, write=FOnReadObject };

Remarks

The component fires this event repeatedly during an overridden download operation to request object data from the application.

The handler of this event should read up to Size bytes from the downloaded object, and pass them to the component with a SetClientBuffer call.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:

RefreshLock Event (WebDAVServer Component)

Notifies the application about a lock refresh request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  String Token;
  __int64 Timeout;
  bool LockFound;
} TsbxWebDAVServerRefreshLockEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerRefreshLockEvent)(System::TObject* Sender, TsbxWebDAVServerRefreshLockEventParams *e);
__property TsbxWebDAVServerRefreshLockEvent OnRefreshLock = { read=FOnRefreshLock, write=FOnRefreshLock };

Remarks

The component uses this event to request extension of a lock on the object at Path. This event only fires if fraCustom action was returned from the preceding BeforeRefreshLock call.

In response to this event, check the validity of the provided Token for the object at Path, and extend the lock by Timeout milliseconds if the values match. Set the LockFound result as required.

RemoveObject Event (WebDAVServer Component)

Notifies the application about object deletion requests.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerRemoveObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerRemoveObjectEvent)(System::TObject* Sender, TsbxWebDAVServerRemoveObjectEventParams *e);
__property TsbxWebDAVServerRemoveObjectEvent OnRemoveObject = { read=FOnRemoveObject, write=FOnRemoveObject };

Remarks

The component uses this event to notify the application about an incoming deletion request for the object at Path. This event only fires if fraCustom action was returned from the preceding BeforeRemoveObject call.

The handler of this event should remove the object, if appropriate, and set the OperationStatus parameter to signify the actual operation result.

RenameObject Event (WebDAVServer Component)

Notifies the application about object name change requests.

Syntax

typedef struct {
  __int64 ConnectionID;
  String OldPath;
  String NewPath;
  bool Overwrite;
  int OperationStatus;
} TsbxWebDAVServerRenameObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerRenameObjectEvent)(System::TObject* Sender, TsbxWebDAVServerRenameObjectEventParams *e);
__property TsbxWebDAVServerRenameObjectEvent OnRenameObject = { read=FOnRenameObject, write=FOnRenameObject };

Remarks

The component uses this event to notify the application about an incoming rename request for the object at OldPath. The Overwrite parameter advises whether any objects currently existing at NewPath should be overwritten. This event only fires if fraCustom action was returned from the preceding BeforeRenameObject call.

The handler of this event should rename the object to NewPath (if appropriate) and set the OperationStatus parameter to signify the actual operation result.

ResourceAccess Event (WebDAVServer Component)

Reports an attempt to access a resource.

Syntax

typedef struct {
  __int64 ConnectionID;
  String HTTPMethod;
  String URI;
  bool Allow;
  String RedirectURI;
} TsbxWebDAVServerResourceAccessEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerResourceAccessEvent)(System::TObject* Sender, TsbxWebDAVServerResourceAccessEventParams *e);
__property TsbxWebDAVServerResourceAccessEvent OnResourceAccess = { read=FOnResourceAccess, write=FOnResourceAccess };

Remarks

The component fires this event to notify the application about a request received from the client. The HTTPMethod parameter indicates the HTTP method used (GET, POST, etc.)

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Allow to false to prevent the client from accessing the resource. The component will automatically send a "forbidden" status code (403).

Set a non-empty value to RedirectURI to notify the client that the resource has moved to another place. The component will automatically send a "found" status code (302). If Allow is set to false, the value of RedirectURI is ignored.

SetAttribute Event (WebDAVServer Component)

Lets the application customize attribute assignment requests.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  String NS;
  String Name;
  String Value;
  int OperationStatus;
} TsbxWebDAVServerSetAttributeEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerSetAttributeEvent)(System::TObject* Sender, TsbxWebDAVServerSetAttributeEventParams *e);
__property TsbxWebDAVServerSetAttributeEvent OnSetAttribute = { read=FOnSetAttribute, write=FOnSetAttribute };

Remarks

The component uses this event to pass attribute assignment requests to the application. This event may fire multiple times after a BeforeSetAttributes call, one for each attribute, if fraCustom action was chosen.

In the handler of this event, assign Value to the attribute NS:Name of the object at Path. Set OperationStatus in accordance with the outcome of the operation.

TLSCertValidate Event (WebDAVServer Component)

Fires when a client certificate needs to be validated.

Syntax

typedef struct {
  __int64 ConnectionID;
  bool Accept;
} TsbxWebDAVServerTLSCertValidateEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerTLSCertValidateEvent)(System::TObject* Sender, TsbxWebDAVServerTLSCertValidateEventParams *e);
__property TsbxWebDAVServerTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate };

Remarks

component fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (WebDAVServer Component)

Reports the setup of a TLS session.

Syntax

typedef struct {
  __int64 ConnectionID;
} TsbxWebDAVServerTLSEstablishedEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerTLSEstablishedEvent)(System::TObject* Sender, TsbxWebDAVServerTLSEstablishedEventParams *e);
__property TsbxWebDAVServerTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished };

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (WebDAVServer Component)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

typedef struct {
  __int64 ConnectionID;
  String ServerName;
  bool Abort;
} TsbxWebDAVServerTLSHandshakeEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerTLSHandshakeEvent)(System::TObject* Sender, TsbxWebDAVServerTLSHandshakeEventParams *e);
__property TsbxWebDAVServerTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake };

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (WebDAVServer Component)

Requests a pre-shared key for TLS-PSK.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Identity;
  String PSK;
  String Ciphersuite;
} TsbxWebDAVServerTLSPSKEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerTLSPSKEvent)(System::TObject* Sender, TsbxWebDAVServerTLSPSKEventParams *e);
__property TsbxWebDAVServerTLSPSKEvent OnTLSPSK = { read=FOnTLSPSK, write=FOnTLSPSK };

Remarks

The component fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (WebDAVServer Component)

Reports closure of a TLS session.

Syntax

typedef struct {
  __int64 ConnectionID;
} TsbxWebDAVServerTLSShutdownEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerTLSShutdownEvent)(System::TObject* Sender, TsbxWebDAVServerTLSShutdownEventParams *e);
__property TsbxWebDAVServerTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown };

Remarks

The component fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

UnlockObject Event (WebDAVServer Component)

Virtualizes the object unlocking operation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  String Token;
  bool LockFound;
} TsbxWebDAVServerUnlockObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerUnlockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerUnlockObjectEventParams *e);
__property TsbxWebDAVServerUnlockObjectEvent OnUnlockObject = { read=FOnUnlockObject, write=FOnUnlockObject };

Remarks

The component uses this event to notify the application of the incoming unlock request. This event only fires if fraCustom action was returned from the preceding BeforeUnlockObject call.

In response to this event, check the validity of the provided Token for the object at Path, and cancel the lock if the values match. Set the LockFound result as required.

UploadObject Event (WebDAVServer Component)

Lets the application respond to the Upload Object request.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  __int64 RestartAt;
  bool Append;
  int OperationStatus;
} TsbxWebDAVServerUploadObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerUploadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerUploadObjectEventParams *e);
__property TsbxWebDAVServerUploadObjectEvent OnUploadObject = { read=FOnUploadObject, write=FOnUploadObject };

Remarks

Use this event handler to respond to the received Upload Object request by reserving a place for the new object at Path. This event, if OperationStatus allows, will be followed by a series of WriteObject calls, passing object data in chunks, before a UploadObjectCompleted call signals completion of the upload operation.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

UploadObjectCompleted Event (WebDAVServer Component)

This event is fired when a upload operation completes.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Path;
  int OperationStatus;
} TsbxWebDAVServerUploadObjectCompletedEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerUploadObjectCompletedEvent)(System::TObject* Sender, TsbxWebDAVServerUploadObjectCompletedEventParams *e);
__property TsbxWebDAVServerUploadObjectCompletedEvent OnUploadObjectCompleted = { read=FOnUploadObjectCompleted, write=FOnUploadObjectCompleted };

Remarks

This event is fired when a upload operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeUploadFile event, and with Action parameter set to fraCustom.

The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.

WriteObject Event (WebDAVServer Component)

Hands a piece of object data to the application.

Syntax

typedef struct {
  __int64 ConnectionID;
  int OperationStatus;
} TsbxWebDAVServerWriteObjectEventParams;
typedef void __fastcall (__closure *TsbxWebDAVServerWriteObjectEvent)(System::TObject* Sender, TsbxWebDAVServerWriteObjectEventParams *e);
__property TsbxWebDAVServerWriteObjectEvent OnWriteObject = { read=FOnWriteObject, write=FOnWriteObject };

Remarks

The component fires this event repeatedly during an overridden upload operation to pass object data to the application.

The handler of this event should retrieve the pending data buffer with a GetClientBuffer call, and write it to the end of the object that is being uploaded.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:

Config Settings (WebDAVServer 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.

WebDAVServer Config Settings

Base Config Settings

Trappable Errors (WebDAVServer Component)

WebDAVServer Errors