DAVServer Component

Properties   Methods   Events   Config Settings   Errors  

A component used for implementing DAV servers, granting full control over data storage, access and permissions, and server behavior.

Syntax

callback.DAVSDK.DAVServer

Remarks

The DAVServer component provides a streamlined way to extend WebDAV server support to data stored in different locations, including the local filesystem, remote storage, or in custom storage like a database. DAVServer is easy to use with minimal setup while also being flexible and highly configurable.

Getting Started

The DAVServer component provides an event-driven API for implementing WebDAV servers that can serve data from any data source, enforce granular access control rules, and implement custom logic according to your specific file access needs.

The Getting Started page provides a comprehensive introduction to the component, including hosting options and handling of events. The component may be hosted using an embedded server, within an existing server framework like ASP.NET Core, or in offline mode. A brief overview of hosting options is included below. Please refer to the Hosting Options page for additional details.

Hosting the Server

The component can be hosted one of three ways:

• Via the embedded HTTP server
• Integrated with an external server framework
• In a fully-offline mode

Comprehensive information on hosting options and configuration can be found in the Hosting Options page.

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.

ProcessingMode Property (DAVServer Component)

The mode in which the component will be hosted.

Syntax

• C#
• VB.NET

public DAVServerProcessingModes ProcessingMode { get; set; }

enum DAVServerProcessingModes {
  modeEmbeddedServer,
  modeExternalServer,
  modeOffline
}

Public Property ProcessingMode As DavserverProcessingModes

Enum DAVServerProcessingModes
  modeEmbeddedServer
  modeExternalServer
  modeOffline
End Enum

Default Value

0

Remarks

This property governs whether the component operates via the embedded HTTP server, an external server, or in a fully-offline mode. Possible values are as follows:

• modeEmbeddedServer (0, default): Use embedded server.
• modeExternalServer (1): Use external server.
• modeOffline (2): Use offline processing.

Please refer to the Hosting Options pages to the learn more about the different processing modes and how they relate to configuring a host server.

Request Property (DAVServer Component)

The body of the HTTP request to be processed by the component.

Syntax

• C#
• VB.NET

public string Request { get; set; }
public byte[] RequestB { get; set; }

Public Property Request As String
Public Property RequestB As Byte()

Default Value

""

Remarks

When the ProcessingMode property is set to modeOffline, the component processes inbound HTTP requests via this property and the RequestHeaders property.

After setting this property to the full body content of the HTTP request, as well as setting any headers in the RequestHeaders property, the component will begin processing the request when the ProcessRequest method is called.

RequestHeaders Property (DAVServer Component)

The full set of headers of the HTTP request to be processed by the component.

Syntax

• C#
• VB.NET

public string RequestHeaders { get; set; }

Public Property RequestHeaders As String

Default Value

""

Remarks

When the ProcessingMode property is set to modeOffline, the component processes inbound HTTP requests via this property and the Request property.

After setting this property to the header content of the HTTP request, as well as setting the body content in the Request property, the component will begin processing the request when the ProcessRequest method is called.

Response Property (DAVServer Component)

The body of the HTTP response generated after processing a request with the component.

Syntax

• C#
• VB.NET

public string Response { get; set; }
public byte[] ResponseB { get; set; }

Public Property Response As String
Public Property ResponseB As Byte()

Default Value

""

Remarks

When the ProcessingMode property is set to modeOffline, this property holds the body of the HTTP response that was generated as a result of calling the ProcessRequest method.

Note that this response is not sent to a client, and instead the component simply populates this property along with the ResponseHeaders property.

ResponseHeaders Property (DAVServer Component)

The full set of headers of the HTTP response generated after processing a request with the component.

Syntax

• C#
• VB.NET

public string ResponseHeaders { get; set; }

Public Property ResponseHeaders As String

Default Value

""

Remarks

When the ProcessingMode property is set to modeOffline, this property holds the headers of the HTTP response that was generated as a result of calling the ProcessRequest method.

Note that this response is not sent to a client, and instead the component simply populates this property along with the Response property.

ServerCert Property (DAVServer Component)

The certificate used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate ServerCert { get; set; }

Public Property ServerCert As Certificate

Remarks

When the ProcessingMode property is set to modeEmbeddedServer, this property holds the digital certificate that the component will use during SSL negotiation.

This is the server's certificate, and it must be set before the StartListening method is called.

ServerSettings Property (DAVServer Component)

The embedded HTTP server settings used by the component.

Syntax

• C#
• VB.NET

public ServerSettings ServerSettings { get; set; }

Public Property ServerSettings As ServerSettings

Remarks

When the ProcessingMode property is set to modeEmbeddedServer, this property is used to define the necessary fields to configure the embedded HTTP server.

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

GetSessionParam Method (DAVServer Component)

Provides the value of the specified session parameter.

Syntax

• C#
• VB.NET

public string GetSessionParam(long sessionId, string name);

Public Function GetSessionParam(ByVal SessionId As Long, ByVal Name As String) As String

Remarks

This method provides access to session parameters, which are key-value pairs that store session-specific information. This method is used in event handlers to retrieve a session parameter value that was previously set using the SetSessionParam method.

SessionId is the unique identifier of the session with which the parameter name and value will be associated. This value is assigned by the component and is available in the SessionStart event as well as other events.

Name corresponds to the user-defined parameter name.

ListFile Method (DAVServer Component)

Passes information about a specific file to the component.

Syntax

• C#
• VB.NET

public bool ListFile(long requestId, string parentId, string fileName, int attributes, long size, DateTime creationTime, DateTime lastAccessTime, DateTime lastModifiedTime, string ownerId);

Public Function ListFile(ByVal RequestId As Long, ByVal ParentId As String, ByVal FileName As String, ByVal Attributes As Integer, ByVal Size As Long, ByVal CreationTime As DateTime, ByVal LastAccessTime As DateTime, ByVal LastModifiedTime As DateTime, ByVal OwnerId As String) As Boolean

Remarks

This method is used to pass information about a specific file when the ListDirectory event is handled.

The RequestId parameter must be set to the value received in the corresponding event handler. The parameters detailed below must be set if they were requested as indicated by the RequestedInfo parameter of the event.

This method returns true if the information was accepted; otherwise, false is returned.

ParentId must be set to the path of the parent of the file or directory relative to the server root. If the item is located in the root directory, the value should be empty.

FileName must be set to the item's file name (usually, human-readable) without any path.

Attributes should be set to indicate the type of the item by setting the corresponding attributes flags. The following flags are available:

CreationTime should be set to the time the item was initially created.

LastAccessTime should be set to the most recent time the item was opened.

LastModifiedTime should be set to the most recent time the item was written.

Owner should be set to the identifier of the owner of the item.

Size should be set to the size of a file in bytes.

ListFolder Method (DAVServer Component)

Passes information about a specific directory to the component.

Syntax

• C#
• VB.NET

public bool ListFolder(long requestId, string parentId, string fileName, int attributes, DateTime creationTime, DateTime lastAccessTime, DateTime lastModifiedTime, string owner);

Public Function ListFolder(ByVal RequestId As Long, ByVal ParentId As String, ByVal FileName As String, ByVal Attributes As Integer, ByVal CreationTime As DateTime, ByVal LastAccessTime As DateTime, ByVal LastModifiedTime As DateTime, ByVal Owner As String) As Boolean

Remarks

This method is used to pass information about a specific directory when the ListDirectory event is handled.

The RequestId parameter must be set to the value received in the corresponding event handler. The parameters detailed below must be set if they were requested as indicated by the RequestedInfo parameter of the event.

This method returns true if the information was accepted; otherwise, false is returned.

ParentId must be set to the path of the parent of the file or directory relative to the server root. If the item is located in the root directory, the value should be empty.

FileName must be set to the item's file name (usually, human-readable) without any path.

Attributes should be set to indicate the type of the item by setting the corresponding attributes flags. The following flags are available:

CreationTime should be set to the time the item was initially created.

LastAccessTime should be set to the most recent time the item was opened.

LastModifiedTime should be set to the most recent time the item was written.

Owner should be set to the identifier of the owner of the item.

ProcessRequest Method (DAVServer Component)

Processes the request and sends the result.

Syntax

• C#
• VB.NET

public void ProcessRequest(object Context);

Public Sub ProcessRequest(ByVal Context As Object)

Remarks

When the ProcessingMode property is set to modeExternalServer or modeOffline, this method acts as the main entry point for the component and is used to process a specific request. This method should not be called when the component is running in the modeEmbeddedServer mode.

Note that when using the modeOffline mode, the component processes the request and its associated headers supplied via the Request and RequestHeaders properties, respectively, and therefore ignores the parameters of this method.

When using the modeExternalServer mode, Context must be set to an instance of the HttpContext class that corresponds to the request to be handled.

Note that authentication occurs fully outside the scope of the component, and the logic that verifies these credentials is separate from any interaction with the component. Only once the request has been authenticated through this external verification should the HttpContext be passed to this method.

SetSessionParam Method (DAVServer Component)

Sets a user-defined value as a session parameter.

Syntax

• C#
• VB.NET

public void SetSessionParam(long sessionId, string name, string value);

Public Sub SetSessionParam(ByVal SessionId As Long, ByVal Name As String, ByVal Value As String)

Remarks

This method assigns session parameters, which are key-value pairs that store information specific to the session. This method is used in event handlers to store session-specific data which can be retrieved later by calling the GetSessionParam method.

SessionId is the unique identifier of the session with which the parameter name and value will be associated. This value is assigned by the component and is available in the SessionStart event as well as other events.

Name and Value correspond to the user-defined parameter name and value, respectively.

StartListening Method (DAVServer Component)

Instructs the component to start listening for incoming connections.

Syntax

• C#
• VB.NET

public void StartListening();

Public Sub StartListening()

Remarks

When the ProcessingMode property is set to modeEmbeddedServer, this method instructs the component to start listening for incoming connections on the port specified by LocalPort.

To stop listening for new connections, please refer to the StopListening method.

StopListening Method (DAVServer Component)

Instructs the component to stop listening for new connections.

Syntax

• C#
• VB.NET

public void StopListening();

Public Sub StopListening()

Remarks

When the ProcessingMode property is set to modeEmbeddedServer, this method instructs the component to stop listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

CheckAccess Event (DAVServer Component)

Fires when the component needs to create or open a file or directory.

Syntax

• C#
• VB.NET

public event OnCheckAccessHandler OnCheckAccess;

public delegate void OnCheckAccessHandler(object sender, DAVServerCheckAccessEventArgs e);

public class DAVServerCheckAccessEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public int DesiredOperation { get; }
  public int ResultCode { get; set; }
}

Public Event OnCheckAccess As OnCheckAccessHandler

Public Delegate Sub OnCheckAccessHandler(sender As Object, e As DAVServerCheckAccessEventArgs)

Public Class DAVServerCheckAccessEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property DesiredOperation As Integer
  Public Property ResultCode As Integer
End Class

Remarks

This optional event fires when the component needs to create or open an existing file or directory. It can be used to control and optionally restrict access to files and directories. The event can be disabled by setting the FireCheckAccessEvent configuration setting to false, which can improve performance.

When an existing file is accessed, this event is fired only for this file and not for its parent directories. When a new file or directory is created, the event is first fired for the parent directory. When a file or directory is copied or moved into another directory, the event is first fired for the destination directory (i.e., the new parent).

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item to be accessed is in the root directory, the value will be empty.

FileName identifies the name of the file or directory to be accessed.

DesiredOperation specifies which kind of operation is performed and can be one or more of the following:

Usually, only one flag is set; however, when a file is opened, both ACCESS_TYPE_READ and ACCESS_TYPE_WRITE flags may be set.

ResultCode must be set to report the result of the check to the component. When this event is fired, the parameter will be set either to 0 (to permit access by default) for most types of desired operations, or to DAVSDK_ERR_ACCESS_DENIED for operations that must be forbidden by default for security reasons.

If access is permitted, this should be set to 0. If access is denied, this should be set to DAVSDK_ERR_ACCESS_DENIED. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, etc.), this should be set to a non-zero value different from DAVSDK_ERR_ACCESS_DENIED.

CopyFile Event (DAVServer Component)

Fires when the component needs to copy a file or directory.

Syntax

• C#
• VB.NET

public event OnCopyFileHandler OnCopyFile;

public delegate void OnCopyFileHandler(object sender, DAVServerCopyFileEventArgs e);

public class DAVServerCopyFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string DestParentPath { get; }
  public string DestFileName { get; }
  public bool OverwriteExisting { get; }
  public int ResultCode { get; set; }
}

Public Event OnCopyFile As OnCopyFileHandler

Public Delegate Sub OnCopyFileHandler(sender As Object, e As DAVServerCopyFileEventArgs)

Public Class DAVServerCopyFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property DestParentPath As String
  Public ReadOnly Property DestFileName As String
  Public ReadOnly Property OverwriteExisting As Boolean
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to copy a file or directory is received. When a directory with its contents is copied, this event is fired only once for the directory itself.

During recursive copying, if a file or directory cannot be copied, copying should continue, but the event handler should set the ResultCode parameter to a non-zero value to communicate an error.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item to be copied is in the root directory, the value will be empty.

FileName identifies the name of the file or directory to be copied.

DestParentPath contains the path of the new parent directory relative to the server root. If the item is to be copied to the root directory, the value will be empty.

DestFileName contains the name of the newly-copied file or directory.

OverwriteExisting specifies whether the handler should overwrite an existing file if one already exists. If this is false and a destination item exists, the event handler must return the DAVSDK_ERR_ALREADY_EXISTS error. If this is true, the following rules apply:

• If the destination item exists and is a file, it must be replaced by the copy of the source item, regardless of whether it is a file or directory.
• If the destination item exists and is a directory, the event handler must return the DAVSDK_ERR_ALREADY_EXISTS error, as a directory cannot be overwritten.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

CreateDirectory Event (DAVServer Component)

Fires when the component needs to create a new directory.

Syntax

• C#
• VB.NET

public event OnCreateDirectoryHandler OnCreateDirectory;

public delegate void OnCreateDirectoryHandler(object sender, DAVServerCreateDirectoryEventArgs e);

public class DAVServerCreateDirectoryEventArgs : EventArgs {
  public long SessionId { get; }
  public string ParentPath { get; }
  public string FileName { get; }
  public int ResultCode { get; set; }
}

Public Event OnCreateDirectory As OnCreateDirectoryHandler

Public Delegate Sub OnCreateDirectoryHandler(sender As Object, e As DAVServerCreateDirectoryEventArgs)

Public Class DAVServerCreateDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property ParentPath As String
  Public ReadOnly Property FileName As String
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to create a new directory is received.

If a file or directory with the same name already exists, the event handler must return the DAVSDK_ERR_ALREADY_EXISTS error.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

ParentPath identifies the path of the parent directory relative to the server root where the new directory should be created. If the item is to be created in the root directory, the value will be empty.

FileName identifies the name of the directory to be created.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

CreateFile Event (DAVServer Component)

Fires when the component needs to create an empty file.

Syntax

• C#
• VB.NET

public event OnCreateFileHandler OnCreateFile;

public delegate void OnCreateFileHandler(object sender, DAVServerCreateFileEventArgs e);

public class DAVServerCreateFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string ParentPath { get; }
  public string FileName { get; }
  public bool OverwriteExisting { get; }
  public int ResultCode { get; set; }
}

Public Event OnCreateFile As OnCreateFileHandler

Public Delegate Sub OnCreateFileHandler(sender As Object, e As DAVServerCreateFileEventArgs)

Public Class DAVServerCreateFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property ParentPath As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property OverwriteExisting As Boolean
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when the component needs to create a file that does not already exist.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

ParentPath identifies the path of the parent directory relative to the server root where the new file should be created. If the item is to be created in the root directory, the value will be empty.

FileName identifies the name of the file to be created.

OverwriteExisting specifies whether the handler should overwrite an existing file if one already exists. If this is false and a destination item exists, the event handler must return the DAVSDK_ERR_ALREADY_EXISTS error. If this is true, the following rules apply:

• If the item exists and is a file, it must be replaced by the newly-created item, regardless of whether it is a file or directory.
• If the item exists and is a directory, the event handler must return the DAVSDK_ERR_ALREADY_EXISTS error, as a directory cannot be overwritten.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

DeleteFile Event (DAVServer Component)

Fires when the component needs to delete a file or directory.

Syntax

• C#
• VB.NET

public event OnDeleteFileHandler OnDeleteFile;

public delegate void OnDeleteFileHandler(object sender, DAVServerDeleteFileEventArgs e);

public class DAVServerDeleteFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public bool Recursive { get; }
  public int ResultCode { get; set; }
}

Public Event OnDeleteFile As OnDeleteFileHandler

Public Delegate Sub OnDeleteFileHandler(sender As Object, e As DAVServerDeleteFileEventArgs)

Public Class DAVServerDeleteFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Recursive As Boolean
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to delete a file or directory is received.

When deleting multiple items, such as a directory and its contents, failure to delete one of the items should not abort the operation; rather, it should continue with remaining items.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item to be deleted is in the root directory, the value will be empty.

FileName identifies the name of the file or directory to be deleted.

Recursive specifies whether directory contents may be removed if the item is a directory and it contains any children. If this is false and the directory contains subdirectories or files, the deletion should be stopped and the DAVSDK_ERR_DIR_NOT_EMPTY error should be reported. If this is true, all contents including subdirectories and their contents should be deleted recursively.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

DeleteProperty Event (DAVServer Component)

Fires when the component needs to delete specific custom metadata of a file or directory.

Syntax

• C#
• VB.NET

public event OnDeletePropertyHandler OnDeleteProperty;

public delegate void OnDeletePropertyHandler(object sender, DAVServerDeletePropertyEventArgs e);

public class DAVServerDeletePropertyEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string Namespace { get; }
  public string PropertyName { get; }
  public int ResultCode { get; set; }
}

Public Event OnDeleteProperty As OnDeletePropertyHandler

Public Delegate Sub OnDeletePropertyHandler(sender As Object, e As DAVServerDeletePropertyEventArgs)

Public Class DAVServerDeletePropertyEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Namespace As String
  Public ReadOnly Property PropertyName As String
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to delete specific custom metadata of a file or directory is received.

Note that the component does not maintain these custom metadata properties internally. Developers making use of custom properties should maintain a dictionary or other data structure to store these property names and values, and within this event handler check to see if a corresponding property exists on the item that can be deleted.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item whose custom metadata is to be deleted is in the root directory, the value will be empty.

FileName identifies the name of the file or directory whose custom metadata is to be deleted.

Namespace and PropertyName identify the specific custom metadata property to be deleted.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

Error Event (DAVServer Component)

Fires information about unhandled exceptions caught by the component.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

public class DAVServerErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

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

Public Class DAVServerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event fires when an unhandled exception is caught by the component, providing information about the error.

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 Error Codes section.

GetFile Event (DAVServer Component)

Fires when the component needs to serve file data.

Syntax

• C#
• VB.NET

public event OnGetFileHandler OnGetFile;

public delegate void OnGetFileHandler(object sender, DAVServerGetFileEventArgs e);

public class DAVServerGetFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string LocalPath { get; set; }
}

Public Event OnGetFile As OnGetFileHandler

Public Delegate Sub OnGetFileHandler(sender As Object, e As DAVServerGetFileEventArgs)

Public Class DAVServerGetFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public Property LocalPath As String
End Class

Remarks

This event fires when a request to download file data is received and is the first of two events that can be used to determine what data is returned.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file relative to the server root. If the file to be downloaded is in the root directory, the value will be empty.

FileName contains the name of the file to be downloaded.

LocalPath may optionally be set to a full path of a local file, in which case the file's contents will be returned as the download response. If this is not set, which is useful in cases where the response to the download request will not be the entire contents of a single file, the component will not immediately respond to the download request and will instead fire the ReadFile event, where developers have more control over exactly what data is returned in response to the download request.

Event Order During Download Operations

When a download request is received, the component fires a series of events in the following order. Note that certain details like the number of levels of directories within which the target file resides may impact how events fire.

1. SessionStart - Fires when a client initiates a session with the component and helps associate a unique session identifier with the request.
2. CheckAccess - Fires when a client attempts to read or list a file or directory, and provides an opportunity to check access and permissions (optional).
3. GetFileInfo - Fires to access metadata regarding the file or directory being read or listed.
4. GetFile - Fires to provide a simple way for the component to serve a file by providing a filepath (optional).
5. GetProperty - Fires to access custom metadata regarding the file or directory being read or listed (optional).
6. ReadFile - Fires if GetFile was not used to serve the file and provides full control over response data.
7. SessionEnd - Fires when a client successfully ends a session and allows closing out the session identifier.

GetFileInfo Event (DAVServer Component)

Fires when the component needs to obtain information about a specific file or directory.

Syntax

• C#
• VB.NET

public event OnGetFileInfoHandler OnGetFileInfo;

public delegate void OnGetFileInfoHandler(object sender, DAVServerGetFileInfoEventArgs e);

public class DAVServerGetFileInfoEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public int RequestedInfo { get; }
  public int Attributes { get; set; }
  public long Size { get; set; }
  public DateTime CreationTime { get; set; }
  public DateTime LastAccessTime { get; set; }
  public DateTime LastModifiedTime { get; set; }
  public string Owner { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnGetFileInfo As OnGetFileInfoHandler

Public Delegate Sub OnGetFileInfoHandler(sender As Object, e As DAVServerGetFileInfoEventArgs)

Public Class DAVServerGetFileInfoEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property RequestedInfo As Integer
  Public Property Attributes As Integer
  Public Property Size As Long
  Public Property CreationTime As DateTime
  Public Property LastAccessTime As DateTime
  Public Property LastModifiedTime As DateTime
  Public Property Owner As String
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to obtain information about a file or directory is received, to check existence of the specified file or directory, or to determine whether the specified item is a directory. To handle this event, values should be supplied to each of the event parameters according to the type of needed information as specified in the RequestedInfo parameter.

This event may fire several times for the same file or directory when handling one request. If retrieval of item information is slow (e.g., from databases, remote cloud storages, etc.), all item information may need to be requested at once and cached for some time (several seconds or the duration of the session, whichever is shorter).

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item whose information is being queried is in the root directory, the value will be empty.

FileName identifies the name of the file or directory whose information is being queried.

RequestedInfo specifies what information is requested and may contain one or more flags. The following flags are available:

The parameters listed below must be set if they were requested as indicated by the RequestedInfo parameter of the event.

Attributes should be set to indicate the type of the item by setting the corresponding attributes flags. The following flags are available:

Size should be set to the size of the file in bytes. If the item is a directory, no value should be supplied.

CreationTime should be set to the time the item was initially created.

LastAccessTime should be set to the most recent time the item was opened.

LastModifiedTime should be set to the most recent time the item was written.

Owner should be set to the identifier of the owner of the item.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

GetFileLocks Event (DAVServer Component)

Fires when the component needs to obtain information about the existing locks of a file or directory.

Syntax

• C#
• VB.NET

public event OnGetFileLocksHandler OnGetFileLocks;

public delegate void OnGetFileLocksHandler(object sender, DAVServerGetFileLocksEventArgs e);

public class DAVServerGetFileLocksEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string LockToken { get; set; }
  public DateTime Expires { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnGetFileLocks As OnGetFileLocksHandler

Public Delegate Sub OnGetFileLocksHandler(sender As Object, e As DAVServerGetFileLocksEventArgs)

Public Class DAVServerGetFileLocksEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public Property LockToken As String
  Public Property Expires As DateTime
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to obtain information about the existing locks of a file or directory is received.

Note that the component does not maintain locks internally. Developers making use of locks should maintain a dictionary or other data structure to keep track of item lock information, and within this event handler check to see if a corresponding lock exists for the item with a value that can be returned.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item whose lock information is being queried is in the root directory, the value will be empty.

FileName identifies the name of the file or directory whose lock information is being queried.

LockToken must be set to the unique identifier of the lock.

Expires must be set to the time at which the lock will expire.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

GetProperty Event (DAVServer Component)

Fires when the component needs to retrieve specific custom metadata about a file or directory.

Syntax

• C#
• VB.NET

public event OnGetPropertyHandler OnGetProperty;

public delegate void OnGetPropertyHandler(object sender, DAVServerGetPropertyEventArgs e);

public class DAVServerGetPropertyEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string Namespace { get; }
  public string PropertyName { get; }
  public string Value { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnGetProperty As OnGetPropertyHandler

Public Delegate Sub OnGetPropertyHandler(sender As Object, e As DAVServerGetPropertyEventArgs)

Public Class DAVServerGetPropertyEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Namespace As String
  Public ReadOnly Property PropertyName As String
  Public Property Value As String
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request for a specific custom metadata value of a file or directory is received.

Note that the component does not maintain these custom metadata properties internally. Developers making use of custom properties should maintain a dictionary or other data structure to store these property names and values, and within this event handler check to see if a corresponding property exists for the item with a value that can be returned.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item whose custom metadata is being queried is in the root directory, the value will be empty.

FileName identifies the name of the file or directory whose custom metadata is being queried.

Namespace and PropertyName identify the specific custom metadata property being requested.

Value should be set to the value of the requested custom metadata property. This typically requires checking an external data structure in which custom metadata properties are stored for each item.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

GetQuotaInfo Event (DAVServer Component)

Fires when the component needs to obtain information about the storage.

Syntax

• C#
• VB.NET

public event OnGetQuotaInfoHandler OnGetQuotaInfo;

public delegate void OnGetQuotaInfoHandler(object sender, DAVServerGetQuotaInfoEventArgs e);

public class DAVServerGetQuotaInfoEventArgs : EventArgs {
  public long SessionId { get; }
  public long AvailableSpace { get; set; }
  public long TotalSpace { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnGetQuotaInfo As OnGetQuotaInfoHandler

Public Delegate Sub OnGetQuotaInfoHandler(sender As Object, e As DAVServerGetQuotaInfoEventArgs)

Public Class DAVServerGetQuotaInfoEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public Property AvailableSpace As Long
  Public Property TotalSpace As Long
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to retrieve information about the storage is received.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

AvailableSpace indicates the amount of storage in bytes that is available for a user and corresponds to the quota-available-bytes property of the WebDAV quota extension.

TotalSpace indicates the maximum storage capacity in bytes that is available for a user and corresponds to the sum of the quota-available-bytes and quota-used-bytes properties of the WebDAV quota extension.

ResultCode must be set to report the result to the component. This will always be DAVSDK_ERR_NOT_IMPLEMENTED when the event is fired and should be set to 0 to indicate success. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

ListDirectory Event (DAVServer Component)

Fires when the component needs to enumerate the contents of a directory.

Syntax

• C#
• VB.NET

public event OnListDirectoryHandler OnListDirectory;

public delegate void OnListDirectoryHandler(object sender, DAVServerListDirectoryEventArgs e);

public class DAVServerListDirectoryEventArgs : EventArgs {
  public long SessionId { get; }
  public string ParentPath { get; }
  public string Mask { get; }
  public int RequestedInfo { get; }
  public int StartAt { get; }
  public string StartAfter { get; }
  public int MaxFiles { get; }
  public int OrderBy { get; }
  public bool ReverseOrder { get; }
  public bool Recursive { get; }
  public long RequestId { get; }
  public bool ListingComplete { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnListDirectory As OnListDirectoryHandler

Public Delegate Sub OnListDirectoryHandler(sender As Object, e As DAVServerListDirectoryEventArgs)

Public Class DAVServerListDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property ParentPath As String
  Public ReadOnly Property Mask As String
  Public ReadOnly Property RequestedInfo As Integer
  Public ReadOnly Property StartAt As Integer
  Public ReadOnly Property StartAfter As String
  Public ReadOnly Property MaxFiles As Integer
  Public ReadOnly Property OrderBy As Integer
  Public ReadOnly Property ReverseOrder As Boolean
  Public ReadOnly Property Recursive As Boolean
  Public ReadOnly Property RequestId As Long
  Public Property ListingComplete As Boolean
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to enumerate the contents of a directory is received. To provide the directory's contents to the component, the ListFile or ListFolder methods should be called for each discovered file or subdirectory, respectively.

By default, the advanced filtering and ordering parameters, including Mask, StartAt, StartAfter, MaxFiles, OrderBy, and ReverseOrder, contain values that need to be handled. To meet this requirement, a listing of files and directories should be returned within this event in accordance with these values.

If the UseSimpleFileEnumeration configuration setting is enabled, the advanced filtering and ordering parameters can be safely ignored and the component will handle ordering and filtration automatically.

The StartAt, StartAfter, and MaxFiles parameters in particular are used when the client collects enumeration information in batches. When this happens, consequent requests to the component may occur in different sessions.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

ParentPath identifies the path of the parent directory to enumerate relative to the server root. The value may be empty if the root directory is to be listed.

Mask may be empty, in which case all files and directories should be returned, or it may contain a file mask with wildcards that must be used to filter items by matching their human-readable names to the mask.

RequestedInfo specifies what information is requested and may contain one or more flags. The following flags are available:

StartAt specifies the index of the first file or directory in the list of found items to return. It is set to 0 initially but may contain a non-zero value if the contents are requested by the client in batches. This has priority over the StartAfter parameter and may be set to -1 if StartAfter must be taken into account; in all other cases, this should be used and StartAfter must be ignored.

StartAfter specifies the last file or directory received by the component that was passed to the client in the previous call to the event handler (or during the previous enumeration). If no file or directory was found (e.g., the item was since deleted), an event handler should return items that would follow such an item after sorting is applied.

For example, given the files A.txt, B.txt, D.txt, and E.txt, and C.txt is passed in this parameter, enumeration should return D.txt and E.txt.

MaxFiles specifies the maximum number of items to return in a batch.

OrderBy specifies the order in which the items must be returned and may be one of the following values:

ReverseOrder specifies whether the items should be returned in the opposite order than what is specified by the other advanced ordering and filtering parameters.

Recursive specifies whether items in subdirectories should be reported as well. This parameter may be true when the EnableRecursiveDirectoryListings configuration setting is enabled.

RequestId contains an unique identifier generated by the component that must be passed to the ListFile and ListFolder methods.

ListingComplete must be set to true if the last file or subdirectory has been reported to the component and there are no more items to report during this enumeration; otherwise, it must be set to false.

For example, if the component has requested 20 items by setting MaxFiles accordingly, and the directory to be enumerated contains exactly 20 files and subdirectories, this must be set to true. If the number of subitems is 21 or more, or if the total number is not known, this must be set to false.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

ListProperties Event (DAVServer Component)

Fires when the component needs to enumerate the custom metadata of a file or directory.

Syntax

• C#
• VB.NET

public event OnListPropertiesHandler OnListProperties;

public delegate void OnListPropertiesHandler(object sender, DAVServerListPropertiesEventArgs e);

public class DAVServerListPropertiesEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string Namespaces { get; set; }
  public string Names { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnListProperties As OnListPropertiesHandler

Public Delegate Sub OnListPropertiesHandler(sender As Object, e As DAVServerListPropertiesEventArgs)

Public Class DAVServerListPropertiesEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public Property Namespaces As String
  Public Property Names As String
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to enumerate the custom metadata of a file or directory is received.

Note that the component does not maintain these custom metadata properties internally. Developers making use of custom properties should maintain a dictionary or other data structure to store these property names and values, and within this event handler check to see if a corresponding property exists for the item with a value that can be listed.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item whose custom metadata is to be listed is in the root directory, the value will be empty.

FileName identifies the name of the file or directory whose custom metadata is to be listed.

Namespaces should be set to a newline character (\n)-separated list of namespaces corresponding to each custom metadata property to be listed.

Names should be set to a newline character (\n)-separated list of names corresponding to each custom metadata property to be listed.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

LockFile Event (DAVServer Component)

Fires when the component needs to lock a file or directory.

Syntax

• C#
• VB.NET

public event OnLockFileHandler OnLockFile;

public delegate void OnLockFileHandler(object sender, DAVServerLockFileEventArgs e);

public class DAVServerLockFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string LockToken { get; }
  public DateTime Expires { get; }
  public int ResultCode { get; set; }
}

Public Event OnLockFile As OnLockFileHandler

Public Delegate Sub OnLockFileHandler(sender As Object, e As DAVServerLockFileEventArgs)

Public Class DAVServerLockFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property LockToken As String
  Public ReadOnly Property Expires As DateTime
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to lock a file or directory is received.

Note that the component does not maintain locks internally. Developers making use of locks should maintain a dictionary or other data structure to keep track of item lock information, and within this event handler add or update the lock information to the existing list.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item to be locked is in the root directory, the value will be empty.

FileName identifies the name of the file or directory to be locked.

LockToken specifies the unique identifier for the lock to be added or updated.

Expires identifies the time at which the lock will expire.

ResultCode provides an opportunity to report the result of the operation. This will always be DAVSDK_ERR_NOT_IMPLEMENTED when the event is fired and should be set to 0 to indicate success or DAVSDK_ERR_LOCK_FAILED to indicate that a lock could not be created or removed specifically due to a conflict with another lock. Any other non-zero value indicates the lock could not be created or removed for other reasons.

Log Event (DAVServer Component)

Fires once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, DAVServerLogEventArgs e);

public class DAVServerLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As DAVServerLogEventArgs)

Public Class DAVServerLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
End Class

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

Message is the log entry.

PutFile Event (DAVServer Component)

Fires when the component needs to store file data.

Syntax

• C#
• VB.NET

public event OnPutFileHandler OnPutFile;

public delegate void OnPutFileHandler(object sender, DAVServerPutFileEventArgs e);

public class DAVServerPutFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string LocalPath { get; set; }
}

Public Event OnPutFile As OnPutFileHandler

Public Delegate Sub OnPutFileHandler(sender As Object, e As DAVServerPutFileEventArgs)

Public Class DAVServerPutFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public Property LocalPath As String
End Class

Remarks

This event fires when a request to upload file data is received and is the first of two events that can be used to determine how data should be stored.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file relative to the server root. If the file is to be uploaded in the root directory, the value will be empty.

FileName contains the name of the file to be uploaded.

LocalPath may optionally be set to a full path of a local file, in which case the contents of the client's request will be written to that file. If this is not set, which is useful in cases where the data should be stored in a different manner than writing the entire contents to a single file, the component will not immediately respond to the upload request and will instead fire the WriteFile event, where developers have full access to the upload contents and full control over how that data is stored.

Event Order During Upload Operations

When an upload request is received, the component fires a series of events in the following order. Note that certain details like the number of levels of directories within which the target file resides may impact how events fire.

1. SessionStart - Fires when a client initiates a session with the component and helps associate a unique session identifier with the request.
2. CheckAccess - Fires when a client attempts to list or write a file or directory and provides an opportunity to check access and permissions (optional).
3. GetFileInfo - Fires to access metadata regarding the file or directory being written or listed.
4. PutFile - Fires to provide a simple way for the component to store file data by setting a filepath (optional).
5. GetFileLocks - Fires when the component needs to check or acquire locks to the file being written.
6. CreateFile - Fires when the component is asked to create a file that does not already exist.
7. WriteFile - Fires if PutFile was not used to store the file and provides full control over inbound upload data.
8. SessionEnd - Fires when a client successfully ends a session and allows closing out the session identifier.

ReadFile Event (DAVServer Component)

Fires when the component needs to serve file data.

Syntax

• C#
• VB.NET

public event OnReadFileHandler OnReadFile;

public delegate void OnReadFileHandler(object sender, DAVServerReadFileEventArgs e);

public class DAVServerReadFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public byte[] Buffer { get; }
  public long Offset { get; }
  public int Length { get; }
  public int BytesRead { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnReadFile As OnReadFileHandler

Public Delegate Sub OnReadFileHandler(sender As Object, e As DAVServerReadFileEventArgs)

Public Class DAVServerReadFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Buffer As Byte()
  Public ReadOnly Property Offset As Long
  Public ReadOnly Property Length As Integer
  Public Property BytesRead As Integer
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to download file data is received and that request was not already satisfied within the GetFile event.

Any failure to write to the data buffer in this event should be reported as an error.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file relative to the server root. If the file to be downloaded is in the root directory, the value will be empty.

FileName contains the name of the file to be downloaded.

Buffer holds the block of data that will be returned in the response and should be filled through whatever custom logic is appropriate for the server's behavior.

Offset indicates how many bytes have already been transferred in prior firings of this event (which can occur when handling large sets of data) and provides the starting index for the current block of data.

Length indicates the size of the current block of data to be copied to the Buffer.

BytesRead must be set to the actual number of bytes copied into the Buffer at the end of the event.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

Event Order During Download Operations

When a download request is received, the component fires a series of events in the following order. Note that certain details like the number of levels of directories within which the target file resides may impact how events fire.

1. SessionStart - Fires when a client initiates a session with the component and helps associate a unique session identifier with the request.
2. CheckAccess - Fires when a client attempts to read or list a file or directory, and provides an opportunity to check access and permissions (optional).
3. GetFileInfo - Fires to access metadata regarding the file or directory being read or listed.
4. GetFile - Fires to provide a simple way for the component to serve a file by providing a filepath (optional).
5. GetProperty - Fires to access custom metadata regarding the file or directory being read or listed (optional).
6. ReadFile - Fires if GetFile was not used to serve the file and provides full control over response data.
7. SessionEnd - Fires when a client successfully ends a session and allows closing out the session identifier.

RenameFile Event (DAVServer Component)

Fires when the component needs to rename or move a file or directory.

Syntax

• C#
• VB.NET

public event OnRenameFileHandler OnRenameFile;

public delegate void OnRenameFileHandler(object sender, DAVServerRenameFileEventArgs e);

public class DAVServerRenameFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public bool MoveItem { get; }
  public string DestParentPath { get; }
  public string NewFileName { get; }
  public bool OverwriteExisting { get; }
  public int ResultCode { get; set; }
}

Public Event OnRenameFile As OnRenameFileHandler

Public Delegate Sub OnRenameFileHandler(sender As Object, e As DAVServerRenameFileEventArgs)

Public Class DAVServerRenameFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property MoveItem As Boolean
  Public ReadOnly Property DestParentPath As String
  Public ReadOnly Property NewFileName As String
  Public ReadOnly Property OverwriteExisting As Boolean
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to rename or move a file or directory is received. When a directory with its contents is moved, this event is fired only once for the directory itself.

During recursive moving, if a file or directory cannot be moved, moving should continue, but the event handler should set the ResultCode parameter to a non-zero value to communicate an error.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item to be renamed or moved is in the root directory, the value will be empty.

FileName identifies the name of the file or directory to be renamed or moved.

MoveItem specifies whether the file or directory is to be moved to a new parent directory. If this is true, the new parent directory is identified by DestParentPath; otherwise, only the name of the item is to be changed, and DestParentPath must be ignored.

DestParentPath contains the path of the new parent directory relative to the server root, but only if MoveFile is true. If the item is to be moved to the root directory, the value will be empty.

NewFileName contains the name of the newly-moved file or directory. If the name should remain the same, the value will be empty.

OverwriteExisting specifies whether the handler should overwrite an existing file if one already exists. If this is false and a destination item exists, the event handler must return the DAVSDK_ERR_ALREADY_EXISTS error. If this is true, the following rules apply:

• If the destination item exists and is a file, it must be replaced by the source item, regardless of whether it is a file or directory.
• If the destination item exists and is a directory, the event handler must return the DAVSDK_ERR_ALREADY_EXISTS error, as a directory cannot be overwritten.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

SessionEnd Event (DAVServer Component)

Fires when the component ends a session.

Syntax

• C#
• VB.NET

public event OnSessionEndHandler OnSessionEnd;

public delegate void OnSessionEndHandler(object sender, DAVServerSessionEndEventArgs e);

public class DAVServerSessionEndEventArgs : EventArgs {
  public long SessionId { get; }
}

Public Event OnSessionEnd As OnSessionEndHandler

Public Delegate Sub OnSessionEndHandler(sender As Object, e As DAVServerSessionEndEventArgs)

Public Class DAVServerSessionEndEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
End Class

Remarks

This event fires when the component ends a previously started session. The component doesn't expect any errors to occur or be reported by handlers of this event.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

SessionStart Event (DAVServer Component)

Fires when the component starts a session.

Syntax

• C#
• VB.NET

public event OnSessionStartHandler OnSessionStart;

public delegate void OnSessionStartHandler(object sender, DAVServerSessionStartEventArgs e);

public class DAVServerSessionStartEventArgs : EventArgs {
  public long SessionId { get; }
  public int ResultCode { get; set; }
}

Public Event OnSessionStart As OnSessionStartHandler

Public Delegate Sub OnSessionStartHandler(sender As Object, e As DAVServerSessionStartEventArgs)

Public Class DAVServerSessionStartEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a new session with a connected client begins. The lifetime of a session is a single HTTP request and response, meaning once the response has been sent, the session ends.

The SetSessionParam and GetSessionParam methods may be used to set and retrieve custom data associated with the session from within this event and any other event.

SessionId is the unique identifier of the session, assigned by the component. It is provided as a parameter in all other events so that the operations for a particular client session may be tracked.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

Reporting an error will abort the operation.

SetFileInfo Event (DAVServer Component)

Fires when the component needs to update times and attributes of a specific file or directory.

Syntax

• C#
• VB.NET

public event OnSetFileInfoHandler OnSetFileInfo;

public delegate void OnSetFileInfoHandler(object sender, DAVServerSetFileInfoEventArgs e);

public class DAVServerSetFileInfoEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public int Attributes { get; }
  public DateTime CreationTime { get; }
  public DateTime LastModifiedTime { get; }
  public DateTime LastAccessTime { get; }
  public int ResultCode { get; set; }
}

Public Event OnSetFileInfo As OnSetFileInfoHandler

Public Delegate Sub OnSetFileInfoHandler(sender As Object, e As DAVServerSetFileInfoEventArgs)

Public Class DAVServerSetFileInfoEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Attributes As Integer
  Public ReadOnly Property CreationTime As DateTime
  Public ReadOnly Property LastModifiedTime As DateTime
  Public ReadOnly Property LastAccessTime As DateTime
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when the component receives a request to update times and attributes of a file or directory. To handle this event, file information should be updated on the target file or directory in accordance with the parameters provided in this event.

Note that the component does not update last access time or last modification time times when a file or directory is accessed or updated; this event only fires in response to received requests.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item whose information is to be updated is in the root directory, the value will be empty.

FileName identifies the name of the file or directory whose information is to be updated.

Attributes may contain 0 if no attributes need to be updated or may be a combination of the following flags:

CreationTime contains a new value for the creation time attribute of the item.

LastModifiedTime contains a new value for the modification time attribute of the item.

LastAccessTime contains a new value for the last access time attribute of the item.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

SetFileSize Event (DAVServer Component)

Fires when the component needs to adjust the size of an open file.

Syntax

• C#
• VB.NET

public event OnSetFileSizeHandler OnSetFileSize;

public delegate void OnSetFileSizeHandler(object sender, DAVServerSetFileSizeEventArgs e);

public class DAVServerSetFileSizeEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public long NewSize { get; }
  public int ResultCode { get; set; }
}

Public Event OnSetFileSize As OnSetFileSizeHandler

Public Delegate Sub OnSetFileSizeHandler(sender As Object, e As DAVServerSetFileSizeEventArgs)

Public Class DAVServerSetFileSizeEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property NewSize As Long
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when the component needs to adjust the size of an open file. To handle this event, the size of the target file should be updated based on the NewSize parameter.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file relative to the server root. If the file whose size is to be updated is in the root directory, the value will be empty.

FileName identifies the name of the file whose size is to be updated.

NewSize contains the new size of the file in bytes. The file size may be increased or decreased.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

SetProperty Event (DAVServer Component)

Fires when the component needs to add or update custom metadata to a file or directory.

Syntax

• C#
• VB.NET

public event OnSetPropertyHandler OnSetProperty;

public delegate void OnSetPropertyHandler(object sender, DAVServerSetPropertyEventArgs e);

public class DAVServerSetPropertyEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string Namespace { get; }
  public string PropertyName { get; }
  public string Value { get; }
  public int ResultCode { get; set; }
}

Public Event OnSetProperty As OnSetPropertyHandler

Public Delegate Sub OnSetPropertyHandler(sender As Object, e As DAVServerSetPropertyEventArgs)

Public Class DAVServerSetPropertyEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Namespace As String
  Public ReadOnly Property PropertyName As String
  Public ReadOnly Property Value As String
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to add or update custom metadata to a file or directory is received.

Note that the component does not maintain these custom metadata properties internally. Developers making use of custom properties should maintain a dictionary or other data structure to store these property names and values, and within this event handler add or update the metadata value to the existing list.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item whose custom metadata is to be set is located in the root directory, the value will be empty.

FileName identifies the name of the file or directory whose custom metadata is to be set.

Namespace and PropertyName identify the name of the custom metadata property to be set.

Value contains the value of the specified custom metadata property for the file or directory.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

UnknownRequest Event (DAVServer Component)

Fires when the component does not recognize the request.

Syntax

• C#
• VB.NET

public event OnUnknownRequestHandler OnUnknownRequest;

public delegate void OnUnknownRequestHandler(object sender, DAVServerUnknownRequestEventArgs e);

public class DAVServerUnknownRequestEventArgs : EventArgs {
  public long SessionId { get; }
  public string HttpMethod { get; }
  public string URI { get; }
  public string RequestHeaders { get; }
  public byte[] RequestBody { get; }
  public string ResponseHeaders { get; set; }
  public byte[] ResponseBody { get; set; }
  public int StatusCode { get; set; }
}

Public Event OnUnknownRequest As OnUnknownRequestHandler

Public Delegate Sub OnUnknownRequestHandler(sender As Object, e As DAVServerUnknownRequestEventArgs)

Public Class DAVServerUnknownRequestEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property HttpMethod As String
  Public ReadOnly Property URI As String
  Public ReadOnly Property RequestHeaders As String
  Public ReadOnly Property RequestBody As Byte()
  Public Property ResponseHeaders As String
  Public Property ResponseBody As Byte()
  Public Property StatusCode As Integer
End Class

Remarks

This event fires when a request that falls outside the operations understood by the component is received, providing access to the raw content of the request. Within this event, developers can implement any arbitrary logic to handle these unknown requests and then provide the full response headers and body to return to the client.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

HttpMethod indicates the HTTP method used in the HTTP request that triggered this event.

URI indicates the URI that identifies the target resource in the HTTP request.

RequestHeaders contains the headers used in the HTTP request provided as name-value pairs.

RequestBody contains the raw content of the body of the HTTP request.

ResponseHeaders should be set to the names and values of headers returned to the client in the HTTP response. As per HTTP standard, header names and values should be separated by a colon, and separate headers are separate strings in the array.

ResponseBody should be set to the raw content that will be sent in the body of the HTTP response.

StatusCode should be set to an appropriate error code from the Error Codes page.

UnlockFile Event (DAVServer Component)

Fires when the component needs to unlock a file or directory.

Syntax

• C#
• VB.NET

public event OnUnlockFileHandler OnUnlockFile;

public delegate void OnUnlockFileHandler(object sender, DAVServerUnlockFileEventArgs e);

public class DAVServerUnlockFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public string LockToken { get; }
  public int ResultCode { get; set; }
}

Public Event OnUnlockFile As OnUnlockFileHandler

Public Delegate Sub OnUnlockFileHandler(sender As Object, e As DAVServerUnlockFileEventArgs)

Public Class DAVServerUnlockFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property LockToken As String
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to unlock a file or directory is received.

If the lock did not exist when this event was fired, the event handler must return the DAVSDK_ERR_LOCK_VIOLATION.

Note that the component does not maintain locks internally. Developers making use of locks should maintain a dictionary or other data structure to keep track of item lock information, and within this event handler check to see if a corresponding lock exists on the item that can be deleted.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file or directory relative to the server root. If the item to be unlocked is in the root directory, the value will be empty.

FileName identifies the name of the file or directory to be unlocked.

LockToken specifies the unique identifier for the lock to be removed.

ResultCode provides an opportunity to report the result of the operation. This will always be DAVSDK_ERR_NOT_IMPLEMENTED when the event is fired and should be set to 0 to indicate success or DAVSDK_ERR_LOCK_FAILED to indicate that a lock could not be created or removed specifically due to a conflict with another lock. Any other non-zero value indicates the lock could not be created or removed for other reasons.

UserAuthRequest Event (DAVServer Component)

Fires when the component attempts to authenticate a client.

Syntax

• C#
• VB.NET

public event OnUserAuthRequestHandler OnUserAuthRequest;

public delegate void OnUserAuthRequestHandler(object sender, DAVServerUserAuthRequestEventArgs e);

public class DAVServerUserAuthRequestEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string AuthMethod { get; }
  public string User { get; }
  public string Password { get; set; }
  public string Realm { get; }
  public string KerberosSPN { get; }
  public bool Accept { get; set; }
}

Public Event OnUserAuthRequest As OnUserAuthRequestHandler

Public Delegate Sub OnUserAuthRequestHandler(sender As Object, e As DAVServerUserAuthRequestEventArgs)

Public Class DAVServerUserAuthRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property AuthMethod As String
  Public ReadOnly Property User As String
  Public Property Password As String
  Public ReadOnly Property Realm As String
  Public ReadOnly Property KerberosSPN As String
  Public Property Accept As Boolean
End Class

Remarks

When the ProcessingMode property is set to modeEmbeddedServer, this event provides access to the authentication credentials that a client supplies when attempting to connect. Within this event, developers have the ability to validate credentials using whatever logic is appropriate. Note that the component does not directly validate or invalidate the credentials.

ConnectionId specifies the unique identifier that distinguishes this connection from other connections, even from the same client.

AuthMethod identifies the type of authentication the client is attempting to perform. This value is taken from the HTTP headers of the connection request.

User contains the user the client claims to be. If applicable, this value is taken from the HTTP headers of the connection request.

Password contains the password supplied by the client. If applicable, this value is taken from the HTTP headers of the connection request.

Realm indicates the authentication group for the client, e.g. for Kerberos authentication.

KerberosSPN indicates the Service Principal Name, or service that the client is attempting to authenticate for (when using Kerberos authentication).

Accept should be set to true in order to successfully authenticate the client or false in order to deny the client's connection request.

WriteFile Event (DAVServer Component)

Fires when the component needs to store file data.

Syntax

• C#
• VB.NET

public event OnWriteFileHandler OnWriteFile;

public delegate void OnWriteFileHandler(object sender, DAVServerWriteFileEventArgs e);

public class DAVServerWriteFileEventArgs : EventArgs {
  public long SessionId { get; }
  public string Path { get; }
  public string FileName { get; }
  public byte[] Data { get; }
  public long Offset { get; }
  public int Length { get; }
  public int ResultCode { get; set; }
}

Public Event OnWriteFile As OnWriteFileHandler

Public Delegate Sub OnWriteFileHandler(sender As Object, e As DAVServerWriteFileEventArgs)

Public Class DAVServerWriteFileEventArgs Inherits EventArgs
  Public ReadOnly Property SessionId As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Data As Byte()
  Public ReadOnly Property Offset As Long
  Public ReadOnly Property Length As Integer
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when a request to upload file data is received and and that request was not already satisfied within the PutFile event.

Any failure to write any part of the data should be reported as an error.

SessionId specifies the unique identifier for the current session and can be obtained from the initial SessionStart event when the session is first opened.

Path identifies the path of the file relative to the server root. If the file is to be uploaded in the root directory, the value will be empty.

FileName contains the name of the file to be uploaded.

Data contains the block of data that the server should store. This data comes from the inbound request and the component imposes no restrictions on how this data should be treated.

Offset indicates how many bytes have already been transferred in prior firings of this event (which can occur when handling large sets of data) and provides the starting index for the current block of data.

Length indicates the size of the current block of data to be written.

ResultCode provides an opportunity to report the operation as failed. This parameter will always be 0 when the event is fired, indicating the operation was successful. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), this must be set to a non-zero value.

Event Order During Upload Operations

When an upload request is received, the component fires a series of events in the following order. Note that certain details like the number of levels of directories within which the target file resides may impact how events fire.

1. SessionStart - Fires when a client initiates a session with the component and helps associate a unique session identifier with the request.
2. CheckAccess - Fires when a client attempts to list or write a file or directory and provides an opportunity to check access and permissions (optional).
3. GetFileInfo - Fires to access metadata regarding the file or directory being written or listed.
4. PutFile - Fires to provide a simple way for the component to store file data by setting a filepath (optional).
5. GetFileLocks - Fires when the component needs to check or acquire locks to the file being written.
6. CreateFile - Fires when the component is asked to create a file that does not already exist.
7. WriteFile - Fires if PutFile was not used to store the file and provides full control over inbound upload data.
8. SessionEnd - Fires when a client successfully ends a session and allows closing out the session identifier.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

ServerSettings Type

The embedded HTTP server settings used by the component.

Remarks

This type describes the current embedded HTTP server settings used by the component. The fields are used to configure the server.

• AllowedAuthMethods
• LocalHost
• LocalPort
• Timeout

Fields

Constructors

• C#
• VB.NET

public ServerSettings();

Public ServerSettings()

Config Settings (DAVServer Component)

DAVServer Config Settings

Trappable Errors (DAVServer Component)

Please refer to the Error Handling topic for more information.

DAVServer Errors