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