WebDAVServer Module

Properties   Methods   Events   Config Settings   Errors  

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

Method List

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

Event List

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

Config Settings

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

Active Property (WebDAVServer Module)

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

Syntax

• Swift
• Objective-C

public var active: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=active) BOOL active;

- (BOOL)active;

Default Value

False

Remarks

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

This property is read-only.

AuthRealm Property (WebDAVServer Module)

Specifies authentication realm for digest and NTLM authentication.

Syntax

• Swift
• Objective-C

public var authRealm: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=authRealm,setter=setAuthRealm:) NSString* authRealm;

- (NSString*)authRealm;
- (void)setAuthRealm :(NSString*)newAuthRealm;

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

AuthTypes Property (WebDAVServer Module)

Defines allowed HTTP authentication types.

Syntax

• Swift
• Objective-C

public var authTypes: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=authTypes,setter=setAuthTypes:) int authTypes;

- (int)authTypes;
- (void)setAuthTypes :(int)newAuthTypes;

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

Indicates the bound listening port.

Syntax

• Swift
• Objective-C

public var boundPort: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=boundPort) int boundPort;

- (int)boundPort;

Default Value

0

Remarks

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

This property is read-only.

ClientFileEntry Property (WebDAVServer Module)

A container for current file entry details.

Syntax

• Swift
• Objective-C

public var clientFileEntry: WebDAVListEntry {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=clientFileEntryATime,setter=setClientFileEntryATime:) NSString* clientFileEntryATime;

- (NSString*)clientFileEntryATime;
- (void)setClientFileEntryATime :(NSString*)newClientFileEntryATime;

@property (nonatomic,readwrite,assign,getter=clientFileEntryContentType,setter=setClientFileEntryContentType:) NSString* clientFileEntryContentType;

- (NSString*)clientFileEntryContentType;
- (void)setClientFileEntryContentType :(NSString*)newClientFileEntryContentType;

@property (nonatomic,readwrite,assign,getter=clientFileEntryCTime,setter=setClientFileEntryCTime:) NSString* clientFileEntryCTime;

- (NSString*)clientFileEntryCTime;
- (void)setClientFileEntryCTime :(NSString*)newClientFileEntryCTime;

@property (nonatomic,readwrite,assign,getter=clientFileEntryDirectory,setter=setClientFileEntryDirectory:) BOOL clientFileEntryDirectory;

- (BOOL)clientFileEntryDirectory;
- (void)setClientFileEntryDirectory :(BOOL)newClientFileEntryDirectory;

@property (nonatomic,readwrite,assign,getter=clientFileEntryDisplayName,setter=setClientFileEntryDisplayName:) NSString* clientFileEntryDisplayName;

- (NSString*)clientFileEntryDisplayName;
- (void)setClientFileEntryDisplayName :(NSString*)newClientFileEntryDisplayName;

@property (nonatomic,readwrite,assign,getter=clientFileEntryETag,setter=setClientFileEntryETag:) NSString* clientFileEntryETag;

- (NSString*)clientFileEntryETag;
- (void)setClientFileEntryETag :(NSString*)newClientFileEntryETag;

@property (nonatomic,readwrite,assign,getter=clientFileEntryFullURL,setter=setClientFileEntryFullURL:) NSString* clientFileEntryFullURL;

- (NSString*)clientFileEntryFullURL;
- (void)setClientFileEntryFullURL :(NSString*)newClientFileEntryFullURL;

@property (nonatomic,readwrite,assign,getter=clientFileEntryMTime,setter=setClientFileEntryMTime:) NSString* clientFileEntryMTime;

- (NSString*)clientFileEntryMTime;
- (void)setClientFileEntryMTime :(NSString*)newClientFileEntryMTime;

@property (nonatomic,readwrite,assign,getter=clientFileEntryParentURL,setter=setClientFileEntryParentURL:) NSString* clientFileEntryParentURL;

- (NSString*)clientFileEntryParentURL;
- (void)setClientFileEntryParentURL :(NSString*)newClientFileEntryParentURL;

@property (nonatomic,readwrite,assign,getter=clientFileEntrySize,setter=setClientFileEntrySize:) long long clientFileEntrySize;

- (long long)clientFileEntrySize;
- (void)setClientFileEntrySize :(long long)newClientFileEntrySize;

@property (nonatomic,readwrite,assign,getter=clientFileEntrySupportsExclusiveLock,setter=setClientFileEntrySupportsExclusiveLock:) BOOL clientFileEntrySupportsExclusiveLock;

- (BOOL)clientFileEntrySupportsExclusiveLock;
- (void)setClientFileEntrySupportsExclusiveLock :(BOOL)newClientFileEntrySupportsExclusiveLock;

@property (nonatomic,readwrite,assign,getter=clientFileEntrySupportsSharedLock,setter=setClientFileEntrySupportsSharedLock:) BOOL clientFileEntrySupportsSharedLock;

- (BOOL)clientFileEntrySupportsSharedLock;
- (void)setClientFileEntrySupportsSharedLock :(BOOL)newClientFileEntrySupportsSharedLock;

@property (nonatomic,readwrite,assign,getter=clientFileEntryURL,setter=setClientFileEntryURL:) NSString* clientFileEntryURL;

- (NSString*)clientFileEntryURL;
- (void)setClientFileEntryURL :(NSString*)newClientFileEntryURL;

 

Default Value

"SecureBlackbox"

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.

DocumentRoot Property (WebDAVServer Module)

The document root of the server.

Syntax

• Swift
• Objective-C

public var documentRoot: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=documentRoot,setter=setDocumentRoot:) NSString* documentRoot;

- (NSString*)documentRoot;
- (void)setDocumentRoot :(NSString*)newDocumentRoot;

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

Provides access to external signing and DC parameters.

Syntax

• Swift
• Objective-C

public var externalCrypto: ExternalCrypto {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=externalCryptoAsyncDocumentID,setter=setExternalCryptoAsyncDocumentID:) NSString* externalCryptoAsyncDocumentID;

- (NSString*)externalCryptoAsyncDocumentID;
- (void)setExternalCryptoAsyncDocumentID :(NSString*)newExternalCryptoAsyncDocumentID;

@property (nonatomic,readwrite,assign,getter=externalCryptoCustomParams,setter=setExternalCryptoCustomParams:) NSString* externalCryptoCustomParams;

- (NSString*)externalCryptoCustomParams;
- (void)setExternalCryptoCustomParams :(NSString*)newExternalCryptoCustomParams;

@property (nonatomic,readwrite,assign,getter=externalCryptoData,setter=setExternalCryptoData:) NSString* externalCryptoData;

- (NSString*)externalCryptoData;
- (void)setExternalCryptoData :(NSString*)newExternalCryptoData;

@property (nonatomic,readwrite,assign,getter=externalCryptoExternalHashCalculation,setter=setExternalCryptoExternalHashCalculation:) BOOL externalCryptoExternalHashCalculation;

- (BOOL)externalCryptoExternalHashCalculation;
- (void)setExternalCryptoExternalHashCalculation :(BOOL)newExternalCryptoExternalHashCalculation;

@property (nonatomic,readwrite,assign,getter=externalCryptoHashAlgorithm,setter=setExternalCryptoHashAlgorithm:) NSString* externalCryptoHashAlgorithm;

- (NSString*)externalCryptoHashAlgorithm;
- (void)setExternalCryptoHashAlgorithm :(NSString*)newExternalCryptoHashAlgorithm;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeyID,setter=setExternalCryptoKeyID:) NSString* externalCryptoKeyID;

- (NSString*)externalCryptoKeyID;
- (void)setExternalCryptoKeyID :(NSString*)newExternalCryptoKeyID;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeySecret,setter=setExternalCryptoKeySecret:) NSString* externalCryptoKeySecret;

- (NSString*)externalCryptoKeySecret;
- (void)setExternalCryptoKeySecret :(NSString*)newExternalCryptoKeySecret;

@property (nonatomic,readwrite,assign,getter=externalCryptoMethod,setter=setExternalCryptoMethod:) int externalCryptoMethod;

- (int)externalCryptoMethod;
- (void)setExternalCryptoMethod :(int)newExternalCryptoMethod;

@property (nonatomic,readwrite,assign,getter=externalCryptoMode,setter=setExternalCryptoMode:) int externalCryptoMode;

- (int)externalCryptoMode;
- (void)setExternalCryptoMode :(int)newExternalCryptoMode;

@property (nonatomic,readwrite,assign,getter=externalCryptoPublicKeyAlgorithm,setter=setExternalCryptoPublicKeyAlgorithm:) NSString* externalCryptoPublicKeyAlgorithm;

- (NSString*)externalCryptoPublicKeyAlgorithm;
- (void)setExternalCryptoPublicKeyAlgorithm :(NSString*)newExternalCryptoPublicKeyAlgorithm;

 

Default Value

"SecureBlackbox"

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

FIPSMode Property (WebDAVServer Module)

Reserved.

Syntax

• Swift
• Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

Host Property (WebDAVServer Module)

The host to bind the listening port to.

Syntax

• Swift
• Objective-C

public var host: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=host,setter=setHost:) NSString* host;

- (NSString*)host;
- (void)setHost :(NSString*)newHost;

Default Value

""

Remarks

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

MetadataFlushTimeout Property (WebDAVServer Module)

Specifies metadata flush timeout.

Syntax

• Swift
• Objective-C

public var metadataFlushTimeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=metadataFlushTimeout,setter=setMetadataFlushTimeout:) int metadataFlushTimeout;

- (int)metadataFlushTimeout;
- (void)setMetadataFlushTimeout :(int)newMetadataFlushTimeout;

Default Value

600

Remarks

Use this property to specify metadata flush timeout in seconds.

MetadataRoot Property (WebDAVServer Module)

The metadata directory root.

Syntax

• Swift
• Objective-C

public var metadataRoot: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=metadataRoot,setter=setMetadataRoot:) NSString* metadataRoot;

- (NSString*)metadataRoot;
- (void)setMetadataRoot :(NSString*)newMetadataRoot;

Default Value

""

Remarks

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

PinnedClient Property (WebDAVServer Module)

Populates the pinned client details.

Syntax

• Swift
• Objective-C

public var pinnedClient: TLSConnectionInfo {
  get {...}
}

@property (nonatomic,readonly,assign,getter=pinnedClientAEADCipher) BOOL pinnedClientAEADCipher;

- (BOOL)pinnedClientAEADCipher;

@property (nonatomic,readonly,assign,getter=pinnedClientChainValidationDetails) int pinnedClientChainValidationDetails;

- (int)pinnedClientChainValidationDetails;

@property (nonatomic,readonly,assign,getter=pinnedClientChainValidationResult) int pinnedClientChainValidationResult;

- (int)pinnedClientChainValidationResult;

@property (nonatomic,readonly,assign,getter=pinnedClientCiphersuite) NSString* pinnedClientCiphersuite;

- (NSString*)pinnedClientCiphersuite;

@property (nonatomic,readonly,assign,getter=pinnedClientClientAuthenticated) BOOL pinnedClientClientAuthenticated;

- (BOOL)pinnedClientClientAuthenticated;

@property (nonatomic,readonly,assign,getter=pinnedClientClientAuthRequested) BOOL pinnedClientClientAuthRequested;

- (BOOL)pinnedClientClientAuthRequested;

@property (nonatomic,readonly,assign,getter=pinnedClientConnectionEstablished) BOOL pinnedClientConnectionEstablished;

- (BOOL)pinnedClientConnectionEstablished;

@property (nonatomic,readonly,assign,getter=pinnedClientConnectionID) NSData* pinnedClientConnectionID;

- (NSData*)pinnedClientConnectionID;

@property (nonatomic,readonly,assign,getter=pinnedClientDigestAlgorithm) NSString* pinnedClientDigestAlgorithm;

- (NSString*)pinnedClientDigestAlgorithm;

@property (nonatomic,readonly,assign,getter=pinnedClientEncryptionAlgorithm) NSString* pinnedClientEncryptionAlgorithm;

- (NSString*)pinnedClientEncryptionAlgorithm;

@property (nonatomic,readonly,assign,getter=pinnedClientExportable) BOOL pinnedClientExportable;

- (BOOL)pinnedClientExportable;

@property (nonatomic,readonly,assign,getter=pinnedClientID) long long pinnedClientID;

- (long long)pinnedClientID;

@property (nonatomic,readonly,assign,getter=pinnedClientKeyExchangeAlgorithm) NSString* pinnedClientKeyExchangeAlgorithm;

- (NSString*)pinnedClientKeyExchangeAlgorithm;

@property (nonatomic,readonly,assign,getter=pinnedClientKeyExchangeKeyBits) int pinnedClientKeyExchangeKeyBits;

- (int)pinnedClientKeyExchangeKeyBits;

@property (nonatomic,readonly,assign,getter=pinnedClientNamedECCurve) NSString* pinnedClientNamedECCurve;

- (NSString*)pinnedClientNamedECCurve;

@property (nonatomic,readonly,assign,getter=pinnedClientPFSCipher) BOOL pinnedClientPFSCipher;

- (BOOL)pinnedClientPFSCipher;

@property (nonatomic,readonly,assign,getter=pinnedClientPreSharedIdentity) NSString* pinnedClientPreSharedIdentity;

- (NSString*)pinnedClientPreSharedIdentity;

@property (nonatomic,readonly,assign,getter=pinnedClientPreSharedIdentityHint) NSString* pinnedClientPreSharedIdentityHint;

- (NSString*)pinnedClientPreSharedIdentityHint;

@property (nonatomic,readonly,assign,getter=pinnedClientPublicKeyBits) int pinnedClientPublicKeyBits;

- (int)pinnedClientPublicKeyBits;

@property (nonatomic,readonly,assign,getter=pinnedClientRemoteAddress) NSString* pinnedClientRemoteAddress;

- (NSString*)pinnedClientRemoteAddress;

@property (nonatomic,readonly,assign,getter=pinnedClientRemotePort) int pinnedClientRemotePort;

- (int)pinnedClientRemotePort;

@property (nonatomic,readonly,assign,getter=pinnedClientResumedSession) BOOL pinnedClientResumedSession;

- (BOOL)pinnedClientResumedSession;

@property (nonatomic,readonly,assign,getter=pinnedClientSecureConnection) BOOL pinnedClientSecureConnection;

- (BOOL)pinnedClientSecureConnection;

@property (nonatomic,readonly,assign,getter=pinnedClientServerAuthenticated) BOOL pinnedClientServerAuthenticated;

- (BOOL)pinnedClientServerAuthenticated;

@property (nonatomic,readonly,assign,getter=pinnedClientSignatureAlgorithm) NSString* pinnedClientSignatureAlgorithm;

- (NSString*)pinnedClientSignatureAlgorithm;

@property (nonatomic,readonly,assign,getter=pinnedClientSymmetricBlockSize) int pinnedClientSymmetricBlockSize;

- (int)pinnedClientSymmetricBlockSize;

@property (nonatomic,readonly,assign,getter=pinnedClientSymmetricKeyBits) int pinnedClientSymmetricKeyBits;

- (int)pinnedClientSymmetricKeyBits;

@property (nonatomic,readonly,assign,getter=pinnedClientTotalBytesReceived) long long pinnedClientTotalBytesReceived;

- (long long)pinnedClientTotalBytesReceived;

@property (nonatomic,readonly,assign,getter=pinnedClientTotalBytesSent) long long pinnedClientTotalBytesSent;

- (long long)pinnedClientTotalBytesSent;

@property (nonatomic,readonly,assign,getter=pinnedClientValidationLog) NSString* pinnedClientValidationLog;

- (NSString*)pinnedClientValidationLog;

@property (nonatomic,readonly,assign,getter=pinnedClientVersion) NSString* pinnedClientVersion;

- (NSString*)pinnedClientVersion;

 

Default Value

"SecureBlackbox"

Remarks

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

PinnedClientChain Property (WebDAVServer Module)

Contains the certificate chain of the pinned client.

Syntax

• Swift
• Objective-C

public var pinnedClientChain: Array<Certificate> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=pinnedClientCertCount) int pinnedClientCertCount;

- (int)pinnedClientCertCount;

- (NSData*)pinnedClientCertBytes:(int)pinnedClientCertIndex;

- (BOOL)pinnedClientCertCA:(int)pinnedClientCertIndex;

- (NSData*)pinnedClientCertCAKeyID:(int)pinnedClientCertIndex;

- (int)pinnedClientCertCertType:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertCRLDistributionPoints:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertCurve:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertFingerprint:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertFriendlyName:(int)pinnedClientCertIndex;

- (long long)pinnedClientCertHandle:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertHashAlgorithm:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertIssuer:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertIssuerRDN:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertKeyAlgorithm:(int)pinnedClientCertIndex;

- (int)pinnedClientCertKeyBits:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertKeyFingerprint:(int)pinnedClientCertIndex;

- (int)pinnedClientCertKeyUsage:(int)pinnedClientCertIndex;

- (BOOL)pinnedClientCertKeyValid:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertOCSPLocations:(int)pinnedClientCertIndex;

- (BOOL)pinnedClientCertOCSPNoCheck:(int)pinnedClientCertIndex;

- (int)pinnedClientCertOrigin:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertPolicyIDs:(int)pinnedClientCertIndex;

- (NSData*)pinnedClientCertPrivateKeyBytes:(int)pinnedClientCertIndex;

- (BOOL)pinnedClientCertPrivateKeyExists:(int)pinnedClientCertIndex;

- (BOOL)pinnedClientCertPrivateKeyExtractable:(int)pinnedClientCertIndex;

- (NSData*)pinnedClientCertPublicKeyBytes:(int)pinnedClientCertIndex;

- (BOOL)pinnedClientCertQualified:(int)pinnedClientCertIndex;

- (int)pinnedClientCertQualifiedStatements:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertQualifiers:(int)pinnedClientCertIndex;

- (BOOL)pinnedClientCertSelfSigned:(int)pinnedClientCertIndex;

- (NSData*)pinnedClientCertSerialNumber:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertSigAlgorithm:(int)pinnedClientCertIndex;

- (int)pinnedClientCertSource:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertSubject:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertSubjectAlternativeName:(int)pinnedClientCertIndex;

- (NSData*)pinnedClientCertSubjectKeyID:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertSubjectRDN:(int)pinnedClientCertIndex;

- (BOOL)pinnedClientCertValid:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertValidFrom:(int)pinnedClientCertIndex;

- (NSString*)pinnedClientCertValidTo:(int)pinnedClientCertIndex;

Default Value

"SecureBlackbox"

Remarks

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

Port Property (WebDAVServer Module)

Specifies the port number to listen for connections on.

Syntax

• Swift
• Objective-C

public var port: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=port,setter=setPort:) int port;

- (int)port;
- (void)setPort :(int)newPort;

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

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

Syntax

• Swift
• Objective-C

public var portRangeFrom: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=portRangeFrom,setter=setPortRangeFrom:) int portRangeFrom;

- (int)portRangeFrom;
- (void)setPortRangeFrom :(int)newPortRangeFrom;

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

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

Syntax

• Swift
• Objective-C

public var portRangeTo: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=portRangeTo,setter=setPortRangeTo:) int portRangeTo;

- (int)portRangeTo;
- (void)setPortRangeTo :(int)newPortRangeTo;

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

Manages network connection settings.

Syntax

• Swift
• Objective-C

public var socketSettings: SocketSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=socketIncomingSpeedLimit,setter=setSocketIncomingSpeedLimit:) int socketIncomingSpeedLimit;

- (int)socketIncomingSpeedLimit;
- (void)setSocketIncomingSpeedLimit :(int)newSocketIncomingSpeedLimit;

@property (nonatomic,readwrite,assign,getter=socketLocalAddress,setter=setSocketLocalAddress:) NSString* socketLocalAddress;

- (NSString*)socketLocalAddress;
- (void)setSocketLocalAddress :(NSString*)newSocketLocalAddress;

@property (nonatomic,readwrite,assign,getter=socketLocalPort,setter=setSocketLocalPort:) int socketLocalPort;

- (int)socketLocalPort;
- (void)setSocketLocalPort :(int)newSocketLocalPort;

@property (nonatomic,readwrite,assign,getter=socketOutgoingSpeedLimit,setter=setSocketOutgoingSpeedLimit:) int socketOutgoingSpeedLimit;

- (int)socketOutgoingSpeedLimit;
- (void)setSocketOutgoingSpeedLimit :(int)newSocketOutgoingSpeedLimit;

@property (nonatomic,readwrite,assign,getter=socketTimeout,setter=setSocketTimeout:) int socketTimeout;

- (int)socketTimeout;
- (void)setSocketTimeout :(int)newSocketTimeout;

@property (nonatomic,readwrite,assign,getter=socketUseIPv6,setter=setSocketUseIPv6:) BOOL socketUseIPv6;

- (BOOL)socketUseIPv6;
- (void)setSocketUseIPv6 :(BOOL)newSocketUseIPv6;

 

Default Value

"SecureBlackbox"

Remarks

Use this property to tune up network connection parameters.

TLSServerChain Property (WebDAVServer Module)

The server's TLS certificates.

Syntax

• Swift
• Objective-C

public var tlsServerChain: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=TLSServerCertCount,setter=setTLSServerCertCount:) int TLSServerCertCount;

- (int)TLSServerCertCount;
- (void)setTLSServerCertCount :(int)newTLSServerCertCount;

- (NSData*)TLSServerCertBytes:(int)tLSServerCertIndex;

- (long long)TLSServerCertHandle:(int)tLSServerCertIndex;
- (void)setTLSServerCertHandle:(int)tLSServerCertIndex :(long long)newTLSServerCertHandle;

Default Value

"SecureBlackbox"

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.

TLSSettings Property (WebDAVServer Module)

Manages TLS layer settings.

Syntax

• Swift
• Objective-C

public var tlsSettings: TLSSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=TLSAutoValidateCertificates,setter=setTLSAutoValidateCertificates:) BOOL TLSAutoValidateCertificates;

- (BOOL)TLSAutoValidateCertificates;
- (void)setTLSAutoValidateCertificates :(BOOL)newTLSAutoValidateCertificates;

@property (nonatomic,readwrite,assign,getter=TLSBaseConfiguration,setter=setTLSBaseConfiguration:) int TLSBaseConfiguration;

- (int)TLSBaseConfiguration;
- (void)setTLSBaseConfiguration :(int)newTLSBaseConfiguration;

@property (nonatomic,readwrite,assign,getter=TLSCiphersuites,setter=setTLSCiphersuites:) NSString* TLSCiphersuites;

- (NSString*)TLSCiphersuites;
- (void)setTLSCiphersuites :(NSString*)newTLSCiphersuites;

@property (nonatomic,readwrite,assign,getter=TLSClientAuth,setter=setTLSClientAuth:) int TLSClientAuth;

- (int)TLSClientAuth;
- (void)setTLSClientAuth :(int)newTLSClientAuth;

@property (nonatomic,readwrite,assign,getter=TLSECCurves,setter=setTLSECCurves:) NSString* TLSECCurves;

- (NSString*)TLSECCurves;
- (void)setTLSECCurves :(NSString*)newTLSECCurves;

@property (nonatomic,readwrite,assign,getter=TLSExtensions,setter=setTLSExtensions:) NSString* TLSExtensions;

- (NSString*)TLSExtensions;
- (void)setTLSExtensions :(NSString*)newTLSExtensions;

@property (nonatomic,readwrite,assign,getter=TLSForceResumeIfDestinationChanges,setter=setTLSForceResumeIfDestinationChanges:) BOOL TLSForceResumeIfDestinationChanges;

- (BOOL)TLSForceResumeIfDestinationChanges;
- (void)setTLSForceResumeIfDestinationChanges :(BOOL)newTLSForceResumeIfDestinationChanges;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedIdentity,setter=setTLSPreSharedIdentity:) NSString* TLSPreSharedIdentity;

- (NSString*)TLSPreSharedIdentity;
- (void)setTLSPreSharedIdentity :(NSString*)newTLSPreSharedIdentity;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKey,setter=setTLSPreSharedKey:) NSString* TLSPreSharedKey;

- (NSString*)TLSPreSharedKey;
- (void)setTLSPreSharedKey :(NSString*)newTLSPreSharedKey;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKeyCiphersuite,setter=setTLSPreSharedKeyCiphersuite:) NSString* TLSPreSharedKeyCiphersuite;

- (NSString*)TLSPreSharedKeyCiphersuite;
- (void)setTLSPreSharedKeyCiphersuite :(NSString*)newTLSPreSharedKeyCiphersuite;

@property (nonatomic,readwrite,assign,getter=TLSRenegotiationAttackPreventionMode,setter=setTLSRenegotiationAttackPreventionMode:) int TLSRenegotiationAttackPreventionMode;

- (int)TLSRenegotiationAttackPreventionMode;
- (void)setTLSRenegotiationAttackPreventionMode :(int)newTLSRenegotiationAttackPreventionMode;

@property (nonatomic,readwrite,assign,getter=TLSRevocationCheck,setter=setTLSRevocationCheck:) int TLSRevocationCheck;

- (int)TLSRevocationCheck;
- (void)setTLSRevocationCheck :(int)newTLSRevocationCheck;

@property (nonatomic,readwrite,assign,getter=TLSSSLOptions,setter=setTLSSSLOptions:) int TLSSSLOptions;

- (int)TLSSSLOptions;
- (void)setTLSSSLOptions :(int)newTLSSSLOptions;

@property (nonatomic,readwrite,assign,getter=TLSTLSMode,setter=setTLSTLSMode:) int TLSTLSMode;

- (int)TLSTLSMode;
- (void)setTLSTLSMode :(int)newTLSTLSMode;

@property (nonatomic,readwrite,assign,getter=TLSUseExtendedMasterSecret,setter=setTLSUseExtendedMasterSecret:) BOOL TLSUseExtendedMasterSecret;

- (BOOL)TLSUseExtendedMasterSecret;
- (void)setTLSUseExtendedMasterSecret :(BOOL)newTLSUseExtendedMasterSecret;

@property (nonatomic,readwrite,assign,getter=TLSUseSessionResumption,setter=setTLSUseSessionResumption:) BOOL TLSUseSessionResumption;

- (BOOL)TLSUseSessionResumption;
- (void)setTLSUseSessionResumption :(BOOL)newTLSUseSessionResumption;

@property (nonatomic,readwrite,assign,getter=TLSVersions,setter=setTLSVersions:) int TLSVersions;

- (int)TLSVersions;
- (void)setTLSVersions :(int)newTLSVersions;

 

Default Value

"SecureBlackbox"

Remarks

Use this property to tune up the TLS layer parameters.

Users Property (WebDAVServer Module)

Provides a list of registered users.

Syntax

• Swift
• Objective-C

public var users: Array<UserAccount> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=userCount,setter=setUserCount:) int userCount;

- (int)userCount;
- (void)setUserCount :(int)newUserCount;

- (NSData*)userAssociatedData:(int)userIndex;
- (void)setUserAssociatedData:(int)userIndex :(NSData*)newUserAssociatedData;

- (NSString*)userBasePath:(int)userIndex;
- (void)setUserBasePath:(int)userIndex :(NSString*)newUserBasePath;

- (NSData*)userCertificate:(int)userIndex;
- (void)setUserCertificate:(int)userIndex :(NSData*)newUserCertificate;

- (NSString*)userData:(int)userIndex;
- (void)setUserData:(int)userIndex :(NSString*)newUserData;

- (NSString*)userEmail:(int)userIndex;
- (void)setUserEmail:(int)userIndex :(NSString*)newUserEmail;

- (long long)userHandle:(int)userIndex;
- (void)setUserHandle:(int)userIndex :(long long)newUserHandle;

- (NSString*)userHashAlgorithm:(int)userIndex;
- (void)setUserHashAlgorithm:(int)userIndex :(NSString*)newUserHashAlgorithm;

- (int)userIncomingSpeedLimit:(int)userIndex;
- (void)setUserIncomingSpeedLimit:(int)userIndex :(int)newUserIncomingSpeedLimit;

- (int)userOtpAlgorithm:(int)userIndex;
- (void)setUserOtpAlgorithm:(int)userIndex :(int)newUserOtpAlgorithm;

- (int)userOTPLen:(int)userIndex;
- (void)setUserOTPLen:(int)userIndex :(int)newUserOTPLen;

- (int)userOtpValue:(int)userIndex;
- (void)setUserOtpValue:(int)userIndex :(int)newUserOtpValue;

- (int)userOutgoingSpeedLimit:(int)userIndex;
- (void)setUserOutgoingSpeedLimit:(int)userIndex :(int)newUserOutgoingSpeedLimit;

- (NSString*)userPassword:(int)userIndex;
- (void)setUserPassword:(int)userIndex :(NSString*)newUserPassword;

- (NSData*)userSharedSecret:(int)userIndex;
- (void)setUserSharedSecret:(int)userIndex :(NSData*)newUserSharedSecret;

- (NSData*)userSSHKey:(int)userIndex;
- (void)setUserSSHKey:(int)userIndex :(NSData*)newUserSSHKey;

- (NSString*)userUsername:(int)userIndex;
- (void)setUserUsername:(int)userIndex :(NSString*)newUserUsername;

Default Value

"SecureBlackbox"

Remarks

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

WebsiteName Property (WebDAVServer Module)

Specifies the web site name to use in the certificate.

Syntax

• Swift
• Objective-C

public var websiteName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=websiteName,setter=setWebsiteName:) NSString* websiteName;

- (NSString*)websiteName;
- (void)setWebsiteName :(NSString*)newWebsiteName;

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

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

Syntax

• Swift
• Objective-C

public func cleanup() throws -> Void

- (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 Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)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;....

DropClient Method (WebDAVServer Module)

Terminates a client connection.

Syntax

• Swift
• Objective-C

public func dropClient(connectionId: Int64, forced: Bool) throws -> Void

- (void)dropClient:(long long)connectionId :(BOOL)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 Module)

Obtains a pending connection buffer.

Syntax

• Swift
• Objective-C

public func getClientBuffer(connectionID: Int64) throws -> Data

- (NSData*)getClientBuffer:(long 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 Module)

Returns the contents of the client's HTTP request.

Syntax

• Swift
• Objective-C

public func getRequestBytes(connectionId: Int64, requestFilter: String) throws -> Data

- (NSData*)getRequestBytes:(long long)connectionId :(NSString*)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 Module)

Returns a request header value.

Syntax

• Swift
• Objective-C

public func getRequestHeader(connectionId: Int64, headerName: String) throws -> String

- (NSString*)getRequestHeader:(long long)connectionId :(NSString*)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.

GetRequestString Method (WebDAVServer Module)

Returns the contents of the client's HTTP request.

Syntax

• Swift
• Objective-C

public func getRequestString(connectionId: Int64, requestFilter: String) throws -> String

- (NSString*)getRequestString:(long long)connectionId :(NSString*)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 Module)

Returns the username for a connection.

Syntax

• Swift
• Objective-C

public func getRequestUsername(connectionId: Int64) throws -> String

- (NSString*)getRequestUsername:(long 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 Module)

Returns a response header value.

Syntax

• Swift
• Objective-C

public func getResponseHeader(connectionId: Int64, headerName: String) throws -> String

- (NSString*)getResponseHeader:(long long)connectionId :(NSString*)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 Module)

Enumerates the connected clients.

Syntax

• Swift
• Objective-C

public func listClients() throws -> String

- (NSString*)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 Module)

Takes a snapshot of the connection's properties.

Syntax

• Swift
• Objective-C

public func pinClient(connectionId: Int64) throws -> Void

- (void)pinClient:(long 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 Module)

Processes a generic HTTP request.

Syntax

• Swift
• Objective-C

public func processGenericRequest(connectionId: Int64, requestBytes: Data) throws -> Data

- (NSData*)processGenericRequest:(long long)connectionId :(NSData*)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.

Reset Method (WebDAVServer Module)

Resets the component settings.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

SetClientBuffer Method (WebDAVServer Module)

Commits a data buffer to the connection.

Syntax

• Swift
• Objective-C

public func setClientBuffer(connectionID: Int64, value: Data) throws -> Void

- (void)setClientBuffer:(long long)connectionID :(NSData*)value;

Remarks

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

SetClientFileEntry Method (WebDAVServer Module)

Commits a file entry to the connection.

Syntax

• Swift
• Objective-C

public func setClientFileEntry(connectionID: Int64) throws -> Void

- (void)setClientFileEntry:(long 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 Module)

Sets a byte array to be served as a response.

Syntax

• Swift
• Objective-C

public func setResponseBytes(connectionId: Int64, bytes: Data, contentType: String, responseFilter: String) throws -> Void

- (void)setResponseBytes:(long long)connectionId :(NSData*)bytes :(NSString*)contentType :(NSString*)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 Module)

Sets a file to be served as a response.

Syntax

• Swift
• Objective-C

public func setResponseFile(connectionId: Int64, fileName: String, contentType: String, responseFilter: String) throws -> Void

- (void)setResponseFile:(long long)connectionId :(NSString*)fileName :(NSString*)contentType :(NSString*)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 Module)

Sets a response header.

Syntax

• Swift
• Objective-C

public func setResponseHeader(connectionId: Int64, headerName: String, value: String) throws -> Void

- (void)setResponseHeader:(long long)connectionId :(NSString*)headerName :(NSString*)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 Module)

Sets an HTTP status to be sent with the response.

Syntax

• Swift
• Objective-C

public func setResponseStatus(connectionId: Int64, statusCode: Int32) throws -> Void

- (void)setResponseStatus:(long 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.

SetResponseString Method (WebDAVServer Module)

Sets a string to be served as a response.

Syntax

• Swift
• Objective-C

public func setResponseString(connectionId: Int64, dataStr: String, contentType: String, responseFilter: String) throws -> Void

- (void)setResponseString:(long long)connectionId :(NSString*)dataStr :(NSString*)contentType :(NSString*)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 Module)

Starts the server.

Syntax

• Swift
• Objective-C

public func start() throws -> Void

- (void)start;

Remarks

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

Stop Method (WebDAVServer Module)

Stops the server.

Syntax

• Swift
• Objective-C

public func stop() throws -> Void

- (void)stop;

Remarks

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

Accept Event (WebDAVServer Module)

Reports an incoming connection.

Syntax

• Swift
• Objective-C

func onAccept(remoteAddress: String, remotePort: Int32, accept: inout Bool)

- (void)onAccept:(NSString*)remoteAddress :(int)remotePort :(int*)accept;

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

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

Syntax

• Swift
• Objective-C

func onAfterBrowse(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterBrowse:(long long)connectionID :(NSString*)path :(int*)operationStatus;

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

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

Syntax

• Swift
• Objective-C

func onAfterCopyObject(connectionID: Int64, oldPath: String, newPath: String, operationStatus: inout Int32)

- (void)onAfterCopyObject:(long long)connectionID :(NSString*)oldPath :(NSString*)newPath :(int*)operationStatus;

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

This event reports the completion of calendar creation request.

Syntax

• Swift
• Objective-C

func onAfterCreateCalendar(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterCreateCalendar:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

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

AfterCreateCollection Event (WebDAVServer Module)

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

Syntax

• Swift
• Objective-C

func onAfterCreateCollection(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterCreateCollection:(long long)connectionID :(NSString*)path :(int*)operationStatus;

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

This event reports the completion of the custom request.

Syntax

• Swift
• Objective-C

func onAfterCustomRequest(connectionID: Int64, requestMethod: String, path: String, operationStatus: inout Int32)

- (void)onAfterCustomRequest:(long long)connectionID :(NSString*)requestMethod :(NSString*)path :(int*)operationStatus;

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

Reports the completion of the object locking operation.

Syntax

• Swift
• Objective-C

func onAfterLockObject(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterLockObject:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

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

AfterRefreshLock Event (WebDAVServer Module)

Reports the completion of the lock refresh operation.

Syntax

• Swift
• Objective-C

func onAfterRefreshLock(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterRefreshLock:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

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

AfterRemoveObject Event (WebDAVServer Module)

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

Syntax

• Swift
• Objective-C

func onAfterRemoveObject(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterRemoveObject:(long long)connectionID :(NSString*)path :(int*)operationStatus;

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

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

Syntax

• Swift
• Objective-C

func onAfterRenameObject(connectionID: Int64, oldPath: String, newPath: String, operationStatus: inout Int32)

- (void)onAfterRenameObject:(long long)connectionID :(NSString*)oldPath :(NSString*)newPath :(int*)operationStatus;

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

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

Syntax

• Swift
• Objective-C

func onAfterSetAttributes(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterSetAttributes:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

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

AfterUnlockObject Event (WebDAVServer Module)

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

Syntax

• Swift
• Objective-C

func onAfterUnlockObject(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterUnlockObject:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

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

AuthAttempt Event (WebDAVServer Module)

Fires when a connected client makes an authentication attempt.

Syntax

• Swift
• Objective-C

func onAuthAttempt(connectionID: Int64, httpMethod: String, uri: String, authMethod: String, username: String, password: String, allow: inout Bool)

- (void)onAuthAttempt:(long long)connectionID :(NSString*)HTTPMethod :(NSString*)URI :(NSString*)authMethod :(NSString*)username :(NSString*)password :(int*)allow;

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

Fires when a Browse request is received.

Syntax

• Swift
• Objective-C

func onBeforeBrowse(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeBrowse:(long long)connectionID :(NSString*)path :(int*)action;

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

Fires when a Copy Object request is received.

Syntax

• Swift
• Objective-C

func onBeforeCopyObject(connectionID: Int64, oldPath: String, newPath: String, action: inout Int32)

- (void)onBeforeCopyObject:(long long)connectionID :(NSString*)oldPath :(NSString*)newPath :(int*)action;

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

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

Syntax

• Swift
• Objective-C

func onBeforeCreateCalendar(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeCreateCalendar:(long long)connectionID :(NSString*)path :(int*)action;

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

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

Syntax

• Swift
• Objective-C

func onBeforeCreateCollection(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeCreateCollection:(long long)connectionID :(NSString*)path :(int*)action;

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

Notifies the application about an incoming custom request.

Syntax

• Swift
• Objective-C

func onBeforeCustomRequest(connectionID: Int64, requestMethod: String, path: String, action: inout Int32)

- (void)onBeforeCustomRequest:(long long)connectionID :(NSString*)requestMethod :(NSString*)path :(int*)action;

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

Fires when an object download request is received.

Syntax

• Swift
• Objective-C

func onBeforeDownloadObject(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeDownloadObject:(long long)connectionID :(NSString*)path :(int*)action;

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

Fires when a lock request is received.

Syntax

• Swift
• Objective-C

func onBeforeLockObject(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeLockObject:(long long)connectionID :(NSString*)path :(int*)action;

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

Reports the receipt of lock refresh request.

Syntax

• Swift
• Objective-C

func onBeforeRefreshLock(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeRefreshLock:(long long)connectionID :(NSString*)path :(int*)action;

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

Fires when an object deletion request is received.

Syntax

• Swift
• Objective-C

func onBeforeRemoveObject(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeRemoveObject:(long long)connectionID :(NSString*)path :(int*)action;

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

Reports object renaming requests.

Syntax

• Swift
• Objective-C

func onBeforeRenameObject(connectionID: Int64, oldPath: String, newPath: String, action: inout Int32)

- (void)onBeforeRenameObject:(long long)connectionID :(NSString*)oldPath :(NSString*)newPath :(int*)action;

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

Fires before a DAV request is processed.

Syntax

• Swift
• Objective-C

func onBeforeRequest(connectionID: Int64, httpMethod: String, url: String, accept: inout Bool)

- (void)onBeforeRequest:(long long)connectionID :(NSString*)HTTPMethod :(NSString*)URL :(int*)accept;

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

Notifies the application about attribute change request.

Syntax

• Swift
• Objective-C

func onBeforeSetAttributes(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeSetAttributes:(long long)connectionID :(NSString*)path :(int*)action;

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

Fires when an unlock request is received.

Syntax

• Swift
• Objective-C

func onBeforeUnlockObject(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeUnlockObject:(long long)connectionID :(NSString*)path :(int*)action;

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

Fires when an object upload request is received.

Syntax

• Swift
• Objective-C

func onBeforeUploadObject(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeUploadObject:(long long)connectionID :(NSString*)path :(int*)action;

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

Reports an attribute clearance request.

Syntax

• Swift
• Objective-C

func onClearAttribute(connectionID: Int64, path: String, ns: String, name: String, operationStatus: inout Int32)

- (void)onClearAttribute:(long long)connectionID :(NSString*)path :(NSString*)NS :(NSString*)name :(int*)operationStatus;

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

Reports an accepted connection.

Syntax

• Swift
• Objective-C

func onConnect(connectionID: Int64, remoteAddress: String, remotePort: Int32)

- (void)onConnect:(long long)connectionID :(NSString*)remoteAddress :(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 Module)

Lets the application handle the Copy Object request.

Syntax

• Swift
• Objective-C

func onCopyObject(connectionID: Int64, oldPath: String, newPath: String, overwrite: Bool, depth: Int32, operationStatus: inout Int32)

- (void)onCopyObject:(long long)connectionID :(NSString*)oldPath :(NSString*)newPath :(BOOL)overwrite :(int)depth :(int*)operationStatus;

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

Lets the application handle a calendar creation request.

Syntax

• Swift
• Objective-C

func onCreateCalendar(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onCreateCalendar:(long long)connectionID :(NSString*)path :(int*)operationStatus;

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

Lets the application respond to collection creation request.

Syntax

• Swift
• Objective-C

func onCreateCollection(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onCreateCollection:(long long)connectionID :(NSString*)path :(int*)operationStatus;

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

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

Syntax

• Swift
• Objective-C

func onCustomRequest(connectionID: Int64, requestMethod: String, path: String, operationStatus: inout Int32)

- (void)onCustomRequest:(long long)connectionID :(NSString*)requestMethod :(NSString*)path :(int*)operationStatus;

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

Supplies a data chunk received from a client.

Syntax

• Swift
• Objective-C

func onData(connectionID: Int64, buffer: Data)

- (void)onData:(long long)connectionID :(NSData*)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 Module)

Fires to report a disconnected client.

Syntax

• Swift
• Objective-C

func onDisconnect(connectionID: Int64)

- (void)onDisconnect:(long long)connectionID;

Remarks

class fires this event when a connected client disconnects.

DownloadObject Event (WebDAVServer Module)

Allows the application respond to Download Object request.

Syntax

• Swift
• Objective-C

func onDownloadObject(connectionID: Int64, path: String, restartAt: Int64, operationStatus: inout Int32)

- (void)onDownloadObject:(long long)connectionID :(NSString*)path :(long long)restartAt :(int*)operationStatus;

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

This event is fired when a download operation completes.

Syntax

• Swift
• Objective-C

func onDownloadObjectCompleted(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onDownloadObjectCompleted:(long long)connectionID :(NSString*)path :(int*)operationStatus;

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

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(connectionID: Int64, errorCode: Int32, fatal: Bool, remote: Bool, description: String)

- (void)onError:(long long)connectionID :(int)errorCode :(BOOL)fatal :(BOOL)remote :(NSString*)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 Module)

Handles remote or external signing initiated by the server protocol.

Syntax

• Swift
• Objective-C

func onExternalSign(connectionID: Int64, operationId: String, hashAlgorithm: String, pars: String, data: String, signedData: inout String)

- (void)onExternalSign:(long long)connectionID :(NSString*)operationId :(NSString*)hashAlgorithm :(NSString*)pars :(NSString*)data :(NSString**)signedData;

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

Reports a file access error to the application.

Syntax

• Swift
• Objective-C

func onFileError(connectionID: Int64, fileName: String, errorCode: Int32)

- (void)onFileError:(long long)connectionID :(NSString*)fileName :(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 Module)

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

Syntax

• Swift
• Objective-C

func onHeadersPrepared(connectionID: Int64)

- (void)onHeadersPrepared:(long 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 Module)

Requests object attributes from the application in fraCustom handling mode.

Syntax

• Swift
• Objective-C

func onListAttributes(connectionID: Int64, path: String, attributes: inout String)

- (void)onListAttributes:(long long)connectionID :(NSString*)path :(NSString**)attributes;

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

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

Syntax

• Swift
• Objective-C

func onListSubObjects(connectionID: Int64, path: String, recursive: Bool, objects: inout String, operationStatus: inout Int32)

- (void)onListSubObjects:(long long)connectionID :(NSString*)path :(BOOL)recursive :(NSString**)objects :(int*)operationStatus;

Remarks

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

LockObject Event (WebDAVServer Module)

Virtualizes the object locking operation.

Syntax

• Swift
• Objective-C

func onLockObject(connectionID: Int64, path: String, owner: String, exclusive: Bool, depth: Int32, timeout: Int64, token: inout String)

- (void)onLockObject:(long long)connectionID :(NSString*)path :(NSString*)owner :(BOOL)exclusive :(int)depth :(long long)timeout :(NSString**)token;

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

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

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)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 Module)

Reflects a quota enquiry by a client.

Syntax

• Swift
• Objective-C

func onQueryQuota(connectionID: Int64, username: String, available: inout Int64, used: inout Int64)

- (void)onQueryQuota:(long long)connectionID :(NSString*)username :(long long*)available :(long long*)used;

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

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

Syntax

• Swift
• Objective-C

func onReadAttribute(connectionID: Int64, path: String, ns: String, name: String, value: inout String, operationStatus: inout Int32)

- (void)onReadAttribute:(long long)connectionID :(NSString*)path :(NSString*)NS :(NSString*)name :(NSString**)value :(int*)operationStatus;

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

Requests a piece of object data from the application.

Syntax

• Swift
• Objective-C

func onReadObject(connectionID: Int64, size: Int32, operationStatus: inout Int32)

- (void)onReadObject:(long long)connectionID :(int)size :(int*)operationStatus;

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

Notifies the application about a lock refresh request.

Syntax

• Swift
• Objective-C

func onRefreshLock(connectionID: Int64, path: String, token: String, timeout: Int64, lockFound: inout Bool)

- (void)onRefreshLock:(long long)connectionID :(NSString*)path :(NSString*)token :(long long)timeout :(int*)lockFound;

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

Notifies the application about object deletion requests.

Syntax

• Swift
• Objective-C

func onRemoveObject(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onRemoveObject:(long long)connectionID :(NSString*)path :(int*)operationStatus;

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

Notifies the application about object name change requests.

Syntax

• Swift
• Objective-C

func onRenameObject(connectionID: Int64, oldPath: String, newPath: String, overwrite: Bool, operationStatus: inout Int32)

- (void)onRenameObject:(long long)connectionID :(NSString*)oldPath :(NSString*)newPath :(BOOL)overwrite :(int*)operationStatus;

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

Reports an attempt to access a resource.

Syntax

• Swift
• Objective-C

func onResourceAccess(connectionID: Int64, httpMethod: String, uri: String, allow: inout Bool, redirectURI: inout String)

- (void)onResourceAccess:(long long)connectionID :(NSString*)HTTPMethod :(NSString*)URI :(int*)allow :(NSString**)redirectURI;

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

Lets the application customize attribute assignment requests.

Syntax

• Swift
• Objective-C

func onSetAttribute(connectionID: Int64, path: String, ns: String, name: String, value: String, operationStatus: inout Int32)

- (void)onSetAttribute:(long long)connectionID :(NSString*)path :(NSString*)NS :(NSString*)name :(NSString*)value :(int*)operationStatus;

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

Fires when a client certificate needs to be validated.

Syntax

• Swift
• Objective-C

func onTLSCertValidate(connectionID: Int64, accept: inout Bool)

- (void)onTLSCertValidate:(long long)connectionID :(int*)accept;

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

Reports the setup of a TLS session.

Syntax

• Swift
• Objective-C

func onTLSEstablished(connectionID: Int64)

- (void)onTLSEstablished:(long long)connectionID;

Remarks

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

TLSHandshake Event (WebDAVServer Module)

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

Syntax

• Swift
• Objective-C

func onTLSHandshake(connectionID: Int64, serverName: String, abort: inout Bool)

- (void)onTLSHandshake:(long long)connectionID :(NSString*)serverName :(int*)abort;

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

Requests a pre-shared key for TLS-PSK.

Syntax

• Swift
• Objective-C

func onTLSPSK(connectionID: Int64, identity: String, psk: inout String, ciphersuite: inout String)

- (void)onTLSPSK:(long long)connectionID :(NSString*)identity :(NSString**)PSK :(NSString**)ciphersuite;

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

Reports closure of a TLS session.

Syntax

• Swift
• Objective-C

func onTLSShutdown(connectionID: Int64)

- (void)onTLSShutdown:(long 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 Module)

Virtualizes the object unlocking operation.

Syntax

• Swift
• Objective-C

func onUnlockObject(connectionID: Int64, path: String, token: String, lockFound: inout Bool)

- (void)onUnlockObject:(long long)connectionID :(NSString*)path :(NSString*)token :(int*)lockFound;

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

Lets the application respond to the Upload Object request.

Syntax

• Swift
• Objective-C

func onUploadObject(connectionID: Int64, path: String, restartAt: Int64, append: Bool, operationStatus: inout Int32)

- (void)onUploadObject:(long long)connectionID :(NSString*)path :(long long)restartAt :(BOOL)append :(int*)operationStatus;

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

This event is fired when a upload operation completes.

Syntax

• Swift
• Objective-C

func onUploadObjectCompleted(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onUploadObjectCompleted:(long long)connectionID :(NSString*)path :(int*)operationStatus;

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

Hands a piece of object data to the application.

Syntax

• Swift
• Objective-C

func onWriteObject(connectionID: Int64, operationStatus: inout Int32)

- (void)onWriteObject:(long long)connectionID :(int*)operationStatus;

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 init(stream: )

public init()

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