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_PackageContentProvider_idl__
28#define __com_sun_star_ucb_PackageContentProvider_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 Package Content Provider (PCP) implements a <type>ContentProvider</type>
40    for the <type>UniversalContentBroker</type> (UCB).
41
42	<p>It provides access to packages ( zip / jar archive files ) containing
43	folders and streams.
44
45	@see com::sun::star::ucb::Content
46*/
47published service PackageContentProvider
48{
49	//-------------------------------------------------------------------------
50	/** provides two types of contents: Stream and Folder.
51
52		<p>
53
54		<b>PCP Contents</b>
55		<ol>
56		<li>
57		A PCP Stream (<type>PackageStreamContent</type>) is a content which
58		represents a file inside a package.	It is always contained in a PCP
59		Folder. A PCP Stream has no children.
60		</li>
61		<li>
62		A PCP Folder (<type>PackageFolderContent</type>) is a container for
63		other PCP Folders and PCP Streams.
64		</li>
65		</ol>
66
67		<p><b>URL Scheme for PCP Contents</b>
68
69		<p>Each HCP content has an identifier corresponding to the following
70		scheme:
71
72		<ul>
73		<li>
74		package-URL    = "vnd.sun.star.pkg://" orig-URL [ abs-path ]
75		</li>
76		<li>
77		abs-path       = "/" path-segments
78		</li>
79		<li>
80		path-segements = segment *( "/" segment )
81		</li>
82		<li>
83		segment        = pchar
84		</li>
85		<li>
86		pchar          = unreserved | escaped | ":" | "@" | "&" | "="
87		                 | "+" | "$" | ","
88		</li>
89		<li>
90		unreserved     = alphanum | mark
91		</li>
92		<li>
93		mark           = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")"
94		</li>
95		<li>
96		escaped        = "%" hex hex
97		</li>
98		<li>
99		orig-URL       = 1 *( unreserved | escaped | "$" | "," | ";"
100        		         | ":" | "@" | "&" | "&" | "=" | "+"
101		</li>
102		</ul>
103
104		<p>Examples:
105
106		<ul>
107		<li>
108		vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/
109		( The root folder of the package located at file:///e:/my.xsw )
110		</li>
111		<li>
112		vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content
113		( The folder/stream named "Content" that is contained in the root
114		folder of the located at file:///e:/my.xsw )
115		</li>
116		<li>
117		vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content%20A
118		( The folder/stream named "Content A" that is contained in the root
119		folder of the located at file:///e:/my.xsw )
120		</li>
121		</ul>
122
123		</p>
124	 */
125	interface com::sun::star::ucb::XContentProvider;
126};
127
128//=============================================================================
129
130}; }; }; };
131
132#endif
133