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