WebDAVServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

secureblackbox.WebDAVServer

Remarks

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

Property List

---

The following is the full list of the properties of the 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.

Active Property (WebDAVServer Class)

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

Syntax

public boolean isActive();

Default Value

False

Remarks

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

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

AuthRealm Property (WebDAVServer Class)

Specifies authentication realm for digest and NTLM authentication.

Syntax

public String getAuthRealm();
public void setAuthRealm(String authRealm);

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

AuthTypes Property (WebDAVServer Class)

Defines allowed HTTP authentication types.

Syntax

public int getAuthTypes();
public void setAuthTypes(int authTypes);

Default Value

0

Remarks

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

BoundPort Property (WebDAVServer Class)

Indicates the bound listening port.

Syntax

public int getBoundPort();

Default Value

0

Remarks

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

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

ClientFileEntry Property (WebDAVServer Class)

A container for current file entry details.

Syntax

public WebDAVListEntry getClientFileEntry();
public void setClientFileEntry(WebDAVListEntry clientFileEntry);

Remarks

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

This property is not available at design time.

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

DocumentRoot Property (WebDAVServer Class)

The document root of the server.

Syntax

public String getDocumentRoot();
public void setDocumentRoot(String documentRoot);

Default Value

""

Remarks

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

ExternalCrypto Property (WebDAVServer Class)

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto getExternalCrypto();

Remarks

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

This property is read-only.

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

FIPSMode Property (WebDAVServer Class)

Reserved.

Syntax

public boolean isFIPSMode();
public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

Host Property (WebDAVServer Class)

The host to bind the listening port to.

Syntax

public String getHost();
public void setHost(String host);

Default Value

""

Remarks

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

MetadataFlushTimeout Property (WebDAVServer Class)

Specifies metadata flush timeout.

Syntax

public int getMetadataFlushTimeout();
public void setMetadataFlushTimeout(int metadataFlushTimeout);

Default Value

600

Remarks

Use this property to specify metadata flush timeout in seconds.

MetadataRoot Property (WebDAVServer Class)

The metadata directory root.

Syntax

public String getMetadataRoot();
public void setMetadataRoot(String metadataRoot);

Default Value

""

Remarks

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

PinnedClient Property (WebDAVServer Class)

Populates the pinned client details.

Syntax

public TLSConnectionInfo getPinnedClient();

Remarks

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

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

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

PinnedClientChain Property (WebDAVServer Class)

Contains the certificate chain of the pinned client.

Syntax

public CertificateList getPinnedClientChain();

Remarks

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

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

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

Port Property (WebDAVServer Class)

Specifies the port number to listen for connections on.

Syntax

public int getPort();
public void setPort(int port);

Default Value

80

Remarks

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

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

PortRangeFrom Property (WebDAVServer Class)

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

Syntax

public int getPortRangeFrom();
public void setPortRangeFrom(int portRangeFrom);

Default Value

0

Remarks

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

PortRangeTo Property (WebDAVServer Class)

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

Syntax

public int getPortRangeTo();
public void setPortRangeTo(int portRangeTo);

Default Value

0

Remarks

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

SocketSettings Property (WebDAVServer Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

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

TLSServerChain Property (WebDAVServer Class)

The server's TLS certificates.

Syntax

public CertificateList getTLSServerChain();
public void setTLSServerChain(CertificateList TLSServerChain);

Remarks

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

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

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

This property is not available at design time.

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

TLSSettings Property (WebDAVServer Class)

Manages TLS layer settings.

Syntax

public TLSSettings getTLSSettings();

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

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

Users Property (WebDAVServer Class)

Provides a list of registered users.

Syntax

public UserAccountList getUsers();
public void setUsers(UserAccountList users);

Remarks

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

This property is not available at design time.

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

WebsiteName Property (WebDAVServer Class)

Specifies the web site name to use in the certificate.

Syntax

public String getWebsiteName();
public void setWebsiteName(String websiteName);

Default Value

"SecureBlackbox"

Remarks

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

Cleanup Method (WebDAVServer Class)

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

Syntax

public void cleanup();

Remarks

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

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

DoAction Method (WebDAVServer Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

DropClient Method (WebDAVServer Class)

Terminates a client connection.

Syntax

public void dropClient(long connectionId, boolean forced);

Remarks

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

GetClientBuffer Method (WebDAVServer Class)

Obtains a pending connection buffer.

Syntax

public byte[] getClientBuffer(long connectionID);

Remarks

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

GetRequestBytes Method (WebDAVServer Class)

Returns the contents of the client's HTTP request.

Syntax

public byte[] getRequestBytes(long connectionId, String requestFilter);

Remarks

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

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

GetRequestHeader Method (WebDAVServer Class)

Returns a request header value.

Syntax

public String getRequestHeader(long connectionId, String headerName);

Remarks

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

GetRequestStream Method (WebDAVServer Class)

Returns the contents of the client's HTTP request.

Syntax

public void getRequestStream(long connectionId, String requestFilter, java.io.OutputStream outputStream);

Remarks

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

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

GetRequestString Method (WebDAVServer Class)

Returns the contents of the client's HTTP request.

Syntax

public String getRequestString(long connectionId, String requestFilter);

Remarks

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

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

GetRequestUsername Method (WebDAVServer Class)

Returns the username for a connection.

Syntax

public String getRequestUsername(long connectionId);

Remarks

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

GetResponseHeader Method (WebDAVServer Class)

Returns a response header value.

Syntax

public String getResponseHeader(long connectionId, String headerName);

Remarks

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

ListClients Method (WebDAVServer Class)

Enumerates the connected clients.

Syntax

public String listClients();

Remarks

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

PinClient Method (WebDAVServer Class)

Takes a snapshot of the connection's properties.

Syntax

public void pinClient(long connectionId);

Remarks

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

ProcessGenericRequest Method (WebDAVServer Class)

Processes a generic HTTP request.

Syntax

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

Remarks

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

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

The method returns the complete HTTP response including HTTP headers.

ProcessGenericRequestStream Method (WebDAVServer Class)

Processes a generic HTTP request from a stream.

Syntax

public void processGenericRequestStream(long connectionId, String requestHeaders, java.io.InputStream requestData, java.io.OutputStream responseData);

Remarks

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

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

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

Reset Method (WebDAVServer Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

SetClientBuffer Method (WebDAVServer Class)

Commits a data buffer to the connection.

Syntax

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

Remarks

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

SetClientFileEntry Method (WebDAVServer Class)

Commits a file entry to the connection.

Syntax

public void setClientFileEntry(long connectionID);

Remarks

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

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

SetResponseBytes Method (WebDAVServer Class)

Sets a byte array to be served as a response.

Syntax

public void setResponseBytes(long connectionId, byte[] bytes, String contentType, String responseFilter);

Remarks

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

SetResponseFile Method (WebDAVServer Class)

Sets a file to be served as a response.

Syntax

public void setResponseFile(long connectionId, String fileName, String contentType, String responseFilter);

Remarks

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

SetResponseHeader Method (WebDAVServer Class)

Sets a response header.

Syntax

public void setResponseHeader(long connectionId, String headerName, String value);

Remarks

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

SetResponseStatus Method (WebDAVServer Class)

Sets an HTTP status to be sent with the response.

Syntax

public void setResponseStatus(long connectionId, int statusCode);

Remarks

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

SetResponseStream Method (WebDAVServer Class)

Sets a stream to be served as a response.

Syntax

public void setResponseStream(long connectionId, java.io.InputStream dataStream, boolean closeStream, String contentType, String responseFilter);

Remarks

Use this property to provide the response content in a stream. Set CloseStream to indicate that the stream should be disposed of once sent. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseString Method (WebDAVServer Class)

Sets a string to be served as a response.

Syntax

public void setResponseString(long connectionId, String dataStr, String contentType, String responseFilter);

Remarks

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

Start Method (WebDAVServer Class)

Starts the server.

Syntax

public void start();

Remarks

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

Stop Method (WebDAVServer Class)

Stops the server.

Syntax

public void stop();

Remarks

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

Accept Event (WebDAVServer Class)

Reports an incoming connection.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void accept(WebDAVServerAcceptEvent e) {}
  ...
}

public class WebDAVServerAcceptEvent {
  public String remoteAddress;
  public int remotePort;
  public boolean accept; //read-write
}

Remarks

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

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

AfterBrowse Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterBrowse(WebDAVServerAfterBrowseEvent e) {}
  ...
}

public class WebDAVServerAfterBrowseEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

This event is typically fired after the BeforeBrowse event.

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

AfterCopyObject Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterCopyObject(WebDAVServerAfterCopyObjectEvent e) {}
  ...
}

public class WebDAVServerAfterCopyObjectEvent {
  public long connectionID;
  public String oldPath;
  public String newPath;
  public int operationStatus; //read-write
}

Remarks

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

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

AfterCreateCalendar Event (WebDAVServer Class)

This event reports the completion of calendar creation request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterCreateCalendar(WebDAVServerAfterCreateCalendarEvent e) {}
  ...
}

public class WebDAVServerAfterCreateCalendarEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

AfterCreateCollection Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterCreateCollection(WebDAVServerAfterCreateCollectionEvent e) {}
  ...
}

public class WebDAVServerAfterCreateCollectionEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

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

AfterCustomRequest Event (WebDAVServer Class)

This event reports the completion of the custom request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterCustomRequest(WebDAVServerAfterCustomRequestEvent e) {}
  ...
}

public class WebDAVServerAfterCustomRequestEvent {
  public long connectionID;
  public String requestMethod;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

AfterLockObject Event (WebDAVServer Class)

Reports the completion of the object locking operation.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterLockObject(WebDAVServerAfterLockObjectEvent e) {}
  ...
}

public class WebDAVServerAfterLockObjectEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

AfterRefreshLock Event (WebDAVServer Class)

Reports the completion of the lock refresh operation.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterRefreshLock(WebDAVServerAfterRefreshLockEvent e) {}
  ...
}

public class WebDAVServerAfterRefreshLockEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

AfterRemoveObject Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterRemoveObject(WebDAVServerAfterRemoveObjectEvent e) {}
  ...
}

public class WebDAVServerAfterRemoveObjectEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

AfterRenameObject Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterRenameObject(WebDAVServerAfterRenameObjectEvent e) {}
  ...
}

public class WebDAVServerAfterRenameObjectEvent {
  public long connectionID;
  public String oldPath;
  public String newPath;
  public int operationStatus; //read-write
}

Remarks

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

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

AfterSetAttributes Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterSetAttributes(WebDAVServerAfterSetAttributesEvent e) {}
  ...
}

public class WebDAVServerAfterSetAttributesEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

AfterUnlockObject Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void afterUnlockObject(WebDAVServerAfterUnlockObjectEvent e) {}
  ...
}

public class WebDAVServerAfterUnlockObjectEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

AuthAttempt Event (WebDAVServer Class)

Fires when a connected client makes an authentication attempt.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void authAttempt(WebDAVServerAuthAttemptEvent e) {}
  ...
}

public class WebDAVServerAuthAttemptEvent {
  public long connectionID;
  public String HTTPMethod;
  public String URI;
  public String authMethod;
  public String username;
  public String password;
  public boolean allow; //read-write
}

Remarks

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

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

BeforeBrowse Event (WebDAVServer Class)

Fires when a Browse request is received.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeBrowse(WebDAVServerBeforeBrowseEvent e) {}
  ...
}

public class WebDAVServerBeforeBrowseEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeCopyObject Event (WebDAVServer Class)

Fires when a Copy Object request is received.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeCopyObject(WebDAVServerBeforeCopyObjectEvent e) {}
  ...
}

public class WebDAVServerBeforeCopyObjectEvent {
  public long connectionID;
  public String oldPath;
  public String newPath;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeCreateCalendar Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeCreateCalendar(WebDAVServerBeforeCreateCalendarEvent e) {}
  ...
}

public class WebDAVServerBeforeCreateCalendarEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeCreateCollection Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeCreateCollection(WebDAVServerBeforeCreateCollectionEvent e) {}
  ...
}

public class WebDAVServerBeforeCreateCollectionEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeCustomRequest Event (WebDAVServer Class)

Notifies the application about an incoming custom request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeCustomRequest(WebDAVServerBeforeCustomRequestEvent e) {}
  ...
}

public class WebDAVServerBeforeCustomRequestEvent {
  public long connectionID;
  public String requestMethod;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeDownloadObject Event (WebDAVServer Class)

Fires when an object download request is received.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeDownloadObject(WebDAVServerBeforeDownloadObjectEvent e) {}
  ...
}

public class WebDAVServerBeforeDownloadObjectEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeLockObject Event (WebDAVServer Class)

Fires when a lock request is received.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeLockObject(WebDAVServerBeforeLockObjectEvent e) {}
  ...
}

public class WebDAVServerBeforeLockObjectEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeRefreshLock Event (WebDAVServer Class)

Reports the receipt of lock refresh request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeRefreshLock(WebDAVServerBeforeRefreshLockEvent e) {}
  ...
}

public class WebDAVServerBeforeRefreshLockEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeRemoveObject Event (WebDAVServer Class)

Fires when an object deletion request is received.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeRemoveObject(WebDAVServerBeforeRemoveObjectEvent e) {}
  ...
}

public class WebDAVServerBeforeRemoveObjectEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeRenameObject Event (WebDAVServer Class)

Reports object renaming requests.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeRenameObject(WebDAVServerBeforeRenameObjectEvent e) {}
  ...
}

public class WebDAVServerBeforeRenameObjectEvent {
  public long connectionID;
  public String oldPath;
  public String newPath;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeRequest Event (WebDAVServer Class)

Fires before a DAV request is processed.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeRequest(WebDAVServerBeforeRequestEvent e) {}
  ...
}

public class WebDAVServerBeforeRequestEvent {
  public long connectionID;
  public String HTTPMethod;
  public String URL;
  public boolean accept; //read-write
}

Remarks

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

Use Accept parameter to accept or reject the request.

BeforeSetAttributes Event (WebDAVServer Class)

Notifies the application about attribute change request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeSetAttributes(WebDAVServerBeforeSetAttributesEvent e) {}
  ...
}

public class WebDAVServerBeforeSetAttributesEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeUnlockObject Event (WebDAVServer Class)

Fires when an unlock request is received.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeUnlockObject(WebDAVServerBeforeUnlockObjectEvent e) {}
  ...
}

public class WebDAVServerBeforeUnlockObjectEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

BeforeUploadObject Event (WebDAVServer Class)

Fires when an object upload request is received.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void beforeUploadObject(WebDAVServerBeforeUploadObjectEvent e) {}
  ...
}

public class WebDAVServerBeforeUploadObjectEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

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

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

Choose Action as one of the following values:

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

ClearAttribute Event (WebDAVServer Class)

Reports an attribute clearance request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void clearAttribute(WebDAVServerClearAttributeEvent e) {}
  ...
}

public class WebDAVServerClearAttributeEvent {
  public long connectionID;
  public String path;
  public String NS;
  public String name;
  public int operationStatus; //read-write
}

Remarks

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

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

Connect Event (WebDAVServer Class)

Reports an accepted connection.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void connect(WebDAVServerConnectEvent e) {}
  ...
}

public class WebDAVServerConnectEvent {
  public long connectionID;
  public String remoteAddress;
  public int remotePort;
}

Remarks

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

CopyObject Event (WebDAVServer Class)

Lets the application handle the Copy Object request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void copyObject(WebDAVServerCopyObjectEvent e) {}
  ...
}

public class WebDAVServerCopyObjectEvent {
  public long connectionID;
  public String oldPath;
  public String newPath;
  public boolean overwrite;
  public int depth;
  public int operationStatus; //read-write
}

Remarks

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

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

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

CreateCalendar Event (WebDAVServer Class)

Lets the application handle a calendar creation request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void createCalendar(WebDAVServerCreateCalendarEvent e) {}
  ...
}

public class WebDAVServerCreateCalendarEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

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

CreateCollection Event (WebDAVServer Class)

Lets the application respond to collection creation request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void createCollection(WebDAVServerCreateCollectionEvent e) {}
  ...
}

public class WebDAVServerCreateCollectionEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

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

CustomRequest Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void customRequest(WebDAVServerCustomRequestEvent e) {}
  ...
}

public class WebDAVServerCustomRequestEvent {
  public long connectionID;
  public String requestMethod;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

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

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

Data Event (WebDAVServer Class)

Supplies a data chunk received from a client.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void data(WebDAVServerDataEvent e) {}
  ...
}

public class WebDAVServerDataEvent {
  public long connectionID;
  public byte[] buffer;
}

Remarks

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

Disconnect Event (WebDAVServer Class)

Fires to report a disconnected client.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void disconnect(WebDAVServerDisconnectEvent e) {}
  ...
}

public class WebDAVServerDisconnectEvent {
  public long connectionID;
}

Remarks

class fires this event when a connected client disconnects.

DownloadObject Event (WebDAVServer Class)

Allows the application respond to Download Object request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void downloadObject(WebDAVServerDownloadObjectEvent e) {}
  ...
}

public class WebDAVServerDownloadObjectEvent {
  public long connectionID;
  public String path;
  public long restartAt;
  public int operationStatus; //read-write
}

Remarks

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

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

DownloadObjectCompleted Event (WebDAVServer Class)

This event is fired when a download operation completes.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void downloadObjectCompleted(WebDAVServerDownloadObjectCompletedEvent e) {}
  ...
}

public class WebDAVServerDownloadObjectCompletedEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

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

Error Event (WebDAVServer Class)

Information about errors during data delivery.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void error(WebDAVServerErrorEvent e) {}
  ...
}

public class WebDAVServerErrorEvent {
  public long connectionID;
  public int errorCode;
  public boolean fatal;
  public boolean remote;
  public String description;
}

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.

ExternalSign Event (WebDAVServer Class)

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void externalSign(WebDAVServerExternalSignEvent e) {}
  ...
}

public class WebDAVServerExternalSignEvent {
  public long connectionID;
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData; //read-write
}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

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

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

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

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

FileError Event (WebDAVServer Class)

Reports a file access error to the application.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void fileError(WebDAVServerFileErrorEvent e) {}
  ...
}

public class WebDAVServerFileErrorEvent {
  public long connectionID;
  public String fileName;
  public int errorCode;
}

Remarks

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

HeadersPrepared Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void headersPrepared(WebDAVServerHeadersPreparedEvent e) {}
  ...
}

public class WebDAVServerHeadersPreparedEvent {
  public long connectionID;
}

Remarks

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

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

ListAttributes Event (WebDAVServer Class)

Requests object attributes from the application in fraCustom handling mode.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void listAttributes(WebDAVServerListAttributesEvent e) {}
  ...
}

public class WebDAVServerListAttributesEvent {
  public long connectionID;
  public String path;
  public String attributes; //read-write
}

Remarks

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

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

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

ListSubObjects Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void listSubObjects(WebDAVServerListSubObjectsEvent e) {}
  ...
}

public class WebDAVServerListSubObjectsEvent {
  public long connectionID;
  public String path;
  public boolean recursive;
  public String objects; //read-write
  public int operationStatus; //read-write
}

Remarks

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

LockObject Event (WebDAVServer Class)

Virtualizes the object locking operation.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void lockObject(WebDAVServerLockObjectEvent e) {}
  ...
}

public class WebDAVServerLockObjectEvent {
  public long connectionID;
  public String path;
  public String owner;
  public boolean exclusive;
  public int depth;
  public long timeout;
  public String token; //read-write
}

Remarks

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

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

Notification Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void notification(WebDAVServerNotificationEvent e) {}
  ...
}

public class WebDAVServerNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

QueryQuota Event (WebDAVServer Class)

Reflects a quota enquiry by a client.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void queryQuota(WebDAVServerQueryQuotaEvent e) {}
  ...
}

public class WebDAVServerQueryQuotaEvent {
  public long connectionID;
  public String username;
  public long available; //read-write
  public long used; //read-write
}

Remarks

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

ReadAttribute Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void readAttribute(WebDAVServerReadAttributeEvent e) {}
  ...
}

public class WebDAVServerReadAttributeEvent {
  public long connectionID;
  public String path;
  public String NS;
  public String name;
  public String value; //read-write
  public int operationStatus; //read-write
}

Remarks

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

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

ReadObject Event (WebDAVServer Class)

Requests a piece of object data from the application.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void readObject(WebDAVServerReadObjectEvent e) {}
  ...
}

public class WebDAVServerReadObjectEvent {
  public long connectionID;
  public int size;
  public int operationStatus; //read-write
}

Remarks

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

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

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

Set OperationStatus to one of the following values:

RefreshLock Event (WebDAVServer Class)

Notifies the application about a lock refresh request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void refreshLock(WebDAVServerRefreshLockEvent e) {}
  ...
}

public class WebDAVServerRefreshLockEvent {
  public long connectionID;
  public String path;
  public String token;
  public long timeout;
  public boolean lockFound; //read-write
}

Remarks

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

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

RemoveObject Event (WebDAVServer Class)

Notifies the application about object deletion requests.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void removeObject(WebDAVServerRemoveObjectEvent e) {}
  ...
}

public class WebDAVServerRemoveObjectEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

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

RenameObject Event (WebDAVServer Class)

Notifies the application about object name change requests.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void renameObject(WebDAVServerRenameObjectEvent e) {}
  ...
}

public class WebDAVServerRenameObjectEvent {
  public long connectionID;
  public String oldPath;
  public String newPath;
  public boolean overwrite;
  public int operationStatus; //read-write
}

Remarks

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

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

ResourceAccess Event (WebDAVServer Class)

Reports an attempt to access a resource.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void resourceAccess(WebDAVServerResourceAccessEvent e) {}
  ...
}

public class WebDAVServerResourceAccessEvent {
  public long connectionID;
  public String HTTPMethod;
  public String URI;
  public boolean allow; //read-write
  public String redirectURI; //read-write
}

Remarks

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

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

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

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

SetAttribute Event (WebDAVServer Class)

Lets the application customize attribute assignment requests.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void setAttribute(WebDAVServerSetAttributeEvent e) {}
  ...
}

public class WebDAVServerSetAttributeEvent {
  public long connectionID;
  public String path;
  public String NS;
  public String name;
  public String value;
  public int operationStatus; //read-write
}

Remarks

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

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

TLSCertValidate Event (WebDAVServer Class)

Fires when a client certificate needs to be validated.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void TLSCertValidate(WebDAVServerTLSCertValidateEvent e) {}
  ...
}

public class WebDAVServerTLSCertValidateEvent {
  public long connectionID;
  public boolean accept; //read-write
}

Remarks

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

TLSEstablished Event (WebDAVServer Class)

Reports the setup of a TLS session.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void TLSEstablished(WebDAVServerTLSEstablishedEvent e) {}
  ...
}

public class WebDAVServerTLSEstablishedEvent {
  public long connectionID;
}

Remarks

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

TLSHandshake Event (WebDAVServer Class)

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

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void TLSHandshake(WebDAVServerTLSHandshakeEvent e) {}
  ...
}

public class WebDAVServerTLSHandshakeEvent {
  public long connectionID;
  public String serverName;
  public boolean abort; //read-write
}

Remarks

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

TLSPSK Event (WebDAVServer Class)

Requests a pre-shared key for TLS-PSK.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void TLSPSK(WebDAVServerTLSPSKEvent e) {}
  ...
}

public class WebDAVServerTLSPSKEvent {
  public long connectionID;
  public String identity;
  public String PSK; //read-write
  public String ciphersuite; //read-write
}

Remarks

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

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

TLSShutdown Event (WebDAVServer Class)

Reports closure of a TLS session.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void TLSShutdown(WebDAVServerTLSShutdownEvent e) {}
  ...
}

public class WebDAVServerTLSShutdownEvent {
  public long connectionID;
}

Remarks

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

UnlockObject Event (WebDAVServer Class)

Virtualizes the object unlocking operation.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void unlockObject(WebDAVServerUnlockObjectEvent e) {}
  ...
}

public class WebDAVServerUnlockObjectEvent {
  public long connectionID;
  public String path;
  public String token;
  public boolean lockFound; //read-write
}

Remarks

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

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

UploadObject Event (WebDAVServer Class)

Lets the application respond to the Upload Object request.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void uploadObject(WebDAVServerUploadObjectEvent e) {}
  ...
}

public class WebDAVServerUploadObjectEvent {
  public long connectionID;
  public String path;
  public long restartAt;
  public boolean append;
  public int operationStatus; //read-write
}

Remarks

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

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

UploadObjectCompleted Event (WebDAVServer Class)

This event is fired when a upload operation completes.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void uploadObjectCompleted(WebDAVServerUploadObjectCompletedEvent e) {}
  ...
}

public class WebDAVServerUploadObjectCompletedEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

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

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

WriteObject Event (WebDAVServer Class)

Hands a piece of object data to the application.

Syntax

public class DefaultWebDAVServerEventListener implements WebDAVServerEventListener {
  ...
  public void writeObject(WebDAVServerWriteObjectEvent e) {}
  ...
}

public class WebDAVServerWriteObjectEvent {
  public long connectionID;
  public int operationStatus; //read-write
}

Remarks

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

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

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

Set OperationStatus to one of the following values:

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

public Certificate( bytes,  startIndex,  count);

public Certificate( path,  password);

public Certificate( certPath,  keyPath,  password);

public Certificate( path);

public Certificate( stream);

public Certificate( stream,  password);

public Certificate( certStream,  keyStream,  password);

public Certificate();

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

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

Fields

Constructors

public ExternalCrypto();

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

TLSConnectionInfo Type

Contains information about a network connection.

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

Fields

Constructors

public TLSConnectionInfo();

TLSSettings Type

A container for TLS connection settings.

Remarks

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

Fields

Constructors

public TLSSettings();

UserAccount Type

A container for user account information.

Remarks

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

Fields

Constructors

public UserAccount();

WebDAVListEntry Type

Contains a set of attributes of a single WebDAV object.

Remarks

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

Fields

Constructors

public WebDAVListEntry();

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

WebDAVServer Config Settings

Base Config Settings

Trappable Errors (WebDAVServer Class)

WebDAVServer Errors