SecureBlackbox 2020 Kotlin Edition

Questions / Feedback?

WebDAVClient Component

Properties   Methods   Events   Configuration Settings   Errors  

The WebDAVClient component provides client-side functionality of the WebDAV protocol.

Syntax

secureblackbox.Webdavclient

Remarks

WebDAVClient is capable of making requests to DAV servers via TLS-enabled or plain TCP channels. It supports most of file operations offered by WebDAV servers, such as downloads, uploads, and file system operations.

Property List


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

BaseURLThe base URL.
ClientChainThe TLS client certificate chain.
ConnectedIndicates whether the connection is active.
ConnectionInfoReturns the details of the underlying network connection.
CurrentListEntryPopulates the details of a list entry.
CurrentLocksThe list of current object locks.
EncodeURLEnables or disables URL encoding.
ExternalCryptoProvides access to external signing and DC parameters.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
LockDepthSpecifies the depth of the current lock.
LockScopeSpecifies the scope of the current lock.
LockTimeoutSpecifies the timeout of the current lock.
MoveToRenameEnables move-to-rename operation handling mode.
OverwriteOnCopyEnables overwriting on copy.
OverwriteOnMoveEnables overwriting on move.
PasswordA password to authenticate to the server.
ProxyThe proxy server settings.
ResourceOwnerIndicates the resource owner.
ServerChainThe TLS server's certificate chain.
SocketSettingsManages network connection settings.
TLSSettingsManages TLS layer settings.
TrustedCertificatesA list of trusted certificates for chain validation.
UsernameA username to authenticate to the server.

Method List


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

ConfigSets or retrieves a configuration setting.
ConnectEstablishes connection to a WebDAV server.
CopyCopies a remote file.
CustomRequestPerforms custom WebDAV request.
DeleteDirRemoves a remote directory.
DeleteFileDeletes a remote file.
DirExistsChecks if a directory exists on the server.
DisconnectDisconnects from the server.
DownloadFileDownloads a file from the server.
DownloadStreamDownloads a file from the server.
FileExistsChecks if a file exists on the server.
GetFileSizeRequests the size of a remote file.
ListDirLists the remote directory contents.
ListDirRecursiveLists the remote directory contents, recursively.
LockSets up a lock on a URL.
MakeDirCreates a directory on the server.
MoveFileMoves an object.
RefreshLockRefreshes an object lock.
RenameRenames an object.
UnlockRemoves a lock from a URL.
UploadFileUploads a file to the server.
UploadStreamUploads a stream to the server.

Event List


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

CertificateValidateFires when the server's TLS certificate has to be validated.
ErrorInformation about connection and request errors.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
ListEntryPasses the next directory listing entry to the application.
NotificationThis event notifies the application about an underlying control flow event.
OperationErrorReports a protocol error.
ProgressFires periodically during the data transfer.

Configuration Settings


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

ErrorOriginSpecifies where the error has been originated.
ErrorSeverityError severity.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
MoveToRenameUse MOVE operation to rename objects.
OverwriteOnCopyOverwrite any existing target objects during COPY.
OverwriteOnMoveOverwrite any existing target objects during MOVE.
TempPathPath for storing temporary files.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseOptionsForExistenceCheckUse OPTIONS request to query the server for object existence.
UseSystemCertificatesEnables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Kotlin Edition - Version 20.0 [Build 8063]