Class ServiceConfig.Webdav

java.lang.Object

org.apache.opendal.ServiceConfig.Webdav

All Implemented Interfaces:

ServiceConfig

Enclosing interface:

ServiceConfig

public static class ServiceConfig.Webdav
extends Object
implements ServiceConfig

Configuration for service webdav.

Nested Class Summary

Nested classes/interfaces inherited from interface ServiceConfig

ServiceConfig.AliyunDrive, ServiceConfig.Alluxio, ServiceConfig.Azblob, ServiceConfig.Azdls, ServiceConfig.Azfile, ServiceConfig.B2, ServiceConfig.Cacache, ServiceConfig.CloudflareKv, ServiceConfig.Compfs, ServiceConfig.Cos, ServiceConfig.D1, ServiceConfig.Dashmap, ServiceConfig.Dbfs, ServiceConfig.Dropbox, ServiceConfig.Etcd, ServiceConfig.Foyer, ServiceConfig.Fs, ServiceConfig.Gcs, ServiceConfig.Gdrive, ServiceConfig.Ghac, ServiceConfig.Github, ServiceConfig.Goosefs, ServiceConfig.Gridfs, ServiceConfig.HdfsNative, ServiceConfig.Hf, ServiceConfig.Http, ServiceConfig.Ipfs, ServiceConfig.Ipmfs, ServiceConfig.Koofr, ServiceConfig.Lakefs, ServiceConfig.Memcached, ServiceConfig.Memory, ServiceConfig.MiniMoka, ServiceConfig.Moka, ServiceConfig.Mongodb, ServiceConfig.Monoiofs, ServiceConfig.Mysql, ServiceConfig.Obs, ServiceConfig.Onedrive, ServiceConfig.Opfs, ServiceConfig.Oss, ServiceConfig.Pcloud, ServiceConfig.Persy, ServiceConfig.Postgresql, ServiceConfig.Redb, ServiceConfig.Redis, ServiceConfig.S3, ServiceConfig.Seafile, ServiceConfig.Sftp, ServiceConfig.Sled, ServiceConfig.Sqlite, ServiceConfig.Surrealdb, ServiceConfig.Swift, ServiceConfig.Tos, ServiceConfig.Upyun, ServiceConfig.VercelArtifacts, ServiceConfig.VercelBlob, ServiceConfig.Webdav, ServiceConfig.Webhdfs, ServiceConfig.YandexDisk

Field Summary

Fields

Modifier and Type	Field	Description
final Boolean	disableCopy	Deprecated. WebDAV copy capability is enabled by default and this option is no longer needed.
final Boolean	disableCreateDir	Disable automatic parent directory creation before write operations.
final Boolean	enableUserMetadata	Deprecated. WebDAV user metadata capability is enabled by default.
final String	endpoint	endpoint of this backend
final String	password	password of this backend
final String	root	root of this backend
final String	token	token of this backend
final String	userMetadataPrefix	The XML namespace prefix for user metadata properties.
final String	userMetadataUri	The XML namespace URI for user metadata properties.
final String	username	username of this backend

Constructor Summary

Constructors

Constructor	Description
Webdav()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	configMap()	Convert the structured config to a type erased config map.
String	scheme()	The scheme of the service.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

disableCopy

public final Boolean disableCopy

Deprecated.

WebDAV copy capability is enabled by default and this option is no longer needed.

Deprecated: WebDAV copy capability is enabled by default.

disableCreateDir

public final Boolean disableCreateDir

Disable automatic parent directory creation before write operations.

By default, OpenDAL creates parent directories using MKCOL before writing files. This requires PROPFIND support to check directory existence.

Some WebDAV-compatible servers (e.g., bazel-remote) don't support PROPFIND or don't require explicit directory creation. Enable this option to skip the MKCOL calls and write files directly.

Default: false

enableUserMetadata

public final Boolean enableUserMetadata

Deprecated.

WebDAV user metadata capability is enabled by default. Use CapabilityOverrideLayer to override write_with_user_metadata for endpoints without PROPPATCH support.

Deprecated: WebDAV user metadata capability is enabled by default.

endpoint

public final String endpoint

endpoint of this backend

password

public final String password

password of this backend

root

public final String root

root of this backend

token

public final String token

token of this backend

userMetadataPrefix

public final String userMetadataPrefix

The XML namespace prefix for user metadata properties.

This prefix is used in PROPPATCH/PROPFIND XML requests. Different servers may require different prefixes.

Default: "opendal"

userMetadataUri

public final String userMetadataUri

The XML namespace URI for user metadata properties.

This URI uniquely identifies the namespace for custom properties. Different servers may require different namespace URIs. For example, Nextcloud might work better with its own namespace.

Default: https://opendal.apache.org/ns

username

public final String username

username of this backend

Constructor Details

Webdav

public Webdav()

Method Details

scheme

public String scheme()

Description copied from interface: ServiceConfig

The scheme of the service.

Specified by:

scheme in interface ServiceConfig

Returns:

the scheme

configMap

public Map<String,String> configMap()

Description copied from interface: ServiceConfig

Convert the structured config to a type erased config map.

Specified by:

configMap in interface ServiceConfig

Returns:

the config map