offapi/com/sun/star/ucb/WebDAVContentProvider.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_WebDAVContentProvider_idl__
  20 #define __com_sun_star_ucb_WebDAVContentProvider_idl__
  21
  22 #include <com/sun/star/ucb/XContentProvider.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27 /** The WebDAV Content Provider (DCP) implements a ContentProvider
  28     for the UniversalContentBroker (UCB).
  29
  30     <p>It provides access to WebDAV and standard HTTP servers. The DCP
  31     communicates with the server using the WebDAV protocol which is an
  32     extension to the HTTP protocol or using the plain HTTP protocol in case
  33     the server  is not WebDAV enabled.
  34
  35     @see com::sun::star::ucb::Content
  36 */
  37 published service WebDAVContentProvider
  38 {
  39     /** provides two types of content: a Folder or Document which corresponds
  40         to a collection or non-collection (nodes and leafs) in WebDAV
  41         respectively.
  42
  43         <p>
  44
  45         <b>DCP Contents</b>
  46         <ol>
  47         <li>
  48         A DCP Folder (WebDAVFolderContent) is a container for
  49         other DCP Folders or Documents.
  50         </li>
  51         <li>
  52         A DCP Document (WebDAVDocumentContent) is a container for
  53         Document data/content. The data/content may be anything, a WebDAV
  54         server, like an HTTP server, does not necessarily mandate what type of
  55         data/content may be contained within Documents. The type of data/content
  56         is defined by the MediaType property which is different from the content
  57         type returned from the getContentType method. The MediaType property is
  58         mapped to the equivalent WebDAV property and the WebDAV server
  59         calculates the value.
  60         </li>
  61         </ol>
  62
  63         <p><b>URL Scheme for DCP Contents</b>
  64
  65         <p>Each DCP content has an identifier corresponding to the following
  66         scheme:
  67
  68             <ul>
  69             <li>
  70             vnd.sun.star.webdav://host:port/&lt;path&gt; where &lt;path&gt; is
  71             a hierarchical path of the form &lt;name&gt;/.../&lt;name&gt; and
  72             where &lt;name&gt; is a string encoded according to the URL
  73             conventions.
  74             </li>
  75             </ul>
  76
  77         <p>It is also possible to use standard HTTP-URLs. In this case the
  78         implementation will determine by itself, if the requested resource
  79         is DAV enabled.
  80
  81         <p>Examples:
  82
  83         <ul>
  84         <li>
  85         vnd.sun.star.webdav://localhost/davhome/ ( a DAV collection )
  86         </li>
  87         <li>
  88         vnd.sun.star.webdav://dav.foo.com/Documents/report.sdw
  89         </li>
  90         <li>
  91         http://dav.foo.com/Documents/report.sdw
  92         </li>
  93         </ul>
  94
  95         </p>
  96      */
  97     interface com::sun::star::ucb::XContentProvider;
  98 };
  99
 100
 101 }; }; }; };
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */