WebDAVServer Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.SecureBlackbox.WebDAVServer

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

• C#
• VB.NET

public bool Active { get; }

Public ReadOnly Property Active As Boolean

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.

AuthRealm Property (WebDAVServer Component)

Specifies authentication realm for digest and NTLM authentication.

Syntax

• C#
• VB.NET

public string AuthRealm { get; set; }

Public Property AuthRealm As String

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

AuthTypes Property (WebDAVServer Component)

Defines allowed HTTP authentication types.

Syntax

• C#
• VB.NET

public int AuthTypes { get; set; }

Public Property AuthTypes As Integer

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:

BoundPort Property (WebDAVServer Component)

Indicates the bound listening port.

Syntax

• C#
• VB.NET

public int BoundPort { get; }

Public ReadOnly Property BoundPort As Integer

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.

ClientFileEntry Property (WebDAVServer Component)

A container for current file entry details.

Syntax

• C#
• VB.NET

public WebDAVListEntry ClientFileEntry { get; set; }

Public Property ClientFileEntry As WebDAVListEntry

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.

DocumentRoot Property (WebDAVServer Component)

The document root of the server.

Syntax

• C#
• VB.NET

public string DocumentRoot { get; set; }

Public Property DocumentRoot As String

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

ExternalCrypto Property (WebDAVServer Component)

Provides access to external signing and DC parameters.

Syntax

• C#
• VB.NET

public ExternalCrypto ExternalCrypto { get; }

Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

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

This property is read-only.

FIPSMode Property (WebDAVServer Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

Host Property (WebDAVServer Component)

The host to bind the listening port to.

Syntax

• C#
• VB.NET

public string Host { get; set; }

Public Property Host As String

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

• C#
• VB.NET

public int MetadataFlushTimeout { get; set; }

Public Property MetadataFlushTimeout As Integer

Default Value

600

Remarks

Use this property to specify metadata flush timeout in seconds.

MetadataRoot Property (WebDAVServer Component)

The metadata directory root.

Syntax

• C#
• VB.NET

public string MetadataRoot { get; set; }

Public Property MetadataRoot As String

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

• C#
• VB.NET

public TLSConnectionInfo PinnedClient { get; }

Public ReadOnly Property PinnedClient As TLSConnectionInfo

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.

PinnedClientChain Property (WebDAVServer Component)

Contains the certificate chain of the pinned client.

Syntax

• C#
• VB.NET

public CertificateList PinnedClientChain { get; }

Public ReadOnly Property PinnedClientChain As CertificateList

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.

Port Property (WebDAVServer Component)

Specifies the port number to listen for connections on.

Syntax

• C#
• VB.NET

public int Port { get; set; }

Public Property Port As Integer

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

• C#
• VB.NET

public int PortRangeFrom { get; set; }

Public Property PortRangeFrom As Integer

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

• C#
• VB.NET

public int PortRangeTo { get; set; }

Public Property PortRangeTo As Integer

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.

SocketSettings Property (WebDAVServer Component)

Manages network connection settings.

Syntax

• C#
• VB.NET

public SocketSettings SocketSettings { get; }

Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

TLSServerChain Property (WebDAVServer Component)

The server's TLS certificates.

Syntax

• C#
• VB.NET

public CertificateList TLSServerChain { get; }

Public Property TLSServerChain As CertificateList

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.

TLSSettings Property (WebDAVServer Component)

Manages TLS layer settings.

Syntax

• C#
• VB.NET

public TLSSettings TLSSettings { get; }

Public ReadOnly Property TLSSettings As TLSSettings

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Users Property (WebDAVServer Component)

Provides a list of registered users.

Syntax

• C#
• VB.NET

public UserAccountList Users { get; }

Public Property Users As UserAccountList

Remarks

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

This property is not available at design time.

WebsiteName Property (WebDAVServer Component)

Specifies the web site name to use in the certificate.

Syntax

• C#
• VB.NET

public string WebsiteName { get; set; }

Public Property WebsiteName As String

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

Cleanup Method (WebDAVServer Component)

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

Syntax

• C#
• VB.NET

public void Cleanup();

Public Sub 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

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As 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

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As 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 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;....

DropClient Method (WebDAVServer Component)

Terminates a client connection.

Syntax

• C#
• VB.NET

public void DropClient(long connectionId, bool forced);

Public Sub DropClient(ByVal ConnectionId As Long, ByVal Forced As 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

• C#
• VB.NET

public byte[] GetClientBuffer(long connectionID);

Public Function GetClientBuffer(ByVal ConnectionID As Long) As Byte()

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

• C#
• VB.NET

public byte[] GetRequestBytes(long connectionId, string requestFilter);

Public Function GetRequestBytes(ByVal ConnectionId As Long, ByVal RequestFilter As String) As Byte()

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

• C#
• VB.NET

public string GetRequestHeader(long connectionId, string headerName);

Public Function GetRequestHeader(ByVal ConnectionId As Long, ByVal HeaderName As String) As 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

• C#
• VB.NET

public void GetRequestStream(long connectionId, string requestFilter, System.IO.Stream outputStream);

Public Sub GetRequestStream(ByVal ConnectionId As Long, ByVal RequestFilter As String, ByVal OutputStream As System.IO.Stream)

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

• C#
• VB.NET

public string GetRequestString(long connectionId, string requestFilter);

Public Function GetRequestString(ByVal ConnectionId As Long, ByVal RequestFilter As String) As 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

• C#
• VB.NET

public string GetRequestUsername(long connectionId);

Public Function GetRequestUsername(ByVal ConnectionId As Long) As 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

• C#
• VB.NET

public string GetResponseHeader(long connectionId, string headerName);

Public Function GetResponseHeader(ByVal ConnectionId As Long, ByVal HeaderName As String) As 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

• C#
• VB.NET

public string ListClients();

Public Function ListClients() As 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

• C#
• VB.NET

public void PinClient(long connectionId);

Public Sub PinClient(ByVal ConnectionId As Long)

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

• C#
• VB.NET

public byte[] ProcessGenericRequest(long connectionId, byte[] requestBytes);

Public Function ProcessGenericRequest(ByVal ConnectionId As Long, ByVal RequestBytes As Byte()) As Byte()

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

• C#
• VB.NET

public void ProcessGenericRequestStream(long connectionId, string requestHeaders, System.IO.Stream requestData, System.IO.Stream responseData);

Public Sub ProcessGenericRequestStream(ByVal ConnectionId As Long, ByVal RequestHeaders As String, ByVal RequestData As System.IO.Stream, ByVal ResponseData As System.IO.Stream)

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.

Reset Method (WebDAVServer Component)

Resets the component settings.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

Reset is a generic method available in every component.

SetClientBuffer Method (WebDAVServer Component)

Commits a data buffer to the connection.

Syntax

• C#
• VB.NET

public void SetClientBuffer(long connectionID, byte[] value);

Public Sub SetClientBuffer(ByVal ConnectionID As Long, ByVal Value As Byte())

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

• C#
• VB.NET

public void SetClientFileEntry(long connectionID);

Public Sub SetClientFileEntry(ByVal ConnectionID As Long)

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

• C#
• VB.NET

public void SetResponseBytes(long connectionId, byte[] bytes, string contentType, string responseFilter);

Public Sub SetResponseBytes(ByVal ConnectionId As Long, ByVal Bytes As Byte(), ByVal ContentType As String, ByVal ResponseFilter As 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

• C#
• VB.NET

public void SetResponseFile(long connectionId, string fileName, string contentType, string responseFilter);

Public Sub SetResponseFile(ByVal ConnectionId As Long, ByVal FileName As String, ByVal ContentType As String, ByVal ResponseFilter As 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

• C#
• VB.NET

public void SetResponseHeader(long connectionId, string headerName, string value);

Public Sub SetResponseHeader(ByVal ConnectionId As Long, ByVal HeaderName As String, ByVal Value As String)

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

• C#
• VB.NET

public void SetResponseStatus(long connectionId, int statusCode);

Public Sub SetResponseStatus(ByVal ConnectionId As Long, ByVal StatusCode As 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

• C#
• VB.NET

public void SetResponseStream(long connectionId, System.IO.Stream dataStream, bool closeStream, string contentType, string responseFilter);

Public Sub SetResponseStream(ByVal ConnectionId As Long, ByVal DataStream As System.IO.Stream, ByVal CloseStream As Boolean, ByVal ContentType As String, ByVal ResponseFilter As 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

• C#
• VB.NET

public void SetResponseString(long connectionId, string dataStr, string contentType, string responseFilter);

Public Sub SetResponseString(ByVal ConnectionId As Long, ByVal DataStr As String, ByVal ContentType As String, ByVal ResponseFilter As 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

• C#
• VB.NET

public void Start();

Public Sub Start()

Remarks

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

Stop Method (WebDAVServer Component)

Stops the server.

Syntax

• C#
• VB.NET

public void Stop();

Public Sub Stop()

Remarks

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

Accept Event (WebDAVServer Component)

Reports an incoming connection.

Syntax

• C#
• VB.NET

public event OnAcceptHandler OnAccept;

public delegate void OnAcceptHandler(object sender, WebDAVServerAcceptEventArgs e);

public class WebDAVServerAcceptEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public bool Accept { get; set; }
}

Public Event OnAccept As OnAcceptHandler

Public Delegate Sub OnAcceptHandler(sender As Object, e As WebDAVServerAcceptEventArgs)

Public Class WebDAVServerAcceptEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public Property Accept As Boolean
End Class

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

• C#
• VB.NET

public event OnAfterBrowseHandler OnAfterBrowse;

public delegate void OnAfterBrowseHandler(object sender, WebDAVServerAfterBrowseEventArgs e);

public class WebDAVServerAfterBrowseEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterBrowse As OnAfterBrowseHandler

Public Delegate Sub OnAfterBrowseHandler(sender As Object, e As WebDAVServerAfterBrowseEventArgs)

Public Class WebDAVServerAfterBrowseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterCopyObjectHandler OnAfterCopyObject;

public delegate void OnAfterCopyObjectHandler(object sender, WebDAVServerAfterCopyObjectEventArgs e);

public class WebDAVServerAfterCopyObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterCopyObject As OnAfterCopyObjectHandler

Public Delegate Sub OnAfterCopyObjectHandler(sender As Object, e As WebDAVServerAfterCopyObjectEventArgs)

Public Class WebDAVServerAfterCopyObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterCreateCalendarHandler OnAfterCreateCalendar;

public delegate void OnAfterCreateCalendarHandler(object sender, WebDAVServerAfterCreateCalendarEventArgs e);

public class WebDAVServerAfterCreateCalendarEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterCreateCalendar As OnAfterCreateCalendarHandler

Public Delegate Sub OnAfterCreateCalendarHandler(sender As Object, e As WebDAVServerAfterCreateCalendarEventArgs)

Public Class WebDAVServerAfterCreateCalendarEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterCreateCollectionHandler OnAfterCreateCollection;

public delegate void OnAfterCreateCollectionHandler(object sender, WebDAVServerAfterCreateCollectionEventArgs e);

public class WebDAVServerAfterCreateCollectionEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterCreateCollection As OnAfterCreateCollectionHandler

Public Delegate Sub OnAfterCreateCollectionHandler(sender As Object, e As WebDAVServerAfterCreateCollectionEventArgs)

Public Class WebDAVServerAfterCreateCollectionEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterCustomRequestHandler OnAfterCustomRequest;

public delegate void OnAfterCustomRequestHandler(object sender, WebDAVServerAfterCustomRequestEventArgs e);

public class WebDAVServerAfterCustomRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string RequestMethod { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterCustomRequest As OnAfterCustomRequestHandler

Public Delegate Sub OnAfterCustomRequestHandler(sender As Object, e As WebDAVServerAfterCustomRequestEventArgs)

Public Class WebDAVServerAfterCustomRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property RequestMethod As String
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterLockObjectHandler OnAfterLockObject;

public delegate void OnAfterLockObjectHandler(object sender, WebDAVServerAfterLockObjectEventArgs e);

public class WebDAVServerAfterLockObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterLockObject As OnAfterLockObjectHandler

Public Delegate Sub OnAfterLockObjectHandler(sender As Object, e As WebDAVServerAfterLockObjectEventArgs)

Public Class WebDAVServerAfterLockObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterRefreshLockHandler OnAfterRefreshLock;

public delegate void OnAfterRefreshLockHandler(object sender, WebDAVServerAfterRefreshLockEventArgs e);

public class WebDAVServerAfterRefreshLockEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRefreshLock As OnAfterRefreshLockHandler

Public Delegate Sub OnAfterRefreshLockHandler(sender As Object, e As WebDAVServerAfterRefreshLockEventArgs)

Public Class WebDAVServerAfterRefreshLockEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterRemoveObjectHandler OnAfterRemoveObject;

public delegate void OnAfterRemoveObjectHandler(object sender, WebDAVServerAfterRemoveObjectEventArgs e);

public class WebDAVServerAfterRemoveObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRemoveObject As OnAfterRemoveObjectHandler

Public Delegate Sub OnAfterRemoveObjectHandler(sender As Object, e As WebDAVServerAfterRemoveObjectEventArgs)

Public Class WebDAVServerAfterRemoveObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterRenameObjectHandler OnAfterRenameObject;

public delegate void OnAfterRenameObjectHandler(object sender, WebDAVServerAfterRenameObjectEventArgs e);

public class WebDAVServerAfterRenameObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRenameObject As OnAfterRenameObjectHandler

Public Delegate Sub OnAfterRenameObjectHandler(sender As Object, e As WebDAVServerAfterRenameObjectEventArgs)

Public Class WebDAVServerAfterRenameObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterSetAttributesHandler OnAfterSetAttributes;

public delegate void OnAfterSetAttributesHandler(object sender, WebDAVServerAfterSetAttributesEventArgs e);

public class WebDAVServerAfterSetAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterSetAttributes As OnAfterSetAttributesHandler

Public Delegate Sub OnAfterSetAttributesHandler(sender As Object, e As WebDAVServerAfterSetAttributesEventArgs)

Public Class WebDAVServerAfterSetAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAfterUnlockObjectHandler OnAfterUnlockObject;

public delegate void OnAfterUnlockObjectHandler(object sender, WebDAVServerAfterUnlockObjectEventArgs e);

public class WebDAVServerAfterUnlockObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterUnlockObject As OnAfterUnlockObjectHandler

Public Delegate Sub OnAfterUnlockObjectHandler(sender As Object, e As WebDAVServerAfterUnlockObjectEventArgs)

Public Class WebDAVServerAfterUnlockObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnAuthAttemptHandler OnAuthAttempt;

public delegate void OnAuthAttemptHandler(object sender, WebDAVServerAuthAttemptEventArgs e);

public class WebDAVServerAuthAttemptEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string HTTPMethod { get; }
  public string URI { get; }
  public string AuthMethod { get; }
  public string Username { get; }
  public string Password { get; }
  public bool Allow { get; set; }
}

Public Event OnAuthAttempt As OnAuthAttemptHandler

Public Delegate Sub OnAuthAttemptHandler(sender As Object, e As WebDAVServerAuthAttemptEventArgs)

Public Class WebDAVServerAuthAttemptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property HTTPMethod As String
  Public ReadOnly Property URI As String
  Public ReadOnly Property AuthMethod As String
  Public ReadOnly Property Username As String
  Public ReadOnly Property Password As String
  Public Property Allow As Boolean
End Class

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

• C#
• VB.NET

public event OnBeforeBrowseHandler OnBeforeBrowse;

public delegate void OnBeforeBrowseHandler(object sender, WebDAVServerBeforeBrowseEventArgs e);

public class WebDAVServerBeforeBrowseEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeBrowse As OnBeforeBrowseHandler

Public Delegate Sub OnBeforeBrowseHandler(sender As Object, e As WebDAVServerBeforeBrowseEventArgs)

Public Class WebDAVServerBeforeBrowseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeCopyObjectHandler OnBeforeCopyObject;

public delegate void OnBeforeCopyObjectHandler(object sender, WebDAVServerBeforeCopyObjectEventArgs e);

public class WebDAVServerBeforeCopyObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int Action { get; set; }
}

Public Event OnBeforeCopyObject As OnBeforeCopyObjectHandler

Public Delegate Sub OnBeforeCopyObjectHandler(sender As Object, e As WebDAVServerBeforeCopyObjectEventArgs)

Public Class WebDAVServerBeforeCopyObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeCreateCalendarHandler OnBeforeCreateCalendar;

public delegate void OnBeforeCreateCalendarHandler(object sender, WebDAVServerBeforeCreateCalendarEventArgs e);

public class WebDAVServerBeforeCreateCalendarEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeCreateCalendar As OnBeforeCreateCalendarHandler

Public Delegate Sub OnBeforeCreateCalendarHandler(sender As Object, e As WebDAVServerBeforeCreateCalendarEventArgs)

Public Class WebDAVServerBeforeCreateCalendarEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeCreateCollectionHandler OnBeforeCreateCollection;

public delegate void OnBeforeCreateCollectionHandler(object sender, WebDAVServerBeforeCreateCollectionEventArgs e);

public class WebDAVServerBeforeCreateCollectionEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeCreateCollection As OnBeforeCreateCollectionHandler

Public Delegate Sub OnBeforeCreateCollectionHandler(sender As Object, e As WebDAVServerBeforeCreateCollectionEventArgs)

Public Class WebDAVServerBeforeCreateCollectionEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeCustomRequestHandler OnBeforeCustomRequest;

public delegate void OnBeforeCustomRequestHandler(object sender, WebDAVServerBeforeCustomRequestEventArgs e);

public class WebDAVServerBeforeCustomRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string RequestMethod { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeCustomRequest As OnBeforeCustomRequestHandler

Public Delegate Sub OnBeforeCustomRequestHandler(sender As Object, e As WebDAVServerBeforeCustomRequestEventArgs)

Public Class WebDAVServerBeforeCustomRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property RequestMethod As String
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeDownloadObjectHandler OnBeforeDownloadObject;

public delegate void OnBeforeDownloadObjectHandler(object sender, WebDAVServerBeforeDownloadObjectEventArgs e);

public class WebDAVServerBeforeDownloadObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeDownloadObject As OnBeforeDownloadObjectHandler

Public Delegate Sub OnBeforeDownloadObjectHandler(sender As Object, e As WebDAVServerBeforeDownloadObjectEventArgs)

Public Class WebDAVServerBeforeDownloadObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeLockObjectHandler OnBeforeLockObject;

public delegate void OnBeforeLockObjectHandler(object sender, WebDAVServerBeforeLockObjectEventArgs e);

public class WebDAVServerBeforeLockObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeLockObject As OnBeforeLockObjectHandler

Public Delegate Sub OnBeforeLockObjectHandler(sender As Object, e As WebDAVServerBeforeLockObjectEventArgs)

Public Class WebDAVServerBeforeLockObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeRefreshLockHandler OnBeforeRefreshLock;

public delegate void OnBeforeRefreshLockHandler(object sender, WebDAVServerBeforeRefreshLockEventArgs e);

public class WebDAVServerBeforeRefreshLockEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRefreshLock As OnBeforeRefreshLockHandler

Public Delegate Sub OnBeforeRefreshLockHandler(sender As Object, e As WebDAVServerBeforeRefreshLockEventArgs)

Public Class WebDAVServerBeforeRefreshLockEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeRemoveObjectHandler OnBeforeRemoveObject;

public delegate void OnBeforeRemoveObjectHandler(object sender, WebDAVServerBeforeRemoveObjectEventArgs e);

public class WebDAVServerBeforeRemoveObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRemoveObject As OnBeforeRemoveObjectHandler

Public Delegate Sub OnBeforeRemoveObjectHandler(sender As Object, e As WebDAVServerBeforeRemoveObjectEventArgs)

Public Class WebDAVServerBeforeRemoveObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeRenameObjectHandler OnBeforeRenameObject;

public delegate void OnBeforeRenameObjectHandler(object sender, WebDAVServerBeforeRenameObjectEventArgs e);

public class WebDAVServerBeforeRenameObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRenameObject As OnBeforeRenameObjectHandler

Public Delegate Sub OnBeforeRenameObjectHandler(sender As Object, e As WebDAVServerBeforeRenameObjectEventArgs)

Public Class WebDAVServerBeforeRenameObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeRequestHandler OnBeforeRequest;

public delegate void OnBeforeRequestHandler(object sender, WebDAVServerBeforeRequestEventArgs e);

public class WebDAVServerBeforeRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string HTTPMethod { get; }
  public string URL { get; }
  public bool Accept { get; set; }
}

Public Event OnBeforeRequest As OnBeforeRequestHandler

Public Delegate Sub OnBeforeRequestHandler(sender As Object, e As WebDAVServerBeforeRequestEventArgs)

Public Class WebDAVServerBeforeRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property HTTPMethod As String
  Public ReadOnly Property URL As String
  Public Property Accept As Boolean
End Class

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

• C#
• VB.NET

public event OnBeforeSetAttributesHandler OnBeforeSetAttributes;

public delegate void OnBeforeSetAttributesHandler(object sender, WebDAVServerBeforeSetAttributesEventArgs e);

public class WebDAVServerBeforeSetAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeSetAttributes As OnBeforeSetAttributesHandler

Public Delegate Sub OnBeforeSetAttributesHandler(sender As Object, e As WebDAVServerBeforeSetAttributesEventArgs)

Public Class WebDAVServerBeforeSetAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeUnlockObjectHandler OnBeforeUnlockObject;

public delegate void OnBeforeUnlockObjectHandler(object sender, WebDAVServerBeforeUnlockObjectEventArgs e);

public class WebDAVServerBeforeUnlockObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeUnlockObject As OnBeforeUnlockObjectHandler

Public Delegate Sub OnBeforeUnlockObjectHandler(sender As Object, e As WebDAVServerBeforeUnlockObjectEventArgs)

Public Class WebDAVServerBeforeUnlockObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeUploadObjectHandler OnBeforeUploadObject;

public delegate void OnBeforeUploadObjectHandler(object sender, WebDAVServerBeforeUploadObjectEventArgs e);

public class WebDAVServerBeforeUploadObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeUploadObject As OnBeforeUploadObjectHandler

Public Delegate Sub OnBeforeUploadObjectHandler(sender As Object, e As WebDAVServerBeforeUploadObjectEventArgs)

Public Class WebDAVServerBeforeUploadObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

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

• C#
• VB.NET

public event OnClearAttributeHandler OnClearAttribute;

public delegate void OnClearAttributeHandler(object sender, WebDAVServerClearAttributeEventArgs e);

public class WebDAVServerClearAttributeEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public string NS { get; }
  public string Name { get; }
  public int OperationStatus { get; set; }
}

Public Event OnClearAttribute As OnClearAttributeHandler

Public Delegate Sub OnClearAttributeHandler(sender As Object, e As WebDAVServerClearAttributeEventArgs)

Public Class WebDAVServerClearAttributeEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property NS As String
  Public ReadOnly Property Name As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnConnectHandler OnConnect;

public delegate void OnConnectHandler(object sender, WebDAVServerConnectEventArgs e);

public class WebDAVServerConnectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string RemoteAddress { get; }
  public int RemotePort { get; }
}

Public Event OnConnect As OnConnectHandler

Public Delegate Sub OnConnectHandler(sender As Object, e As WebDAVServerConnectEventArgs)

Public Class WebDAVServerConnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
End Class

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

• C#
• VB.NET

public event OnCopyObjectHandler OnCopyObject;

public delegate void OnCopyObjectHandler(object sender, WebDAVServerCopyObjectEventArgs e);

public class WebDAVServerCopyObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public bool Overwrite { get; }
  public int Depth { get; }
  public int OperationStatus { get; set; }
}

Public Event OnCopyObject As OnCopyObjectHandler

Public Delegate Sub OnCopyObjectHandler(sender As Object, e As WebDAVServerCopyObjectEventArgs)

Public Class WebDAVServerCopyObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public ReadOnly Property Overwrite As Boolean
  Public ReadOnly Property Depth As Integer
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnCreateCalendarHandler OnCreateCalendar;

public delegate void OnCreateCalendarHandler(object sender, WebDAVServerCreateCalendarEventArgs e);

public class WebDAVServerCreateCalendarEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnCreateCalendar As OnCreateCalendarHandler

Public Delegate Sub OnCreateCalendarHandler(sender As Object, e As WebDAVServerCreateCalendarEventArgs)

Public Class WebDAVServerCreateCalendarEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnCreateCollectionHandler OnCreateCollection;

public delegate void OnCreateCollectionHandler(object sender, WebDAVServerCreateCollectionEventArgs e);

public class WebDAVServerCreateCollectionEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnCreateCollection As OnCreateCollectionHandler

Public Delegate Sub OnCreateCollectionHandler(sender As Object, e As WebDAVServerCreateCollectionEventArgs)

Public Class WebDAVServerCreateCollectionEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnCustomRequestHandler OnCustomRequest;

public delegate void OnCustomRequestHandler(object sender, WebDAVServerCustomRequestEventArgs e);

public class WebDAVServerCustomRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string RequestMethod { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnCustomRequest As OnCustomRequestHandler

Public Delegate Sub OnCustomRequestHandler(sender As Object, e As WebDAVServerCustomRequestEventArgs)

Public Class WebDAVServerCustomRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property RequestMethod As String
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnDataHandler OnData;

public delegate void OnDataHandler(object sender, WebDAVServerDataEventArgs e);

public class WebDAVServerDataEventArgs : EventArgs {
  public long ConnectionID { get; }
  public byte[] Buffer { get; }
}

Public Event OnData As OnDataHandler

Public Delegate Sub OnDataHandler(sender As Object, e As WebDAVServerDataEventArgs)

Public Class WebDAVServerDataEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Buffer As Byte()
End Class

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

• C#
• VB.NET

public event OnDisconnectHandler OnDisconnect;

public delegate void OnDisconnectHandler(object sender, WebDAVServerDisconnectEventArgs e);

public class WebDAVServerDisconnectEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnDisconnect As OnDisconnectHandler

Public Delegate Sub OnDisconnectHandler(sender As Object, e As WebDAVServerDisconnectEventArgs)

Public Class WebDAVServerDisconnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

component fires this event when a connected client disconnects.

DownloadObject Event (WebDAVServer Component)

Allows the application respond to Download Object request.

Syntax

• C#
• VB.NET

public event OnDownloadObjectHandler OnDownloadObject;

public delegate void OnDownloadObjectHandler(object sender, WebDAVServerDownloadObjectEventArgs e);

public class WebDAVServerDownloadObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public long RestartAt { get; }
  public int OperationStatus { get; set; }
}

Public Event OnDownloadObject As OnDownloadObjectHandler

Public Delegate Sub OnDownloadObjectHandler(sender As Object, e As WebDAVServerDownloadObjectEventArgs)

Public Class WebDAVServerDownloadObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property RestartAt As Long
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnDownloadObjectCompletedHandler OnDownloadObjectCompleted;

public delegate void OnDownloadObjectCompletedHandler(object sender, WebDAVServerDownloadObjectCompletedEventArgs e);

public class WebDAVServerDownloadObjectCompletedEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnDownloadObjectCompleted As OnDownloadObjectCompletedHandler

Public Delegate Sub OnDownloadObjectCompletedHandler(sender As Object, e As WebDAVServerDownloadObjectCompletedEventArgs)

Public Class WebDAVServerDownloadObjectCompletedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, WebDAVServerErrorEventArgs e);

public class WebDAVServerErrorEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int ErrorCode { get; }
  public bool Fatal { get; }
  public bool Remote { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As WebDAVServerErrorEventArgs)

Public Class WebDAVServerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Fatal As Boolean
  Public ReadOnly Property Remote As Boolean
  Public ReadOnly Property Description As String
End Class

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

• C#
• VB.NET

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, WebDAVServerExternalSignEventArgs e);

public class WebDAVServerExternalSignEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OperationId { get; }
  public string HashAlgorithm { get; }
  public string Pars { get; }
  public string Data { get; }
  public string SignedData { get; set; }
}

Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As WebDAVServerExternalSignEventArgs)

Public Class WebDAVServerExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property Data As String
  Public Property SignedData As String
End Class

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

• C#
• VB.NET

public event OnFileErrorHandler OnFileError;

public delegate void OnFileErrorHandler(object sender, WebDAVServerFileErrorEventArgs e);

public class WebDAVServerFileErrorEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string FileName { get; }
  public int ErrorCode { get; }
}

Public Event OnFileError As OnFileErrorHandler

Public Delegate Sub OnFileErrorHandler(sender As Object, e As WebDAVServerFileErrorEventArgs)

Public Class WebDAVServerFileErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property FileName As String
  Public ReadOnly Property ErrorCode As Integer
End Class

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

• C#
• VB.NET

public event OnHeadersPreparedHandler OnHeadersPrepared;

public delegate void OnHeadersPreparedHandler(object sender, WebDAVServerHeadersPreparedEventArgs e);

public class WebDAVServerHeadersPreparedEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnHeadersPrepared As OnHeadersPreparedHandler

Public Delegate Sub OnHeadersPreparedHandler(sender As Object, e As WebDAVServerHeadersPreparedEventArgs)

Public Class WebDAVServerHeadersPreparedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

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

• C#
• VB.NET

public event OnListAttributesHandler OnListAttributes;

public delegate void OnListAttributesHandler(object sender, WebDAVServerListAttributesEventArgs e);

public class WebDAVServerListAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public string Attributes { get; set; }
}

Public Event OnListAttributes As OnListAttributesHandler

Public Delegate Sub OnListAttributesHandler(sender As Object, e As WebDAVServerListAttributesEventArgs)

Public Class WebDAVServerListAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Attributes As String
End Class

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

• C#
• VB.NET

public event OnListSubObjectsHandler OnListSubObjects;

public delegate void OnListSubObjectsHandler(object sender, WebDAVServerListSubObjectsEventArgs e);

public class WebDAVServerListSubObjectsEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public bool Recursive { get; }
  public string Objects { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnListSubObjects As OnListSubObjectsHandler

Public Delegate Sub OnListSubObjectsHandler(sender As Object, e As WebDAVServerListSubObjectsEventArgs)

Public Class WebDAVServerListSubObjectsEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property Recursive As Boolean
  Public Property Objects As String
  Public Property OperationStatus As Integer
End Class

Remarks

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

LockObject Event (WebDAVServer Component)

Virtualizes the object locking operation.

Syntax

• C#
• VB.NET

public event OnLockObjectHandler OnLockObject;

public delegate void OnLockObjectHandler(object sender, WebDAVServerLockObjectEventArgs e);

public class WebDAVServerLockObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public string Owner { get; }
  public bool Exclusive { get; }
  public int Depth { get; }
  public long Timeout { get; }
  public string Token { get; set; }
}

Public Event OnLockObject As OnLockObjectHandler

Public Delegate Sub OnLockObjectHandler(sender As Object, e As WebDAVServerLockObjectEventArgs)

Public Class WebDAVServerLockObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property Owner As String
  Public ReadOnly Property Exclusive As Boolean
  Public ReadOnly Property Depth As Integer
  Public ReadOnly Property Timeout As Long
  Public Property Token As String
End Class

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

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, WebDAVServerNotificationEventArgs e);

public class WebDAVServerNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As WebDAVServerNotificationEventArgs)

Public Class WebDAVServerNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

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

• C#
• VB.NET

public event OnQueryQuotaHandler OnQueryQuota;

public delegate void OnQueryQuotaHandler(object sender, WebDAVServerQueryQuotaEventArgs e);

public class WebDAVServerQueryQuotaEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Username { get; }
  public long Available { get; set; }
  public long Used { get; set; }
}

Public Event OnQueryQuota As OnQueryQuotaHandler

Public Delegate Sub OnQueryQuotaHandler(sender As Object, e As WebDAVServerQueryQuotaEventArgs)

Public Class WebDAVServerQueryQuotaEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Username As String
  Public Property Available As Long
  Public Property Used As Long
End Class

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

• C#
• VB.NET

public event OnReadAttributeHandler OnReadAttribute;

public delegate void OnReadAttributeHandler(object sender, WebDAVServerReadAttributeEventArgs e);

public class WebDAVServerReadAttributeEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public string NS { get; }
  public string Name { get; }
  public string Value { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnReadAttribute As OnReadAttributeHandler

Public Delegate Sub OnReadAttributeHandler(sender As Object, e As WebDAVServerReadAttributeEventArgs)

Public Class WebDAVServerReadAttributeEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property NS As String
  Public ReadOnly Property Name As String
  Public Property Value As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnReadObjectHandler OnReadObject;

public delegate void OnReadObjectHandler(object sender, WebDAVServerReadObjectEventArgs e);

public class WebDAVServerReadObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int Size { get; }
  public int OperationStatus { get; set; }
}

Public Event OnReadObject As OnReadObjectHandler

Public Delegate Sub OnReadObjectHandler(sender As Object, e As WebDAVServerReadObjectEventArgs)

Public Class WebDAVServerReadObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Size As Integer
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnRefreshLockHandler OnRefreshLock;

public delegate void OnRefreshLockHandler(object sender, WebDAVServerRefreshLockEventArgs e);

public class WebDAVServerRefreshLockEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public string Token { get; }
  public long Timeout { get; }
  public bool LockFound { get; set; }
}

Public Event OnRefreshLock As OnRefreshLockHandler

Public Delegate Sub OnRefreshLockHandler(sender As Object, e As WebDAVServerRefreshLockEventArgs)

Public Class WebDAVServerRefreshLockEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property Token As String
  Public ReadOnly Property Timeout As Long
  Public Property LockFound As Boolean
End Class

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

• C#
• VB.NET

public event OnRemoveObjectHandler OnRemoveObject;

public delegate void OnRemoveObjectHandler(object sender, WebDAVServerRemoveObjectEventArgs e);

public class WebDAVServerRemoveObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRemoveObject As OnRemoveObjectHandler

Public Delegate Sub OnRemoveObjectHandler(sender As Object, e As WebDAVServerRemoveObjectEventArgs)

Public Class WebDAVServerRemoveObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnRenameObjectHandler OnRenameObject;

public delegate void OnRenameObjectHandler(object sender, WebDAVServerRenameObjectEventArgs e);

public class WebDAVServerRenameObjectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public bool Overwrite { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRenameObject As OnRenameObjectHandler

Public Delegate Sub OnRenameObjectHandler(sender As Object, e As WebDAVServerRenameObjectEventArgs)

Public Class WebDAVServerRenameObjectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public ReadOnly Property Overwrite As Boolean
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnResourceAccessHandler OnResourceAccess;

public delegate void OnResourceAccessHandler(object sender, WebDAVServerResourceAccessEventArgs e);

public class WebDAVServerResourceAccessEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string HTTPMethod { get; }
  public string URI { get; }
  public bool Allow { get; set; }
  public string RedirectURI { get; set; }
}

Public Event OnResourceAccess As OnResourceAccessHandler

Public Delegate Sub OnResourceAccessHandler(sender As Object, e As WebDAVServerResourceAccessEventArgs)

Public Class WebDAVServerResourceAccessEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property HTTPMethod As String
  Public ReadOnly Property URI As String
  Public Property Allow As Boolean
  Public Property RedirectURI As String
End Class

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

• C#
• VB.NET

public event OnSetAttributeHandler OnSetAttribute;

public delegate void OnSetAttributeHandler(object sender, WebDAVServerSetAttributeEventArgs e);

public class WebDAVServerSetAttributeEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public string NS { get; }
  public string Name { get; }
  public string Value { get; }
  public int OperationStatus { get; set; }
}

Public Event OnSetAttribute As OnSetAttributeHandler

Public Delegate Sub OnSetAttributeHandler(sender As Object, e As WebDAVServerSetAttributeEventArgs)

Public Class WebDAVServerSetAttributeEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property NS As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property Value As String
  Public Property OperationStatus As Integer
End Class

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

• C#
• VB.NET

public event OnTLSCertValidateHandler OnTLSCertValidate;

public delegate void OnTLSCertValidateHandler(object sender, WebDAVServerTLSCertValidateEventArgs e);

public class WebDAVServerTLSCertValidateEventArgs : EventArgs {
  public long ConnectionID { get; }
  public bool Accept { get; set; }
}

Public Event OnTLSCertValidate As OnTLSCertValidateHandler

Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As WebDAVServerTLSCertValidateEventArgs)

Public Class WebDAVServerTLSCertValidateEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Accept As Boolean
End Class

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

• C#
• VB.NET

public event OnTLSEstablishedHandler OnTLSEstablished;

public delegate void OnTLSEstablishedHandler(object sender, WebDAVServerTLSEstablishedEventArgs e);

public class WebDAVServerTLSEstablishedEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnTLSEstablished As OnTLSEstablishedHandler

Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As WebDAVServerTLSEstablishedEventArgs)

Public Class WebDAVServerTLSEstablishedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

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