DAVServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

davsdk.DAVServer

Remarks

The DAVServer class 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 class 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 class 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 class with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

ProcessingMode Property (DAVServer Class)

The mode in which the class will be hosted.

Syntax

public int getProcessingMode();
public void setProcessingMode(int processingMode);

Enumerated values:
  public final static int modeEmbeddedServer = 0;
  public final static int modeExternalServer = 1;
  public final static int modeOffline = 2;

Default Value

0

Remarks

This property governs whether the class 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 Class)

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

Syntax

public byte[] getRequest();
public void setRequest(byte[] request);

Default Value

""

Remarks

When the ProcessingMode property is set to modeOffline, the class 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 class will begin processing the request when the ProcessRequest method is called.

RequestHeaders Property (DAVServer Class)

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

Syntax

public String getRequestHeaders();
public void setRequestHeaders(String requestHeaders);

Default Value

""

Remarks

When the ProcessingMode property is set to modeOffline, the class 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 class will begin processing the request when the ProcessRequest method is called.

Response Property (DAVServer Class)

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

Syntax

public byte[] getResponse();
public void setResponse(byte[] response);

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 class simply populates this property along with the ResponseHeaders property.

ResponseHeaders Property (DAVServer Class)

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

Syntax

public String getResponseHeaders();
public void setResponseHeaders(String responseHeaders);

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 class simply populates this property along with the Response property.

ServerCert Property (DAVServer Class)

The certificate used during SSL negotiation.

Syntax

public Certificate getServerCert();
public void setServerCert(Certificate serverCert);

Remarks

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

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

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

ServerSettings Property (DAVServer Class)

The embedded HTTP server settings used by the class.

Syntax

public ServerSettings getServerSettings();
public void setServerSettings(ServerSettings 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.

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

Config Method (DAVServer Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

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

Provides the value of the specified session parameter.

Syntax

public String getSessionParam(long sessionId, String name);

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 class and is available in the SessionStart event as well as other events.

Name corresponds to the user-defined parameter name.

ListFile Method (DAVServer Class)

Passes information about a specific file to the class.

Syntax

public boolean listFile(long requestId, String parentId, String fileName, int attributes, long size, java.util.Date creationTime, java.util.Date lastAccessTime, java.util.Date lastModifiedTime, String ownerId);

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

Passes information about a specific directory to the class.

Syntax

public boolean listFolder(long requestId, String parentId, String fileName, int attributes, java.util.Date creationTime, java.util.Date lastAccessTime, java.util.Date lastModifiedTime, String owner);

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

Processes the request and sends the result.

Syntax

public void processRequest(Object request, Object response);

Remarks

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

Note that when using the modeOffline mode, the class 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, Request and Response must be set to instances of the HttpServletRequest and HttpServletResponse classes that correspond to the request to be handled and response to be constructed, respectively.

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

SetSessionParam Method (DAVServer Class)

Sets a user-defined value as a session parameter.

Syntax

public void setSessionParam(long sessionId, String name, String value);

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 class 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 Class)

Instructs the class to start listening for incoming connections.

Syntax

public void startListening();

Remarks

When the ProcessingMode property is set to modeEmbeddedServer, this method instructs the class 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 Class)

Instructs the class to stop listening for new connections.

Syntax

public void stopListening();

Remarks

When the ProcessingMode property is set to modeEmbeddedServer, this method instructs the class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void checkAccess(DAVServerCheckAccessEvent e) {}
  ...
}

public class DAVServerCheckAccessEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public int desiredOperation;
  public int resultCode; //read-write
}

Remarks

This optional event fires when the class 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 class. 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void copyFile(DAVServerCopyFileEvent e) {}
  ...
}

public class DAVServerCopyFileEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String destParentPath;
  public String destFileName;
  public boolean overwriteExisting;
  public int resultCode; //read-write
}

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

Fires when the class needs to create a new directory.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void createDirectory(DAVServerCreateDirectoryEvent e) {}
  ...
}

public class DAVServerCreateDirectoryEvent {
  public long sessionId;
  public String parentPath;
  public String fileName;
  public int resultCode; //read-write
}

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

Fires when the class needs to create an empty file.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void createFile(DAVServerCreateFileEvent e) {}
  ...
}

public class DAVServerCreateFileEvent {
  public long sessionId;
  public String parentPath;
  public String fileName;
  public boolean overwriteExisting;
  public int resultCode; //read-write
}

Remarks

This event fires when the class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void deleteFile(DAVServerDeleteFileEvent e) {}
  ...
}

public class DAVServerDeleteFileEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public boolean recursive;
  public int resultCode; //read-write
}

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

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void deleteProperty(DAVServerDeletePropertyEvent e) {}
  ...
}

public class DAVServerDeletePropertyEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String namespace;
  public String propertyName;
  public int resultCode; //read-write
}

Remarks

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

Note that the class 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 Class)

Fires information about unhandled exceptions caught by the class.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void error(DAVServerErrorEvent e) {}
  ...
}

public class DAVServerErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

This event fires when an unhandled exception is caught by the class, 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 Class)

Fires when the class needs to serve file data.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void getFile(DAVServerGetFileEvent e) {}
  ...
}

public class DAVServerGetFileEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String localPath; //read-write
}

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 class 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 class 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 class 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 class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void getFileInfo(DAVServerGetFileInfoEvent e) {}
  ...
}

public class DAVServerGetFileInfoEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public int requestedInfo;
  public int attributes; //read-write
  public long size; //read-write
  public java.util.Date creationTime; //read-write
  public java.util.Date lastAccessTime; //read-write
  public java.util.Date lastModifiedTime; //read-write
  public String owner; //read-write
  public int resultCode; //read-write
}

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

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void getFileLocks(DAVServerGetFileLocksEvent e) {}
  ...
}

public class DAVServerGetFileLocksEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String lockToken; //read-write
  public java.util.Date expires; //read-write
  public int resultCode; //read-write
}

Remarks

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

Note that the class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void getProperty(DAVServerGetPropertyEvent e) {}
  ...
}

public class DAVServerGetPropertyEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String namespace;
  public String propertyName;
  public String value; //read-write
  public int resultCode; //read-write
}

Remarks

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

Note that the class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void getQuotaInfo(DAVServerGetQuotaInfoEvent e) {}
  ...
}

public class DAVServerGetQuotaInfoEvent {
  public long sessionId;
  public long availableSpace; //read-write
  public long totalSpace; //read-write
  public int resultCode; //read-write
}

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

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void listDirectory(DAVServerListDirectoryEvent e) {}
  ...
}

public class DAVServerListDirectoryEvent {
  public long sessionId;
  public String parentPath;
  public String mask;
  public int requestedInfo;
  public int startAt;
  public String startAfter;
  public int maxFiles;
  public int orderBy;
  public boolean reverseOrder;
  public boolean recursive;
  public long requestId;
  public boolean listingComplete; //read-write
  public int resultCode; //read-write
}

Remarks

This event fires when a request to enumerate the contents of a directory is received. To provide the directory's contents to the class, 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 class 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 class 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 class 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:

Note that ordering must occur through the whole set of items and not just the subset defined by the StartAt, StartAfter, and MaxFiles parameters.

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 class 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 class and there are no more items to report during this enumeration; otherwise, it must be set to false.

For example, if the class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void listProperties(DAVServerListPropertiesEvent e) {}
  ...
}

public class DAVServerListPropertiesEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String namespaces; //read-write
  public String names; //read-write
  public int resultCode; //read-write
}

Remarks

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

Note that the class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void lockFile(DAVServerLockFileEvent e) {}
  ...
}

public class DAVServerLockFileEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String lockToken;
  public java.util.Date expires;
  public int resultCode; //read-write
}

Remarks

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

Note that the class 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 Class)

Fires once for each log message.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void log(DAVServerLogEvent e) {}
  ...
}

public class DAVServerLogEvent {
  public int logLevel;
  public String message;
}

Remarks

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

Message is the log entry.

PutFile Event (DAVServer Class)

Fires when the class needs to store file data.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void putFile(DAVServerPutFileEvent e) {}
  ...
}

public class DAVServerPutFileEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String localPath; //read-write
}

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 class 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 class 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 class 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 class to store file data by setting a filepath (optional).
5. GetFileLocks - Fires when the class needs to check or acquire locks to the file being written.
6. CreateFile - Fires when the class 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 Class)

Fires when the class needs to serve file data.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void readFile(DAVServerReadFileEvent e) {}
  ...
}

public class DAVServerReadFileEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public byte[] buffer;
  public long offset;
  public int length;
  public int bytesRead; //read-write
  public int resultCode; //read-write
}

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 class 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 class 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 class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void renameFile(DAVServerRenameFileEvent e) {}
  ...
}

public class DAVServerRenameFileEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public boolean moveItem;
  public String destParentPath;
  public String newFileName;
  public boolean overwriteExisting;
  public int resultCode; //read-write
}

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

Fires when the class ends a session.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void sessionEnd(DAVServerSessionEndEvent e) {}
  ...
}

public class DAVServerSessionEndEvent {
  public long sessionId;
}

Remarks

This event fires when the class ends a previously started session. The class 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 Class)

Fires when the class starts a session.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void sessionStart(DAVServerSessionStartEvent e) {}
  ...
}

public class DAVServerSessionStartEvent {
  public long sessionId;
  public int resultCode; //read-write
}

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

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void setFileInfo(DAVServerSetFileInfoEvent e) {}
  ...
}

public class DAVServerSetFileInfoEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public int attributes;
  public java.util.Date creationTime;
  public java.util.Date lastModifiedTime;
  public java.util.Date lastAccessTime;
  public int resultCode; //read-write
}

Remarks

This event fires when the class 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 class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void setFileSize(DAVServerSetFileSizeEvent e) {}
  ...
}

public class DAVServerSetFileSizeEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public long newSize;
  public int resultCode; //read-write
}

Remarks

This event fires when the class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void setProperty(DAVServerSetPropertyEvent e) {}
  ...
}

public class DAVServerSetPropertyEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String namespace;
  public String propertyName;
  public String value;
  public int resultCode; //read-write
}

Remarks

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

Note that the class 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 Class)

Fires when the class does not recognize the request.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void unknownRequest(DAVServerUnknownRequestEvent e) {}
  ...
}

public class DAVServerUnknownRequestEvent {
  public long sessionId;
  public String httpMethod;
  public String URI;
  public String requestHeaders;
  public byte[] requestBody;
  public String responseHeaders; //read-write
  public byte[] responseBody; //read-write
  public int statusCode; //read-write
}

Remarks

This event fires when a request that falls outside the operations understood by the class 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 Class)

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

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void unlockFile(DAVServerUnlockFileEvent e) {}
  ...
}

public class DAVServerUnlockFileEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public String lockToken;
  public int resultCode; //read-write
}

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 class 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 Class)

Fires when the class attempts to authenticate a client.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void userAuthRequest(DAVServerUserAuthRequestEvent e) {}
  ...
}

public class DAVServerUserAuthRequestEvent {
  public String connectionId;
  public String authMethod;
  public String user;
  public String password; //read-write
  public String realm;
  public String kerberosSPN;
  public boolean accept; //read-write
}

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 class 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 Class)

Fires when the class needs to store file data.

Syntax

public class DefaultDAVServerEventListener implements DAVServerEventListener {
  ...
  public void writeFile(DAVServerWriteFileEvent e) {}
  ...
}

public class DAVServerWriteFileEvent {
  public long sessionId;
  public String path;
  public String fileName;
  public byte[] data;
  public long offset;
  public int length;
  public int resultCode; //read-write
}

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 class 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 class 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 class 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 class to store file data by setting a filepath (optional).
5. GetFileLocks - Fires when the class needs to check or acquire locks to the file being written.
6. CreateFile - Fires when the class 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
• KeyPassword
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

public Certificate();

public Certificate( certificateFile);

public Certificate( encoded);

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

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

public Certificate( storeType,  store,  storePassword,  encoded);

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

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

public Certificate( storeType,  store,  storePassword,  encoded);

ServerSettings Type

The embedded HTTP server settings used by the class.

Remarks

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

• AllowedAuthMethods
• LocalHost
• LocalPort
• Timeout

Fields

Constructors

public ServerSettings();

Config Settings (DAVServer Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

DAVServer Config Settings

Trappable Errors (DAVServer Class)

The class uses the error codes listed below. They are also available as constants for applications' convenience.

Please refer to the Error Handling topic for more information.

DAVServer Errors