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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: WebDAVContentProvider.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_WebDAVContentProvider_idl__
  31 #define __com_sun_star_ucb_WebDAVContentProvider_idl__
  32
  33 #ifndef __com_sun_star_ucb_XContentProvider_idl__
  34 #include <com/sun/star/ucb/XContentProvider.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module ucb {
  40
  41 //=============================================================================
  42 /** The WebDAV Content Provider (DCP) implements a <type>ContentProvider</type>
  43     for the <type>UniversalContentBroker</type> (UCB).
  44
  45     <p>It provides access to WebDAV     and standard HTTP servers. The DCP
  46     communicates with the server using the WebDAV protocol which is an
  47     extention to the HTTP protocol or using the plain HTTP protocol in case
  48     the server  is not WebDAV enabled.
  49
  50     @see com::sun::star::ucb::Content
  51 */
  52 published service WebDAVContentProvider
  53 {
  54     //-------------------------------------------------------------------------
  55     /** provides two types of content: a Folder or Document which corresponds
  56         to a collection or non-collection (nodes and leafs) in WebDAV
  57         respectively.
  58
  59         <p>
  60
  61         <b>DCP Contents</b>
  62         <ol>
  63         <li>
  64         A DCP Folder (<type>WebDAVFolderContent</type>) is a container for
  65         other DCP Folders or Documents.
  66         </li>
  67         <li>
  68         A DCP Document (<type>WebDAVDocumentContent</type>) is a container for
  69         Document data/content. The data/content may be anything, a WebDAV
  70         server, like an HTTP server, does not necessarily mandate what type of
  71         data/content may be     contained within Documents. The type of data/content
  72         is defined by the MediaType property which is different from the content
  73         type returned from the getContentType method. The MediaType property is
  74         mapped to the equivalent WebDAV property and the WebDAV server
  75         calculates the value.
  76         </li>
  77         </ol>
  78
  79         <p><b>URL Scheme for DCP Contents</b>
  80
  81         <p>Each DCP content has an identifier corresponding to the following
  82         scheme:
  83
  84             <ul>
  85             <li>
  86             vnd.sun.star.webdav://host:port/&lt;path&gt; where &lt;path&gt; is
  87             a hierarchical path of the form     &lt;name&gt;/.../&lt;name&gt; and
  88             where &lt;name&gt; is a string encoded according to the URL
  89             conventions.
  90             </li>
  91             </ul>
  92
  93         <p>It is also possible to use standard HTTP-URLs. In this case the
  94         implementation will determine by itself, if the requested resource
  95         is DAV enabled.
  96
  97         <p>Examples:
  98
  99         <ul>
 100         <li>
 101         vnd.sun.star.webdav://localhost/davhome/ ( a DAV collection )
 102         </li>
 103         <li>
 104         vnd.sun.star.webdav://dav.foo.com/Documents/report.sdw
 105         </li>
 106         <li>
 107         http://dav.foo.com/Documents/report.sdw
 108         </li>
 109         </ul>
 110
 111         </p>
 112      */
 113     interface com::sun::star::ucb::XContentProvider;
 114 };
 115
 116 //=============================================================================
 117
 118 }; }; }; };
 119
 120 #endif