Changes

Jump to navigation Jump to search
463 bytes removed ,  13:40, 2 July 2020
This page is part presents one of the [[Developer SectionWeb Application]]services. It describes how to use the WebDAV API of BaseXfile system interface.
BaseX offers access to the databases and documents using the [httphttps://en.wikipedia.org/wiki/Webdav WebDAV] protocol. WebDAV provides convenient means to access and edit XML documents by representing BaseX databases and documents in the form of a file system hierarchy.
==Starting WebDAV==The implementation in BaseX is based on the [http://milton.io Milton library]. Currently, only Basic Authentication is supported.
The WebDAV implementation of BaseX is provided by a module (servlet) which runs in the BaseX HTTP server. Please check the [[Startup#BaseX HTTP Server|Startup: BaseX HTTP Server]] page for details on how to start the HTTP Server. The WebDAV service can either use the local databases or connect to a remote BaseX Server, as described in the [[Startup_Options#BaseX_HTTP_Server|startup options]] page.=Usage=
==Accessing By default, the BaseX HTTP server makes the WebDAV==service accessible at {{Code|http://localhost:8984/webdav/}}. If no default credentials are specified, they will be requested by the client ([[Web Application#User Management|see further]]). It can be accessed by either <code>http:&#47;&#47;<httphost>:<httpport>/webdav/</code> or <code>webdav://<httphost>:<httpport>/webdav/</code>, depending on your WebDAV client.
The BaseX WebDAV Server Please note that the file size of XML documents will be displayed as 0 bytes, as the actual file size can only be accessed using either determined if the full document is being returned and serialized. This may cause problems with a <code>http:&#47;&#47;<httphost>:<httpport>/webdav/</code> or <code>webdav://<httphost>:<httpport>/webdav/</code> URL, depending on the used some WebDAV clientclients (e. By default, afterstarting the HTTP server, the following URL will be provided: <code>http://localhost:8984/webdav/</code>g. NetDrive or WebDrive).
==Authorization==
The WebDAV service uses the database user credentials in order to perform authentication and authorization. Initial user name and password are both set to <code>admin</code>. If database user and password are explicitly specified when starting the BaseX HTTP Server using the corresponding [[Startup_OptionsCommand-Line Options#BaseX_HTTP_Server|startup options]], WebDAV will not request additional user authentication from the client.
==WebDAV Clients=Root Directory=
===oXygen Editor===In the WebDAV root directory, all existing databases are listed. As new resources can only be stored inside a database, it is not possible to store files in the root directory. If a file is copied on top level, a new database will be created, which contains this resource.
Please have a look at our tutorial [[Integrating oXygen|How to integrate oXygen]] in BaseX.=Resources=
==XML Documents=Windows 7===* Open "Map network drive..." by right-clicking on "My Computer"* Click on the link "Connect to a Web site that you can use to store your documents and pictures."<br/>[[File:Webdav-explorer01.png]]<br/><br/>* Click "Next", select "Choose a custom network location" and click "Next" again.<br/>[[File:Webdav-explorer03.png]]<br/><br/>* Enter the URL address of the BaseX WebDAV Server and click "Next".<br/>[[File:Webdav-explorer04.png]]<br/>If a message saying that the folder is not valid, this is because Microsoft WebClient is not configured to use Baseic HTTP authentication. Please check [http://support.microsoft.com/kb/928692/en this Microsoft article] in order to enable Basic HTTP authentication.<br/><br/>* Enter a name for the network location and click "Next".<br/>[[File:Webdav-explorer06.png]]<br/><br/>* The BaseX WebDAV can be accessed from the Explorer window.<br/>[[File:Webdav-explorer07.png]]<br/>
===Windows XP===Uploaded files that start with an angle bracket will be stored as XML files. XML entities will be decoded during this process.
* In the "My Network Places" view, double click on "Add Network Place":[[File:WinXP01.png]]<br/>* Confirm the upcoming introductory dialog:[[File:WinXP02.png]]<br/>* Select "Choose another network location" in the next dialog:[[File:WinXP03.png]]<br/>* NextIf a file is downloaded, specify the BaseX WebDAV URL:[[File:WinXP04.png]]<br/>* Enter the user/password combination to connect to the WebDAV service:[[File:WinXP05.png]]<br/>* Assign a name to your WebDAV connection:[[File:WinXP06.png]]<br/>* Finish the wizard:[[File:WinXP07.png]]<br/>* You can now see all BaseX databases in characters with the Windows Explorer:[[Filefollowing code points will be encoded as entities:WinXP08.png]]<br/>
===KDE===* 160 (non-breaking space)* 8192–8207, 8232–8239, 8287–8303 (see [https://en.wikipedia.org/wiki/General_Punctuation General Punctuation])
* KDE SC provides two file managers - Dolphin and Konqueror, which both support WebDAV using the "webdav://" URL prefix. Start Dolphin or Konqueror and enter the BaseX WebDAV URL (e.g. webdav://localhost:8984/webdav):[[File:webdav-dolphin01.png]]<br/>* Enter the user credentials:[[File:webdav-dolphin02.png]]<br/>* After clicking "OK" the databases can be browsed:[[File:webdav-dolphin03.png]]<br/>==Binary Files==
If XML parsing files, or if the first character of the input is no angle bracket, the file will be stored as binary resource. ===GNOME Nautilus==Locking=* In Nautilus choose File -> Connect to Server:The BaseX WebDAV implementation supports locking. It can be utilized with clients which support this feature (e.g. [[FileoXygen|oXygen Editor]]). [https:webdav//tools.ietf.org/html/rfc4918#section-nautilus016.png2 EXCLUSIVE and SHARED]locks are supported, as well as [https://tools.ietf.org/html/rfc4918#section-7 WRITE]locks. '''Note:''' WebDAV locks are stored in a database called <code>~webdav</code>. If the database is deleted, it will automatically be recreated along with the next lock operations. If a resource remains locked, it can be unlocking by removing the correspondent <code><w:lockinfo><br/code>entry.* Choose "=WebDAV (HTTP)" from Clients= Please check out the "Type" drop-down following tutorials to get WebDAV running on different operating systems and enter the server address, port with oXygen: * [[WebDAV: Windows 7|Windows 7 and user credentialsup]]* [[WebDAV:Windows XP|Windows XP]]* [[FileWebDAV:webdav-nautilus02Mac OSX|Mac OSX 10.png4+]]<br/>* After clicking "Connect" the databases can be browsed[[WebDAV:GNOME|GNOME and Nautilus]]* [[FileWebDAV:webdav-nautilus03KDE|KDE]]* [[Integrating oXygen|oXygen Editor]] =Changelog= ;Version 7.png7* Added: [[#Locking|Locking]]<br/> ;Version 7.0* WebDAV API introduced
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu