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