WebDAV Application Properties

jmix.webdav.applications

Maps document formats to external applications that should open these documents. You can configure a set of file extensions for each application in the "extensions" property.

For example, the following mapping makes the system open PPT and PPTX files with Microsoft PowerPoint:

"ms-powerpoint":{\
  "name":"Microsoft PowerPoint",\
  "protocols":{"writable":"ms-powerpoint:ofe%7Cu%7C","read_only":"ms-powerpoint:ofv%7Cu%7C"},\
  "extensions":["ppt","pptx"]\
  }

Default value:

{"ms-word":{"name":"Microsoft Word","protocols":{"writable":"ms-word:ofe%7Cu%7C",\
  "read_only":"ms-word:ofv%7Cu%7C"},"extensions":["docx","doc","rtf"]},\
  "ms-excel":{"name":"Microsoft Excel","protocols":{"writable":"ms-excel:ofe%7Cu%7C",\
  "read_only":"ms-excel:ofv%7Cu%7C"},"extensions":["xls","xlsx"]},\
  "ms-powerpoint":{"name":"Microsoft PowerPoint",\
  "protocols":{"writable":"ms-powerpoint:ofe%7Cu%7C","read_only":"ms-powerpoint:ofv%7Cu%7C"},\
  "extensions":["ppt","pptx"]}}

Example value for LibreOffice:

jmix.webdav.applications = {"vnd.libreoffice.command":\
  {"name":"LibreOffice","protocols":\
  {"writable":"vnd.libreoffice.command:ofe|u|",\
  "read_only":"vnd.libreoffice.command:ofv|u|"},\
  "extensions":["odt", "ods", "odp", "doc", "docx", "xls", "xlsx", "ppt", "pptx"]}}

jmix.webdav.authentication-method

Defines the authentication type.

Default value: basic.

Although not recommended, you can set a digest in this property and avoid setting up HTTPS on the server. In this case, remember to change the jmix.webdav.url-prefix property to generate links with the correct server protocol and port. Also, note that all users must have hashed passwords stored separately in the database. The add-on updates these passwords when you change a user’s password, so you must do this for each user after setting up digest authentication.

jmix.webdav.auto-generate-unique-resource-uri

If this property is set to false and a newly uploaded document has the URI already assigned to another document, a unique constraint violation will occur.

If this property is set to true and the URI is already assigned to some document, a new path will be automatically generated with the {id}.extension format.

Default value: true.

jmix.webdav.document-versions-cleaning-cron

This property allows you to change the schedule of WebdavDocumentVersionsCleaningJob as cron expression if necessary.

The default value is 0 0 0 1 * ? * (once a month).

jmix.webdav.expired-lock-cleaning-cron

This property allows you to change the schedule of ExpiredLockCleaningJob as cron expression if necessary.

The default value is 0 0 0/2 ? * * (every two hours).

jmix.webdav.file-storage

Defines a file storage used to store WebDAV files.

By default, the file storage returned by FileStorageLocator.getDefault() is used.

jmix.webdav.lock-timeout

Defines the default interval in milliseconds for a document locking.

Default value: 600000.

jmix.webdav.use-default-document-versions-cleaner-quartz-configuration

This property allows you to disable the default configuration that creates and schedules the WebdavDocumentVersionsCleaningJob job.

Default value: true.

jmix.webdav.use-default-expired-lock-cleaner-quartz-configuration

This property allows you to disable the default configuration that creates and schedules the ExpiredLockCleaningJob job.

Default value: true.

jmix.webdav.url-prefix

Defines the prefix for WebDAV document link.

Default value: https://localhost:8443/webdav.

It must match the root URL of the application with the additional /webdav path.

jmix.webdav.versioning-enabled

Enables versioning for all attributes of the WebdavDocument type without @WebdavSupport annotation.

Default value: true.