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 Active: Boolean read get_Active;

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.

AuthBasic Property (WebDAVServer Component)

Enables or disables basic authentication.

Syntax

property AuthBasic: Boolean read get_AuthBasic write set_AuthBasic;

Default Value

false

Remarks

Use this property to enable or disable basic user authentication in the HTTP server.

AuthDigest Property (WebDAVServer Component)

Enables or disables digest authentication.

Syntax

property AuthDigest: Boolean read get_AuthDigest write set_AuthDigest;

Default Value

false

Remarks

Use this property to enable or disable digest-based user authentication in the HTTP server.

AuthDigestExpire Property (WebDAVServer Component)

Specifies digest expiration time for digest authentication.

Syntax

property AuthDigestExpire: Integer read get_AuthDigestExpire write set_AuthDigestExpire;

Default Value

20

Remarks

Use this property to specify the digest expiration time for digest authentication, in seconds.

AuthRealm Property (WebDAVServer Component)

Specifies authentication realm for digest and NTLM authentication.

Syntax

property AuthRealm: String read get_AuthRealm write set_AuthRealm;

Default Value

'SecureBlackbox'

Remarks

Specifies authentication realm for digest and NTLM authentication types.

BoundPort Property (WebDAVServer Component)

Indicates the bound listening port.

Syntax

property BoundPort: Integer read get_BoundPort;

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.

ClientAuth Property (WebDAVServer Component)

Enables or disables certificate-based client authentication.

Syntax

property ClientAuth: TsbxClientAuthTypes read get_ClientAuth write set_ClientAuth;

TsbxClientAuthTypes = (
  ccatNoAuth,
  ccatRequestCert,
  ccatRequireCert
);

Default Value

ccatNoAuth

Remarks

Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;

ClientFileEntry Property (WebDAVServer Component)

A container for current file entry details.

Syntax

property ClientFileEntry: TsbxWebDAVListEntry read get_ClientFileEntry write set_ClientFileEntry;

Remarks

Use this object to specify file entry details for a file listing or attributes request, before committing them to the server with SetClientFileEntry method.

This property is not available at design time.

Please refer to the WebDAVListEntry type for a complete list of fields.

DocumentRoot Property (WebDAVServer Component)

The document root of the server.

Syntax

property DocumentRoot: String read get_DocumentRoot write set_DocumentRoot;

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

ErrorOrigin Property (WebDAVServer Component)

Indicates the endpoint where the error originates from.

Syntax

property ErrorOrigin: TsbxErrorOrigins read get_ErrorOrigin write set_ErrorOrigin;

TsbxErrorOrigins = (
  eoLocal,
  eoRemote
);

Default Value

eoLocal

Remarks

Use this property to establish whether the reported error originates from a local or remote endpoint.

This property is not available at design time.

ErrorSeverity Property (WebDAVServer Component)

The severity of the error that happened.

Syntax

property ErrorSeverity: TsbxErrorSeverities read get_ErrorSeverity write set_ErrorSeverity;

TsbxErrorSeverities = (
  esInfo,
  esWarning,
  esFatal
);

Default Value

esWarning

Remarks

Use this property to establish whether the error is fatal.

This property is not available at design time.

ExternalCrypto Property (WebDAVServer Component)

Provides access to external signing and DC parameters.

Syntax

property ExternalCrypto: TsbxExternalCrypto read get_ExternalCrypto;

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).

This property is read-only.

Please refer to the ExternalCrypto type for a complete list of fields.

FIPSMode Property (WebDAVServer Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

Host Property (WebDAVServer Component)

The host to bind the listening port to.

Syntax

property Host: String read get_Host write set_Host;

Default Value

''

Remarks

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

MetadataFlushTimeout Property (WebDAVServer Component)

Specifies metadata flush timeout.

Syntax

property MetadataFlushTimeout: Integer read get_MetadataFlushTimeout write set_MetadataFlushTimeout;

Default Value

600

Remarks

Use this property to specify metadata flush timeout in seconds.

MetadataRoot Property (WebDAVServer Component)

The metadata directory root.

Syntax

property MetadataRoot: String read get_MetadataRoot write set_MetadataRoot;

Default Value

''

Remarks

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

PinnedClient Property (WebDAVServer Component)

Populates the pinned client details.

Syntax

property PinnedClient: TsbxTLSClientEntry read get_PinnedClient;

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

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

Please refer to the TLSClientEntry type for a complete list of fields.

PinnedClientChain Property (WebDAVServer Component)

Contains the certificate chain of the pinned client.

Syntax

property PinnedClientChain: TsbxCertificateList read get_PinnedClientChain;

Remarks

Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.

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

Please refer to the Certificate type for a complete list of fields.

Port Property (WebDAVServer Component)

Specifies the port number to listen for connections on.

Syntax

property Port: Integer read get_Port write set_Port;

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.

PortRangeFrom Property (WebDAVServer Component)

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

Syntax

property PortRangeFrom: Integer read get_PortRangeFrom write set_PortRangeFrom;

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.

PortRangeTo Property (WebDAVServer Component)

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

Syntax

property PortRangeTo: Integer read get_PortRangeTo write set_PortRangeTo;

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.

ServerCertificates Property (WebDAVServer Component)

The server's TLS certificates.

Syntax

property ServerCertificates: TsbxCertificateList read get_ServerCertificates write set_ServerCertificates;

Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

SocketSettings Property (WebDAVServer Component)

Manages network connection settings.

Syntax

property SocketSettings: TsbxSocketSettings read get_SocketSettings;

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Please refer to the SocketSettings type for a complete list of fields.

TLSSettings Property (WebDAVServer Component)

Manages TLS layer settings.

Syntax

property TLSSettings: TsbxTLSSettings read get_TLSSettings;

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Please refer to the TLSSettings type for a complete list of fields.

Users Property (WebDAVServer Component)

Provides a list of registered users.

Syntax

property Users: TsbxUserAccountList read get_Users write set_Users;

Remarks

Assign a list of 'known' users to this property to automate authentication handling by component.

This property is not available at design time.

Please refer to the UserAccount type for a complete list of fields.

WebsiteName Property (WebDAVServer Component)

Specifies the web site name to use in the certificate.

Syntax

property WebsiteName: String read get_WebsiteName write set_WebsiteName;

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

Config Method (WebDAVServer Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

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

function DoAction(ActionID: String; ActionParams: String): String;

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

DropClient Method (WebDAVServer Component)

Terminates a client connection.

Syntax

procedure DropClient(ConnectionId: Int64; Forced: Boolean);

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

function GetClientBuffer(ConnectionID: Int64): TBytes;

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

function GetRequestBytes(ConnectionId: Int64; RequestFilter: String): TBytes;

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

function GetRequestHeader(ConnectionId: Int64; HeaderName: String): String;

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.

GetRequestStream Method (WebDAVServer Component)

Returns the contents of the client's HTTP request.

Syntax

procedure GetRequestStream(ConnectionId: Int64; RequestFilter: String; OutputStream: TStream);

Remarks

Use this method to get the body of the client's HTTP request into a stream. 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:

GetRequestString Method (WebDAVServer Component)

Returns the contents of the client's HTTP request.

Syntax

function GetRequestString(ConnectionId: Int64; RequestFilter: String): String;

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

function GetRequestUsername(ConnectionId: Int64): String;

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

function GetResponseHeader(ConnectionId: Int64; HeaderName: String): String;

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

function ListClients(): String;

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

procedure PinClient(ConnectionId: Int64);

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

function ProcessGenericRequest(ConnectionId: Int64; RequestBytes: TBytes): TBytes;

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.

ProcessGenericRequestStream Method (WebDAVServer Component)

Processes a generic HTTP request from a stream.

Syntax

procedure ProcessGenericRequestStream(ConnectionId: Int64; RequestHeaders: String; RequestData: TStream; ResponseData: TStream);

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.

The method expects the request headers in RequestHeaders, and the request data is read from RequestData stream. Once the request is processed, the response headers are reported through HeadersPrepared event before any data is written to ResponseData stream. ConnectionId allows to identify the request in the events.

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.

SetClientBuffer Method (WebDAVServer Component)

Commits a data buffer to the connection.

Syntax

procedure SetClientBuffer(ConnectionID: Int64; Value: TBytes);

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

procedure SetClientFileEntry(ConnectionID: Int64);

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

procedure SetResponseBytes(ConnectionId: Int64; Bytes: TBytes; ContentType: String; ResponseFilter: String);

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

procedure SetResponseFile(ConnectionId: Int64; FileName: String; ContentType: String; ResponseFilter: String);

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

function SetResponseHeader(ConnectionId: Int64; HeaderName: String; Value: String): Boolean;

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

procedure SetResponseStatus(ConnectionId: Int64; StatusCode: Integer);

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.

SetResponseStream Method (WebDAVServer Component)

Sets a stream to be served as a response.

Syntax

procedure SetResponseStream(ConnectionId: Int64; DataStream: TStream; CloseStream: Boolean; ContentType: String; ResponseFilter: String);

Remarks

Use this property to provide the response content in a stream. Set CloseStream to indicate that the stream should be disposed of once sent. 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:

SetResponseString Method (WebDAVServer Component)

Sets a string to be served as a response.

Syntax

procedure SetResponseString(ConnectionId: Int64; DataStr: String; ContentType: String; ResponseFilter: String);

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

procedure Start();

Remarks

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

Stop Method (WebDAVServer Component)

Stops the server.

Syntax

procedure Stop();

Remarks

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

Accept Event (WebDAVServer Component)

Reports an incoming connection.

Syntax

type TAcceptEvent = procedure (
  Sender: TObject;
  const RemoteAddress: String;
  RemotePort: Integer;
  var Accept: Boolean
) of Object;

property OnAccept: TAcceptEvent 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

type TAfterBrowseEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterBrowse: TAfterBrowseEvent 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

type TAfterCopyObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OldPath: String;
  const NewPath: String;
  var OperationStatus: Integer
) of Object;

property OnAfterCopyObject: TAfterCopyObjectEvent 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

type TAfterCreateCalendarEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterCreateCalendar: TAfterCreateCalendarEvent 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

type TAfterCreateCollectionEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterCreateCollection: TAfterCreateCollectionEvent 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

type TAfterCustomRequestEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const RequestMethod: String;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterCustomRequest: TAfterCustomRequestEvent 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

type TAfterLockObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterLockObject: TAfterLockObjectEvent 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

type TAfterRefreshLockEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterRefreshLock: TAfterRefreshLockEvent 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

type TAfterRemoveObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterRemoveObject: TAfterRemoveObjectEvent 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

type TAfterRenameObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OldPath: String;
  const NewPath: String;
  var OperationStatus: Integer
) of Object;

property OnAfterRenameObject: TAfterRenameObjectEvent 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

type TAfterSetAttributesEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterSetAttributes: TAfterSetAttributesEvent 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

type TAfterUnlockObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnAfterUnlockObject: TAfterUnlockObjectEvent 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

type TAuthAttemptEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const HTTPMethod: String;
  const URI: String;
  const AuthMethod: String;
  const Username: String;
  const Password: String;
  var Allow: Boolean
) of Object;

property OnAuthAttempt: TAuthAttemptEvent 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

type TBeforeBrowseEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeBrowse: TBeforeBrowseEvent 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

type TBeforeCopyObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OldPath: String;
  const NewPath: String;
  var Action: Integer
) of Object;

property OnBeforeCopyObject: TBeforeCopyObjectEvent 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

type TBeforeCreateCalendarEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeCreateCalendar: TBeforeCreateCalendarEvent 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

type TBeforeCreateCollectionEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeCreateCollection: TBeforeCreateCollectionEvent 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

type TBeforeCustomRequestEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const RequestMethod: String;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeCustomRequest: TBeforeCustomRequestEvent 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

type TBeforeDownloadObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeDownloadObject: TBeforeDownloadObjectEvent 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

type TBeforeLockObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeLockObject: TBeforeLockObjectEvent 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

type TBeforeRefreshLockEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeRefreshLock: TBeforeRefreshLockEvent 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

type TBeforeRemoveObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeRemoveObject: TBeforeRemoveObjectEvent 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

type TBeforeRenameObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OldPath: String;
  const NewPath: String;
  var Action: Integer
) of Object;

property OnBeforeRenameObject: TBeforeRenameObjectEvent 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

type TBeforeRequestEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const HTTPMethod: String;
  const URL: String;
  var Accept: Boolean
) of Object;

property OnBeforeRequest: TBeforeRequestEvent 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

type TBeforeSetAttributesEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeSetAttributes: TBeforeSetAttributesEvent 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

type TBeforeUnlockObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeUnlockObject: TBeforeUnlockObjectEvent 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

type TBeforeUploadObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Action: Integer
) of Object;

property OnBeforeUploadObject: TBeforeUploadObjectEvent 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

type TClearAttributeEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  const NS: String;
  const Name: String;
  var OperationStatus: Integer
) of Object;

property OnClearAttribute: TClearAttributeEvent 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

type TConnectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const RemoteAddress: String;
  RemotePort: Integer
) of Object;

property OnConnect: TConnectEvent 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

type TCopyObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OldPath: String;
  const NewPath: String;
  Overwrite: Boolean;
  Depth: Integer;
  var OperationStatus: Integer
) of Object;

property OnCopyObject: TCopyObjectEvent 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

type TCreateCalendarEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnCreateCalendar: TCreateCalendarEvent 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

type TCreateCollectionEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnCreateCollection: TCreateCollectionEvent 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

type TCustomRequestEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const RequestMethod: String;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnCustomRequest: TCustomRequestEvent 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

type TDataEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  Buffer: TBytes
) of Object;

property OnData: TDataEvent 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

type TDisconnectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnDisconnect: TDisconnectEvent 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

type TDownloadObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  RestartAt: Int64;
  var OperationStatus: Integer
) of Object;

property OnDownloadObject: TDownloadObjectEvent 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

type TDownloadObjectCompletedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnDownloadObjectCompleted: TDownloadObjectCompletedEvent 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

type TErrorEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent 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

type TExternalSignEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OperationId: String;
  const HashAlgorithm: String;
  const Pars: String;
  const Data: String;
  var SignedData: String
) of Object;

property OnExternalSign: TExternalSignEvent 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 SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FileError Event (WebDAVServer Component)

Reports a file access error to the application.

Syntax

type TFileErrorEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const FileName: String;
  ErrorCode: Integer
) of Object;

property OnFileError: TFileErrorEvent 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

type THeadersPreparedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnHeadersPrepared: THeadersPreparedEvent 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

type TListAttributesEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var Attributes: String
) of Object;

property OnListAttributes: TListAttributesEvent 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

type TListSubObjectsEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  Recursive: Boolean;
  var Objects: String;
  var OperationStatus: Integer
) of Object;

property OnListSubObjects: TListSubObjectsEvent 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

type TLockObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  const Owner: String;
  Exclusive: Boolean;
  Depth: Integer;
  Timeout: Int64;
  var Token: String
) of Object;

property OnLockObject: TLockObjectEvent 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

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent 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 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

type TQueryQuotaEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Username: String;
  var Available: Int64;
  var Used: Int64
) of Object;

property OnQueryQuota: TQueryQuotaEvent 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

type TReadAttributeEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  const NS: String;
  const Name: String;
  var Value: String;
  var OperationStatus: Integer
) of Object;

property OnReadAttribute: TReadAttributeEvent 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

type TReadObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  Size: Integer;
  var OperationStatus: Integer
) of Object;

property OnReadObject: TReadObjectEvent 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

type TRefreshLockEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  const Token: String;
  Timeout: Int64;
  var LockFound: Boolean
) of Object;

property OnRefreshLock: TRefreshLockEvent 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

type TRemoveObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnRemoveObject: TRemoveObjectEvent 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

type TRenameObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OldPath: String;
  const NewPath: String;
  Overwrite: Boolean;
  var OperationStatus: Integer
) of Object;

property OnRenameObject: TRenameObjectEvent 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

type TResourceAccessEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const HTTPMethod: String;
  const URI: String;
  var Allow: Boolean;
  var RedirectURI: String
) of Object;

property OnResourceAccess: TResourceAccessEvent 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

type TSetAttributeEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  const NS: String;
  const Name: String;
  const Value: String;
  var OperationStatus: Integer
) of Object;

property OnSetAttribute: TSetAttributeEvent 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

type TTLSCertValidateEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Accept: Boolean
) of Object;

property OnTLSCertValidate: TTLSCertValidateEvent 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

type TTLSEstablishedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnTLSEstablished: TTLSEstablishedEvent 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

type TTLSHandshakeEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const ServerName: String;
  var Abort: Boolean
) of Object;

property OnTLSHandshake: TTLSHandshakeEvent 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

type TTLSPSKEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Identity: String;
  var PSK: String;
  var Ciphersuite: String
) of Object;

property OnTLSPSK: TTLSPSKEvent 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

type TTLSShutdownEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnTLSShutdown: TTLSShutdownEvent 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

type TUnlockObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  const Token: String;
  var LockFound: Boolean
) of Object;

property OnUnlockObject: TUnlockObjectEvent 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

type TUploadObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  RestartAt: Int64;
  Append: Boolean;
  var OperationStatus: Integer
) of Object;

property OnUploadObject: TUploadObjectEvent 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

type TUploadObjectCompletedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Path: String;
  var OperationStatus: Integer
) of Object;

property OnUploadObjectCompleted: TUploadObjectCompletedEvent 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

type TWriteObjectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var OperationStatus: Integer
) of Object;

property OnWriteObject: TWriteObjectEvent 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:

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

>

constructor Create();

Creates a new object with default field values.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

>

constructor Create();

Creates a new ExternalCrypto object with default field values.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

>

constructor Create();

Creates a new SocketSettings object.

TLSClientEntry Type

A container for a connected TLS client's details.

Remarks

Use this property to access the details of a particular connected client.

Fields

Constructors

>

constructor Create();

Creates a new TLSClientEntry object.

TLSSettings Type

A container for TLS connection settings.

Remarks

TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

Constructors

>

constructor Create();

Creates a new TLSSettings object.

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

Constructors

>

constructor Create();

Creates a new UserAccount object.

WebDAVListEntry Type

Contains a set of attributes of a single WebDAV object.

Remarks

This type represents a single entry returned by the list command.

Fields

Constructors

>

constructor Create();

Creates a new WebDAVListEntry object.

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

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)